Documentation diagnostics can be enabled for DocumentationMode.Parse

sharwell · sharwell · commit 1f27f1893819 · 2016-01-07T15:25:37.000-06:00
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/SpecialRules/SA0001UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/SpecialRules/SA0001UnitTests.cs
@@ -20,6 +20,7 @@ public class SA0001UnitTests : DiagnosticVerifier
         private DocumentationMode documentationMode;
 
         [Theory]
+        [InlineData(DocumentationMode.Parse)]
         [InlineData(DocumentationMode.Diagnose)]
         public async Task TestEnabledDocumentationModesAsync(DocumentationMode documentationMode)
         {
@@ -34,7 +35,6 @@ public async Task TestEnabledDocumentationModesAsync(DocumentationMode documenta
 
         [Theory]
         [InlineData(DocumentationMode.None)]
-        [InlineData(DocumentationMode.Parse)]
         public async Task TestDisabledDocumentationModesAsync(DocumentationMode documentationMode)
         {
             var testCode = @"public class Foo
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1600ElementsMustBeDocumented.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1600ElementsMustBeDocumented.cs
@@ -84,7 +84,7 @@ private static class Analyzer
         {
             public static void HandleBaseTypeDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
@@ -109,7 +109,7 @@ public static void HandleBaseTypeDeclaration(SyntaxNodeAnalysisContext context,
 
             public static void HandleMethodDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
@@ -129,7 +129,7 @@ public static void HandleMethodDeclaration(SyntaxNodeAnalysisContext context, St
 
             public static void HandleConstructorDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
@@ -149,7 +149,7 @@ public static void HandleConstructorDeclaration(SyntaxNodeAnalysisContext contex
 
             public static void HandleDestructorDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
@@ -169,7 +169,7 @@ public static void HandleDestructorDeclaration(SyntaxNodeAnalysisContext context
 
             public static void HandlePropertyDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
@@ -189,7 +189,7 @@ public static void HandlePropertyDeclaration(SyntaxNodeAnalysisContext context,
 
             public static void HandleIndexerDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
@@ -209,7 +209,7 @@ public static void HandleIndexerDeclaration(SyntaxNodeAnalysisContext context, S
 
             public static void HandleFieldDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
@@ -234,7 +234,7 @@ public static void HandleFieldDeclaration(SyntaxNodeAnalysisContext context, Sty
 
             public static void HandleDelegateDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
@@ -254,7 +254,7 @@ public static void HandleDelegateDeclaration(SyntaxNodeAnalysisContext context,
 
             public static void HandleEventDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
@@ -274,7 +274,7 @@ public static void HandleEventDeclaration(SyntaxNodeAnalysisContext context, Sty
 
             public static void HandleEventFieldDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1601PartialElementsMustBeDocumented.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1601PartialElementsMustBeDocumented.cs
@@ -109,7 +109,7 @@ private static class Analyzer
         {
             public static void HandleBaseTypeDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
@@ -133,7 +133,7 @@ public static void HandleBaseTypeDeclaration(SyntaxNodeAnalysisContext context,
 
             public static void HandleMethodDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1602EnumerationItemsMustBeDocumented.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1602EnumerationItemsMustBeDocumented.cs
@@ -74,7 +74,7 @@ private static class Analyzer
         {
             public static void HandleEnumMemberDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
             {
-                if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
+                if (context.GetDocumentationMode() == DocumentationMode.None)
                 {
                     return;
                 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/SpecialRules/SA0001XmlCommentAnalysisDisabled.cs b/StyleCop.Analyzers/StyleCop.Analyzers/SpecialRules/SA0001XmlCommentAnalysisDisabled.cs
@@ -61,7 +61,7 @@ public void HandleCompilation(CompilationAnalysisContext context)
 
             public void HandleSyntaxTree(SyntaxTreeAnalysisContext context)
             {
-                if (context.Tree.Options.DocumentationMode != DocumentationMode.Diagnose)
+                if (context.Tree.Options.DocumentationMode == DocumentationMode.None)
                 {
                     Volatile.Write(ref this.documentationAnalysisDisabled, true);
                 }
diff --git a/documentation/SA0001.md b/documentation/SA0001.md
@@ -24,7 +24,7 @@ All diagnostics of XML documentation comments has been disabled due to the curre
 ## Rule description
 
 A violation of this rule occurs when a compilation (project) contains one or more files which are parsed with the
-`DocumentationMode` not set to `Diagnose`. This most frequently occurs when the project is configured to not produce an
+`DocumentationMode` set to `None`. This most frequently occurs when the project is configured to not produce an
 XML documentation file during the build.
 
 Each project should be configured to include an XML documentation file with the compiled output. Otherwise, the

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ public class SA0001UnitTests : DiagnosticVerifier`
`20`	`20`	`private DocumentationMode documentationMode;`
`21`	`21`
`22`	`22`	`[Theory]`
	`23`	`+ [InlineData(DocumentationMode.Parse)]`
`23`	`24`	`[InlineData(DocumentationMode.Diagnose)]`
`24`	`25`	`public async Task TestEnabledDocumentationModesAsync(DocumentationMode documentationMode)`
`25`	`26`	`{`
`@@ -34,7 +35,6 @@ public async Task TestEnabledDocumentationModesAsync(DocumentationMode documenta`
`34`	`35`
`35`	`36`	`[Theory]`
`36`	`37`	`[InlineData(DocumentationMode.None)]`
`37`		`- [InlineData(DocumentationMode.Parse)]`
`38`	`38`	`public async Task TestDisabledDocumentationModesAsync(DocumentationMode documentationMode)`
`39`	`39`	`{`
`40`	`40`	`var testCode = @"public class Foo`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ private static class Analyzer`
`84`	`84`	`{`
`85`	`85`	`public static void HandleBaseTypeDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`86`	`86`	`{`
`87`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`87`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`88`	`88`	`{`
`89`	`89`	`return;`
`90`	`90`	`}`
`@@ -109,7 +109,7 @@ public static void HandleBaseTypeDeclaration(SyntaxNodeAnalysisContext context,`
`109`	`109`
`110`	`110`	`public static void HandleMethodDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`111`	`111`	`{`
`112`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`112`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`113`	`113`	`{`
`114`	`114`	`return;`
`115`	`115`	`}`
`@@ -129,7 +129,7 @@ public static void HandleMethodDeclaration(SyntaxNodeAnalysisContext context, St`
`129`	`129`
`130`	`130`	`public static void HandleConstructorDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`131`	`131`	`{`
`132`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`132`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`133`	`133`	`{`
`134`	`134`	`return;`
`135`	`135`	`}`
`@@ -149,7 +149,7 @@ public static void HandleConstructorDeclaration(SyntaxNodeAnalysisContext contex`
`149`	`149`
`150`	`150`	`public static void HandleDestructorDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`151`	`151`	`{`
`152`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`152`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`153`	`153`	`{`
`154`	`154`	`return;`
`155`	`155`	`}`
`@@ -169,7 +169,7 @@ public static void HandleDestructorDeclaration(SyntaxNodeAnalysisContext context`
`169`	`169`
`170`	`170`	`public static void HandlePropertyDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`171`	`171`	`{`
`172`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`172`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`173`	`173`	`{`
`174`	`174`	`return;`
`175`	`175`	`}`
`@@ -189,7 +189,7 @@ public static void HandlePropertyDeclaration(SyntaxNodeAnalysisContext context,`
`189`	`189`
`190`	`190`	`public static void HandleIndexerDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`191`	`191`	`{`
`192`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`192`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`193`	`193`	`{`
`194`	`194`	`return;`
`195`	`195`	`}`
`@@ -209,7 +209,7 @@ public static void HandleIndexerDeclaration(SyntaxNodeAnalysisContext context, S`
`209`	`209`
`210`	`210`	`public static void HandleFieldDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`211`	`211`	`{`
`212`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`212`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`213`	`213`	`{`
`214`	`214`	`return;`
`215`	`215`	`}`
`@@ -234,7 +234,7 @@ public static void HandleFieldDeclaration(SyntaxNodeAnalysisContext context, Sty`
`234`	`234`
`235`	`235`	`public static void HandleDelegateDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`236`	`236`	`{`
`237`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`237`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`238`	`238`	`{`
`239`	`239`	`return;`
`240`	`240`	`}`
`@@ -254,7 +254,7 @@ public static void HandleDelegateDeclaration(SyntaxNodeAnalysisContext context,`
`254`	`254`
`255`	`255`	`public static void HandleEventDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`256`	`256`	`{`
`257`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`257`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`258`	`258`	`{`
`259`	`259`	`return;`
`260`	`260`	`}`
`@@ -274,7 +274,7 @@ public static void HandleEventDeclaration(SyntaxNodeAnalysisContext context, Sty`
`274`	`274`
`275`	`275`	`public static void HandleEventFieldDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`276`	`276`	`{`
`277`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`277`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`278`	`278`	`{`
`279`	`279`	`return;`
`280`	`280`	`}`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ private static class Analyzer`
`109`	`109`	`{`
`110`	`110`	`public static void HandleBaseTypeDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`111`	`111`	`{`
`112`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`112`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`113`	`113`	`{`
`114`	`114`	`return;`
`115`	`115`	`}`
`@@ -133,7 +133,7 @@ public static void HandleBaseTypeDeclaration(SyntaxNodeAnalysisContext context,`
`133`	`133`
`134`	`134`	`public static void HandleMethodDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`135`	`135`	`{`
`136`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`136`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`137`	`137`	`{`
`138`	`138`	`return;`
`139`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ private static class Analyzer`
`74`	`74`	`{`
`75`	`75`	`public static void HandleEnumMemberDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)`
`76`	`76`	`{`
`77`		`- if (context.GetDocumentationMode() != DocumentationMode.Diagnose)`
	`77`	`+ if (context.GetDocumentationMode() == DocumentationMode.None)`
`78`	`78`	`{`
`79`	`79`	`return;`
`80`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public void HandleCompilation(CompilationAnalysisContext context)`
`61`	`61`
`62`	`62`	`public void HandleSyntaxTree(SyntaxTreeAnalysisContext context)`
`63`	`63`	`{`
`64`		`- if (context.Tree.Options.DocumentationMode != DocumentationMode.Diagnose)`
	`64`	`+ if (context.Tree.Options.DocumentationMode == DocumentationMode.None)`
`65`	`65`	`{`
`66`	`66`	`Volatile.Write(ref this.documentationAnalysisDisabled, true);`
`67`	`67`	`}`