Skip to content

Document the xref nameWithType option #10368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yufeih merged 1 commit into from
Nov 7, 2024
Merged

Document the xref nameWithType option #10368

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/docs/links-and-cross-references.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,8 @@ You can create a cross link with following options:
- `displayProperty`: the property of display text when the cross reference is has resolved correctly.

e.g.: `<a href="xref:System.String?displayProperty=fullName"/>` will be resolved as <a href="xref:System.String?displayProperty=fullName"/>.

e.g.: `<a href="xref:System.String.Length?displayProperty=nameWithType"/>` will be resolved as <a href="xref:System.String.Length?displayProperty=nameWithType"/>.
- `altProperty`: the property of display text when the cross reference does not have a `href` property.

e.g.: ``<xref href="System.Collections.Immutable.ImmutableArray`1" altProperty="name"/>`` will be resolved as <xref href="System.Collections.Immutable.ImmutableArray`1" altProperty="name"/>.
Expand Down