dotnet / dotnet/docfx

Filter out API without triple-slash comments

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

Description

**Operating System**: `Windows`
**DocFX Version Used**: 2.56.2.0

Is it possible to automatically filter out all API that have no triple-slash comments?

**Use case:**

When I develop new API for my library I create types and members without triple-slash comments. I create comments right before new version release. So API without triple-slash comments is in fact new API that should not be exported to documentation (since it's not released yet). So when I want to edit existing docs and pushing changes to repo I want to prevent new API pages in docs.

Of course I can use `filter.yml` with all new API specified (and I do so right now), but it leads to a lot of manual work.

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.