Merge pull request #2228 from dfyx/feature/implement-2227-localize-parameter-not-used

sharwell · web-flow · commit ddc2e315fc81 · 2016-11-17T13:06:23.000-06:00
Implement #2227: SA1625 should accept localized "The parameter is not used."
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.Designer.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.Designer.cs
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.de-DE.resx b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.de-DE.resx
@@ -129,6 +129,9 @@
   <data name="NonPrivateConstructorStandardTextSecondPart" xml:space="preserve">
     <value> {0}</value>
   </data>
+  <data name="ParameterNotUsed" xml:space="preserve">
+    <value>Dieser Parameter wird nicht verwendet.</value>
+  </data>
   <data name="PrivateConstructorStandardTextFirstPart" xml:space="preserve">
     <value>Verhindert, dass eine Standardinstanz der </value>
   </data>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.en-GB.resx b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.en-GB.resx
@@ -129,6 +129,9 @@
   <data name="NonPrivateConstructorStandardTextSecondPart" xml:space="preserve">
     <value> {0}</value>
   </data>
+  <data name="ParameterNotUsed" xml:space="preserve">
+    <value>The parameter is not used.</value>
+  </data>
   <data name="PrivateConstructorStandardTextFirstPart" xml:space="preserve">
     <value>Prevents a default instance of the </value>
   </data>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.es-MX.resx b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.es-MX.resx
@@ -129,6 +129,9 @@
   <data name="NonPrivateConstructorStandardTextSecondPart" xml:space="preserve">
     <value />
   </data>
+  <data name="ParameterNotUsed" xml:space="preserve">
+    <value>El parámetro no se usa.</value>
+  </data>
   <data name="PrivateConstructorStandardTextFirstPart" xml:space="preserve">
     <value>Previene una instancia por defecto de la {0} </value>
   </data>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.fr-FR.resx b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.fr-FR.resx
@@ -129,6 +129,9 @@
   <data name="NonPrivateConstructorStandardTextSecondPart" xml:space="preserve">
     <value />
   </data>
+  <data name="ParameterNotUsed" xml:space="preserve">
+    <value>Le paramètre n'est pas utilisé.</value>
+  </data>
   <data name="PrivateConstructorStandardTextFirstPart" xml:space="preserve">
     <value>Empêche la création d'une instance par défaut de la {0} </value>
   </data>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.pl-PL.resx b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.pl-PL.resx
@@ -129,6 +129,9 @@
   <data name="NonPrivateConstructorStandardTextSecondPart" xml:space="preserve">
     <value />
   </data>
+  <data name="ParameterNotUsed" xml:space="preserve">
+    <value>Parametr nie jest używany.</value>
+  </data>
   <data name="PrivateConstructorStandardTextFirstPart" xml:space="preserve">
     <value>Uniemożliwia utworzenie domyślnej instancji {0} </value>
   </data>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.pt-BR.resx b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.pt-BR.resx
@@ -129,6 +129,9 @@
   <data name="NonPrivateConstructorStandardTextSecondPart" xml:space="preserve">
     <value />
   </data>
+  <data name="ParameterNotUsed" xml:space="preserve">
+    <value>O parâmetro não é usado.</value>
+  </data>
   <data name="PrivateConstructorStandardTextFirstPart" xml:space="preserve">
     <value>Evita que uma instância default da {0} </value>
   </data>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.resx b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.resx
@@ -132,6 +132,9 @@
   <data name="NonPrivateConstructorStandardTextSecondPart" xml:space="preserve">
     <value> {0}</value>
   </data>
+  <data name="ParameterNotUsed" xml:space="preserve">
+    <value>The parameter is not used.</value>
+  </data>
   <data name="PrivateConstructorStandardTextFirstPart" xml:space="preserve">
     <value>Prevents a default instance of the </value>
   </data>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.ru-RU.resx b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.ru-RU.resx
@@ -129,6 +129,9 @@
   <data name="NonPrivateConstructorStandardTextSecondPart" xml:space="preserve">
     <value />
   </data>
+  <data name="ParameterNotUsed" xml:space="preserve">
+    <value>Параметр не используется.</value>
+  </data>
   <data name="PrivateConstructorStandardTextFirstPart" xml:space="preserve">
     <value>Предотвращает вызов конструктора по умолчанию для {0} </value>
   </data>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1625ElementDocumentationMustNotBeCopiedAndPasted.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1625ElementDocumentationMustNotBeCopiedAndPasted.cs
@@ -6,7 +6,9 @@ namespace StyleCop.Analyzers.DocumentationRules
     using System;
     using System.Collections.Generic;
     using System.Collections.Immutable;
+    using System.Globalization;
     using System.Linq;
+    using System.Resources;
     using System.Xml.Linq;
     using Helpers;
     using Helpers.ObjectPools;
@@ -67,7 +69,6 @@ internal class SA1625ElementDocumentationMustNotBeCopiedAndPasted : ElementDocum
         /// analyzer.
         /// </summary>
         public const string DiagnosticId = "SA1625";
-        private const string ParameterNotUsed = "The parameter is not used.";
         private const string Title = "Element documentation must not be copied and pasted";
         private const string MessageFormat = "Element documentation must not be copied and pasted";
         private const string Description = "The Xml documentation for a C# element contains two or more identical entries, indicating that the documentation has been copied and pasted. This can sometimes indicate invalid or poorly written documentation.";
@@ -90,12 +91,15 @@ protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, IEnu
         {
             var objectPool = SharedPools.Default<HashSet<string>>();
             HashSet<string> documentationTexts = objectPool.Allocate();
+            var settings = context.Options.GetStyleCopSettings(context.CancellationToken);
+            var culture = new CultureInfo(settings.DocumentationRules.DocumentationCulture);
+            var resourceManager = DocumentationResources.ResourceManager;
 
             foreach (var documentationSyntax in syntaxList)
             {
                 var documentation = XmlCommentHelper.GetText(documentationSyntax, true)?.Trim();
 
-                if (ShouldSkipElement(documentation))
+                if (ShouldSkipElement(documentation, resourceManager.GetString(nameof(DocumentationResources.ParameterNotUsed), culture)))
                 {
                     continue;
                 }
@@ -119,6 +123,9 @@ protected override void HandleCompleteDocumentation(SyntaxNodeAnalysisContext co
         {
             var objectPool = SharedPools.Default<HashSet<string>>();
             HashSet<string> documentationTexts = objectPool.Allocate();
+            var settings = context.Options.GetStyleCopSettings(context.CancellationToken);
+            var culture = new CultureInfo(settings.DocumentationRules.DocumentationCulture);
+            var resourceManager = DocumentationResources.ResourceManager;
 
             // Concatenate all XML node values
             var documentationElements = completeDocumentation.Nodes()
@@ -140,7 +147,7 @@ protected override void HandleCompleteDocumentation(SyntaxNodeAnalysisContext co
 
             foreach (var documentation in documentationElements)
             {
-                if (ShouldSkipElement(documentation))
+                if (ShouldSkipElement(documentation, resourceManager.GetString(nameof(DocumentationResources.ParameterNotUsed), culture)))
                 {
                     continue;
                 }
@@ -159,9 +166,9 @@ protected override void HandleCompleteDocumentation(SyntaxNodeAnalysisContext co
             objectPool.ClearAndFree(documentationTexts);
         }
 
-        private static bool ShouldSkipElement(string element)
+        private static bool ShouldSkipElement(string element, string parameterNotUsed)
         {
-            return string.IsNullOrWhiteSpace(element) || string.Equals(element, ParameterNotUsed, StringComparison.Ordinal);
+            return string.IsNullOrWhiteSpace(element) || string.Equals(element, parameterNotUsed, StringComparison.Ordinal);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,9 @@ namespace StyleCop.Analyzers.DocumentationRules`
`6`	`6`	`using System;`
`7`	`7`	`using System.Collections.Generic;`
`8`	`8`	`using System.Collections.Immutable;`
	`9`	`+ using System.Globalization;`
`9`	`10`	`using System.Linq;`
	`11`	`+ using System.Resources;`
`10`	`12`	`using System.Xml.Linq;`
`11`	`13`	`using Helpers;`
`12`	`14`	`using Helpers.ObjectPools;`
`@@ -67,7 +69,6 @@ internal class SA1625ElementDocumentationMustNotBeCopiedAndPasted : ElementDocum`
`67`	`69`	`/// analyzer.`
`68`	`70`	`/// </summary>`
`69`	`71`	`public const string DiagnosticId = "SA1625";`
`70`		`- private const string ParameterNotUsed = "The parameter is not used.";`
`71`	`72`	`private const string Title = "Element documentation must not be copied and pasted";`
`72`	`73`	`private const string MessageFormat = "Element documentation must not be copied and pasted";`
`73`	`74`	`private const string Description = "The Xml documentation for a C# element contains two or more identical entries, indicating that the documentation has been copied and pasted. This can sometimes indicate invalid or poorly written documentation.";`
`@@ -90,12 +91,15 @@ protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, IEnu`
`90`	`91`	`{`
`91`	`92`	`var objectPool = SharedPools.Default<HashSet<string>>();`
`92`	`93`	`HashSet<string> documentationTexts = objectPool.Allocate();`
	`94`	`+ var settings = context.Options.GetStyleCopSettings(context.CancellationToken);`
	`95`	`+ var culture = new CultureInfo(settings.DocumentationRules.DocumentationCulture);`
	`96`	`+ var resourceManager = DocumentationResources.ResourceManager;`
`93`	`97`
`94`	`98`	`foreach (var documentationSyntax in syntaxList)`
`95`	`99`	`{`
`96`	`100`	`var documentation = XmlCommentHelper.GetText(documentationSyntax, true)?.Trim();`
`97`	`101`
`98`		`- if (ShouldSkipElement(documentation))`
	`102`	`+ if (ShouldSkipElement(documentation, resourceManager.GetString(nameof(DocumentationResources.ParameterNotUsed), culture)))`
`99`	`103`	`{`
`100`	`104`	`continue;`
`101`	`105`	`}`
`@@ -119,6 +123,9 @@ protected override void HandleCompleteDocumentation(SyntaxNodeAnalysisContext co`
`119`	`123`	`{`
`120`	`124`	`var objectPool = SharedPools.Default<HashSet<string>>();`
`121`	`125`	`HashSet<string> documentationTexts = objectPool.Allocate();`
	`126`	`+ var settings = context.Options.GetStyleCopSettings(context.CancellationToken);`
	`127`	`+ var culture = new CultureInfo(settings.DocumentationRules.DocumentationCulture);`
	`128`	`+ var resourceManager = DocumentationResources.ResourceManager;`
`122`	`129`
`123`	`130`	`// Concatenate all XML node values`
`124`	`131`	`var documentationElements = completeDocumentation.Nodes()`
`@@ -140,7 +147,7 @@ protected override void HandleCompleteDocumentation(SyntaxNodeAnalysisContext co`
`140`	`147`
`141`	`148`	`foreach (var documentation in documentationElements)`
`142`	`149`	`{`
`143`		`- if (ShouldSkipElement(documentation))`
	`150`	`+ if (ShouldSkipElement(documentation, resourceManager.GetString(nameof(DocumentationResources.ParameterNotUsed), culture)))`
`144`	`151`	`{`
`145`	`152`	`continue;`
`146`	`153`	`}`
`@@ -159,9 +166,9 @@ protected override void HandleCompleteDocumentation(SyntaxNodeAnalysisContext co`
`159`	`166`	`objectPool.ClearAndFree(documentationTexts);`
`160`	`167`	`}`
`161`	`168`
`162`		`- private static bool ShouldSkipElement(string element)`
	`169`	`+ private static bool ShouldSkipElement(string element, string parameterNotUsed)`
`163`	`170`	`{`
`164`		`- return string.IsNullOrWhiteSpace(element) \|\| string.Equals(element, ParameterNotUsed, StringComparison.Ordinal);`
	`171`	`+ return string.IsNullOrWhiteSpace(element) \|\| string.Equals(element, parameterNotUsed, StringComparison.Ordinal);`
`165`	`172`	`}`
`166`	`173`	`}`
`167`	`174`	`}`