Skip to content

Commit cd82ac1

Browse files
authored
docs: Document the xref nameWithType option (#10368)
1 parent fefd1db commit cd82ac1

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

docs/docs/links-and-cross-references.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,8 @@ You can create a cross link with following options:
178178
- `displayProperty`: the property of display text when the cross reference is has resolved correctly.
179179

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

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

0 commit comments

Comments
 (0)