Skip to content

Commit f18c68a

Browse files
Apply suggestions from code review
Co-authored-by: Sam Harwell <sam@tunnelvisionlabs.com>
1 parent 393c5a1 commit f18c68a

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1600ElementsMustBeDocumented.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ namespace StyleCop.Analyzers.DocumentationRules
2525
///
2626
/// <para>A violation of this rule occurs if an element is completely missing a documentation header, or if the
2727
/// header is empty. In C# the following types of elements can have documentation headers: classes, constructors,
28-
/// delegates, enums, events, finalizers, indexers, interfaces, methods, properties, records, record classes,
29-
/// record structs and structs.</para>
28+
/// delegates, enums, events, finalizers, indexers, interfaces, methods, properties, records, and structs.</para>
3029
/// </remarks>
3130
[DiagnosticAnalyzer(LanguageNames.CSharp)]
3231
internal class SA1600ElementsMustBeDocumented : DiagnosticAnalyzer

documentation/SA1600.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A C# code element is missing a documentation header.
2323

2424
C# syntax provides a mechanism for inserting documentation for classes and elements directly into the code, through the use of Xml documentation headers. For an introduction to these headers and a description of the header syntax, see the following article: [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments).
2525

26-
A violation of this rule occurs if an element is completely missing a documentation header, or if the header is empty. In C# the following types of elements can have documentation headers: classes, constructors, delegates, enums, events, finalizers, indexers, interfaces, methods, properties, records, record classes, record structs and structs.
26+
A violation of this rule occurs if an element is completely missing a documentation header, or if the header is empty. In C# the following types of elements can have documentation headers: classes, constructors, delegates, enums, events, finalizers, indexers, interfaces, methods, properties, records, and structs.
2727

2828
## How to fix violations
2929

0 commit comments

Comments
 (0)