Skip to content

Enable XML Documentation in NuGet packages #10685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 27, 2025

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

  • Added GenerateDocumentationFile=true in Directory.Build.Props for all non-test projects
  • Added explicit conditions to disable XML documentation for test projects
  • Suppressed CS1591 warnings (missing XML documentation) to avoid build errors
  • Verified that the XML documentation files are correctly included in NuGet packages

Testing

  • Built and packaged Docfx.App to confirm XML documentation is properly included
  • Verified that test projects don't generate XML documentation files
  • All existing functionality continues to work as expected

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
    • Triggering command: dotnet build src/Docfx.App/Docfx.App.csproj (dns block)
    • Triggering command: dotnet build test/Docfx.Common.Tests/Docfx.Common.Tests.csproj (dns block)
  • crl4.digicert.com
    • Triggering command: dotnet build src/Docfx.App/Docfx.App.csproj (dns block)
    • Triggering command: dotnet build test/Docfx.Common.Tests/Docfx.Common.Tests.csproj (dns block)
  • ocsp.digicert.com
    • Triggering command: dotnet build src/Docfx.App/Docfx.App.csproj (dns block)
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)
    • Triggering command: dotnet build test/Docfx.Common.Tests/Docfx.Common.Tests.csproj (dns block)
  • s.symcb.com
    • Triggering command: dotnet build src/Docfx.App/Docfx.App.csproj (dns block)
  • s.symcd.com
    • Triggering command: dotnet build src/Docfx.App/Docfx.App.csproj (dns block)
  • ts-crl.ws.symantec.com
    • Triggering command: dotnet build src/Docfx.App/Docfx.App.csproj (dns block)
  • ts-ocsp.ws.symantec.com
    • Triggering command: dotnet build src/Docfx.App/Docfx.App.csproj (dns block)
  • www.microsoft.com
    • Triggering command: 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.

Co-authored-by: yufeih <511355+yufeih@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] [Feature Request] Include Document XML in NuGet packages Enable XML Documentation in NuGet packages May 27, 2025
@Copilot Copilot AI requested a review from yufeih May 27, 2025 07:35
Copilot finished work on behalf of yufeih May 27, 2025 07:35
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.

[Feature Request] Include Document XML in NuGet packages
2 participants