Use Markdown link format for <see href="url">text</see> XMLDOC tags

domaindrivendev · Apr 15, 2024 · 5c49b58 · 5c49b58
1 parent 0108842
commit 5c49b58
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsTextHelper.cs b/src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsTextHelper.cs
@@ -11,6 +11,7 @@ public static class XmlCommentsTextHelper
         private static Regex CodeTagPattern = new Regex(@"<c>(?<display>.+?)</c>");
         private static Regex MultilineCodeTagPattern = new Regex(@"<code>(?<display>.+?)</code>", RegexOptions.Singleline);
         private static Regex ParaTagPattern = new Regex(@"<para>(?<display>.+?)</para>", RegexOptions.Singleline);
+        private static Regex HrefPattern = new(@"<see href=\""(.*)\"">(.*)<\/see>");
 
         public static string Humanize(string text)
         {
@@ -22,6 +23,7 @@ public static string Humanize(string text)
             return text
                 .NormalizeIndentation()
                 .HumanizeRefTags()
+                .HumanizeHrefTags()
                 .HumanizeCodeTags()
                 .HumanizeMultilineCodeTags()
                 .HumanizeParaTags()
@@ -92,6 +94,11 @@ private static string HumanizeRefTags(this string text)
             return RefTagPattern.Replace(text, (match) => match.Groups["display"].Value);
         }
 
+        private static string HumanizeHrefTags(this string text)
+        {
+            return HrefPattern.Replace(text, m => $"[{m.Groups[2].Value}]({m.Groups[1].Value})");
+        }
+
         private static string HumanizeCodeTags(this string text)
         {
             return CodeTagPattern.Replace(text, (match) => "`" + match.Groups["display"].Value + "`");

diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlCommentsTextHelperTests.cs b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlCommentsTextHelperTests.cs
@@ -131,6 +131,7 @@ Misplaced Tab Indentation
         [InlineData("<para>This is a paragraph</para>.", "<br>This is a paragraph.")]
         [InlineData("GET /Todo?iscomplete=true&amp;owner=mike", "GET /Todo?iscomplete=true&owner=mike")]
         [InlineData(@"Returns a <see langword=""null""/> item.", "Returns a null item.")]
+        [InlineData(@"<see href=""https://www.iso.org/iso-4217-currency-codes.html"">ISO currency code</see>", "[ISO currency code](https://www.iso.org/iso-4217-currency-codes.html)")]
         public void Humanize_HumanizesInlineTags(
             string input,
             string expectedOutput)