Skip to content

Commit 27c85be

Browse files
tdykstraCopilotRick-Anderson
authored
WN10.P4 edit pass for XML comment gen improvements (#35420)
* edit pass for xml comment gen improvements * minor tweak * Update aspnetcore/release-notes/aspnetcore-10/includes/xml-comment-generator.md Co-authored-by: Copilot <[email protected]> * Update aspnetcore-10.0.md * Apply suggestions from code review Co-authored-by: Rick Anderson <[email protected]> * Update aspnetcore/release-notes/aspnetcore-10.0.md * reformat xml lines to make them shorter * Update aspnetcore/release-notes/aspnetcore-10.0.md --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Rick Anderson <[email protected]>
1 parent 4fdd01c commit 27c85be

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

aspnetcore/release-notes/aspnetcore-10.0.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ This section describes new features for OpenAPI.
5353

5454
[!INCLUDE[](~/release-notes/aspnetcore-10/includes/webapiaotTemplateAddedOpenAPI.md)]
5555

56+
[!INCLUDE[](~/release-notes/aspnetcore-10/includes/xml-comment-generator.md)]
57+
5658
[!INCLUDE[](~/release-notes/aspnetcore-10/includes/OpenApiSchemasInTransformers.md)]
5759

5860
## Authentication and authorization

aspnetcore/release-notes/aspnetcore-10/includes/xml-comment-generator.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## Improvements to XML comment generator
1+
### Improvements to the XML comment generator
22

3-
<!-- https://github.com/dotnet/aspnetcore/pull/61145 -->
3+
XML comment generation handles complex types in .NET 10 better than earlier versions of .NET.
44

5-
<!-- it should throw fewer build errors now.
6-
- It should also work with the Identity API XML comments but I haven't verified that.
7-
- Maybe update docs about failure mode. -->
5+
* It produces accurate and complete XML comments for a wider range of types.
6+
* It handles more complex scenarios.
7+
* It gracefully bypasses processing for complex types that cause build errors in earlier versions.
88

9-
The XML comment generator has been enhanced to better handle complex types. In conjunction, the generator now gracefully bypasses processing for complex types that previously caused build errors. Taken together, these changes improve the robustness of XML comment generation but change the failure mode for certain scenarios from build errors to missing metadata.
9+
These improvements change the failure mode for certain scenarios from build errors to missing metadata.
1010

1111
In addition, XML doc comment processing can now be configured to access XML comments in other assemblies. This is useful for generating documentation for types that are defined outside the current assembly, such as the `ProblemDetails` type in the `Microsoft.AspNetCore.Http` namespace.
1212

@@ -15,14 +15,16 @@ This configuration is done with directives in the project build file. The follow
1515
```xml
1616
<Target Name="AddOpenApiDependencies" AfterTargets="ResolveReferences">
1717
<ItemGroup>
18-
<!-- Include XML documentation from Microsoft.AspNetCore.Http.Abstractions to get metadata for ProblemDetails -->
18+
<!-- Include XML documentation from Microsoft.AspNetCore.Http.Abstractions
19+
to get metadata for ProblemDetails -->
1920
<AdditionalFiles
20-
Include="@(ReferencePath->'%(RootDir)%(Directory)%(Filename).xml')"
21-
Condition="'%(ReferencePath.Filename)' == 'Microsoft.AspNetCore.Http.Abstractions'"
21+
Include="@(ReferencePath->'
22+
%(RootDir)%(Directory)%(Filename).xml')"
23+
Condition="'%(ReferencePath.Filename)' ==
24+
'Microsoft.AspNetCore.Http.Abstractions'"
2225
KeepMetadata="Identity;HintPath" />
2326
</ItemGroup>
2427
</Target>
2528
```
2629

2730
We expect to include XML comments from a selected set of assemblies in the shared framework in future previews, to avoid the need for this configuration in most cases.
28-
<!--[!INCLUDE[](~/release-notes/aspnetcore-10/includes/xml-comment-generation.md)] -->

0 commit comments

Comments
 (0)