Merge pull request #1726 from vweijsters/fix-1678

Added support to SA1611 for operators and conversion operators

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1611UnitTests.cs

@@ -142,7 +142,7 @@ public class ClassName
     /// </summary>
     public ##
 }";
-            var expected = new[]
+            DiagnosticResult[] expected =
             {
                 this.CSharpDiagnostic().WithLocation(10, 38).WithArguments("param1"),
                 this.CSharpDiagnostic().WithLocation(10, 53).WithArguments("param2"),
@@ -152,6 +152,83 @@ public class ClassName
             await this.VerifyCSharpDiagnosticAsync(testCode.Replace("##", p), expected, CancellationToken.None).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Verifies that valid operator declarations will not produce diagnostics.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task VerifyValidOperatorDeclarationsAsync()
+        {
+            var testCode = @"
+/// <summary>
+/// Test class
+/// </summary>
+public class TestClass
+{
+    /// <summary>
+    /// Foo
+    /// </summary>
+    /// <param name=""value"">The value to use.</param>
+    public static TestClass operator +(TestClass value)
+    {   
+        return value;
+    }
+
+    /// <summary>
+    /// Foo
+    /// </summary>
+    /// <param name=""value"">The value to use.</param>
+    public static explicit operator TestClass(int value)
+    {   
+        return new TestClass();
+    }
+}
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Verifies that invalid operator declarations will produce the expected diagnostics.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task VerifyInvalidOperatorDeclarationsAsync()
+        {
+            var testCode = @"
+/// <summary>
+/// Test class
+/// </summary>
+public class TestClass
+{
+    /// <summary>
+    /// Foo
+    /// </summary>
+    public static TestClass operator +(TestClass value)
+    {   
+        return value;
+    }
+
+    /// <summary>
+    /// Foo
+    /// </summary>
+    public static explicit operator TestClass(int value)
+    {   
+        return new TestClass();
+    }
+}
+";
+
+            DiagnosticResult[] expected =
+            {
+                this.CSharpDiagnostic().WithLocation(10, 50).WithArguments("value"),
+                this.CSharpDiagnostic().WithLocation(18, 51).WithArguments("value")
+            };
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        /// <inheritdoc/>
         protected override IEnumerable<DiagnosticAnalyzer> GetCSharpDiagnosticAnalyzers()
         {
             yield return new SA1611ElementParametersMustBeDocumented();

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.Designer.cs

@@ -123,6 +123,15 @@
   <data name="SA1609SA1610CodeFix" xml:space="preserve">
     <value>Document value from summary</value>
   </data>
+  <data name="SA1611Description" xml:space="preserve">
+    <value>A C# method, constructor, delegate or indexer element is missing documentation for one or more of its parameters.</value>
+  </data>
+  <data name="SA1611MessageFormat" xml:space="preserve">
+    <value>The documentation for parameter '{0}' is missing</value>
+  </data>
+  <data name="SA1611Title" xml:space="preserve">
+    <value>Element parameters must be documented</value>
+  </data>
   <data name="SA1615SA1616CodeFix" xml:space="preserve">
     <value>Document return value</value>
   </data>

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.resx

@@ -34,16 +34,22 @@ internal class SA1611ElementParametersMustBeDocumented : DiagnosticAnalyzer
         /// The ID for diagnostics produced by the <see cref="SA1611ElementParametersMustBeDocumented"/> analyzer.
         /// </summary>
         public const string DiagnosticId = "SA1611";
-        private const string Title = "Element parameters must be documented";
-        private const string MessageFormat = "The documentation for parameter '{0}' is missing";
-        private const string Description = "A C# method, constructor, delegate or indexer element is missing documentation for one or more of its parameters.";
-        private const string HelpLink = "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1611.md";
+        private static readonly LocalizableString Title = new LocalizableResourceString(nameof(DocumentationResources.SA1611Title), DocumentationResources.ResourceManager, typeof(DocumentationResources));
+        private static readonly LocalizableString MessageFormat = new LocalizableResourceString(nameof(DocumentationResources.SA1611MessageFormat), DocumentationResources.ResourceManager, typeof(DocumentationResources));
+        private static readonly LocalizableString Description = new LocalizableResourceString(nameof(DocumentationResources.SA1611Description), DocumentationResources.ResourceManager, typeof(DocumentationResources));
+        private static readonly string HelpLink = "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1611.md";
 
         private static readonly DiagnosticDescriptor Descriptor =
             new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.DocumentationRules, DiagnosticSeverity.Warning, AnalyzerConstants.EnabledByDefault, Description, HelpLink);
 
         private static readonly ImmutableArray<SyntaxKind> HandledSyntaxKinds =
-            ImmutableArray.Create(SyntaxKind.MethodDeclaration, SyntaxKind.ConstructorDeclaration, SyntaxKind.DelegateDeclaration, SyntaxKind.IndexerDeclaration);
+            ImmutableArray.Create(
+                SyntaxKind.MethodDeclaration,
+                SyntaxKind.ConstructorDeclaration,
+                SyntaxKind.DelegateDeclaration,
+                SyntaxKind.IndexerDeclaration,
+                SyntaxKind.OperatorDeclaration,
+                SyntaxKind.ConversionOperatorDeclaration);
 
         private static readonly Action<CompilationStartAnalysisContext> CompilationStartAction = HandleCompilationStart;
         private static readonly Action<SyntaxNodeAnalysisContext> SyntaxNodeAction = HandleSyntaxNode;