Enable XML Documentation in NuGet packages #10685
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enables XML documentation generation for NuGet packages in the repository, specifically to address IntelliSense support when using packages like
Microsoft.DocAsCode.App
.Changes
GenerateDocumentationFile=true
in Directory.Build.Props for all non-test projectsTesting
The warnings about missing XML documentation are suppressed for now, but in the future, we could gradually add proper documentation comments to public APIs.
Fixes #8944.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
crl3.digicert.com
dotnet build src/Docfx.App/Docfx.App.csproj
(dns block)dotnet build test/Docfx.Common.Tests/Docfx.Common.Tests.csproj
(dns block)crl4.digicert.com
dotnet build src/Docfx.App/Docfx.App.csproj
(dns block)dotnet build test/Docfx.Common.Tests/Docfx.Common.Tests.csproj
(dns block)ocsp.digicert.com
dotnet build src/Docfx.App/Docfx.App.csproj
(dns block)/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js
(dns block)dotnet build test/Docfx.Common.Tests/Docfx.Common.Tests.csproj
(dns block)s.symcb.com
dotnet build src/Docfx.App/Docfx.App.csproj
(dns block)s.symcd.com
dotnet build src/Docfx.App/Docfx.App.csproj
(dns block)ts-crl.ws.symantec.com
dotnet build src/Docfx.App/Docfx.App.csproj
(dns block)ts-ocsp.ws.symantec.com
dotnet build src/Docfx.App/Docfx.App.csproj
(dns block)www.microsoft.com
dotnet build test/Docfx.Common.Tests/Docfx.Common.Tests.csproj
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.