Merge pull request #327 from kapilmb/FixDocInconsistencies

Fixes documentation inconsistencies for some rules.

Author: Kapil Borle

RuleDocumentation/UseBOMForUnicodeEncodedFile.md

@@ -0,0 +1,6 @@
+#UseBOMForUnicodeEncodedFile
+**Severity Level: Warning**
+
+##Description
+
+For a file encoded with a format other than ASCII, ensure BOM is present to ensure that any application consuming this file can interpret it correctly.

Rules/UseBOMForUnicodeEncodedFile.cs

@@ -23,7 +23,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// AvoidAlias: Check if help file uses utf8 encoding
+    /// UseBOMForUnicodeEncodedFile: Checks if a file with missing BOM is ASCII encoded.
     /// </summary>
     [Export(typeof(IScriptRule))]
     public class UseBOMForUnicodeEncodedFile : IScriptRule

Rules/UseDeclaredVarsMoreThanAssignments.cs

@@ -20,7 +20,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// ExtraVarsRule: Analyzes the ast to check that variables are used in more than just their assignment.
+    /// UseDeclaredVarsMoreThanAssigments: Analyzes the ast to check that variables are used in more than just their assignment.
     /// </summary>
     [Export(typeof(IScriptRule))]
     public class UseDeclaredVarsMoreThanAssigments : IScriptRule

Rules/UseOutputTypeCorrectly.cs

@@ -22,15 +22,15 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// ProvideCommentHelp: Checks that objects return in a cmdlet have their types declared in OutputType Attribute
+    /// UseOutputTypeCorrectly: Checks that objects returned in a cmdlet have their types declared in OutputType Attribute.
     /// </summary>
     [Export(typeof(IScriptRule))]
     public class UseOutputTypeCorrectly : SkipTypeDefinition, IScriptRule
     {
         private IEnumerable<TypeDefinitionAst> _classes;
 
         /// <summary>
-        /// AnalyzeScript: Checks that objects return in a cmdlet have their types declared in OutputType Attribute
+        /// AnalyzeScript: Checks that objects returned in a cmdlet have their types declared in OutputType Attribute
         /// </summary>
         /// <param name="ast">The script's ast</param>
         /// <param name="fileName">The name of the script</param>

Rules/UseShouldProcessForStateChangingFunctions.cs

@@ -21,7 +21,7 @@
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {/// <summary>
-    /// UseShouldProcessCorrectly: Analyzes the ast to check that if the ShouldProcess attribute is present, the function calls ShouldProcess and vice versa.
+    /// UseShouldProcessForStateChangingFunctions: Analyzes the ast to check if ShouldProcess is included in Advanced functions if the Verb of the function could change system state.
     /// </summary>
     [Export(typeof(IScriptRule))]
     public class UseShouldProcessForStateChangingFunctions : IScriptRule

Rules/UseStandardDSCFunctionsInResource.cs

@@ -21,7 +21,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// UseStandardDSCFunctionsInResource: 
+    /// UseStandardDSCFunctionsInResource: Checks if the DSC resource uses standard Get/Set/Test TargetResource functions.
     /// </summary>
     [Export(typeof(IDSCResourceRule))]
     public class UseStandardDSCFunctionsInResource : IDSCResourceRule

Rules/UseVerboseMessageInDSCResource.cs

@@ -22,7 +22,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// ProvideVerboseMessage: Analyzes the ast to check that Write-Verbose is called for DSC Resources
+    /// UseVerboseMessageInDSCResource: Analyzes the ast to check that Write-Verbose is called for DSC Resources.
     /// </summary>
     [Export(typeof(IDSCResourceRule))]
     public class UseVerboseMessageInDSCResource : SkipNamedBlock, IDSCResourceRule