Add xml documentation

Author: Kapil Borle

Engine/Commands/InvokeFormatterCommand.cs

@@ -18,17 +18,28 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands
 {
     using PSSASettings = Microsoft.Windows.PowerShell.ScriptAnalyzer.Settings;
 
+    /// <summary>
+    /// A cmdlet to format a PowerShell script text.
+    /// </summary>
     [Cmdlet(VerbsLifecycle.Invoke, "Formatter")]
     public class InvokeFormatterCommand : PSCmdlet, IOutputWriter
     {
         private const string defaultSettingsPreset = "CodeFormatting";
         private Settings defaultSettings;
         private Settings inputSettings;
 
+        /// <summary>
+        /// The script text to be formated.
+        ///
+        /// *NOTE*: Unlike ScriptBlock parameter, the ScriptDefinition parameter require a string value.
+        /// </summary>
         [ParameterAttribute(Mandatory = true)]
         [ValidateNotNull]
         public string ScriptDefinition { get; set; }
 
+        /// <summary>
+        /// A settings hashtable or a path to a PowerShell data file (.psd1) file that contains the settings.
+        /// </summary>
         [Parameter(Mandatory = false)]
         [ValidateNotNull]
         public object Settings { get; set; }

Engine/Formatter.cs

@@ -3,8 +3,19 @@
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer
 {
+    /// <summary>
+    /// A class to provide code formatting capability.
+    /// </summary>
     public class Formatter
     {
+        /// <summary>
+        /// Format a powershell script.
+        /// </summary>
+        /// <param name="scriptDefinition">A string representing a powershell script.</param>
+        /// <param name="settings">Settings to be used for formatting</param>
+        /// <param name="range">The range in which formatting should take place.</param>
+        /// <param name="cmdlet">The cmdlet object that calls this method.</param>
+        /// <returns></returns>
         public static string Format<TCmdlet>(
             string scriptDefinition,
             Settings settings,