Adding documentation for EditorWindow API methods

Author: daviwil

src/PowerShellEditorServices/Extensions/EditorWindow.cs

@@ -19,6 +19,10 @@ public class EditorWindow
 
         #region Constructors
 
+        /// <summary>
+        /// Creates a new instance of the EditorWindow class.
+        /// </summary>
+        /// <param name="editorOperations">An IEditorOperations implementation which handles operations in the host editor.</param>
         internal EditorWindow(IEditorOperations editorOperations)
         {
             this.editorOperations = editorOperations;
@@ -27,37 +31,38 @@ internal EditorWindow(IEditorOperations editorOperations)
         #endregion 
 
         #region Public Methods
+
         /// <summary>
-        /// 
+        /// Shows an informational message to the user.
         /// </summary>
-        /// <param name="message"></param>
+        /// <param name="message">The message to be shown.</param>
         public void ShowInformationMessage(string message)
         {
             this.editorOperations.ShowInformationMessage(message).Wait();
         }
 
         /// <summary>
-        /// 
+        /// Shows an error message to the user.
         /// </summary>
-        /// <param name="message"></param>
+        /// <param name="message">The message to be shown.</param>
         public void ShowErrorMessage(string message)
         {
             this.editorOperations.ShowErrorMessage(message).Wait();
         }
 
         /// <summary>
-        /// 
+        /// Shows a warning message to the user.
         /// </summary>
-        /// <param name="message"></param>
+        /// <param name="message">The message to be shown.</param>
         public void ShowWarningMessage(string message)
         {
             this.editorOperations.ShowWarningMessage(message).Wait();
         }
 
         /// <summary>
-        /// 
+        /// Sets the status bar message in the editor UI (if applicable).
         /// </summary>
-        /// <param name="message"></param>
+        /// <param name="message">The message to be shown.</param>
         public void SetStatusBarMessage(string message)
         {
             this.editorOperations.SetStatusBarMessage(message).Wait();

src/PowerShellEditorServices/Extensions/IEditorOperations.cs

@@ -45,31 +45,31 @@ public interface IEditorOperations
         Task SetSelection(BufferRange selectionRange);
 
         /// <summary>
-        /// 
+        /// Shows an informational message to the user.
         /// </summary>
-        /// <param name="message"></param>
-        /// <returns></returns>
+        /// <param name="message">The message to be shown.</param>
+        /// <returns>A Task that can be tracked for completion.</returns>
         Task ShowInformationMessage(string message);
 
         /// <summary>
-        /// 
+        /// Shows an error message to the user.
         /// </summary>
-        /// <param name="message"></param>
-        /// <returns></returns>
+        /// <param name="message">The message to be shown.</param>
+        /// <returns>A Task that can be tracked for completion.</returns>
         Task ShowErrorMessage(string message);
 
         /// <summary>
-        /// 
+        /// Shows a warning message to the user.
         /// </summary>
-        /// <param name="message"></param>
-        /// <returns></returns>
+        /// <param name="message">The message to be shown.</param>
+        /// <returns>A Task that can be tracked for completion.</returns>
         Task ShowWarningMessage(string message);
 
         /// <summary>
-        /// 
+        /// Sets the status bar message in the editor UI (if applicable).
         /// </summary>
-        /// <param name="message"></param>
-        /// <returns></returns>
+        /// <param name="message">The message to be shown.</param>
+        /// <returns>A Task that can be tracked for completion.</returns>
         Task SetStatusBarMessage(string message);
     }
 }

src/PowerShellEditorServices/Nano.PowerShellEditorServices.csproj

@@ -59,6 +59,7 @@
     <Compile Include="Debugging\VariableContainerDetails.cs" />
     <Compile Include="Extensions\EditorContext.cs" />
     <Compile Include="Extensions\EditorObject.cs" />
+    <Compile Include="Extensions\EditorWindow.cs" />
     <Compile Include="Extensions\EditorWorkspace.cs" />
     <Compile Include="Extensions\EditorCommand.cs" />
     <Compile Include="Extensions\ExtensionService.cs" />

src/PowerShellEditorServices/Workspace/ScriptFile.cs

@@ -499,26 +499,26 @@ private void ParseFileContents()
             {
 #if PowerShellv5r2
                 // This overload appeared with Windows 10 Update 1
-                //if (this.powerShellVersion.Major >= 5 &&
-                //    this.powerShellVersion.Build >= 10586)
-                //{
-                //    // Include the file path so that module relative
-                //    // paths are evaluated correctly
-                //    this.ScriptAst =
-                //        Parser.ParseInput(
-                //            this.Contents,
-                //            this.FilePath,
-                //            out this.scriptTokens,
-                //            out parseErrors);
-                //}
-                //else
-                //{
+                if (this.powerShellVersion.Major >= 5 &&
+                    this.powerShellVersion.Build >= 10586)
+                {
+                    // Include the file path so that module relative
+                    // paths are evaluated correctly
+                    this.ScriptAst =
+                        Parser.ParseInput(
+                            this.Contents,
+                            this.FilePath,
+                            out this.scriptTokens,
+                            out parseErrors);
+                }
+                else
+                {
                     this.ScriptAst =
                         Parser.ParseInput(
                             this.Contents,
                             out this.scriptTokens,
                             out parseErrors);
-                //}
+                }
 #else
                 this.ScriptAst =
                     Parser.ParseInput(