Skip to content

Commit 58529d4

Browse files
committed
Include <description> when rendering lists
See dotnet/csharplang#1765
1 parent 8bcfb58 commit 58529d4

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/RefactoringRules/DOC900CodeFixProvider+DocumentationCommentPrinter.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -266,9 +266,9 @@ private static void BlocksToHtmlInner(DocumentationCommentTextWriter writer, Blo
266266

267267
case BlockTag.ListItem:
268268
writer.EnsureLine();
269-
writer.WriteConstant("<item>");
269+
writer.WriteConstant("<item><description>");
270270

271-
stackLiteral = "</item>";
271+
stackLiteral = "</description></item>";
272272
stackTight = tight;
273273
visitChildren = true;
274274
break;

DocumentationAnalyzers/DocumentationAnalyzers.Test/RefactoringRules/DOC900UnitTests.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ class TestClass { }
5555
///$$ <summary>
5656
/// <para>Para 1</para>
5757
/// <list type=""bullet"">
58-
/// <item>Item 1</item>
59-
/// <item>Item 2</item>
60-
/// <item>Item 3</item>
58+
/// <item><description>Item 1</description></item>
59+
/// <item><description>Item 2</description></item>
60+
/// <item><description>Item 3</description></item>
6161
/// </list>
6262
/// </summary>
6363
class TestClass { }
@@ -83,9 +83,9 @@ class TestClass { }
8383
///$$ <summary>
8484
/// <para>Para 1</para>
8585
/// <list type=""number"">
86-
/// <item>Item 1</item>
87-
/// <item>Item 2</item>
88-
/// <item>Item 3</item>
86+
/// <item><description>Item 1</description></item>
87+
/// <item><description>Item 2</description></item>
88+
/// <item><description>Item 3</description></item>
8989
/// </list>
9090
/// </summary>
9191
class TestClass { }

0 commit comments

Comments
 (0)