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.

Sign up for GitHub

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

Enable XML Documentation in NuGet packages #10685

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c453e5
Initial plan for issue
Copilot May 27, 2025
dd1049f
Enable XML documentation generation for NuGet packages
Copilot May 27, 2025
1e6b0e1
Merge branch 'main' into copilot/fix-8944
yufeih May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
<EmbedUntrackedSources>true</EmbedUntrackedSources>

<!-- Generate XML documentation file for IntelliSense -->
<GenerateDocumentationFile Condition="'$(IsTestProject)' != 'true' and !$(MSBuildProjectName.EndsWith('Tests')) and !$(MSBuildProjectName.Contains('.Tests.'))">true</GenerateDocumentationFile>
<!-- Explicitly disable XML documentation for test projects -->
<GenerateDocumentationFile Condition="'$(IsTestProject)' == 'true' or $(MSBuildProjectName.EndsWith('Tests')) or $(MSBuildProjectName.Contains('.Tests.'))">false</GenerateDocumentationFile>
<!-- Suppress XML documentation warnings (CS1591) temporarily -->
<NoWarn Condition="'$(GenerateDocumentationFile)' == 'true'">$(NoWarn);CS1591</NoWarn>

<Authors>.NET Foundation and Contributors</Authors>
<Copyright>Copyright (c) .NET Foundation and Contributors</Copyright>
<Description>Technical documentation tool with markdown, API docs for .NET, REST API and more.</Description>
Expand Down
Loading