Fix malformed XML documentation in PersistentStateAttribute #64113
+2
−2
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
Fixed malformed XML documentation in
PersistentStateAttribute.RestoreBehavior
property that was using incorrect<code cref="..."/>
tags instead of the proper<see cref="..."/>
syntax.Problem
The XML documentation was using
<code>
tags withcref
attributes to reference enum values:/// Use <code cref="RestoreBehavior.SkipInitialValue"/> to skip restoring the initial value
The
<code>
tag is meant for code samples, not for creating references to types or members. This results in malformed documentation where the cross-references won't work properly in generated documentation or IDE IntelliSense.Solution
Changed the tags to use
<see cref="..."/>
, which is the correct XML documentation syntax for creating references:/// Use <see cref="RestoreBehavior.SkipInitialValue"/> to skip restoring the initial value
This change ensures that:
RestoreBehavior.cs
already uses<see cref="..."/>
)Changes
PersistentStateAttribute.RestoreBehavior
property<code cref="RestoreBehavior.SkipInitialValue"/>
to<see cref="RestoreBehavior.SkipInitialValue"/>
<code cref="RestoreBehavior.SkipLastSnapshot"/>
to<see cref="RestoreBehavior.SkipLastSnapshot"/>
Fixes #issue_number
Original prompt
Fixes #64107
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.