dotnet / dotnet/docfx

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

Open
#9,979 2 comments 1 reaction 0 assignees View on GitHub
dotnet: xml-comment
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 9m
Merged PRs (30d)
11

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.

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.