More comment cleanup. Sigh... Also renamed SetFunctionBreakpoints to SetCommandBreakpoints. This is a "PowerShell" service and as such its API should be "PowerShell" oriented.

Author: rkeithhill

src/PowerShellEditorServices.Protocol/Server/DebugAdapter.cs

@@ -231,7 +231,7 @@ protected async Task HandleSetFunctionBreakpointsRequest(
             }
 
             FunctionBreakpointDetails[] breakpoints =
-                await editorSession.DebugService.SetFunctionBreakpoints(
+                await editorSession.DebugService.SetCommandBreakpoints(
                     breakpointDetails);
 
             await requestContext.SendResult(

src/PowerShellEditorServices/Debugging/DebugService.cs

@@ -119,6 +119,8 @@ public async Task<BreakpointDetails[]> SetLineBreakpoints(
                     IEnumerable<Breakpoint> configuredBreakpoints =
                         await this.powerShellContext.ExecuteCommand<Breakpoint>(psCommand);
 
+                    // The order in which the breakpoints are returned is significant to the 
+                    // VSCode client and should match the order in which they are passed in.
                     resultBreakpointDetails.AddRange(
                         configuredBreakpoints.Select(BreakpointDetails.Create));
                 }
@@ -128,12 +130,12 @@ public async Task<BreakpointDetails[]> SetLineBreakpoints(
         }
 
         /// <summary>
-        /// Sets the list of line breakpoints for the current debugging session.
+        /// Sets the list of command breakpoints for the current debugging session. 
         /// </summary>
-        /// <param name="breakpoints">BreakpointDetails for each breakpoint that will be set.</param>
-        /// <param name="clearExisting">If true, causes all existing breakpoints to be cleared before setting new ones.</param>
+        /// <param name="breakpoints">BreakpointDetails for each command breakpoint that will be set.</param>
+        /// <param name="clearExisting">If true, causes all existing function breakpoints to be cleared before setting new ones.</param>
         /// <returns>An awaitable Task that will provide details about the breakpoints that were set.</returns>
-        public async Task<FunctionBreakpointDetails[]> SetFunctionBreakpoints(
+        public async Task<FunctionBreakpointDetails[]> SetCommandBreakpoints(
             FunctionBreakpointDetails[] breakpoints,
             bool clearExisting = true)
         {
@@ -171,6 +173,8 @@ public async Task<FunctionBreakpointDetails[]> SetFunctionBreakpoints(
                     IEnumerable<Breakpoint> configuredBreakpoints =
                         await this.powerShellContext.ExecuteCommand<Breakpoint>(psCommand);
 
+                    // The order in which the breakpoints are returned is significant to the 
+                    // VSCode client and should match the order in which they are passed in.
                     resultBreakpointDetails.AddRange(
                         configuredBreakpoints.Select(FunctionBreakpointDetails.Create));
                 }

test/PowerShellEditorServices.Test/Debugging/DebugServiceTests.cs

@@ -151,7 +151,7 @@ await this.debugService.SetLineBreakpoints(
         public async Task DebuggerSetsAndClearsFunctionBreakpoints()
         {
             FunctionBreakpointDetails[] breakpoints =
-                await this.debugService.SetFunctionBreakpoints(
+                await this.debugService.SetCommandBreakpoints(
                     new[] {
                         FunctionBreakpointDetails.Create("Write-Host"),
                         FunctionBreakpointDetails.Create("Get-Date")
@@ -162,14 +162,14 @@ await this.debugService.SetFunctionBreakpoints(
             Assert.Equal("Get-Date", breakpoints[1].Name);
 
             breakpoints =
-                await this.debugService.SetFunctionBreakpoints(
+                await this.debugService.SetCommandBreakpoints(
                     new[] { FunctionBreakpointDetails.Create("Get-Host") });
 
             Assert.Equal(1, breakpoints.Length);
             Assert.Equal("Get-Host", breakpoints[0].Name);
 
             breakpoints =
-                await this.debugService.SetFunctionBreakpoints(
+                await this.debugService.SetCommandBreakpoints(
                     new FunctionBreakpointDetails[] {});
 
             Assert.Equal(0, breakpoints.Length);
@@ -179,7 +179,7 @@ await this.debugService.SetFunctionBreakpoints(
         public async Task DebuggerStopsOnFunctionBreakpoints()
         {
             FunctionBreakpointDetails[] breakpoints =
-                await this.debugService.SetFunctionBreakpoints(
+                await this.debugService.SetCommandBreakpoints(
                     new[] {
                         FunctionBreakpointDetails.Create("Write-Host")
                     });