Merge branch 'main' into avoid-multi-enumeration-warnings-in-TryGetSt…

…ringBeforeChars
dotnet · Nov 7, 2024 · 7b46e2f · 7b46e2f
2 parents 6e79b7c + 2375701
commit 7b46e2f
Show file tree

Hide file tree

Showing 6 changed files with 5 additions and 4,612 deletions.
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -43,7 +43,6 @@
     <PackageVersion Include="coverlet.collector" Version="6.0.2" />
     <PackageVersion Include="FluentAssertions" Version="6.12.1" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
-    <PackageVersion Include="PublicApiGenerator" Version="11.1.0" />
     <PackageVersion Include="Verify.DiffPlex" Version="3.1.2" />
     <PackageVersion Include="Verify.Xunit" Version="28.1.3" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />

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"/>.

diff --git a/src/Docfx.Dotnet/Parsers/XmlComment.cs b/src/Docfx.Dotnet/Parsers/XmlComment.cs
@@ -60,9 +60,8 @@ private XmlComment(string xml, XmlCommentParserContext context)
             else
                 xml = $"<member><summary>{innerXml}</summary></member>";
         }
-
         // Workaround: https://github.com/dotnet/roslyn/pull/66668
-        if (!xml.StartsWith("<member", StringComparison.Ordinal) && !xml.EndsWith("</member>", StringComparison.Ordinal))
+        else if (!xml.StartsWith("<member", StringComparison.Ordinal) && !xml.EndsWith("</member>", StringComparison.Ordinal))
         {
             xml = $"<member>{xml}</member>";
         }