Skip to content

Commit 0a8c518

Browse files
committed
Clarify API doc comments
1 parent 40f61f2 commit 0a8c518

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/ElementDocumentationBase.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public override void Initialize(AnalysisContext context)
6060
}
6161

6262
/// <summary>
63-
/// Analyzes the top-level <c>&lt;param&gt;</c> elements of a documentation comment.
63+
/// Analyzes the top-level elements of a documentation comment.
6464
/// </summary>
6565
/// <param name="context">The current analysis context.</param>
6666
/// <param name="syntaxList">The <see cref="XmlElementSyntax"/> or <see cref="XmlEmptyElementSyntax"/> of the node
@@ -69,7 +69,7 @@ public override void Initialize(AnalysisContext context)
6969
protected abstract void HandleXmlElement(SyntaxNodeAnalysisContext context, IEnumerable<XmlNodeSyntax> syntaxList, params Location[] diagnosticLocations);
7070

7171
/// <summary>
72-
/// Analyzes the top-level <c>&lt;param&gt;</c> elements of a documentation comment.
72+
/// Analyzes the XML elements of a documentation comment.
7373
/// </summary>
7474
/// <param name="context">The current analysis context.</param>
7575
/// <param name="completeDocumentation">The complete documentation for the declared symbol, with any

0 commit comments

Comments
 (0)