Backport XML doc comments for DispatchProxy from dotnet-api-docs#124361
Backport XML doc comments for DispatchProxy from dotnet-api-docs#124361
Conversation
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
…es not have' parameterless constructor Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
|
@copilot Please also update the .csproj file for this assembly to remove |
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Done in 086f322.
Done in 086f322. |
|
Tagging subscribers to this area: @dotnet/area-system-reflection |
There was a problem hiding this comment.
Pull request overview
Backports and modernizes XML documentation for System.Reflection.DispatchProxy to align with dotnet-api-docs, and adjusts the project to allow compiler-generated XML doc output.
Changes:
- Updated
DispatchProxyXML docs (summaries, params/returns, and exception docs), including using<see langword="null" />. - Reformatted multi-condition exception documentation using
<para>blocks. - Removed
<UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile>from the project file to enable compiler XML documentation generation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/libraries/System.Reflection.DispatchProxy/src/System/Reflection/DispatchProxy.cs | Doc updates for summaries/params/returns and exception documentation on Invoke and Create overloads. |
| src/libraries/System.Reflection.DispatchProxy/src/System.Reflection.DispatchProxy.csproj | Enables compiler-generated XML doc file by removing an overriding property. |
src/libraries/System.Reflection.DispatchProxy/src/System/Reflection/DispatchProxy.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Reflection.DispatchProxy/src/System/Reflection/DispatchProxy.cs
Outdated
Show resolved
Hide resolved
…ction/DispatchProxy.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
src/libraries/System.Reflection.DispatchProxy/src/System/Reflection/DispatchProxy.cs
Show resolved
Hide resolved
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Fixes dotnet/dotnet-api-docs#12316.
Description
Backports XML documentation for
DispatchProxyfrom dotnet-api-docs.Changes
<see langword="null" />instead of<c>null</c>for keyword references<para>tags for multi-condition casesCreate<T, TProxy>: Changed "T is a class" to "T is not an interface type" and added "abstract" condition for TProxyCreate(Type, Type): Changed "interfaceType is a class" to "interfaceType is not an interface type" and added "abstract" condition for proxyTypeCreate(Type, Type)exception docs stated proxy type throws when it "has" a parameterless constructor; corrected to "does not have" (matches code behavior requiringDynamicallyAccessedMemberTypes.PublicParameterlessConstructor)<UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile>from the project file to enable automatic XML documentation file generationSimilar to PR #124227.
💡 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.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.