Repository navigation
Enable XML documentation generation in test projects - #10358
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 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=falseoverrides from test-levelDirectory.Build.propsand fromCookieCrumble.Tests.csproj, and deleted redundant testDirectory.Build.propsfiles that only re-imported parents. - Fixed newly-surfaced XML doc warnings in tests (primarily
crefresolution, missing<param>tags, and doc comments on commented-out code). - Updated a few test files to add necessary
usingdirectives forcreftargets 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.
Contributor
|
✅ Nitro CLI E2E snapshots: no flow recordings changed vs |
This was referenced Oct 25, 2026
Merged
This was referenced Oct 26, 2026
This was referenced Oct 29, 2026
Closed
[nuget][SUI_Matcher]- Bump the sui-package-updates group with 21 updates
DFE-Digital/SUI_Matcher#424
Open
Bump HotChocolate.AspNetCore.Pipeline and HotChocolate.Fusion.AspNetCore
feddi-dev/feddi-gateway#109
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
GenerateDocumentationFileis 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).GenerateDocumentationFile=falseoverrides are removed from the test-levelDirectory.Build.propsfiles and from CookieCrumble.Tests. The 24 props files left with only the parent import are deleted, since MSBuild finds the parent on its own.creftargets, missing<param>tags, a///comment on commented-out code) and 3 Roslynator findings. These are fixed.Test plan
dotnet build src/All.slnxpasses with the default warnings-as-errors setting.