Format and add inline docs

Author: Kapil Borle

src/PowerShellEditorServices.Protocol/LanguageServer/ScriptFileMarkersRequest.cs

@@ -7,21 +7,40 @@
 
 namespace Microsoft.PowerShell.EditorServices.Protocol.LanguageServer
 {
+    /// <summary>
+    /// Class to encapsulate the request type.
+    /// </summary>
     class ScriptFileMarkersRequest
     {
         public static readonly
             RequestType<ScriptFileMarkerRequestParams, ScriptFileMarkerRequestResultParams> Type =
                 RequestType<ScriptFileMarkerRequestParams, ScriptFileMarkerRequestResultParams>.Create("powerShell/getScriptFileMarkers");
     }
 
+    /// <summary>
+    /// Class to encapsulate the request parameters.
+    /// </summary>
     class ScriptFileMarkerRequestParams
     {
+        /// <summary>
+        /// Path of the file for which the markers are requested.
+        /// </summary>
         public string filePath;
+
+        /// <summary>
+        /// Settings to provided to ScriptAnalyzer to get the markers.
+        /// </summary>
         public string settings;
     }
 
+    /// <summary>
+    /// Class to encapsulate the result of marker request.
+    /// </summary>
     class ScriptFileMarkerRequestResultParams
     {
+        /// <summary>
+        /// An array of markers obtained by analyzing the given file.
+        /// </summary>
         public ScriptFileMarker[] markers;
     }
 }

src/PowerShellEditorServices/Analysis/AnalysisService.cs

@@ -129,7 +129,7 @@ public AnalysisService(IConsoleHost consoleHost, string settingsPath = null)
         #region Public Methods
 
         /// <summary>
-        /// Performs semantic analysis on the given ScriptFile and returns
+        /// Perform semantic analysis on the given ScriptFile and returns
         /// an array of ScriptFileMarkers.
         /// </summary>
         /// <param name="file">The ScriptFile which will be analyzed for semantic markers.</param>
@@ -139,46 +139,17 @@ public ScriptFileMarker[] GetSemanticMarkers(ScriptFile file)
             return GetSemanticMarkers(file, activeRules, settingsPath);
         }
 
+        /// <summary>
+        /// Perform semantic analysis on the given ScriptFile with the given settings.
+        /// </summary>
+        /// <param name="file">The ScriptFile to be analyzed.</param>
+        /// <param name="settings">ScriptAnalyzer settings</param>
+        /// <returns></returns>
         public ScriptFileMarker[] GetSemanticMarkers(ScriptFile file, Hashtable settings)
         {
             return GetSemanticMarkers<Hashtable>(file, null, settings);
         }
 
-        private ScriptFileMarker[] GetSemanticMarkers<TSettings>(
-            ScriptFile file,
-            string[] rules,
-            TSettings settings) where TSettings: class
-        {
-            if (this.scriptAnalyzerModuleInfo != null
-                && file.IsAnalysisEnabled
-                && (typeof(TSettings) == typeof(string) || typeof(TSettings) == typeof(Hashtable))
-                && (rules != null || settings != null))
-            {
-                // TODO: This is a temporary fix until we can change how
-                // ScriptAnalyzer invokes their async tasks.
-                // TODO: Make this async
-                Task<ScriptFileMarker[]> analysisTask =
-                    Task.Factory.StartNew<ScriptFileMarker[]>(
-                        () =>
-                        {
-                            return
-                                 GetDiagnosticRecords(file, rules, settings)
-                                .Select(ScriptFileMarker.FromDiagnosticRecord)
-                                .ToArray();
-                        },
-                        CancellationToken.None,
-                        TaskCreationOptions.None,
-                        TaskScheduler.Default);
-                analysisTask.Wait();
-                return analysisTask.Result;
-            }
-            else
-            {
-                // Return an empty marker list
-                return new ScriptFileMarker[0];
-            }
-        }
-
         /// <summary>
         /// Returns a list of builtin-in PSScriptAnalyzer rules
         /// </summary>
@@ -220,6 +191,42 @@ public void Dispose()
         #endregion // public methods
 
         #region Private Methods
+
+        private ScriptFileMarker[] GetSemanticMarkers<TSettings>(
+            ScriptFile file,
+            string[] rules,
+            TSettings settings) where TSettings : class
+        {
+            if (this.scriptAnalyzerModuleInfo != null
+                && file.IsAnalysisEnabled
+                && (typeof(TSettings) == typeof(string) || typeof(TSettings) == typeof(Hashtable))
+                && (rules != null || settings != null))
+            {
+                // TODO: This is a temporary fix until we can change how
+                // ScriptAnalyzer invokes their async tasks.
+                // TODO: Make this async
+                Task<ScriptFileMarker[]> analysisTask =
+                    Task.Factory.StartNew<ScriptFileMarker[]>(
+                        () =>
+                        {
+                            return
+                                 GetDiagnosticRecords(file, rules, settings)
+                                .Select(ScriptFileMarker.FromDiagnosticRecord)
+                                .ToArray();
+                        },
+                        CancellationToken.None,
+                        TaskCreationOptions.None,
+                        TaskScheduler.Default);
+                analysisTask.Wait();
+                return analysisTask.Result;
+            }
+            else
+            {
+                // Return an empty marker list
+                return new ScriptFileMarker[0];
+            }
+        }
+
         private void FindPSScriptAnalyzer()
         {
             lock (runspaceLock)

src/PowerShellEditorServices/Language/LanguageService.cs

@@ -450,6 +450,13 @@ await CommandHelpers.GetCommandInfo(
             }
         }
 
+        /// <summary>
+        /// Returns a hashtable from its literal representation in PowerShell.
+        ///
+        /// If the input is null or If the method encounter any error during the conversion it returns null.
+        /// </summary>
+        /// <param name="hashtableString"></param>
+        /// <returns></returns>
         public Hashtable GetHashtableFromString(string hashtableString)
         {
             if (hashtableString == null)