Merge pull request #2138 from vweijsters/fix-2098

Fixed issue where PropertySummaryDocumentationAnalyzer would provide …

Author: sharwell

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

@@ -176,6 +176,55 @@ public int Property
             Assert.Empty(offeredFixes);
         }
 
+        /// <summary>
+        /// Verifies that an incomplete summary tag (with only get or set, when get and set are needed) will be fixed
+        /// correctly. Regression test for #2098.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task IncompleteSummaryTagShouldBeFixedCorrectlyAsync()
+        {
+            var testCode = @"
+public class TestClass
+{
+    /// <summary>
+    /// Gets the first test value.
+    /// </summary>
+    public int TestProperty1 { get; set; }
+
+    /// <summary>
+    /// Sets the seconds test value.
+    /// </summary>
+    public int TestProperty2 { get; set; }
+}
+";
+
+            var fixedTestCode = @"
+public class TestClass
+{
+    /// <summary>
+    /// Gets or sets the first test value.
+    /// </summary>
+    public int TestProperty1 { get; set; }
+
+    /// <summary>
+    /// Gets or sets the seconds test value.
+    /// </summary>
+    public int TestProperty2 { get; set; }
+}
+";
+
+            DiagnosticResult[] expected =
+            {
+                this.CSharpDiagnostic(PropertySummaryDocumentationAnalyzer.SA1623Descriptor).WithLocation(7, 16).WithArguments("Gets or sets"),
+                this.CSharpDiagnostic(PropertySummaryDocumentationAnalyzer.SA1623Descriptor).WithLocation(12, 16).WithArguments("Gets or sets"),
+            };
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+            await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+            await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
+        }
+
         /// <inheritdoc/>
         protected override CodeFixProvider GetCSharpCodeFixProvider()
         {

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

@@ -119,7 +119,7 @@ private static void AnalyzeSummaryElement(SyntaxNodeAnalysisContext context, Xml
             var textElement = summaryElement.Content.FirstOrDefault() as XmlTextSyntax;
             var text = textElement == null ? string.Empty : XmlCommentHelper.GetText(textElement, true).TrimStart();
 
-            bool startsWithGetOrSet = text.StartsWith(startingTextGetsOrSets, StringComparison.Ordinal);
+            bool startsWithGetOrSet = text.StartsWith(startingTextGetsOrSets, StringComparison.OrdinalIgnoreCase);
             bool getterVisible, setterVisible;
             if (getter != null && setter != null)
             {
@@ -217,6 +217,16 @@ private static void AnalyzeSummaryElement(SyntaxNodeAnalysisContext context, Xml
                     if (!startsWithGetOrSet)
                     {
                         diagnosticProperties.Add(ExpectedTextKey, startingTextGetsOrSets);
+
+                        if (text.StartsWith(startingTextGets, StringComparison.OrdinalIgnoreCase))
+                        {
+                            diagnosticProperties.Add(TextToRemoveKey, text.Substring(0, startingTextGets.Length));
+                        }
+                        else if (text.StartsWith(startingTextSets, StringComparison.OrdinalIgnoreCase))
+                        {
+                            diagnosticProperties.Add(TextToRemoveKey, text.Substring(0, startingTextSets.Length));
+                        }
+
                         context.ReportDiagnostic(Diagnostic.Create(SA1623Descriptor, diagnosticLocation, diagnosticProperties.ToImmutable(), startingTextGetsOrSets));
                     }
                 }
@@ -228,7 +238,7 @@ private static void AnalyzeSummaryElement(SyntaxNodeAnalysisContext context, Xml
                         diagnosticProperties.Add(TextToRemoveKey, startingTextGetsOrSets);
                         context.ReportDiagnostic(Diagnostic.Create(SA1624Descriptor, diagnosticLocation, diagnosticProperties.ToImmutable(), "get", startingTextGets));
                     }
-                    else if (!text.StartsWith(startingTextGets, StringComparison.Ordinal))
+                    else if (!text.StartsWith(startingTextGets, StringComparison.OrdinalIgnoreCase))
                     {
                         diagnosticProperties.Add(ExpectedTextKey, startingTextGets);
                         context.ReportDiagnostic(Diagnostic.Create(SA1623Descriptor, diagnosticLocation, diagnosticProperties.ToImmutable(), startingTextGets));
@@ -243,7 +253,7 @@ private static void AnalyzeSummaryElement(SyntaxNodeAnalysisContext context, Xml
                     diagnosticProperties.Add(TextToRemoveKey, startingTextGetsOrSets);
                     context.ReportDiagnostic(Diagnostic.Create(SA1624Descriptor, diagnosticLocation, diagnosticProperties.ToImmutable(), "set", startingTextSets));
                 }
-                else if (!text.StartsWith(startingTextSets, StringComparison.Ordinal))
+                else if (!text.StartsWith(startingTextSets, StringComparison.OrdinalIgnoreCase))
                 {
                     diagnosticProperties.Add(ExpectedTextKey, startingTextSets);
                     context.ReportDiagnostic(Diagnostic.Create(SA1623Descriptor, diagnosticLocation, diagnosticProperties.ToImmutable(), startingTextSets));