Add documentation for IgnoreOneLineBlock switch

Author: Kapil Borle

RuleDocumentation/PlaceCloseBrace.md

@@ -12,6 +12,7 @@ Close brace placement should follow a consistent style. It should be on a new li
         PSPlaceCloseBrace = @{
             Enable = $true
             NoEmptyLineBefore = $false
+            IgnoreOneLineBlock = $true
         }
     }
 ```
@@ -23,3 +24,8 @@ Enable or disable the rule during ScriptAnalyzer invocation.
 
 #### NoEmptyLineBefore: bool (Default value is `$false`)
 Create violation if there is an empty line before a close brace.
+
+#### IgnoreOneLineBlock: bool (Default value is `$true`)
+Indicates if close braces in a one line block should be ignored or not.
+E.g. $x = if ($true) { "blah" } else { "blah blah" }
+In the above example, if the property is set to true then the rule will not fire a violation.

RuleDocumentation/PlaceOpenBrace.md

@@ -13,6 +13,7 @@ Open brace placement should follow a consistent style. It can either follow KR s
             Enable = $true
             OnSameLine = $true
             NewLineAfter = $true
+            IgnoreOneLineBlock = $true
         }
     }
 ```
@@ -27,3 +28,8 @@ Provide an option to enforce the open brace to be on the same line as preceding
 
 #### NewLineAfter: bool (Default value is `$true`)
 Enforce a new line character after an open brace. The default value is true.
+
+#### IgnoreOneLineBlock: bool (Default value is `$true`)
+Indicates if open braces in a one line block should be ignored or not.
+E.g. $x = if ($true) { "blah" } else { "blah blah" }
+In the above example, if the property is set to true then the rule will not fire a violation.

Rules/PlaceCloseBrace.cs

@@ -36,6 +36,14 @@ public class PlaceCloseBrace : ConfigurableRule
         [ConfigurableRuleProperty(defaultValue:false)]
         public bool NoEmptyLineBefore { get; protected set; }
 
+        /// <summary>
+        /// Indicates if close braces in a one line block should be ignored or not.
+        /// E.g. $x = if ($true) { "blah" } else { "blah blah" }
+        /// In the above example, if the property is set to true then the rule will
+        /// not fire a violation.
+        ///
+        /// Default value if true.
+        /// </summary>
         [ConfigurableRuleProperty(defaultValue: true)]
         public bool IgnoreOneLineBlock { get; protected set; }
 
@@ -70,7 +78,7 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
             var tokenOps = new TokenOperations(tokens, ast);
             tokensToIgnore = new HashSet<Token> (tokenOps.GetCloseBracesInCommandElements());
 
-            // Ignore open braces that are part of a one line if-else statement
+            // Ignore close braces that are part of a one line if-else statement
             // E.g. $x = if ($true) { "blah" } else { "blah blah" }
             if (IgnoreOneLineBlock)
             {

Rules/PlaceOpenBrace.cs

@@ -45,6 +45,14 @@ public class PlaceOpenBrace : ConfigurableRule
         [ConfigurableRuleProperty(defaultValue: true)]
         public bool NewLineAfter { get; protected set; }
 
+        /// <summary>
+        /// Indicates if open braces in a one line block should be ignored or not.
+        /// E.g. $x = if ($true) { "blah" } else { "blah blah" }
+        /// In the above example, if the property is set to true then the rule will
+        /// not fire a violation.
+        ///
+        /// Default value if true.
+        /// </summary>
         [ConfigurableRuleProperty(defaultValue: true)]
         public bool IgnoreOneLineBlock { get; protected set; }