Merge pull request #3137 from VitaliAntonov/issue-2950

 SA1629 should not ignore enum members

Author: vweijsters

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1608UnitTests.cs

@@ -146,6 +146,48 @@ public class ClassName
             await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
         }
 
+        [Fact]
+        public async Task TestEnumMemberWithContentDocumentationAsync()
+        {
+            var testCode = @"
+public enum EnumName
+{
+    /// <summary>
+    /// Foo.
+    /// </summary>
+    EnumMember1 = 0,
+}
+";
+            await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        public async Task TestEnumMemberWithDefaultDocumentationAsync()
+        {
+            var testCode = @"
+public enum EnumName
+{
+    /// <summary>
+    /// Summary description for the EnumMember1 enum member.
+    /// </summary>
+    EnumMember1 = 0,
+
+    /// <summary>
+    /// Summary           description
+    /// for the      EnumMember2 enum member.
+    /// </summary>
+    EnumMember2 = 1,
+}
+";
+            DiagnosticResult[] expected = new[]
+            {
+                Diagnostic().WithLocation(4, 9),
+                Diagnostic().WithLocation(9, 9),
+            };
+
+            await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
         [Fact]
         public async Task TestClassWithIncludedEmptyDocumentationAsync()
         {

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1625UnitTests.cs

@@ -273,6 +273,23 @@ public class TestClass
             await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
         }
 
+        [Fact]
+        public async Task VerifyThatDuplicatedDocumentationForEnumMemberDoesReportADiagnosticAsync()
+        {
+            var testCode = @"
+public enum EnumName
+{
+    /// <summary>
+    /// Some documentation.
+    /// </summary>
+    /// <remark>Some documentation.</remark>
+    EnumMember = 0,
+}";
+            var expected = Diagnostic().WithLocation(7, 9);
+
+            await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
         [Fact]
         public async Task VerifyThatCorrectIncludedDocumentationDoesNotReportADiagnosticAsync()
         {

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1629UnitTests.cs

@@ -172,6 +172,35 @@ public int TestMethod2<T>(T arg1)
             await VerifyCSharpFixAsync(testCode, expectedDiagnostics, fixedTestCode, CancellationToken.None).ConfigureAwait(false);
         }
 
+        [Fact]
+        [WorkItem(2950, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/2950")]
+        public async Task TestEnumMemberAsync()
+        {
+            var testCode = @"
+public enum TestEnum
+{
+    /// <summary>
+    /// Enum member
+    /// </summary>
+    EnumMember = 0,
+}
+";
+
+            var fixedTestCode = @"
+public enum TestEnum
+{
+    /// <summary>
+    /// Enum member.
+    /// </summary>
+    EnumMember = 0,
+}
+";
+
+            var expected = Diagnostic().WithLocation(5, 20);
+
+            await VerifyCSharpFixAsync(testCode, expected, fixedTestCode, CancellationToken.None).ConfigureAwait(false);
+        }
+
         [Fact]
         public async Task TestAugmentedInheritedDocumentationAsync()
         {

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

@@ -31,6 +31,7 @@ internal abstract class ElementDocumentationBase : DiagnosticAnalyzer
         private readonly Action<SyntaxNodeAnalysisContext, StyleCopSettings> baseTypeDeclarationAction;
         private readonly Action<SyntaxNodeAnalysisContext, StyleCopSettings> fieldDeclarationAction;
         private readonly Action<SyntaxNodeAnalysisContext, StyleCopSettings> propertyDeclarationAction;
+        private readonly Action<SyntaxNodeAnalysisContext, StyleCopSettings> enumMemberDeclarationAction;
 
         protected ElementDocumentationBase(bool inheritDocSuppressesWarnings, string matchElementName = null)
         {
@@ -46,6 +47,7 @@ protected ElementDocumentationBase(bool inheritDocSuppressesWarnings, string mat
             this.baseTypeDeclarationAction = this.HandleBaseTypeDeclaration;
             this.fieldDeclarationAction = this.HandleFieldDeclaration;
             this.propertyDeclarationAction = this.HandlePropertyDeclaration;
+            this.enumMemberDeclarationAction = this.HandleEnumMemberDeclaration;
         }
 
         /// <inheritdoc/>
@@ -63,6 +65,7 @@ public override void Initialize(AnalysisContext context)
             context.RegisterSyntaxNodeAction(this.baseTypeDeclarationAction, SyntaxKinds.BaseTypeDeclaration);
             context.RegisterSyntaxNodeAction(this.fieldDeclarationAction, SyntaxKind.FieldDeclaration);
             context.RegisterSyntaxNodeAction(this.propertyDeclarationAction, SyntaxKind.PropertyDeclaration);
+            context.RegisterSyntaxNodeAction(this.enumMemberDeclarationAction, SyntaxKind.EnumMemberDeclaration);
         }
 
         /// <summary>
@@ -200,6 +203,16 @@ private void HandlePropertyDeclaration(SyntaxNodeAnalysisContext context, StyleC
             this.HandleDeclaration(context, settings, needsComment, node, node.Identifier.GetLocation());
         }
 
+        private void HandleEnumMemberDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
+        {
+            var node = (EnumMemberDeclarationSyntax)context.Node;
+
+            Accessibility declaredAccessibility = node.GetDeclaredAccessibility();
+            Accessibility effectiveAccessibility = node.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
+            bool needsComment = SA1600ElementsMustBeDocumented.NeedsComment(settings.DocumentationRules, node.Kind(), node.Parent.Kind(), declaredAccessibility, effectiveAccessibility);
+            this.HandleDeclaration(context, settings, needsComment, node, node.Identifier.GetLocation());
+        }
+
         private void HandleDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings, bool needsComment, SyntaxNode node, params Location[] locations)
         {
             var documentation = node.GetDocumentationCommentTriviaSyntax();