Merge pull request #3292 from angelobreuer/fix/3291

SA1648 throws an exception on delegates that use the <include> tag

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1648UnitTests.cs

@@ -305,6 +305,57 @@ public void TestMethod() { }
             await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Verifies that a delegate declaration that includes the inheritdoc will produce diagnostics.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3291, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3291")]
+        [WorkItem(3291, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3291")]
+        public async Task TestIncorrectDocumentedDelegateInheritDocAsync()
+        {
+            var testCode = @"
+/// <summary>Foo</summary>
+/// <param name=""value"">some param</param>
+/// <returns>something</returns>
+public delegate bool TestDelegate(int value);
+
+/// <summary>Test class</summary>
+public class TestClass
+{
+  /// {|#0:<include file='DelegateInheritDoc.xml' path='/TestDelegate/*'/>|}
+  public delegate bool TestDelegate(int value);
+}
+";
+
+            var expected = Diagnostic().WithLocation(0);
+            await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Verifies that a delegate declaration that includes the inheritdoc will produce diagnostics.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3291, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3291")]
+        [WorkItem(3291, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3291")]
+        public async Task TestIncorrectDelegateInheritDocAsync()
+        {
+            var testCode = @"
+public delegate bool TestDelegate(int value);
+
+/// <summary>Test class</summary>
+public class TestClass
+{
+  /// {|#0:<include file='DelegateInheritDoc.xml' path='/TestDelegate/*'/>|}
+  public delegate bool TestDelegate(int value);
+}
+";
+
+            var expected = Diagnostic().WithLocation(0);
+            await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
         private static Task VerifyCSharpDiagnosticAsync(string source, DiagnosticResult expected, CancellationToken cancellationToken)
             => VerifyCSharpDiagnosticAsync(source, new[] { expected }, cancellationToken);
 
@@ -329,6 +380,11 @@ private static StyleCopDiagnosticVerifier<SA1648InheritDocMustBeUsedWithInheriti
     <inheritdoc/>
   </TestMethod>
 </TestClass>
+";
+            string contentDelegateInheritDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
+<TestDelegate>
+    <inheritdoc/>
+</TestDelegate>
 ";
 
             var test = new StyleCopDiagnosticVerifier<SA1648InheritDocMustBeUsedWithInheritingClass>.CSharpTest
@@ -337,6 +393,7 @@ private static StyleCopDiagnosticVerifier<SA1648InheritDocMustBeUsedWithInheriti
                 {
                     { "ClassInheritDoc.xml", contentClassInheritDoc },
                     { "MethodInheritDoc.xml", contentMethodInheritDoc },
+                    { "DelegateInheritDoc.xml", contentDelegateInheritDoc },
                 },
             };
 

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1648InheritDocMustBeUsedWithInheritingClass.cs

@@ -86,7 +86,7 @@ private static void HandleBaseTypeLikeDeclaration(SyntaxNodeAnalysisContext cont
 
             if (documentation.Content.GetFirstXmlElement(XmlCommentHelper.IncludeXmlTag) is XmlEmptyElementSyntax includeElement)
             {
-                var declaration = context.SemanticModel.GetDeclaredSymbol(baseType, context.CancellationToken);
+                var declaration = context.SemanticModel.GetDeclaredSymbol(context.Node, context.CancellationToken);
                 if (declaration == null)
                 {
                     return;