Support extracting markdown from <remarks>, and parse <img src="" /> to markdown.

Layoric · Layoric · commit b34ad70b08c5 · 2022-10-11T16:17:48.000+11:00
diff --git a/markdowngen/DTOs.cs b/markdowngen/DTOs.cs
@@ -39,6 +39,7 @@ public class Item
     public string[]? InheritedMembers { get; set; }
 
     public string[] ExtensionMethods { get; set; }
+    public string Remarks { get; set; }
     // modifiers.csharp
     // modifiers.vb
 }
diff --git a/markdowngen/Program.cs b/markdowngen/Program.cs
@@ -78,7 +78,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>
         str.AppendLine("sidebar_label: " + item.Name);
         if (item.Summary != null)
             // todo: run a regex replace to get rid of hyperlinks and inline code blocks?
-            str.AppendLine($"description: \"{items.GetSummary(item.Summary)?.Trim().Replace("\"", "\\\"")}\"");
+            str.AppendLine($"description: \"{item.GetSummary(items,item.Summary)?.Trim().Replace("\"", "\\\"")}\"");
         str.AppendLine("---");
         str.AppendLine();
         if (config.UseIconify)
@@ -88,7 +88,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>
         }
         
         str.AppendLine(item.WithIconifyHeading("# "));
-        str.AppendLine(items.GetSummary(item.Summary)?.Trim());
+        str.AppendLine(item.GetSummary(items,item.Summary)?.Trim());
         str.AppendLine();
         str.AppendLine($"###### **Assembly**: {item.Assemblies[0]}.dll");
         MarkdownWritingExtensions.Declaration(str, item);
@@ -103,7 +103,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>
                     str.AppendLine(property.WithIconifyHeading());
                 else
                     str.AppendLine($"### {property.Name}");
-                str.AppendLine(items.GetSummary(property.Summary)?.Trim());
+                str.AppendLine(item.GetSummary(items,property.Summary)?.Trim());
                 MarkdownWritingExtensions.Declaration(str, property);
             }
         }
@@ -119,7 +119,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>
                     str.AppendLine(property.WithIconifyHeading());
                 else
                     str.AppendLine($"### {property.Name}");
-                str.AppendLine(items.GetSummary(property.Summary)?.Trim());
+                str.AppendLine(item.GetSummary(items,property.Summary)?.Trim());
                 MarkdownWritingExtensions.Declaration(str, property);
             }
         }
@@ -133,7 +133,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>
             foreach (var field in fields)
             {
                 str.AppendLine(config.UseIconify ? field.WithIconifyHeading() : $"### {field.Name}");
-                str.AppendLine(items.GetSummary(field.Summary)?.Trim());
+                str.AppendLine(item.GetSummary(items,field.Summary)?.Trim());
                 MarkdownWritingExtensions.Declaration(str, field);
             }
         }
@@ -168,7 +168,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>
             foreach (var @event in events)
             {
                 str.AppendLine($"### {@event.Name.HtmlEscape()}");
-                str.AppendLine(items.GetSummary(@event.Summary)?.Trim());
+                str.AppendLine(item.GetSummary(items,@event.Summary)?.Trim());
                 MarkdownWritingExtensions.Declaration(str, @event);
                 str.AppendLine("##### Event Type");
                 if (@event.Syntax.Return.Description == null)
@@ -219,7 +219,7 @@ void Do(string type, string header)
                 foreach (var item1 in @where.OrderBy(i => i.Name))
                 {
                     str.AppendLine($"### {items.Link(item1.Uid, config, true)}");
-                    str.AppendLine(items.GetSummary(item1.Summary)?.Trim());
+                    str.AppendLine(item.GetSummary(items,item1.Summary)?.Trim());
                 }
             }
         }
diff --git a/markdowngen/Utils.cs b/markdowngen/Utils.cs
@@ -80,6 +80,7 @@ public static class MarkdownWritingExtensions
 
     static Regex codeRegex = new("<code>(.+?)</code>", RegexOptions.Compiled);
     static Regex linkRegex = new("<a href=\"(.+?)\">(.+?)</a>", RegexOptions.Compiled);
+    static Regex imgRegex = new ("<img src=[\"'](.+?)[\"'].*?>", RegexOptions.Compiled);
 
     private static List<string> csharpKeywords = new()
     {
@@ -176,7 +177,7 @@ public static string Link(this Dictionary<string, Item> items, string uid, Confi
         return result;
     }
     
-    public static string? GetSummary(this Dictionary<string, Item> items, string? summary)
+    public static string? GetSummary(this Item item, Dictionary<string, Item> items, string? summary)
     {
         if (summary == null)
             return null;
@@ -188,6 +189,9 @@ public static string Link(this Dictionary<string, Item> items, string uid, Confi
         summary = langwordXrefRegex.Replace(summary, match => $"`{match.Groups[1].Value}`");
         summary = codeRegex.Replace(summary, match => $"`{match.Groups[1].Value}`");
         summary = linkRegex.Replace(summary, match => $"[{match.Groups[2].Value}]({match.Groups[1].Value})");
+        summary = imgRegex.Replace(summary, match => $"![]({match.Groups[1].Value})");
+
+        summary += $"\n{item.Remarks}\n";
         
         return summary.HtmlEscape();
     }
@@ -213,7 +217,7 @@ public static void MethodSummary(this Dictionary<string, Item> items, StringBuil
             str.AppendLine(method.WithIconifyHeading());
         else
             str.AppendLine($"### {method.Name.HtmlEscape()}");
-        str.AppendLine(items.GetSummary(method.Summary)?.Trim());
+        str.AppendLine(method.GetSummary(items,method.Summary)?.Trim());
         Declaration(str, method);
         if (!string.IsNullOrWhiteSpace(method.Syntax.Return?.Type))
         {
@@ -224,7 +228,7 @@ public static void MethodSummary(this Dictionary<string, Item> items, StringBuil
             if (string.IsNullOrWhiteSpace(method.Syntax.Return?.Description))
                 str.AppendLine();
             else
-                str.Append(": " + items.GetSummary(method.Syntax.Return.Description));
+                str.Append(": " + method.GetSummary(items, method.Syntax.Return.Description));
         }
 
         if ((method.Syntax?.Parameters?.Length ?? 0) != 0)
@@ -238,7 +242,7 @@ public static void MethodSummary(this Dictionary<string, Item> items, StringBuil
                 str.AppendLine("|:--- |:--- |:--- |");
                 foreach (var parameter in method.Syntax.Parameters)
                     str.AppendLine(
-                        $"| {items.Link(parameter.Type)} | *{parameter.Id}* | {items.GetSummary(parameter.Description)} |");
+                        $"| {items.Link(parameter.Type)} | *{parameter.Id}* | {method.GetSummary(items,parameter.Description)} |");
             }
             else
             {

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ public class Item`
`39`	`39`	`public string[]? InheritedMembers { get; set; }`
`40`	`40`
`41`	`41`	`public string[] ExtensionMethods { get; set; }`
	`42`	`+ public string Remarks { get; set; }`
`42`	`43`	`// modifiers.csharp`
`43`	`44`	`// modifiers.vb`
`44`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>`
`78`	`78`	`str.AppendLine("sidebar_label: " + item.Name);`
`79`	`79`	`if (item.Summary != null)`
`80`	`80`	`// todo: run a regex replace to get rid of hyperlinks and inline code blocks?`
`81`		`- str.AppendLine($"description: \"{items.GetSummary(item.Summary)?.Trim().Replace("\"", "\\\"")}\"");`
	`81`	`+ str.AppendLine($"description: \"{item.GetSummary(items,item.Summary)?.Trim().Replace("\"", "\\\"")}\"");`
`82`	`82`	`str.AppendLine("---");`
`83`	`83`	`str.AppendLine();`
`84`	`84`	`if (config.UseIconify)`
`@@ -88,7 +88,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`str.AppendLine(item.WithIconifyHeading("# "));`
`91`		`- str.AppendLine(items.GetSummary(item.Summary)?.Trim());`
	`91`	`+ str.AppendLine(item.GetSummary(items,item.Summary)?.Trim());`
`92`	`92`	`str.AppendLine();`
`93`	`93`	`str.AppendLine($"###### Assembly: {item.Assemblies[0]}.dll");`
`94`	`94`	`MarkdownWritingExtensions.Declaration(str, item);`
`@@ -103,7 +103,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>`
`103`	`103`	`str.AppendLine(property.WithIconifyHeading());`
`104`	`104`	`else`
`105`	`105`	`str.AppendLine($"### {property.Name}");`
`106`		`- str.AppendLine(items.GetSummary(property.Summary)?.Trim());`
	`106`	`+ str.AppendLine(item.GetSummary(items,property.Summary)?.Trim());`
`107`	`107`	`MarkdownWritingExtensions.Declaration(str, property);`
`108`	`108`	`}`
`109`	`109`	`}`
`@@ -119,7 +119,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>`
`119`	`119`	`str.AppendLine(property.WithIconifyHeading());`
`120`	`120`	`else`
`121`	`121`	`str.AppendLine($"### {property.Name}");`
`122`		`- str.AppendLine(items.GetSummary(property.Summary)?.Trim());`
	`122`	`+ str.AppendLine(item.GetSummary(items,property.Summary)?.Trim());`
`123`	`123`	`MarkdownWritingExtensions.Declaration(str, property);`
`124`	`124`	`}`
`125`	`125`	`}`
`@@ -133,7 +133,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>`
`133`	`133`	`foreach (var field in fields)`
`134`	`134`	`{`
`135`	`135`	`str.AppendLine(config.UseIconify ? field.WithIconifyHeading() : $"### {field.Name}");`
`136`		`- str.AppendLine(items.GetSummary(field.Summary)?.Trim());`
	`136`	`+ str.AppendLine(item.GetSummary(items,field.Summary)?.Trim());`
`137`	`137`	`MarkdownWritingExtensions.Declaration(str, field);`
`138`	`138`	`}`
`139`	`139`	`}`
`@@ -168,7 +168,7 @@ await Parallel.ForEachAsync(items, async (kvp, _) =>`
`168`	`168`	`foreach (var @event in events)`
`169`	`169`	`{`
`170`	`170`	`str.AppendLine($"### {@event.Name.HtmlEscape()}");`
`171`		`- str.AppendLine(items.GetSummary(@event.Summary)?.Trim());`
	`171`	`+ str.AppendLine(item.GetSummary(items,@event.Summary)?.Trim());`
`172`	`172`	`MarkdownWritingExtensions.Declaration(str, @event);`
`173`	`173`	`str.AppendLine("##### Event Type");`
`174`	`174`	`if (@event.Syntax.Return.Description == null)`
`@@ -219,7 +219,7 @@ void Do(string type, string header)`
`219`	`219`	`foreach (var item1 in @where.OrderBy(i => i.Name))`
`220`	`220`	`{`
`221`	`221`	`str.AppendLine($"### {items.Link(item1.Uid, config, true)}");`
`222`		`- str.AppendLine(items.GetSummary(item1.Summary)?.Trim());`
	`222`	`+ str.AppendLine(item.GetSummary(items,item1.Summary)?.Trim());`
`223`	`223`	`}`
`224`	`224`	`}`
`225`	`225`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,7 @@ public static class MarkdownWritingExtensions`
`80`	`80`
`81`	`81`	`static Regex codeRegex = new("<code>(.+?)</code>", RegexOptions.Compiled);`
`82`	`82`	`static Regex linkRegex = new("<a href=\"(.+?)\">(.+?)</a>", RegexOptions.Compiled);`
	`83`	`+ static Regex imgRegex = new ("<img src=[\"'](.+?)[\"'].*?>", RegexOptions.Compiled);`
`83`	`84`
`84`	`85`	`private static List<string> csharpKeywords = new()`
`85`	`86`	`{`
`@@ -176,7 +177,7 @@ public static string Link(this Dictionary<string, Item> items, string uid, Confi`
`176`	`177`	`return result;`
`177`	`178`	`}`
`178`	`179`
`179`		`- public static string? GetSummary(this Dictionary<string, Item> items, string? summary)`
	`180`	`+ public static string? GetSummary(this Item item, Dictionary<string, Item> items, string? summary)`
`180`	`181`	`{`
`181`	`182`	`if (summary == null)`
`182`	`183`	`return null;`
`@@ -188,6 +189,9 @@ public static string Link(this Dictionary<string, Item> items, string uid, Confi`
`188`	`189`	summary = langwordXrefRegex.Replace(summary, match => $"`{match.Groups[1].Value}`");
`189`	`190`	summary = codeRegex.Replace(summary, match => $"`{match.Groups[1].Value}`");
`190`	`191`	`summary = linkRegex.Replace(summary, match => $"[{match.Groups[2].Value}]({match.Groups[1].Value})");`
	`192`	`+ summary = imgRegex.Replace(summary, match => $"![]({match.Groups[1].Value})");`
	`193`	`+`
	`194`	`+ summary += $"\n{item.Remarks}\n";`
`191`	`195`
`192`	`196`	`return summary.HtmlEscape();`
`193`	`197`	`}`
`@@ -213,7 +217,7 @@ public static void MethodSummary(this Dictionary<string, Item> items, StringBuil`
`213`	`217`	`str.AppendLine(method.WithIconifyHeading());`
`214`	`218`	`else`
`215`	`219`	`str.AppendLine($"### {method.Name.HtmlEscape()}");`
`216`		`- str.AppendLine(items.GetSummary(method.Summary)?.Trim());`
	`220`	`+ str.AppendLine(method.GetSummary(items,method.Summary)?.Trim());`
`217`	`221`	`Declaration(str, method);`
`218`	`222`	`if (!string.IsNullOrWhiteSpace(method.Syntax.Return?.Type))`
`219`	`223`	`{`
`@@ -224,7 +228,7 @@ public static void MethodSummary(this Dictionary<string, Item> items, StringBuil`
`224`	`228`	`if (string.IsNullOrWhiteSpace(method.Syntax.Return?.Description))`
`225`	`229`	`str.AppendLine();`
`226`	`230`	`else`
`227`		`- str.Append(": " + items.GetSummary(method.Syntax.Return.Description));`
	`231`	`+ str.Append(": " + method.GetSummary(items, method.Syntax.Return.Description));`
`228`	`232`	`}`
`229`	`233`
`230`	`234`	`if ((method.Syntax?.Parameters?.Length ?? 0) != 0)`
`@@ -238,7 +242,7 @@ public static void MethodSummary(this Dictionary<string, Item> items, StringBuil`
`238`	`242`	`str.AppendLine("\|:--- \|:--- \|:--- \|");`
`239`	`243`	`foreach (var parameter in method.Syntax.Parameters)`
`240`	`244`	`str.AppendLine(`
`241`		`- $"\| {items.Link(parameter.Type)} \| {parameter.Id} \| {items.GetSummary(parameter.Description)} \|");`
	`245`	`+ $"\| {items.Link(parameter.Type)} \| {parameter.Id} \| {method.GetSummary(items,parameter.Description)} \|");`
`242`	`246`	`}`
`243`	`247`	`else`
`244`	`248`	`{`