Skip to content

fix(cli): omit internal interfaces in generate-doc output - #1801

Merged
josefpihrt merged 8 commits into
mainfrom
fix/cli/generate-doc-internal-interfaces
Aug 14, 2026
Merged

fix(cli): omit internal interfaces in generate-doc output#1801
josefpihrt merged 8 commits into
mainfrom
fix/cli/generate-doc-internal-interfaces

Conversation

@josefpihrt

@josefpihrt josefpihrt commented Aug 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Filter implemented interfaces in generate-doc with IsPubliclyVisible() so internal (and otherwise non-public) interfaces are omitted from consumer-facing documentation
  • Applies to type declaration snippets, the Implements section, and member-level Implements annotations
  • GetDisplayParts takes an optional shouldDisplayInterface callback so list-symbols can still honor its own visibility filter
  • Fixes public class Public : IInternal producing links to internal IInternal in github and docusaurus output

Fixes #1635

Test plan

  • dotnet build src/Documentation/Documentation.csproj
  • dotnet build src/CommandLine/CommandLine.csproj

josefpihrt and others added 2 commits August 9, 2026 17:34
Fixes #1635

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

@josefpihrt josefpihrt left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review notes for omitting restrictive interfaces from generate-doc. The accessibility filter matches #1635; a couple of cleanup/test notes.

Comment thread src/Documentation/Extensions/SymbolExtensions.cs Outdated
Comment thread src/Documentation/Extensions/SymbolExtensions.cs Outdated
Josef Pihrt and others added 4 commits August 14, 2026 19:34
Co-authored-by: Cursor <cursoragent@cursor.com>
…lter

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Use the existing public-API visibility check instead of comparing declared accessibility, and drop the Documentation.Tests project added for the previous helpers.

Co-authored-by: Cursor <cursoragent@cursor.com>
Comment thread src/Documentation/TypeDocumentationModel.cs Outdated
Comment thread src/Documentation/SymbolDefinitionDisplay.cs Outdated
josefpihrt and others added 2 commits August 14, 2026 23:18
Keep generate-doc on IsPubliclyVisible without hardcoding public-only in the shared list-symbols display path.

Co-authored-by: Cursor <cursoragent@cursor.com>
@josefpihrt
josefpihrt merged commit 005016f into main Aug 14, 2026
17 checks passed
@josefpihrt
josefpihrt deleted the fix/cli/generate-doc-internal-interfaces branch August 14, 2026 21:33
This was referenced Aug 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

generate-doc: don't mention internal interfaces

1 participant