Updated SA1610

Author: vweijsters

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1610UnitTests.cs

@@ -6,6 +6,8 @@ namespace StyleCop.Analyzers.Test.DocumentationRules
     using System.Collections.Generic;
     using System.Threading;
     using System.Threading.Tasks;
+    using Helpers;
+    using Microsoft.CodeAnalysis;
     using Microsoft.CodeAnalysis.CodeFixes;
     using Microsoft.CodeAnalysis.Diagnostics;
     using StyleCop.Analyzers.DocumentationRules;
@@ -280,6 +282,141 @@ public class ClassName
             await this.VerifyCSharpFixAsync(testCode, fixedCode, cancellationToken: CancellationToken.None).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Verifies that included property documentation will be accepted.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task TestPropertyWithValidIncludeAsync()
+        {
+            var testCode = @"
+public class ClassName
+{
+    /// <include file='PropertyWithValue.xml' path='/ClassName/Property/*'/>
+    public int Property
+    {
+        get;
+    }
+}";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Verifies that included property documentation without a value tag will be accepted (this is handled by SA1609).
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task TestPropertyWithoutValueInIncludeAsync()
+        {
+            var testCode = @"
+public class ClassName
+{
+    /// <include file='PropertyWithoutValue.xml' path='/ClassName/Property/*'/>
+    public int Property
+    {
+        get;
+    }
+}";
+            await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Verifies that included property documentation with an empty value tag will be flagged.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task TestPropertyWithEmptyValueInIncludeAsync()
+        {
+            var testCode = @"
+public class ClassName
+{
+    /// <include file='PropertyWithEmptyValue.xml' path='/ClassName/Property/*'/>
+    public int Property
+    {
+        get;
+    }
+}";
+            var expected = this.CSharpDiagnostic().WithLocation(5, 16);
+            await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Verifies that included property documentation containing &gt;inheritdoc/&lt; will be accepted.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task TestPropertyWithInheritdocInIncludeAsync()
+        {
+            var testCode = @"
+public interface ITestInterface
+{
+  /// <summary>
+  /// Gets the test property value.
+  /// </summary>
+  /// <value>Test number.</value>
+  int Property { get; }
+}
+
+public class ClassName : ITestInterface
+{
+    /// <include file='PropertyWithInheritdoc.xml' path='/ClassName/Property/*'/>
+    public int Property
+    {
+        get;
+    }
+}";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        protected override Project ApplyCompilationOptions(Project project)
+        {
+            var resolver = new TestXmlReferenceResolver();
+
+            string contentWithValue = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
+<ClassName>
+  <Property>
+    <summary>Foo</summary>
+    <value>Bar</value>
+  </Property>
+</ClassName>
+";
+            resolver.XmlReferences.Add("PropertyWithValue.xml", contentWithValue);
+
+            string contentWithoutValue = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
+<ClassName>
+  <Property>
+    <summary>Foo</summary>
+  </Property>
+</ClassName>
+";
+            resolver.XmlReferences.Add("PropertyWithoutValue.xml", contentWithoutValue);
+
+            string contentWithEmptyValue = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
+<ClassName>
+  <Property>
+    <summary>Foo</summary>
+    <value>  </value>
+  </Property>
+</ClassName>
+";
+            resolver.XmlReferences.Add("PropertyWithEmptyValue.xml", contentWithEmptyValue);
+
+            string contentWithInheritdocValue = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
+<ClassName>
+  <Property>
+    <inheritdoc/>
+  </Property>
+</ClassName>
+";
+            resolver.XmlReferences.Add("PropertyWithInheritdoc.xml", contentWithInheritdocValue);
+
+            project = base.ApplyCompilationOptions(project);
+            project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
+            return project;
+        }
+
         protected override IEnumerable<DiagnosticAnalyzer> GetCSharpDiagnosticAnalyzers()
         {
             yield return new SA1610PropertyDocumentationMustHaveValueText();

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1610PropertyDocumentationMustHaveValueText.cs

@@ -4,6 +4,7 @@
 namespace StyleCop.Analyzers.DocumentationRules
 {
     using System.Collections.Immutable;
+    using System.Linq;
     using System.Xml.Linq;
     using Helpers;
     using Microsoft.CodeAnalysis;
@@ -50,10 +51,35 @@ internal class SA1610PropertyDocumentationMustHaveValueText : PropertyDocumentat
         /// <inheritdoc/>
         protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, XmlNodeSyntax syntax, XElement completeDocumentation, Location diagnosticLocation)
         {
-            if (syntax != null && XmlCommentHelper.IsConsideredEmpty(syntax))
+            if (completeDocumentation != null)
             {
-                context.ReportDiagnostic(Diagnostic.Create(Descriptor, diagnosticLocation));
+                var valueTag = completeDocumentation.Nodes().OfType<XElement>().FirstOrDefault(element => element.Name == XmlCommentHelper.ValueXmlTag);
+                if (valueTag == null)
+                {
+                    // handled by SA1609
+                    return;
+                }
+
+                if (!XmlCommentHelper.IsConsideredEmpty(valueTag))
+                {
+                    return;
+                }
             }
+            else
+            {
+                if (syntax == null)
+                {
+                    // Handled by SA1609
+                    return;
+                }
+
+                if (!XmlCommentHelper.IsConsideredEmpty(syntax))
+                {
+                    return;
+                }
+            }
+
+            context.ReportDiagnostic(Diagnostic.Create(Descriptor, diagnosticLocation));
         }
     }
 }