docs: Document the xref nameWithType option (#10368)

dotnet · Nov 7, 2024 · cd82ac1 · cd82ac1
1 parent fefd1db
commit cd82ac1
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/docs/links-and-cross-references.md b/docs/docs/links-and-cross-references.md
@@ -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"/>.