Merge pull request #1890 from pdelvo/fix-1876

Fix that SA1625 ignores empty xml elements

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1625UnitTests.cs

@@ -47,6 +47,27 @@ public class TestClass
             await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
         }
 
+        [Theory]
+        [MemberData(nameof(Members))]
+        public async Task VerifyThatCorrectDocumentationWithEmptyElementsDoesNotReportADiagnosticAsync(string member)
+        {
+            var testCode = $@"
+public class TestClass
+{{
+    /// <summary>
+    /// Some documentation <see cref=""TestClass""/>.
+    /// </summary>
+    /// <summary>
+    /// Some documentation <see cref=""TestClass2""/>.
+    /// </summary>
+    /// <remark>Some remark.</remark>
+    {member}
+}}
+public class TestClass2 {{ }}
+";
+            await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
         [Theory]
         [MemberData(nameof(Members))]
         public async Task VerifyThatTheAnalyzerDoesNotCrashOnInheritDocAsync(string member)
@@ -61,6 +82,27 @@ public class TestClass
             await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
         }
 
+        [Theory]
+        [MemberData(nameof(Members))]
+        public async Task VerifyThatWhitespacesAreNormalizedForEmptyXmlElementsAsync(string member)
+        {
+            var testCode = $@"
+public class TestClass
+{{
+    /// <summary>
+    /// Some documentation <see cref=""TestClass""/>.
+    /// </summary>
+    /// <summary>
+    /// Some documentation <see       cref  =   ""TestClass""     />.
+    /// </summary>
+    /// <remark>Some remark.</remark>
+    {member}
+}}
+";
+            var expected = this.CSharpDiagnostic().WithLocation(7, 9);
+            await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
         [Theory]
         [MemberData(nameof(Members))]
         public async Task VerifyThatDublicatedDocumentationDoesReportADiagnosticAsync(string member)

StyleCop.Analyzers/StyleCop.Analyzers/Helpers/XmlCommentHelper.cs

@@ -184,6 +184,13 @@ internal static string GetText(XmlNodeSyntax nodeSyntax, bool normalizeWhitespac
                 return StringBuilderPool.ReturnAndFree(stringBuilder);
             }
 
+            var emptyXmlElement = nodeSyntax as XmlEmptyElementSyntax;
+
+            if (emptyXmlElement != null)
+            {
+                return emptyXmlElement.NormalizeWhitespace(string.Empty).ToString();
+            }
+
             return null;
         }