Backport XML documentation for CustomReflectionContext#124365
Backport XML documentation for CustomReflectionContext#124365
Conversation
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
|
Tagging subscribers to this area: @dotnet/area-system-reflection |
src/libraries/System.Reflection.Context/ref/System.Reflection.Context.cs
Show resolved
Hide resolved
...libraries/System.Reflection.Context/src/System/Reflection/Context/CustomReflectionContext.cs
Outdated
Show resolved
Hide resolved
… src remarks Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Addressed all feedback in commit 865415d:
|
...libraries/System.Reflection.Context/src/System/Reflection/Context/CustomReflectionContext.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR backports XML documentation from dotnet-api-docs to the runtime repository for the CustomReflectionContext class, following the established pattern from PR #124227. The documentation provides IntelliSense support for developers using this reflection API.
Changes:
- Added comprehensive XML documentation to
CustomReflectionContextclass including type-level summary, simplified remarks with a link to supplemental documentation, and complete member-level documentation - All public and protected members now have summaries, parameter descriptions, return value documentation, and brief contextual remarks where appropriate
- Followed the established convention of not adding documentation to ref assemblies
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
There was a problem hiding this comment.
@copilot please remove docs from ref assembly but keep changes to .csproj file.
There was a problem hiding this comment.
Removed XML docs from the ref assembly in commit 6c60cb8. Kept the .csproj change (no UseCompilerGeneratedDocXmlFile=false) and added NoWarn for CS1591 to suppress missing XML doc warnings in the generated netstandard2.0 platform-not-supported stub.
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Description
Backports XML documentation from dotnet-api-docs to the runtime repository per #124227.
Changes:
CustomReflectionContextclass in src assembly with summary and simplified type-level remarkshttps://github.com/dotnet/docs/raw/main/docs/fundamentals/runtime-libraries/system-reflection-context-customreflectioncontext.mdAddPropertiesandCreatePropertymethods)UseCompilerGeneratedDocXmlFile=falsefrom csproj to enable compiler-generated XML documentation files<NoWarn>$(NoWarn);CS1591</NoWarn>to suppress missing XML documentation warnings in generated platform-not-supported stubsCustomer Impact
Developers using
System.Reflection.Contextwill have IntelliSense documentation with summaries, parameter descriptions, and brief contextual remarks for all members, plus a link to comprehensive documentation showing how to customize reflection behavior through attribute manipulation and virtual properties.Regression
No. Documentation-only change.
Testing
Risk
Minimal. Documentation-only change with no runtime impact.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.