Update docs.

JohanLarsson · JohanLarsson · commit 5ca663b412c6 · 2018-12-30T12:36:20.000+01:00
diff --git a/AspNetCoreAnalyzers.Tests/ASP001ParameterNameTests/CodeFix.cs b/AspNetCoreAnalyzers.Tests/ASP001ParameterNameTests/CodeFix.cs
@@ -8,7 +8,7 @@ namespace AspNetCoreAnalyzers.Tests.ASP001ParameterNameTests
     public class CodeFix
     {
         private static readonly DiagnosticAnalyzer Analyzer = new AttributeAnalyzer();
-        private static readonly ExpectedDiagnostic ExpectedDiagnostic = ExpectedDiagnostic.Create(ASP001ParameterName.Descriptor);
+        private static readonly ExpectedDiagnostic ExpectedDiagnostic = ExpectedDiagnostic.Create(ASP001ParameterSymbolName.Descriptor);
         private static readonly CodeFixProvider Fix = new ParameterNameFix();
 
         [TestCase("@\"{value}\"")]
diff --git a/AspNetCoreAnalyzers.Tests/ASP001ParameterNameTests/ValidCode.cs b/AspNetCoreAnalyzers.Tests/ASP001ParameterNameTests/ValidCode.cs
@@ -8,7 +8,7 @@ namespace AspNetCoreAnalyzers.Tests.ASP001ParameterNameTests
     public class ValidCode
     {
         private static readonly DiagnosticAnalyzer Analyzer = new AttributeAnalyzer();
-        private static readonly DiagnosticDescriptor Descriptor = ASP001ParameterName.Descriptor;
+        private static readonly DiagnosticDescriptor Descriptor = ASP001ParameterSymbolName.Descriptor;
 
         [TestCase("@\"{value}\"")]
         [TestCase("\"{value}\"")]
diff --git a/AspNetCoreAnalyzers.Tests/ASP002MissingParameterTests/CodeFix.cs b/AspNetCoreAnalyzers.Tests/ASP002MissingParameterTests/CodeFix.cs
@@ -8,7 +8,7 @@ namespace AspNetCoreAnalyzers.Tests.ASP002MissingParameterTests
     public class CodeFix
     {
         private static readonly DiagnosticAnalyzer Analyzer = new AttributeAnalyzer();
-        private static readonly ExpectedDiagnostic ExpectedDiagnostic = ExpectedDiagnostic.Create(ASP002MissingParameter.Descriptor);
+        private static readonly ExpectedDiagnostic ExpectedDiagnostic = ExpectedDiagnostic.Create(ASP007MissingParameter.Descriptor);
         private static readonly CodeFixProvider Fix = new TemplateTextFix();
 
         [TestCase("\"api/{↓value}\"",       "\"api/{text}\"")]
diff --git a/AspNetCoreAnalyzers.Tests/ASP002MissingParameterTests/Diagnostics.cs b/AspNetCoreAnalyzers.Tests/ASP002MissingParameterTests/Diagnostics.cs
@@ -7,7 +7,7 @@ namespace AspNetCoreAnalyzers.Tests.ASP002MissingParameterTests
     public class Diagnostics
     {
         private static readonly DiagnosticAnalyzer Analyzer = new AttributeAnalyzer();
-        private static readonly ExpectedDiagnostic ExpectedDiagnostic = ExpectedDiagnostic.Create(ASP002MissingParameter.Descriptor);
+        private static readonly ExpectedDiagnostic ExpectedDiagnostic = ExpectedDiagnostic.Create(ASP007MissingParameter.Descriptor);
 
         [Test]
         public void WhenNoParameter()
diff --git a/AspNetCoreAnalyzers/ASP001ParameterSymbolName.cs b/AspNetCoreAnalyzers/ASP001ParameterSymbolName.cs
@@ -2,18 +2,18 @@ namespace AspNetCoreAnalyzers
 {
     using Microsoft.CodeAnalysis;
 
-    internal static class ASP001ParameterName
+    internal static class ASP001ParameterSymbolName
     {
         public const string DiagnosticId = "ASP001";
 
         internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor(
             id: DiagnosticId,
-            title: "The parameter name does not match the url parameter.",
-            messageFormat: "The parameter name does not match the url parameter.",
+            title: "Parameter name does not match the name specified by the route parameter.",
+            messageFormat: "Parameter name does not match the name specified by the route parameter.",
             category: AnalyzerCategory.Routing,
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: true,
-            description: "The parameter name does not match the url parameter.",
+            description: "Parameter name does not match the name specified by the route parameter.",
             helpLinkUri: HelpLink.ForId(DiagnosticId));
     }
 }
diff --git a/AspNetCoreAnalyzers/ASP003ParameterSymbolType.cs b/AspNetCoreAnalyzers/ASP003ParameterSymbolType.cs
@@ -8,12 +8,12 @@ internal static class ASP003ParameterSymbolType
 
         internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor(
             id: DiagnosticId,
-            title: "Parameter type does not match the type specified by the route parameter.",
-            messageFormat: "Parameter type does not match the type specified by the route parameter.",
+            title: "Parameter type does not match the type specified by the name specified by the route parameter.",
+            messageFormat: "Parameter type does not match the type specified by the name specified by the route parameter.",
             category: AnalyzerCategory.Routing,
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: true,
-            description: "Parameter type does not match the type specified by the route parameter.",
+            description: "Parameter type does not match the type specified by the name specified by the route parameter.",
             helpLinkUri: HelpLink.ForId(DiagnosticId));
     }
 }
diff --git a/AspNetCoreAnalyzers/ASP007MissingParameter.cs b/AspNetCoreAnalyzers/ASP007MissingParameter.cs
@@ -2,7 +2,7 @@ namespace AspNetCoreAnalyzers
 {
     using Microsoft.CodeAnalysis;
 
-    internal static class ASP002MissingParameter
+    internal static class ASP007MissingParameter
     {
         public const string DiagnosticId = "ASP002";
 
diff --git a/AspNetCoreAnalyzers/Analyzers/AttributeAnalyzer.cs b/AspNetCoreAnalyzers/Analyzers/AttributeAnalyzer.cs
@@ -15,8 +15,8 @@ namespace AspNetCoreAnalyzers
     public class AttributeAnalyzer : DiagnosticAnalyzer
     {
         public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(
-            ASP001ParameterName.Descriptor,
-            ASP002MissingParameter.Descriptor,
+            ASP001ParameterSymbolName.Descriptor,
+            ASP007MissingParameter.Descriptor,
             ASP003ParameterSymbolType.Descriptor,
             ASP004RouteParameterType.Descriptor,
             ASP005ParameterSyntax.Descriptor,
@@ -44,15 +44,15 @@ context.ContainingSymbol is IMethodSymbol method &&
                     {
                         context.ReportDiagnostic(
                             Diagnostic.Create(
-                                ASP001ParameterName.Descriptor,
+                                ASP001ParameterSymbolName.Descriptor,
                                 parameterSyntax.Identifier.GetLocation(),
                                 ImmutableDictionary<string, string>.Empty.Add(
                                     nameof(NameSyntax),
                                     templateParameter.Name.ToString())));
 
                         context.ReportDiagnostic(
                             Diagnostic.Create(
-                                ASP002MissingParameter.Descriptor,
+                                ASP007MissingParameter.Descriptor,
                                 templateParameter.Name.GetLocation(),
                                 ImmutableDictionary<string, string>.Empty.Add(
                                     nameof(Text),
@@ -63,7 +63,7 @@ context.ContainingSymbol is IMethodSymbol method &&
                     {
                         context.ReportDiagnostic(
                             Diagnostic.Create(
-                                ASP001ParameterName.Descriptor,
+                                ASP001ParameterSymbolName.Descriptor,
                                 methodDeclaration.ParameterList.GetLocation()));
                     }
 
@@ -72,7 +72,7 @@ context.ContainingSymbol is IMethodSymbol method &&
                     {
                         context.ReportDiagnostic(
                             Diagnostic.Create(
-                                ASP002MissingParameter.Descriptor,
+                                ASP007MissingParameter.Descriptor,
                                 methodDeclaration.ParameterList.GetLocation()));
                     }
 
diff --git a/AspNetCoreAnalyzers/CodeFixes/ParameterNameFix.cs b/AspNetCoreAnalyzers/CodeFixes/ParameterNameFix.cs
@@ -16,7 +16,7 @@ namespace AspNetCoreAnalyzers
     public class ParameterNameFix : CodeFixProvider
     {
         public override ImmutableArray<string> FixableDiagnosticIds { get; } = ImmutableArray.Create(
-            ASP001ParameterName.DiagnosticId);
+            ASP001ParameterSymbolName.DiagnosticId);
 
         public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;
 
diff --git a/AspNetCoreAnalyzers/CodeFixes/TemplateTextFix.cs b/AspNetCoreAnalyzers/CodeFixes/TemplateTextFix.cs
@@ -16,7 +16,7 @@ namespace AspNetCoreAnalyzers
     public class TemplateTextFix : CodeFixProvider
     {
         public override ImmutableArray<string> FixableDiagnosticIds { get; } = ImmutableArray.Create(
-            ASP002MissingParameter.DiagnosticId,
+            ASP007MissingParameter.DiagnosticId,
             ASP004RouteParameterType.DiagnosticId,
             ASP005ParameterSyntax.DiagnosticId,
             ASP006ParameterRegex.DiagnosticId);
@@ -54,7 +54,7 @@ private static string GetTitle(Diagnostic diagnostic)
         {
             switch (diagnostic.Id)
             {
-                case ASP002MissingParameter.DiagnosticId:
+                case ASP007MissingParameter.DiagnosticId:
                     return "Rename parameter.";
                 case ASP004RouteParameterType.DiagnosticId:
                     return "Change type to match symbol.";
diff --git a/README.md b/README.md
@@ -13,15 +13,15 @@ Roslyn analyzers for ASP.NET.Core.
 <table>
   <tr>
     <td><a href="https://github.com/DotNetAnalyzers/AspNetCoreAnalyzers/tree/master/documentation/ASP001.md">ASP001</a></td>
-    <td>The parameter name does not match the url parameter.</td>
+    <td>Parameter name does not match the name specified by the route parameter.</td>
   </tr>
   <tr>
     <td><a href="https://github.com/DotNetAnalyzers/AspNetCoreAnalyzers/tree/master/documentation/ASP002.md">ASP002</a></td>
     <td>The method has no corresponding parameter.</td>
   </tr>
   <tr>
     <td><a href="https://github.com/DotNetAnalyzers/AspNetCoreAnalyzers/tree/master/documentation/ASP003.md">ASP003</a></td>
-    <td>Parameter type does not match the type specified by the route parameter.</td>
+    <td>Parameter type does not match the type specified by the name specified by the route parameter.</td>
   </tr>
   <tr>
     <td><a href="https://github.com/DotNetAnalyzers/AspNetCoreAnalyzers/tree/master/documentation/ASP004.md">ASP004</a></td>
diff --git a/documentation/ASP001.md b/documentation/ASP001.md
@@ -1,5 +1,5 @@
 ﻿# ASP001
-## The parameter name does not match the url parameter.
+## Parameter name does not match the name specified by the route parameter.
 
 <!-- start generated table -->
 <table>
@@ -28,7 +28,7 @@
 
 ## Description
 
-The parameter name does not match the url parameter.
+Parameter name does not match the name specified by the route parameter.
 
 ## Motivation
 
@@ -75,21 +75,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros
 
 ### Via #pragma directive.
 ```C#
-#pragma warning disable ASP001 // The parameter name does not match the url parameter.
+#pragma warning disable ASP001 // Parameter name does not match the name specified by the route parameter.
 Code violating the rule here
-#pragma warning restore ASP001 // The parameter name does not match the url parameter.
+#pragma warning restore ASP001 // Parameter name does not match the name specified by the route parameter.
 ```
 
 Or put this at the top of the file to disable all instances.
 ```C#
-#pragma warning disable ASP001 // The parameter name does not match the url parameter.
+#pragma warning disable ASP001 // Parameter name does not match the name specified by the route parameter.
 ```
 
 ### Via attribute `[SuppressMessage]`.
 
 ```C#
 [System.Diagnostics.CodeAnalysis.SuppressMessage("AspNetCoreAnalyzers.Routing", 
-    "ASP001:The parameter name does not match the url parameter.", 
+    "ASP001:Parameter name does not match the name specified by the route parameter.", 
     Justification = "Reason...")]
 ```
 <!-- end generated config severity -->
diff --git a/documentation/ASP003.md b/documentation/ASP003.md
@@ -1,5 +1,5 @@
 # ASP003
-## Parameter type does not match the type specified by the route parameter.
+## Parameter type does not match the type specified by the name specified by the route parameter.
 
 <!-- start generated table -->
 <table>
@@ -28,7 +28,7 @@
 
 ## Description
 
-Parameter type does not match the type specified by the route parameter.
+Parameter type does not match the type specified by the name specified by the route parameter.
 
 ## Motivation
 
@@ -47,21 +47,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros
 
 ### Via #pragma directive.
 ```C#
-#pragma warning disable ASP003 // Parameter type does not match the type specified by the route parameter.
+#pragma warning disable ASP003 // Parameter type does not match the type specified by the name specified by the route parameter.
 Code violating the rule here
-#pragma warning restore ASP003 // Parameter type does not match the type specified by the route parameter.
+#pragma warning restore ASP003 // Parameter type does not match the type specified by the name specified by the route parameter.
 ```
 
 Or put this at the top of the file to disable all instances.
 ```C#
-#pragma warning disable ASP003 // Parameter type does not match the type specified by the route parameter.
+#pragma warning disable ASP003 // Parameter type does not match the type specified by the name specified by the route parameter.
 ```
 
 ### Via attribute `[SuppressMessage]`.
 
 ```C#
 [System.Diagnostics.CodeAnalysis.SuppressMessage("AspNetCoreAnalyzers.Routing", 
-    "ASP003:Parameter type does not match the type specified by the route parameter.", 
+    "ASP003:Parameter type does not match the type specified by the name specified by the route parameter.", 
     Justification = "Reason...")]
 ```
 <!-- end generated config severity -->

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace AspNetCoreAnalyzers.Tests.ASP001ParameterNameTests`
`8`	`8`	`public class CodeFix`
`9`	`9`	`{`
`10`	`10`	`private static readonly DiagnosticAnalyzer Analyzer = new AttributeAnalyzer();`
`11`		`- private static readonly ExpectedDiagnostic ExpectedDiagnostic = ExpectedDiagnostic.Create(ASP001ParameterName.Descriptor);`
	`11`	`+ private static readonly ExpectedDiagnostic ExpectedDiagnostic = ExpectedDiagnostic.Create(ASP001ParameterSymbolName.Descriptor);`
`12`	`12`	`private static readonly CodeFixProvider Fix = new ParameterNameFix();`
`13`	`13`
`14`	`14`	`[TestCase("@\"{value}\"")]`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace AspNetCoreAnalyzers.Tests.ASP001ParameterNameTests`
`8`	`8`	`public class ValidCode`
`9`	`9`	`{`
`10`	`10`	`private static readonly DiagnosticAnalyzer Analyzer = new AttributeAnalyzer();`
`11`		`- private static readonly DiagnosticDescriptor Descriptor = ASP001ParameterName.Descriptor;`
	`11`	`+ private static readonly DiagnosticDescriptor Descriptor = ASP001ParameterSymbolName.Descriptor;`
`12`	`12`
`13`	`13`	`[TestCase("@\"{value}\"")]`
`14`	`14`	`[TestCase("\"{value}\"")]`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ namespace AspNetCoreAnalyzers.Tests.ASP002MissingParameterTests`
`7`	`7`	`public class Diagnostics`
`8`	`8`	`{`
`9`	`9`	`private static readonly DiagnosticAnalyzer Analyzer = new AttributeAnalyzer();`
`10`		`- private static readonly ExpectedDiagnostic ExpectedDiagnostic = ExpectedDiagnostic.Create(ASP002MissingParameter.Descriptor);`
	`10`	`+ private static readonly ExpectedDiagnostic ExpectedDiagnostic = ExpectedDiagnostic.Create(ASP007MissingParameter.Descriptor);`
`11`	`11`
`12`	`12`	`[Test]`
`13`	`13`	`public void WhenNoParameter()`
Original file line number	Diff line number	Diff line change
`@@ -2,18 +2,18 @@ namespace AspNetCoreAnalyzers`
`2`	`2`	`{`
`3`	`3`	`using Microsoft.CodeAnalysis;`
`4`	`4`
`5`		`- internal static class ASP001ParameterName`
	`5`	`+ internal static class ASP001ParameterSymbolName`
`6`	`6`	`{`
`7`	`7`	`public const string DiagnosticId = "ASP001";`
`8`	`8`
`9`	`9`	`internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor(`
`10`	`10`	`id: DiagnosticId,`
`11`		`- title: "The parameter name does not match the url parameter.",`
`12`		`- messageFormat: "The parameter name does not match the url parameter.",`
	`11`	`+ title: "Parameter name does not match the name specified by the route parameter.",`
	`12`	`+ messageFormat: "Parameter name does not match the name specified by the route parameter.",`
`13`	`13`	`category: AnalyzerCategory.Routing,`
`14`	`14`	`defaultSeverity: DiagnosticSeverity.Warning,`
`15`	`15`	`isEnabledByDefault: true,`
`16`		`- description: "The parameter name does not match the url parameter.",`
	`16`	`+ description: "Parameter name does not match the name specified by the route parameter.",`
`17`	`17`	`helpLinkUri: HelpLink.ForId(DiagnosticId));`
`18`	`18`	`}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ namespace AspNetCoreAnalyzers`
`2`	`2`	`{`
`3`	`3`	`using Microsoft.CodeAnalysis;`
`4`	`4`
`5`		`- internal static class ASP002MissingParameter`
	`5`	`+ internal static class ASP007MissingParameter`
`6`	`6`	`{`
`7`	`7`	`public const string DiagnosticId = "ASP002";`
`8`	`8`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ namespace AspNetCoreAnalyzers`
`16`	`16`	`public class ParameterNameFix : CodeFixProvider`
`17`	`17`	`{`
`18`	`18`	`public override ImmutableArray<string> FixableDiagnosticIds { get; } = ImmutableArray.Create(`
`19`		`- ASP001ParameterName.DiagnosticId);`
	`19`	`+ ASP001ParameterSymbolName.DiagnosticId);`
`20`	`20`
`21`	`21`	`public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;`
`22`	`22`