Merge pull request #2869 from sharwell/ref-docs

Update documentation analyzer to handle ref returns

Author: vweijsters

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/DocumentationRules/SA1623CSharp7UnitTests.cs

@@ -48,6 +48,9 @@ public class SA1623CSharp7UnitTests : SA1623UnitTests
         [InlineData("protected internal", "int", "{ private get => 0; set => this.field = value; }", "Sets")]
         [InlineData("internal", "int", "{ get => 0; private set => this.field = value; }", "Gets")]
         [InlineData("internal", "int", "{ private get => 0; set => this.field = value; }", "Sets")]
+
+        [WorkItem(2861, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/2861")]
+        [InlineData("public", "ref int", "{ get => throw null; }", "Gets")]
         public async Task VerifyDocumentationWithWrongStartingTextWillProduceDiagnosticWithExpressionBodiedAccessorsAsync(string accessibility, string type, string accessors, string expectedArgument)
         {
             var testCode = $@"

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/PropertySummaryDocumentationAnalyzer.cs

@@ -12,6 +12,7 @@ namespace StyleCop.Analyzers.DocumentationRules
     using Microsoft.CodeAnalysis.CSharp.Syntax;
     using Microsoft.CodeAnalysis.Diagnostics;
     using StyleCop.Analyzers.Helpers;
+    using StyleCop.Analyzers.Lightup;
 
     /// <summary>
     /// Analyzes the correct usage of property summary documentation.
@@ -60,7 +61,7 @@ internal class PropertySummaryDocumentationAnalyzer : PropertyDocumentationBase
         protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, bool needsComment, XmlNodeSyntax syntax, XElement completeDocumentation, Location diagnosticLocation)
         {
             var propertyDeclaration = (PropertyDeclarationSyntax)context.Node;
-            var propertyType = context.SemanticModel.GetTypeInfo(propertyDeclaration.Type);
+            var propertyType = context.SemanticModel.GetTypeInfo(propertyDeclaration.Type.StripRefFromType());
             var settings = context.Options.GetStyleCopSettings(context.CancellationToken);
             var culture = new CultureInfo(settings.DocumentationRules.DocumentationCulture);
             var resourceManager = DocumentationResources.ResourceManager;

StyleCop.Analyzers/StyleCop.Analyzers/Helpers/TypeSyntaxHelper.cs

@@ -3,6 +3,7 @@
 
 namespace StyleCop.Analyzers.Helpers
 {
+    using Microsoft.CodeAnalysis;
     using Microsoft.CodeAnalysis.CSharp;
     using Microsoft.CodeAnalysis.CSharp.Syntax;
     using StyleCop.Analyzers.Lightup;
@@ -55,5 +56,15 @@ public static bool IsReturnType(this TypeSyntax syntax)
                 return false;
             }
         }
+
+        public static TypeSyntax StripRefFromType(this TypeSyntax syntax)
+        {
+            if (syntax.IsKind(SyntaxKindEx.RefType))
+            {
+                syntax = ((RefTypeSyntaxWrapper)syntax).Type;
+            }
+
+            return syntax;
+        }
     }
 }