Skip to content

XML Documentation for PersistentStateAttribute.RestoreBehavior is malformed. #64107

@KristofferStrube

Description

@KristofferStrube

Is there an existing issue for this?

  • I have searched the existing issues

Describe the bug

When we look in the source of PersistentStateAttribute we see that it uses <code /> tags to link to a type/value, but that is not the right syntax for XML Documentation.

Expected Behavior

The <code /> tags should be changed to <see /> tags.

/// <remarks>
/// By default it always restores the value on all situations.
-/// Use <code cref="RestoreBehavior.SkipInitialValue"/> to skip restoring the initial value
+/// Use <see cref="RestoreBehavior.SkipInitialValue"/> to skip restoring the initial value
/// when the host starts up.
-/// Use <code cref="RestoreBehavior.SkipLastSnapshot"/> to skip restoring the last value captured
+/// Use <see cref="RestoreBehavior.SkipLastSnapshot"/> to skip restoring the last value captured
/// the last time the current host was shut down.
/// </remarks>

I can submit a PR if you would like.

Steps To Reproduce

No response

Exceptions (if any)

No response

.NET Version

No response

Anything else?

No response

Metadata

Metadata

Assignees

Labels

area-blazorIncludes: Blazor, Razor Components

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions