From e6b6efc946f75eae60bb17b248a513c0d12dbc2b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Hellander?= <bjorn.hellander@gmail.com>
Date: Fri, 2 Aug 2024 14:15:01 +0200
Subject: [PATCH] Update PropertySummaryDocumentationAnalyzer (SA1623 and
 SA1624) to ignore summary tags containing an inheritdoc tag #3465

---
 .../DocumentationRules/SA1623UnitTests.cs     | 20 +++++++++++++++++++
 .../DocumentationRules/SA1624UnitTests.cs     | 20 +++++++++++++++++++
 .../PropertySummaryDocumentationAnalyzer.cs   |  6 ++++++
 3 files changed, 46 insertions(+)

diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1623UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1623UnitTests.cs
index 0e6503f58..948328aaf 100644
--- a/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1623UnitTests.cs
+++ b/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1623UnitTests.cs
@@ -341,6 +341,26 @@ public class TestClass
     /// <summary/>
     public int TestProperty { get; set; }
 }
+";
+
+            await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Theory]
+        [InlineData("<inheritdoc/>")]
+        [InlineData("XYZ <inheritdoc/>")]
+        [InlineData("<inheritdoc/> XYZ")]
+        [WorkItem(3465, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3465")]
+        public async Task VerifyInheritdocInSummaryTagIsAllowedAsync(string summary)
+        {
+            var testCode = $@"
+public class TestClass
+{{
+    /// <summary>
+    /// {summary}
+    /// </summary>
+    public int TestProperty {{ get; set; }}
+}}
 ";
 
             await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1624UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1624UnitTests.cs
index fb9ce294e..ad524a756 100644
--- a/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1624UnitTests.cs
+++ b/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1624UnitTests.cs
@@ -152,6 +152,26 @@ public class TestClass
     /// <summary/>
     public int TestProperty { get; set; }
 }
+";
+
+            await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Theory]
+        [InlineData("<inheritdoc/>")]
+        [InlineData("XYZ <inheritdoc/>")]
+        [InlineData("<inheritdoc/> XYZ")]
+        [WorkItem(3465, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3465")]
+        public async Task VerifyInheritdocInSummaryTagIsAllowedAsync(string summary)
+        {
+            var testCode = $@"
+public class TestClass
+{{
+    /// <summary>
+    /// {summary}
+    /// </summary>
+    public int TestProperty {{ get; private set; }}
+}}
 ";
 
             await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/PropertySummaryDocumentationAnalyzer.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/PropertySummaryDocumentationAnalyzer.cs
index 19dffdd88..c3087b145 100644
--- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/PropertySummaryDocumentationAnalyzer.cs
+++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/PropertySummaryDocumentationAnalyzer.cs
@@ -67,6 +67,12 @@ protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, Styl
                 return;
             }
 
+            if (summaryElement.Content.GetFirstXmlElement(XmlCommentHelper.InheritdocXmlTag) != null)
+            {
+                // Ignore nodes with an <inheritdoc/> tag.
+                return;
+            }
+
             var propertyDeclaration = (PropertyDeclarationSyntax)context.Node;
             var propertyType = context.SemanticModel.GetTypeInfo(propertyDeclaration.Type.StripRefFromType());
             var culture = settings.DocumentationRules.DocumentationCultureInfo;