dotnet / dotnet/docfx

Cannot filter out the APIs

Open
#3,665 16 comments 0 reactions 0 assignees View on GitHub
dotnet dotnet: api-filter
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**DocFX Version Used**:
2.40.2

**Template used**: (`default` or `statictoc` or contain custom template)
statistic

**Steps to Reproduce**:

1. Created a filter document (filterConfig.yml)
2. Included APIs
apiRules:

-include:
uidRegex: ^Kevin\.Avignon\.People\.Namespace\.Person
type: Class
-include:
uidRegex: ^Kevin\.Avignon\.People\.Namespace\.PeopleController\.GetPerson
type: Method

-exclude:
uidRegex: ^Kevin\.Avignon\.People
type: Type

3.

**Expected Behavior**:

I expect to see to the public documentation of Person class, the public documentation for GetPerson method and everything under the People namespace to be excluded.
**Actual Behavior**:
I only see the public documentation of Person.

This is a business case where I have changed the documentation content so I don't divulge any sensible information, but the gist is here.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.