Skip to content

Exclude API class #1948

Description

@dawsongh

DocFX Version Used 2.22.2.0

Template used: default

Steps to Reproduce:
Trying to exclude a specific class from being included, so I have added to docfx.json the filter option:
],
"dest": "api",
"filter": "filterConfig.yml"
}

Inside the filerConfig.yml, I have tried two different ways.

  1. Using uidRegex on the namespace and class name
  2. Also by attribute as I added [Obsolete] before the class

Expected Behavior:
I expect the class CRCdelme not to be included in the documentation, it seems that the filterConfig.yml is being opening but the excludes are not happening!

Actual Behavior:
The class is included in the index and is documented in the _Site directory

filterConfig.yml

apiRules:

- exclude:
  uidRegex: '^FpAssistantCore\.BusinessObjects\.GeneralAviation\.CRCdelme$'
  type: Class

- exclude:
    hasAttribute:
      uid: System.ObsoleteAttribute
    type: Member

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions