Update documentation of analyzers, refactoring and code fixes

dotnet · Jan 16, 2022 · c717591 · c717591
1 parent e06e186
commit c717591
Show file tree

Hide file tree

Showing 396 changed files with 1,264 additions and 2,261 deletions.
diff --git a/docs/analyzers/RCS0001.md b/docs/analyzers/RCS0001.md
@@ -1,4 +1,4 @@
-# RCS0001: Add empty line after embedded statement
+# RCS0001: Add blank line after embedded statement
 
 | Property | Value      |
 | -------- | ---------- |
@@ -25,17 +25,9 @@ if (x)
 Bar();
 ```
 
-## Remarks
-
-This rule was originally introduced as [RCS1030](RCS1030.md)
-
 ## Applies to
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0002.md b/docs/analyzers/RCS0002.md
@@ -1,4 +1,4 @@
-# RCS0002: Add empty line after \#region
+# RCS0002: Add blank line after \#region
 
 | Property | Value      |
 | -------- | ---------- |
@@ -41,9 +41,5 @@ class C
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0003.md b/docs/analyzers/RCS0003.md
@@ -1,4 +1,4 @@
-# RCS0003: Add empty line after using directive list
+# RCS0003: Add blank line after using directive list
 
 | Property | Value      |
 | -------- | ---------- |
@@ -37,9 +37,5 @@ namespace N
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0004.md b/docs/analyzers/RCS0004.md
@@ -1,4 +1,4 @@
-# RCS0004: Add empty line before closing brace of 'do' statement
+# \[deprecated\] RCS0004: Add empty line before closing brace of 'do' statement
 
 | Property | Value      |
 | -------- | ---------- |
@@ -27,17 +27,9 @@ do
 } while (x);
 ```
 
-## Remarks
-
-This rule was originally introduced as [RCS1092](RCS1092.md)
-
 ## Applies to
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0005.md b/docs/analyzers/RCS0005.md
@@ -1,4 +1,4 @@
-# RCS0005: Add empty line before \#endregion
+# RCS0005: Add blank line before \#endregion
 
 | Property | Value      |
 | -------- | ---------- |
@@ -41,9 +41,5 @@ class C
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0006.md b/docs/analyzers/RCS0006.md
@@ -1,4 +1,4 @@
-# RCS0006: Add empty line before using directive list
+# RCS0006: Add blank line before using directive list
 
 | Property | Value      |
 | -------- | ---------- |
@@ -37,9 +37,5 @@ namespace N
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0007.md b/docs/analyzers/RCS0007.md
@@ -1,4 +1,4 @@
-# RCS0007: Add empty line between accessors
+# RCS0007: Add blank line between accessors
 
 | Property | Value      |
 | -------- | ---------- |
@@ -43,15 +43,11 @@ string P
 
 ## Remarks
 
-This rule does not enforce an empty line between two single-line accessors.
+This rule does not enforce an blank line between two single-line accessors.
 
 ## Applies to
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0008.md b/docs/analyzers/RCS0008.md
@@ -1,4 +1,4 @@
-# RCS0008: Add empty line between block and statement
+# RCS0008: Add blank line between closing brace and next statement
 
 | Property | Value      |
 | -------- | ---------- |
@@ -27,17 +27,9 @@ if (x)
 Foo();
 ```
 
-## Remarks
-
-This rule was originally introduced as [RCS1153](RCS1153.md)
-
 ## Applies to
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0009.md b/docs/analyzers/RCS0009.md
@@ -1,4 +1,4 @@
-# RCS0009: Add empty line between declaration and documentation comment
+# RCS0009: Add blank line between declaration and documentation comment
 
 | Property | Value      |
 | -------- | ---------- |
@@ -33,9 +33,5 @@ object P2 { get; }
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0010.md b/docs/analyzers/RCS0010.md
@@ -1,4 +1,4 @@
-# RCS0010: Add empty line between declarations
+# RCS0010: Add blank line between declarations
 
 | Property | Value      |
 | -------- | ---------- |
@@ -83,17 +83,11 @@ enum Bar
 
 ## Remarks
 
-This rule was originally introduced as [RCS1057](RCS1057.md).
-
-This rule does not enforce an empty line between two single-line declaration.
+This rule does not enforce an blank line between two single-line declaration.
 
 ## Applies to
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0011.md b/docs/analyzers/RCS0011.md
@@ -1,10 +1,11 @@
-# RCS0011: Add empty line between single\-line accessors \(or vice versa\)
+# RCS0011: Add/remove blank line between single\-line accessors
 
-| Property | Value      |
-| -------- | ---------- |
-| Id       | RCS0011    |
-| Category | Formatting |
-| Severity | None       |
+| Property        | Value                                                 |
+| --------------- | ----------------------------------------------------- |
+| Id              | RCS0011                                               |
+| Category        | Formatting                                            |
+| Severity        | None                                                  |
+| Required option | `roslynator_blank_line_between_single_line_accessors` |
 
 ## Example
 
@@ -31,19 +32,15 @@ string P
 
 ## Options
 
-### Remove empty line between single\-line accessors
+### Add/remove blank line between single\-line accessors
 
 ```editorconfig
-roslynator.RCS0011.invert = true
+roslynator_blank_line_between_single_line_accessors = true|false
 ```
 
 ## Applies to
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0012.md b/docs/analyzers/RCS0012.md
@@ -1,4 +1,4 @@
-# RCS0012: Add empty line between single\-line declarations
+# RCS0012: Add blank line between single\-line declarations
 
 | Property | Value      |
 | -------- | ---------- |
@@ -27,9 +27,5 @@ object P2 { get; }
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0013.md b/docs/analyzers/RCS0013.md
@@ -1,4 +1,4 @@
-# RCS0013: Add empty line between single\-line declarations of different kind
+# RCS0013: Add blank line between single\-line declarations of different kind
 
 | Property | Value      |
 | -------- | ---------- |
@@ -27,9 +27,5 @@ object this[int index] { get; }
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0014.md b/docs/analyzers/RCS0014.md
@@ -1,4 +1,4 @@
-# RCS0014: Add empty line between switch sections
+# RCS0014: Add blank line between switch sections
 
 | Property | Value      |
 | -------- | ---------- |
@@ -33,13 +33,17 @@ switch (x)
 }
 ```
 
-## Applies to
+## Options
 
-* [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
+### Add/remove blank line between closing brace and switch section
+
+```editorconfig
+roslynator_blank_line_between_closing_brace_and_switch_section = true|false
+```
 
-## See Also
+## Applies to
 
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
+* [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0015.md b/docs/analyzers/RCS0015.md
@@ -1,10 +1,11 @@
-# RCS0015: Add empty line between using directives with different root namespace \(or vice versa\)
+# RCS0015: Add/remove blank line between using directives
 
-| Property | Value      |
-| -------- | ---------- |
-| Id       | RCS0015    |
-| Category | Formatting |
-| Severity | None       |
+| Property        | Value                                            |
+| --------------- | ------------------------------------------------ |
+| Id              | RCS0015                                          |
+| Category        | Formatting                                       |
+| Severity        | None                                             |
+| Required option | `roslynator_blank_line_between_using_directives` |
 
 ## Example
 
@@ -33,19 +34,15 @@ namespace N
 
 ## Options
 
-### Remove empty line between using directives with different root namespace
+### Add/remove blank line between using directives
 
 ```editorconfig
-roslynator.RCS0015.invert = true
+roslynator_blank_line_between_using_directives = never|separate_groups
 ```
 
 ## Applies to
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0016.md b/docs/analyzers/RCS0016.md
@@ -1,4 +1,4 @@
-# RCS0016: Add newline after attribute list
+# RCS0016: Put attribute list on its own line
 
 | Property | Value      |
 | -------- | ---------- |
@@ -35,9 +35,5 @@ enum Foo
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/analyzers/RCS0017.md b/docs/analyzers/RCS0017.md
@@ -1,4 +1,4 @@
-# \[deprecated\] RCS0017: Add newline after binary operator instead of before it
+# \[deprecated\] RCS0017: Add new line after binary operator instead of before it
 
 | Property | Value      |
 | -------- | ---------- |
@@ -32,9 +32,5 @@ if (x &&
 
 * [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers)
 
-## See Also
-
-* [How to Suppress a Diagnostic](../HowToConfigureAnalyzers.md#how-to-suppress-a-diagnostic)
-
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*