Skip to content

Backport XML doc comments for DispatchProxy from dotnet-api-docs#124361

Open
Copilot wants to merge 8 commits intomainfrom
copilot/backport-xml-doc-comments-again
Open

Backport XML doc comments for DispatchProxy from dotnet-api-docs#124361
Copilot wants to merge 8 commits intomainfrom
copilot/backport-xml-doc-comments-again

Conversation

Copy link
Contributor

Copilot AI commented Feb 12, 2026

Fixes dotnet/dotnet-api-docs#12316.

Description

Backports XML documentation for DispatchProxy from dotnet-api-docs.

Changes

  • Updated summaries and parameter descriptions to match dotnet-api-docs
  • Used <see langword="null" /> instead of <c>null</c> for keyword references
  • Formatted exception documentation with <para> tags for multi-condition cases
  • Fixed exception documentation to accurately reflect actual validation logic:
    • Create<T, TProxy>: Changed "T is a class" to "T is not an interface type" and added "abstract" condition for TProxy
    • Create(Type, Type): Changed "interfaceType is a class" to "interfaceType is not an interface type" and added "abstract" condition for proxyType
  • Fixed grammar error: Create(Type, Type) exception docs stated proxy type throws when it "has" a parameterless constructor; corrected to "does not have" (matches code behavior requiring DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)
  • Added XML documentation for the protected constructor (was missing in dotnet-api-docs)
  • Removed <UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile> from the project file to enable automatic XML documentation file generation

Similar 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.

Copilot AI and others added 3 commits February 12, 2026 23:45
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 AI changed the title [WIP] Backport XML doc comments for DispatchProxy Backport XML doc comments for DispatchProxy from dotnet-api-docs Feb 12, 2026
Copilot AI requested a review from gewarren February 12, 2026 23:47
@github-actions github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Feb 12, 2026
Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

@copilot Please also update the .csproj file for this assembly to remove <UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile>.

@gewarren
Copy link
Contributor

gewarren commented Feb 13, 2026

@copilot Please also update the .csproj file for this assembly to remove <UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile>.

Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 13, 2026

@copilot Please also update the .csproj file for this assembly to remove <UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile>.

Done in 086f322.

@copilot Please also update the .csproj file for this assembly to remove <UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile>.

Done in 086f322.

@dotnet-policy-service
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-system-reflection
See info in area-owners.md if you want to be subscribed.

@gewarren gewarren marked this pull request as ready for review February 13, 2026 01:12
Copilot AI review requested due to automatic review settings February 13, 2026 01:12
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 DispatchProxy XML 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.

…ction/DispatchProxy.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
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.

Backport docs for System.Reflection.DispatchProxy.dll

3 participants