Add xml documentation

Author: Kapil Borle

Engine/ScriptAnalyzer.cs

@@ -1547,6 +1547,7 @@ public string Fix(string scriptDefinition)
         /// Fix the violations in the given script text.
         /// </summary>
         /// <param name="text">An object of type `EditableText` that encapsulates the script text to be fixed.</param>
+        /// <param name="range">The range in which the fixes are allowed.</param>
         /// <param name="updatedRange">The updated range after the fixes have been applied.</param>
         /// <returns>The same instance of `EditableText` that was passed to the method, but the instance encapsulates the fixed script text. This helps in chaining the Fix method.</returns>
         public EditableText Fix(EditableText text, Range range, out Range updatedRange)

Engine/Settings.cs

@@ -23,6 +23,9 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer
 {
     internal enum SettingsMode { None = 0, Auto, File, Hashtable, Preset };
 
+    /// <summary>
+    /// A class to represent the settings provided to ScriptAnalyzer class.
+    /// </summary>
     public class Settings
     {
         private string filePath;
@@ -37,6 +40,11 @@ public class Settings
         public IEnumerable<string> Severities { get { return severities; } }
         public Dictionary<string, Dictionary<string, object>> RuleArguments { get { return ruleArguments; } }
 
+        /// <summary>
+        /// Create a settings object from the input object.
+        /// </summary>
+        /// <param name="settings">An input object of type Hashtable or string.</param>
+        /// <param name="presetResolver">A function that takes in a preset and resolves it to a path.</param>
         public Settings(object settings, Func<string, string> presetResolver)
         {
             if (settings == null)
@@ -90,6 +98,10 @@ public Settings(object settings, Func<string, string> presetResolver)
             }
         }
 
+        /// <summary>
+        /// Create a Settings object from the input object.
+        /// </summary>
+        /// <param name="settings">An input object of type Hashtable or string.</param>
         public Settings(object settings) : this(settings, null)
         {
         }
@@ -159,6 +171,13 @@ public static string GetSettingPresetFilePath(string settingPreset)
             return null;
         }
 
+        /// <summary>
+        /// Create a settings object from an input object.
+        /// </summary>
+        /// <param name="settingsObj">An input object of type Hashtable or string.</param>
+        /// <param name="cwd">The path in which to search for a settings file.</param>
+        /// <param name="outputWriter">An output writer.</param>
+        /// <returns>An object of Settings type.</returns>
         public static Settings Create(object settingsObj, string cwd, IOutputWriter outputWriter)
         {
             object settingsFound;