Updated PropertySummaryDocumentationAnalyzer to always report SA1623 for a property with a lone getter.

Author: bjornhellander

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

@@ -188,6 +188,14 @@ public int Property
         [Theory]
         [InlineData("public", "int", "{ get; set; }", "Gets", "Gets or sets")] // Regression test for #2098
         [InlineData("public", "int", "{ get; set; }", "Sets", "Gets or sets")] // Regression test for #2098
+        [InlineData("public", "int", "{ get; }", "Sets", "Gets")] // Regression test for #2253
+        [InlineData("public", "int", "{ get; }", "Gets or sets", "Gets")] // Regression test for #2253
+        [InlineData("public", "int", "=> 0;", "Sets", "Gets")] // Regression test for #2253
+        [InlineData("public", "int", "=> 0;", "Gets or sets", "Gets")] // Regression test for #2253
+        [InlineData("public", "bool", "=> false;", "Gets or sets a value indicating whether", "Gets a value indicating whether")] // Regression test for #2253
+        [InlineData("protected", "int", "=> 0;", "Gets or sets", "Gets")] // Regression test for #2253
+        [InlineData("protected internal", "int", "=> 0;", "Gets or sets", "Gets")] // Regression test for #2253
+        [InlineData("internal", "int", "=> 0;", "Gets or sets", "Gets")] // Regression test for #2253
         public async Task IncorrectSummaryTagWithKnownPrefixShouldBeFixedCorrectlyAsync(string accessibility, string type, string accessors, string summaryPrefix, string expectedArgument)
         {
             var testCode = $@"

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1624UnitTests.cs

@@ -78,7 +78,7 @@ public class TestClass
         }
 
         /// <summary>
-        /// Verifies that documentation that starts with the proper text for multiple accessors will not produce this
+        /// Verifies that documentation that starts with the proper text for a lone getter will not produce this
         /// diagnostic when the property has an expression body.
         /// </summary>
         /// <param name="accessibility">The accessibility of the property.</param>
@@ -107,52 +107,6 @@ public class TestClass
             await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
         }
 
-        /// <summary>
-        /// Verifies that documentation that starts with the proper text for multiple accessors will produce a diagnostic for expression body properties.
-        /// </summary>
-        /// <param name="accessibility">The accessibility of the property.</param>
-        /// <param name="type">The type to use for the property.</param>
-        /// <param name="summaryPrefix">The prefix to use in the summary text.</param>
-        /// <param name="expectedArgument1">The first expected argument for the diagnostic.</param>
-        /// <param name="expectedArgument2">The second expected argument for the diagnostic.</param>
-        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
-        [Theory(DisplayName = "ExpressionBody Gets&Sets")]
-        [InlineData("public", "int", "Gets or sets", "get", "Gets")]
-        [InlineData("public", "bool", "Gets or sets a value indicating whether", "get", "Gets a value indicating whether")]
-        [InlineData("protected", "int", "Gets or sets", "get", "Gets")]
-        [InlineData("protected internal", "int", "Gets or sets", "get", "Gets")]
-        [InlineData("internal", "int", "Gets or sets", "get", "Gets")]
-        public async Task VerifyThatInvalidDocumentationWillReportDiagnosticForExpressionBodyAsync(string accessibility, string type, string summaryPrefix, string expectedArgument1, string expectedArgument2)
-        {
-            var testCode = $@"
-public class TestClass
-{{
-    /// <summary>
-    /// {summaryPrefix} the test property.
-    /// </summary>
-    {accessibility} {type} TestProperty =>
-        default({type});
-}}
-";
-
-            var fixedTestCode = $@"
-public class TestClass
-{{
-    /// <summary>
-    /// {expectedArgument2} the test property.
-    /// </summary>
-    {accessibility} {type} TestProperty =>
-        default({type});
-}}
-";
-
-            var expected = this.CSharpDiagnostic(PropertySummaryDocumentationAnalyzer.SA1624Descriptor).WithLocation(7, 7 + accessibility.Length + type.Length).WithArguments(expectedArgument1, expectedArgument2);
-
-            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);
-        }
-
         /// <summary>
         /// Verify that no diagnostic will be reported when a public and a private accessor are present within a property that is defined in a contained class of a private class.
         /// </summary>

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

@@ -228,6 +228,7 @@ private static void AnalyzeSummaryElement(SyntaxNodeAnalysisContext context, Xml
             {
                 if (setterVisible)
                 {
+                    // Both getter and setter are visible.
                     if (!startsWithGetsOrSets)
                     {
                         diagnosticProperties.Add(ExpectedTextKey, startingTextGetsOrSets);
@@ -244,8 +245,9 @@ private static void AnalyzeSummaryElement(SyntaxNodeAnalysisContext context, Xml
                         context.ReportDiagnostic(Diagnostic.Create(SA1623Descriptor, diagnosticLocation, diagnosticProperties.ToImmutable(), startingTextGetsOrSets));
                     }
                 }
-                else
+                else if (setter != null)
                 {
+                    // Both getter and setter exist, but only getter is visible.
                     if (startsWithGetsOrSets)
                     {
                         diagnosticProperties.Add(ExpectedTextKey, startingTextGets);
@@ -258,6 +260,25 @@ private static void AnalyzeSummaryElement(SyntaxNodeAnalysisContext context, Xml
                         context.ReportDiagnostic(Diagnostic.Create(SA1623Descriptor, diagnosticLocation, diagnosticProperties.ToImmutable(), startingTextGets));
                     }
                 }
+                else
+                {
+                    // Getter exists and is visible. Setter does not exist.
+                    if (!startsWithGets || startsWithGetsOrSets)
+                    {
+                        diagnosticProperties.Add(ExpectedTextKey, startingTextGets);
+
+                        if (startsWithSets)
+                        {
+                            diagnosticProperties.Add(TextToRemoveKey, text.Substring(0, startingTextSets.Length));
+                        }
+                        else if (startsWithGetsOrSets)
+                        {
+                            diagnosticProperties.Add(TextToRemoveKey, text.Substring(0, startingTextGetsOrSets.Length));
+                        }
+
+                        context.ReportDiagnostic(Diagnostic.Create(SA1623Descriptor, diagnosticLocation, diagnosticProperties.ToImmutable(), startingTextGets));
+                    }
+                }
             }
             else if (setterVisible)
             {