Skip to content

[Feature Request] Generate docs ONLY for stuff with the /// comment. #9979

Open

Description

Is your feature request related to a problem? Please describe.
I want to hide some public APIs in the documentation. I want to include only those with the /// comments.

Describe the solution you'd like
Hope filter rules (apiRules in filterConfig.yml) have some option like

- apiRules:
- include:
    uidRegex: ^MyNamespace$
    type: Namespace
- exclude:
    withTripleSlashComment: false

Or options in docfx.json.

Describe alternatives you've considered
None.

Additional context
None.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    dotnet: xml-commentXML comment for .NET API reference docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions