Skip to content

Enable XML documentation generation in test projects - #10358

Merged
glen-84 merged 3 commits into
mainfrom
gai/enable-xml-docs-in-test-projects
Sep 6, 2026
Merged

glen-84 merged 3 commits into
mainfrom
gai/enable-xml-docs-in-test-projects

Conversation

@glen-84

@glen-84 glen-84 commented Sep 6, 2026

Copy link
Copy Markdown
Member

Summary

  • Every test project now generates its XML documentation file, so GenerateDocumentationFile is on for the whole repository. This is the prerequisite for enforcing IDE0005 (unnecessary usings) in the build: the compiler only reports it when documentation comments are parsed (dotnet/roslyn#41640).
  • The GenerateDocumentationFile=false overrides are removed from the test-level Directory.Build.props files and from CookieCrumble.Tests. The 24 props files left with only the parent import are deleted, since MSBuild finds the parent on its own.
  • Compiling the doc comments in tests surfaced 31 compiler warnings (unresolved or ambiguous cref targets, missing <param> tags, a /// comment on commented-out code) and 3 Roslynator findings. These are fixed.

Test plan

  • dotnet build src/All.slnx passes with the default warnings-as-errors setting.
  • CI.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

A couple of XML-doc-related issues remain (notably documentation mismatches in changed code) that should be corrected to keep the repo’s “XML docs on everywhere” state consistent and warning-free.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Enables XML documentation file generation for test projects across the repository (removing per-test overrides) so doc comments are parsed consistently, which is a prerequisite for enforcing IDE0005/unnecessary usings during builds.

Changes:

  • Removed GenerateDocumentationFile=false overrides from test-level Directory.Build.props and from CookieCrumble.Tests.csproj, and deleted redundant test Directory.Build.props files that only re-imported parents.
  • Fixed newly-surfaced XML doc warnings in tests (primarily cref resolution, missing <param> tags, and doc comments on commented-out code).
  • Updated a few test files to add necessary using directives for cref targets and to adjust doc comment formatting.
File summaries
File Description
src/StrawberryShake/Tooling/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/StrawberryShake/CodeGeneration/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/StrawberryShake/Client/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/Nitro/Common/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/Nitro/CommandLine/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/Nitro/CommandLine/test/CommandLine.Tests/Tui/Shell/TaskItemBuilder.cs Added using to resolve XML doc cref targets.
src/Nitro/CommandLine/test/CommandLine.Tests/Tui/Shell/FakeTaskStore.cs Added using to resolve XML doc cref targets.
src/Nitro/CommandLine/test/CommandLine.Tests/Tui/Mail/FakeMailStore.cs Adjusted XML doc cref to match current API surface.
src/Nitro/CommandLine/test/CommandLine.Tests/Tui/Editing/FakeTaskStore.cs Added using to resolve XML doc cref targets.
src/Nitro/CommandLine/test/CommandLine.Tests/Services/Hook/CodexQueueClientTests.cs Reflowed XML doc text for doc parsing/formatting.
src/Nitro/CommandLine/test/CommandLine.Tests/Commands/CommandTestBase.cs Removed an XML doc block that was causing doc parsing issues.
src/Nitro/CommandLine/test/CommandLine.Tests/Commands/Agent/Mail/WatchMailCommandTests.cs Fixed XML doc cref target to a resolvable member.
src/Nitro/CommandLine/test/CommandLine.Tests/Commands/Agent/Mail/MailCommandTestBase.cs Fixed XML doc cref targets to resolvable members.
src/Nitro/CommandLine/test/CommandLine.Tests/Commands/Agent/CodexHooksCommandTests.cs Reflowed XML doc text for doc parsing/formatting.
src/Mocha/test/Mocha.Transport.InMemory.Tests/Routing/InMemoryNeutralSchemeGatingTests.cs Updated cref to point at the correct API member/signature.
src/Mocha/test/Directory.Build.props Removed GenerateDocumentationFile=false override in test props.
src/HotChocolate/Utilities/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Spatial/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Raven/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Primitives/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/PersistedOperations/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Mutable/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/MongoDb/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Marten/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Language/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Json/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Suites/SimpleEntityCall/Nickname/QueryType.cs Fixed XML doc cref to a resolvable extension method overload.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Suites/ParentEntityCallComplex/C/QueryType.cs Fixed XML doc cref to a resolvable extension method overload.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Suites/ParentEntityCallComplex/B/QueryType.cs Fixed XML doc cref to a resolvable extension method overload.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Suites/ParentEntityCallComplex/A/QueryType.cs Fixed XML doc cref to a resolvable extension method overload.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Suites/ParentEntityCall/C/QueryType.cs Fixed XML doc cref to a resolvable extension method overload.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Suites/ParentEntityCall/B/QueryType.cs Fixed XML doc cref to a resolvable extension method overload.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Suites/Mutations/B/QueryType.cs Fixed XML doc cref to a resolvable extension method overload.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Suites/ComplexEntityCall/Link/QueryType.cs Fixed XML doc cref to a resolvable extension method overload.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Infrastructure/SubgraphEndpointExtensions.cs Added missing <param> doc; adjusted doc content for new parameter.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Infrastructure/FusionGatewayBuilder.cs Added missing <param> docs for newly documented parameters.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Infrastructure/FusionGateway.cs Fixed XML doc cref to a fully-qualified type for resolution.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Infrastructure/ComplianceTestBase.cs Updated XML doc cref to match the correct RunAsync signature.
src/HotChocolate/Fusion/test/Fusion.Connectors.ApolloFederation.Compliance.Tests/Infrastructure/AuditFixture.cs Updated XML doc cref to match the correct RunAsync signature.
src/HotChocolate/Fusion/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Diagnostics/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Data/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Data/test/Data.Tests/TestContext2/Product.cs Removed XML doc comment from commented-out code to avoid doc warnings.
src/HotChocolate/Data/test/Data.Filters.SqlServer.Tests/TestContext/Product.cs Removed XML doc comment from commented-out code to avoid doc warnings.
src/HotChocolate/Data/test/Data.EntityFramework.Tests/TestContext/Product.cs Removed XML doc comment from commented-out code to avoid doc warnings.
src/HotChocolate/Data/test/Data.EntityFramework.Pagination.Tests/TestContext/Product.cs Removed XML doc comment from commented-out code to avoid doc warnings.
src/HotChocolate/CostAnalysis/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Core/test/Directory.Build.props Removed GenerateDocumentationFile=false override in test props.
src/HotChocolate/Caching/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/AzureFunctions/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/AspNetCore/test/Directory.Build.props Removed GenerateDocumentationFile=false override in test props.
src/HotChocolate/ApolloFederation/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/HotChocolate/Adapters/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/GreenDonut/test/GreenDonut.Data.EntityFramework.Tests/TestContext/Product.cs Removed XML doc comment from commented-out code to avoid doc warnings.
src/GreenDonut/test/Directory.Build.props Deleted redundant test props that disabled XML doc generation.
src/CookieCrumble/test/CookieCrumble.Tests/CookieCrumble.Tests.csproj Removed GenerateDocumentationFile=false override in the test project.
Review details
  • Files reviewed: 56/56 changed files
  • Comments generated: 2
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

✅ Nitro CLI E2E snapshots: no flow recordings changed vs main.

@glen-84
glen-84 merged commit 9911d6c into main Sep 6, 2026
153 checks passed
@glen-84
glen-84 deleted the gai/enable-xml-docs-in-test-projects branch September 6, 2026 12:31
This was referenced Oct 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants