documentation for suppression attribute added

tmaczynski · Jan 21, 2016 · ee39c4b · ee39c4b
1 parent ac6bfbd
commit ee39c4b
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/documentation/AvoidAsyncSuffix.md b/documentation/AvoidAsyncSuffix.md
@@ -31,6 +31,10 @@ To fix a violation of this rule, remove the `Async` suffix from the method name
 
 ## How to suppress violations
 
+```csharp
+[SuppressMessage("AsyncUsage.CSharp.Naming", "AvoidAsyncSuffix", Justification = "Reviewed.")]
+```
+
 ```csharp
 #pragma warning disable AvoidAsyncSuffix // Avoid Async suffix
 public int ThisIsNotAsync()

diff --git a/documentation/AvoidAsyncVoid.md b/documentation/AvoidAsyncVoid.md
@@ -29,6 +29,10 @@ To fix a violation of this rule, change the signature of the method to return a
 
 ## How to suppress violations
 
+```csharp
+[SuppressMessage("AsyncUsage.CSharp.Reliability", "AvoidAsyncVoid", Justification = "Reviewed.")]
+```
+
 ```csharp
 #pragma warning disable AvoidAsyncVoid // Avoid async void
 private async void HandleSomeEvent(object sender, EventArgs e)

diff --git a/documentation/UseAsyncSuffix.md b/documentation/UseAsyncSuffix.md
@@ -30,6 +30,10 @@ To fix a violation of this rule, rename the method to include the `Async` suffix
 
 ## How to suppress violations
 
+```csharp
+[SuppressMessage("AsyncUsage.CSharp.Naming", "UseAsyncSuffix", Justification = "Reviewed.")]
+```
+
 ```csharp
 #pragma warning disable UseAsyncSuffix // Use Async suffix
 public async Task<int> GetValue()

diff --git a/documentation/UseConfigureAwait.md b/documentation/UseConfigureAwait.md
@@ -31,6 +31,10 @@ the asynchronous operation.
 
 ## How to suppress violations
 
+```csharp
+[SuppressMessage("AsyncUsage.CSharp.Usage", "UseConfigureAwait", Justification = "Reviewed.")]
+```
+
 ```csharp
 #pragma warning disable UseConfigureAwait // Use ConfigureAwait
 await Task.Delay(1000);