Merge pull request #5716 from Evangelink/missing-api-surface-doc

Add Configurability - Api Surface section

Author: ktoliver

docs/code-quality/ca1002.md

@@ -49,6 +49,16 @@ To fix a violation of this rule, change the <xref:System.Collections.Generic.Lis
 
 Do not suppress a warning from this rule unless the assembly that raises this warning is not meant to be a reusable library. For example, it would be safe to suppress this warning in a performance-tuned application where a performance benefit was gained from the use of generic lists.
 
+## Configurability
+
+If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
+
+```ini
+dotnet_code_quality.ca1002.api_surface = private, internal
+```
+
+You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
+
 ## Related rules
 
 [CA1005: Avoid excessive parameters on generic types](../code-quality/ca1005.md)

docs/code-quality/ca1046.md

@@ -55,6 +55,16 @@ b and a are == ? No
 c and a are == ? Yes
 ```
 
+## Configurability
+
+If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
+
+```ini
+dotnet_code_quality.ca1046.api_surface = private, internal
+```
+
+You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
+
 ## Related rules
 
 [CA1013: Overload operator equals on overloading add and subtract](../code-quality/ca1013.md)

docs/code-quality/ca1700.md

@@ -49,6 +49,16 @@ To fix a violation of this rule, remove or rename the member.
 
 It is safe to suppress a warning from this rule for a member that is currently used or for libraries that have previously shipped.
 
+## Configurability
+
+If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
+
+```ini
+dotnet_code_quality.ca1700.api_surface = private, internal
+```
+
+You can configure this option for just this rule, for all rules, or for all rules in this category (Naming). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
+
 ## Related rules
 
 [CA2217: Do not mark enums with FlagsAttribute](../code-quality/ca2217.md)

docs/code-quality/ca1707.md

@@ -43,6 +43,16 @@ Do not suppress warnings for production code. However, it's safe to suppress thi
 
 For well-known methods in Microsoft code that currently use an underscore and cannot be modified, the rule should be suppressed.
 
+## Configurability
+
+If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
+
+```ini
+dotnet_code_quality.ca1707.api_surface = private, internal
+```
+
+You can configure this option for just this rule, for all rules, or for all rules in this category (Naming). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
+
 ## Related rules
 
 - [CA1709: Identifiers should be cased correctly](../code-quality/ca1709.md)

docs/code-quality/ca1822.md

@@ -35,6 +35,16 @@ Mark the member as static (or Shared in [!INCLUDE[vbprvb](../code-quality/includ
 ## When to suppress warnings
 It is safe to suppress a warning from this rule for previously shipped code for which the fix would be a breaking change.
 
+## Configurability
+
+If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
+
+```ini
+dotnet_code_quality.ca1822.api_surface = private, internal
+```
+
+You can configure this option for just this rule, for all rules, or for all rules in this category (Performance). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
+
 ## Related rules
 [CA1811: Avoid uncalled private code](../code-quality/ca1811.md)