dotnet / docfx

Static site generator for .NET API documentation.
https://dotnet.github.io/docfx/
MIT License
3.94k stars 840 forks source link

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

Open GarfieldJiang opened 1 month ago

GarfieldJiang commented 1 month ago

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.

filzrev commented 1 month ago

docfx supports /// <exclude /> tag to exclude specific items from documentation.

So if the number of undocumented APIs is relatively small. It can be resolved by manually adding exclude tags at locations.

GarfieldJiang commented 1 month ago

Thanks for the heads up. I know this thing, but a little less than satisfying. Acceptable, however.