Skip to content

fix: clarify empty .NET API diagnostics - #11145

Merged
vicancy merged 1 commit into
dotnet:mainfrom
vicancy:vicancy-docfx-release-fixes
Sep 18, 2026
Merged

vicancy merged 1 commit into
dotnet:mainfrom
vicancy:vicancy-docfx-release-fixes

Conversation

@vicancy

@vicancy vicancy commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes #10733.

  • Keep the empty managed-reference result a warning, but make it actionable: check that inputs contain APIs to document, review API visibility and filtering rules, and include the actual configured filter path when present.
  • If no assembly loaded successfully, point to input files and earlier load/compilation diagnostics instead of implying that filtering caused the empty result.
  • Document the troubleshooting steps without recommending that users indiscriminately disable filters or expose private APIs.

Validation

Added 10 regression cases covering custom filters, internal-only APIs, empty sources, default filtering, <exclude />, assembly identification, unmatched inputs, compilation errors, and successful public/private-member generation.

20 targeted tests passed on .NET 10 (new diagnostics cases plus existing API filtering and assembly metadata tests):

dotnet test test/Docfx.Dotnet.Tests/Docfx.Dotnet.Tests.csproj --no-restore -f net10.0 -p:TargetFrameworks=net10.0 --filter "FullyQualifiedName~DotnetApiCatalogTest|FullyQualifiedName~ApiFilterUnitTest|FullyQualifiedName~GenerateMetadataFromAssemblyTest"

No filtering, visibility, or metadata generation defaults are changed.

Explain API visibility and filtering checks, identify the configured filter, and distinguish inputs that did not load or compile.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 7f961f5a-2466-4eea-b957-e596a2813466
@vicancy
vicancy merged commit 28268cf into dotnet:main Sep 18, 2026
9 checks passed
@vicancy
vicancy deleted the vicancy-docfx-release-fixes branch September 18, 2026 06:15
This was referenced Sep 23, 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.

[Bug] Error "No .net API detected" is unclear and wastes many hours

2 participants