Updated SA1609/SA1610 to not offer codefixes for included docs

Author: vweijsters

StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/DocumentationRules/SA1609SA1610CodeFixProvider.cs

@@ -44,12 +44,15 @@ public override Task RegisterCodeFixesAsync(CodeFixContext context)
         {
             foreach (var diagnostic in context.Diagnostics)
             {
-                context.RegisterCodeFix(
-                    CodeAction.Create(
-                        DocumentationResources.SA1609SA1610CodeFix,
-                        cancellationToken => this.GetTransformedDocumentAsync(context.Document, diagnostic, cancellationToken),
-                        nameof(SA1609SA1610CodeFixProvider)),
-                    diagnostic);
+                if (!diagnostic.Properties.ContainsKey(PropertyDocumentationBase.NoCodeFixKey))
+                {
+                    context.RegisterCodeFix(
+                        CodeAction.Create(
+                            DocumentationResources.SA1609SA1610CodeFix,
+                            cancellationToken => this.GetTransformedDocumentAsync(context.Document, diagnostic, cancellationToken),
+                            nameof(SA1609SA1610CodeFixProvider)),
+                        diagnostic);
+                }
             }
 
             return SpecializedTasks.CompletedTask;

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1609UnitTests.cs

@@ -321,6 +321,8 @@ public int Property
 }";
             var expected = this.CSharpDiagnostic().WithLocation(5, 16);
             await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+            var offeredFixes = await this.GetOfferedCSharpFixesAsync(testCode).ConfigureAwait(false);
+            Assert.Empty(offeredFixes);
         }
 
         /// <summary>

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1610UnitTests.cs

@@ -339,6 +339,8 @@ public int Property
 }";
             var expected = this.CSharpDiagnostic().WithLocation(5, 16);
             await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+            var offeredFixes = await this.GetOfferedCSharpFixesAsync(testCode).ConfigureAwait(false);
+            Assert.Empty(offeredFixes);
         }
 
         /// <summary>

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/PropertyDocumentationBase.cs

@@ -17,6 +17,11 @@ namespace StyleCop.Analyzers.DocumentationRules
     /// </summary>
     internal abstract class PropertyDocumentationBase : DiagnosticAnalyzer
     {
+        /// <summary>
+        /// The key used for signalling that no codefix should be offered.
+        /// </summary>
+        internal const string NoCodeFixKey = "NoCodeFix";
+
         private readonly Action<SyntaxNodeAnalysisContext> propertyDeclarationAction;
 
         protected PropertyDocumentationBase()

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1609PropertyDocumentationMustHaveValue.cs

@@ -51,13 +51,17 @@ internal class SA1609PropertyDocumentationMustHaveValue : PropertyDocumentationB
         /// <inheritdoc/>
         protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, XmlNodeSyntax syntax, XElement completeDocumentation, Location diagnosticLocation)
         {
+            var properties = ImmutableDictionary.Create<string, string>();
+
             if (completeDocumentation != null)
             {
                 var hasValueTag = completeDocumentation.Nodes().OfType<XElement>().Any(element => element.Name == XmlCommentHelper.ValueXmlTag);
                 if (hasValueTag)
                 {
                     return;
                 }
+
+                properties = properties.Add(NoCodeFixKey, string.Empty);
             }
             else
             {
@@ -67,7 +71,7 @@ protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, XmlN
                 }
             }
 
-            context.ReportDiagnostic(Diagnostic.Create(Descriptor, diagnosticLocation));
+            context.ReportDiagnostic(Diagnostic.Create(Descriptor, diagnosticLocation, properties));
         }
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1610PropertyDocumentationMustHaveValueText.cs

@@ -51,6 +51,8 @@ internal class SA1610PropertyDocumentationMustHaveValueText : PropertyDocumentat
         /// <inheritdoc/>
         protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, XmlNodeSyntax syntax, XElement completeDocumentation, Location diagnosticLocation)
         {
+            var properties = ImmutableDictionary.Create<string, string>();
+
             if (completeDocumentation != null)
             {
                 var valueTag = completeDocumentation.Nodes().OfType<XElement>().FirstOrDefault(element => element.Name == XmlCommentHelper.ValueXmlTag);
@@ -64,6 +66,8 @@ protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, XmlN
                 {
                     return;
                 }
+
+                properties = properties.Add(NoCodeFixKey, string.Empty);
             }
             else
             {
@@ -79,7 +83,7 @@ protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, XmlN
                 }
             }
 
-            context.ReportDiagnostic(Diagnostic.Create(Descriptor, diagnosticLocation));
+            context.ReportDiagnostic(Diagnostic.Create(Descriptor, diagnosticLocation, properties));
         }
     }
 }