Merge pull request #2769 from sharwell/ending-parens

Allow parenthesized sentences in documentation

Author: vweijsters

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

@@ -451,6 +451,52 @@ public interface ITest
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
 
+        [Theory]
+        [WorkItem(2744, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/2744")]
+        [InlineData("Summary. (For example.)")]
+        [InlineData("Summary (for example).")]
+        public async Task TestSentenceEndingWithParenthesesAsync(string allowedSummary)
+        {
+            var testCode = $@"
+/// <summary>
+/// {allowedSummary}
+/// </summary>
+public interface ITest
+{{
+}}
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        [WorkItem(2744, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/2744")]
+        public async Task TestSentenceEndingWithParenthesesWithoutPeriodAsync()
+        {
+            var testCode = @"
+/// <summary>
+/// Summary (for example)
+/// </summary>
+public interface ITest
+{
+}
+";
+            var fixedTestCode = $@"
+/// <summary>
+/// Summary (for example).
+/// </summary>
+public interface ITest
+{{
+}}
+";
+
+            DiagnosticResult expected = this.CSharpDiagnostic().WithLocation(3, 26);
+
+            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);
+        }
+
         [Fact]
         public async Task TestMultipleParagraphBlocksAsync()
         {

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1629DocumentationTextMustEndWithAPeriod.cs

@@ -91,7 +91,8 @@ protected override void HandleCompleteDocumentation(SyntaxNodeAnalysisContext co
                 var textWithoutTrailingWhitespace = node.Value.TrimEnd(' ', '\r', '\n');
                 if (!string.IsNullOrEmpty(textWithoutTrailingWhitespace))
                 {
-                    if (!textWithoutTrailingWhitespace.EndsWith(".", StringComparison.Ordinal))
+                    if (!textWithoutTrailingWhitespace.EndsWith(".", StringComparison.Ordinal)
+                        && !textWithoutTrailingWhitespace.EndsWith(".)", StringComparison.Ordinal))
                     {
                         context.ReportDiagnostic(Diagnostic.Create(Descriptor, diagnosticLocations[0], NoCodeFixProperties));
 
@@ -123,6 +124,7 @@ private static void HandleSectionOrBlockXmlElement(SyntaxNodeAnalysisContext con
                         if (!string.IsNullOrEmpty(textWithoutTrailingWhitespace))
                         {
                             if (!textWithoutTrailingWhitespace.EndsWith(".", StringComparison.Ordinal)
+                                && !textWithoutTrailingWhitespace.EndsWith(".)", StringComparison.Ordinal)
                                 && (startingWithFinalParagraph || !textWithoutTrailingWhitespace.EndsWith(":", StringComparison.Ordinal))
                                 && !textWithoutTrailingWhitespace.EndsWith("-or-", StringComparison.Ordinal))
                             {