Allow paragraphs before the last to end with ':' instead of '.'

Author: sharwell

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

@@ -486,6 +486,38 @@ public interface ITest
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
 
+        [Fact]
+        public async Task TestMultipleParagraphBlocksWithColonsAsync()
+        {
+            var testCode = @"
+/// <summary>
+/// <para>Paragraph 1:</para>
+/// <para>Paragraph 2:</para>
+/// <para>Paragraph 3:</para>
+/// </summary>
+public interface ITest
+{
+}
+";
+
+            var fixedTestCode = @"
+/// <summary>
+/// <para>Paragraph 1:</para>
+/// <para>Paragraph 2:</para>
+/// <para>Paragraph 3:.</para>
+/// </summary>
+public interface ITest
+{
+}
+";
+
+            DiagnosticResult expected = this.CSharpDiagnostic().WithLocation(5, 23);
+
+            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 TestMultipleParagraphInlinesAsync()
         {

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

@@ -78,7 +78,7 @@ protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, bool
         {
             foreach (var xmlElement in syntaxList.OfType<XmlElementSyntax>())
             {
-                HandleSectionOrBlockXmlElement(context, xmlElement);
+                HandleSectionOrBlockXmlElement(context, xmlElement, startingWithFinalParagraph: true);
             }
         }
 
@@ -101,7 +101,7 @@ protected override void HandleCompleteDocumentation(SyntaxNodeAnalysisContext co
             }
         }
 
-        private static void HandleSectionOrBlockXmlElement(SyntaxNodeAnalysisContext context, XmlElementSyntax xmlElement)
+        private static void HandleSectionOrBlockXmlElement(SyntaxNodeAnalysisContext context, XmlElementSyntax xmlElement, bool startingWithFinalParagraph)
         {
             if (xmlElement.StartTag?.Name?.LocalName.ValueText == XmlCommentHelper.SeeAlsoXmlTag)
             {
@@ -121,6 +121,7 @@ private static void HandleSectionOrBlockXmlElement(SyntaxNodeAnalysisContext con
                         if (!string.IsNullOrEmpty(textWithoutTrailingWhitespace))
                         {
                             if (!textWithoutTrailingWhitespace.EndsWith(".", StringComparison.Ordinal)
+                                && (startingWithFinalParagraph || !textWithoutTrailingWhitespace.EndsWith(":", StringComparison.Ordinal))
                                 && !textWithoutTrailingWhitespace.EndsWith("-or-", StringComparison.Ordinal))
                             {
                                 var location = Location.Create(xmlElement.SyntaxTree, new TextSpan(textToken.SpanStart + textWithoutTrailingWhitespace.Length, 1));
@@ -145,7 +146,7 @@ private static void HandleSectionOrBlockXmlElement(SyntaxNodeAnalysisContext con
                     case XmlCommentHelper.NoteXmlTag:
                     case XmlCommentHelper.ParaXmlTag:
                         // Recursively handle <note> and <para> elements
-                        HandleSectionOrBlockXmlElement(context, childXmlElement);
+                        HandleSectionOrBlockXmlElement(context, childXmlElement, startingWithFinalParagraph);
                         break;
 
                     default:
@@ -155,6 +156,7 @@ private static void HandleSectionOrBlockXmlElement(SyntaxNodeAnalysisContext con
                     if (childXmlElement.IsBlockElement())
                     {
                         currentParagraphDone = false;
+                        startingWithFinalParagraph = false;
                     }
                 }
                 else if (xmlElement.Content[i] is XmlEmptyElementSyntax emptyElement)
@@ -163,6 +165,7 @@ private static void HandleSectionOrBlockXmlElement(SyntaxNodeAnalysisContext con
                     if (emptyElement.Name?.LocalName.ValueText == XmlCommentHelper.ParaXmlTag)
                     {
                         currentParagraphDone = false;
+                        startingWithFinalParagraph = false;
                     }
                 }
             }