Merge pull request #1 from vweijsters/pr-1947

Implemented proposed changes from code review

Author: NikolayIT

StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/DocumentationRules/PropertySummaryDocumentationCodeFixProvider.cs

@@ -40,12 +40,15 @@ public override Task RegisterCodeFixesAsync(CodeFixContext context)
         {
             foreach (Diagnostic diagnostic in context.Diagnostics)
             {
-                context.RegisterCodeFix(
-                    CodeAction.Create(
-                        DocumentationResources.PropertySummaryStartTextCodeFix,
-                        cancellationToken => GetTransformedDocumentAsync(context.Document, diagnostic, cancellationToken),
-                        nameof(PropertySummaryDocumentationCodeFixProvider)),
-                    diagnostic);
+                if (!diagnostic.Properties.ContainsKey(PropertySummaryDocumentationAnalyzer.NoCodeFixKey))
+                {
+                    context.RegisterCodeFix(
+                        CodeAction.Create(
+                            DocumentationResources.PropertySummaryStartTextCodeFix,
+                            cancellationToken => GetTransformedDocumentAsync(context.Document, diagnostic, cancellationToken),
+                            nameof(PropertySummaryDocumentationCodeFixProvider)),
+                        diagnostic);
+                }
             }
 
             return SpecializedTasks.CompletedTask;

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1623UnitTests.cs

@@ -170,13 +170,10 @@ public int Property
 }";
 
             var expected = this.CSharpDiagnostic(PropertySummaryDocumentationAnalyzer.SA1623Descriptor).WithLocation(4, 16).WithArguments("Gets");
-
             await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
 
-            // Intentionally do not provide a code fix: https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/1957#discussion_r47703520
-            //// await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
-
-            await this.VerifyCSharpFixAsync(testCode, testCode).ConfigureAwait(false);
+            var offeredFixes = await this.GetOfferedCSharpFixesAsync(testCode).ConfigureAwait(false);
+            Assert.Empty(offeredFixes);
         }
 
         /// <inheritdoc/>

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/PropertySummaryDocumentationAnalyzer.cs

@@ -19,6 +19,7 @@ internal class PropertySummaryDocumentationAnalyzer : PropertyDocumentationBase
     {
         public const string ExpectedTextKey = "ExpectedText";
         public const string TextToRemoveKey = "TextToRemove";
+        public const string NoCodeFixKey = "NoCodeFix";
 
         private const string SA1623DiagnosticId = "SA1623";
         private const string SA1624DiagnosticId = "SA1624";
@@ -108,6 +109,13 @@ private static void AnalyzeSummaryElement(SyntaxNodeAnalysisContext context, Xml
                 return;
             }
 
+            // Add a no code fix tag when the summary element is empty.
+            // This will only impact SA1623, because SA1624 cannot trigger with an empty summary.
+            if (summaryElement.Content.Count == 0)
+            {
+                diagnosticProperties.Add(NoCodeFixKey, string.Empty);
+            }
+
             var textElement = summaryElement.Content.FirstOrDefault() as XmlTextSyntax;
             var text = textElement == null ? string.Empty : XmlCommentHelper.GetText(textElement, true).TrimStart();