Merge pull request #4917 from theJasonHelmick/JCH-Enable-PSBreakpoint

Update Enable-PSBreakpoint

Author: sdwheeler

reference/3.0/Microsoft.PowerShell.Utility/Enable-PSBreakpoint.md

@@ -2,15 +2,16 @@
 external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
 keywords: powershell,cmdlet
 locale: en-us
-ms.date: 06/09/2017
+Module Name: Microsoft.PowerShell.Utility
+ms.date: 10/09/2019
 online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.utility/enable-psbreakpoint?view=powershell-3.0&WT.mc_id=ps-gethelp
 schema: 2.0.0
 title: Enable-PSBreakpoint
 ---
+
 # Enable-PSBreakpoint
 
 ## SYNOPSIS
-
 Enables the breakpoints in the current console.
 
 ## SYNTAX
@@ -24,47 +25,55 @@ Enable-PSBreakpoint [-PassThru] [-Id] <Int32[]> [-WhatIf] [-Confirm] [<CommonPar
 ### Breakpoint
 
 ```
-Enable-PSBreakpoint [-PassThru] [-Breakpoint] <Breakpoint[]> [-WhatIf] [-Confirm] [<CommonParameters>]
+Enable-PSBreakpoint [-PassThru] [-Breakpoint] <Breakpoint[]> [-WhatIf] [-Confirm]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 
-The Enable-PSBreakpoint cmdlet re-enables disabled breakpoints.
-You can use it to enable all breakpoints, or you can specify breakpoints by submitting breakpoint objects or breakpoint IDs.
+The `Enable-PSBreakpoint` cmdlet re-enables disabled breakpoints. You can use it to enable all
+breakpoints, or specific breakpoints by providing breakpoint objects or IDs.
 
-A breakpoint is a point in a script where execution stops temporarily so that you can examine the instructions in the script.
-Newly created breakpoints are automatically enabled, but you can disable them by using the Disable-PSBreakpoint cmdlet.
+A breakpoint is a point in a script where execution stops temporarily so that you can examine the
+state of the script. Newly created breakpoints are automatically enabled, but can be disabled using
+`Disable-PSBreakpoint`.
 
-Technically, this cmdlet changes the value of the Enabled property of a breakpoint object to True.
+Technically, this cmdlet changes the value of the **Enabled** property of a breakpoint object to
+**True**.
 
-Enable-PSBreakpoint is one of several cmdlets designed for debugging Windows PowerShell scripts.
-For more information about the Windows PowerShell debugger, see about_Debuggers.
+`Enable-PSBreakpoint` is one of several cmdlets designed for debugging PowerShell scripts. For more
+information about the PowerShell debugger, see [about_Debuggers](../Microsoft.PowerShell.Core/About/about_Debuggers.md).
 
 ## EXAMPLES
 
-### Example 1
+### Example 1: Enable all breakpoints
+
+This example enables all breakpoints in the current session.
 
 ```powershell
 Get-PSBreakpoint | Enable-PSBreakpoint
 ```
 
-This command enables all breakpoints in the current console.
-You can abbreviate the command as "gbp | ebp".
+Using aliases, this example can be abbreviated as `gbp | ebp`.
 
-### Example 2
+### Example 2: Enable breakpoints by ID
+
+This example enables multiple breakpoints using their breakpoint IDs.
 
 ```powershell
 Enable-PSBreakpoint -Id 0, 1, 5
 ```
 
-This command enables breakpoints with breakpoint IDs 0, 1, and 5.
+### Example 3: Enable a disabled breakpoint
 
-### Example 3
+This example re-enables a breakpoint that has been disabled.
 
+```powershell
+$B = Set-PSBreakpoint -Script "sample.ps1" -Variable Name -PassThru
+$B | Enable-PSBreakpoint -PassThru
 ```
-PS> $b = set-psbreakpoint -script sample.ps1 -variable Name
-PS> $b | disable-psbreakpoint -passthru
 
+```Output
 AccessMode : Write
 Variable   : Name
 Action     :
@@ -74,8 +83,6 @@ Id         : 0
 Script     : C:\ps-test\sample.ps1
 ScriptName : C:\ps-test\sample.ps1
 
-PS> $b | enable-psbreakpoint -passthru
-
 AccessMode : Write
 Variable   : Name
 Action     :
@@ -86,79 +93,69 @@ Script     : C:\ps-test\sample.ps1
 ScriptName : C:\ps-test\sample.ps1
 ```
 
-These commands re-enable a breakpoint that has been disabled.
+`Set-PSBreakpoint` creates a breakpoint on the **Name** variable in the `Sample.ps1` script saving
+the breakpoint object in the `$B` variable. The **PassThru** parameter displays the value of the
+**Enabled** property of the breakpoint is **False**.
 
-The first command uses the Set-PSBreakpoint cmdlet to create a breakpoint on the "Name" variable in the Sample.ps1 script.
-Then, it saves the breakpoint object in the $b variable.
+`Enable-PSBreakpoint` re-enables the breakpoint. Again, using the **PassThru** parameter we see that
+the value of the **Enabled** property is **True**.
 
-The second command uses the Disable-PSBreakpoint cmdlet to disable the new breakpoint.
-It uses a pipeline operator (|) to send the breakpoint object in $b to the Disable-PSBreakpoint cmdlet, and it uses the PassThru parameter of Disable-PSBreakpoint to display the disabled breakpoint object.
-This lets you verify that the value of the Enabled property of the breakpoint object is False.
+### Example 4: Enable breakpoints using a variable
 
-The third command uses the Enable-PSBreakpoint cmdlet to re-enable the breakpoint.
-It uses a pipeline operator (|) to send the breakpoint object in $b to the Enable-PSBreakpoint cmdlet, and it uses the PassThru parameter of Enable-PSBreakpoint to display the breakpoint object.
-This lets you verify that the value of the Enabled property of the breakpoint object is True.
-
-The results are shown in the following sample output.
-
-### Example 4
+This example enables a set of breakpoints using the breakpoint objects.
 
 ```powershell
-$b = Get-PSBreakpoint -Id 3, 5
-Enable-PSBreakpoint -Breakpoint $b
+$B = Get-PSBreakpoint -Id 3, 5
+Enable-PSBreakpoint -Breakpoint $B
 ```
 
-These commands enable a set of breakpoints by specifying their breakpoint objects.
-
-The first command uses the Get-PSBreakpoint cmdlet to get the breakpoints and saves them in the $b variable.
+`Get-PSBreakpoint` gets the breakpoints and saves them in the `$B` variable. Using the
+**Breakpoint** parameter, `Enable-PSBreakpoint` enables the breakpoints.
 
-The second command uses the Enable-PSBreakpoint cmdlet and its Breakpoint parameter to enable the breakpoints.
-
-This command is the equivalent of "enable-psbreakpoint -id 3, 5".
+This example is equivalent to running `Enable-PSBreakpoint -Id 3, 5`.
 
 ## PARAMETERS
 
 ### -Breakpoint
 
-Specifies the breakpoints to enable.
-Enter a variable that contains breakpoint objects or a command that gets breakpoint objects, such as a Get-PSBreakpoint command.
-You can also pipe breakpoint objects to Enable-PSBreakpoint.
+Specifies the breakpoints to enable. Provide a variable containing breakpoints or a command that
+gets breakpoint objects, such as `Get-PSBreakpoint`. You can also pipe breakpoint objects to
+`Enable-PSBreakpoint`.
 
 ```yaml
 Type: Breakpoint[]
 Parameter Sets: Breakpoint
 Aliases:
 
 Required: True
-Position: 1
-Default value: None.
+Position: 0
+Default value: None
 Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
 ### -Id
 
-Enables breakpoints that have the specified breakpoint IDs.
-The default value is all breakpoints.
-Enter the IDs or a variable that contains the IDs.
-(You cannot pipe IDs to Enable-PSBreakpoint.) To find the ID of a breakpoint, use the Get-PSBreakpoint cmdlet.
+Specifies the **Id** numbers of the breakpoints to enable. The default value is all breakpoints.
+Provide the **Id** by number or in a variable. You can't pipe **Id** numbers to
+`Enable-PSBreakpoint`. To find the **Id** of a breakpoint, use the `Get-PSBreakpoint` cmdlet.
 
 ```yaml
 Type: Int32[]
 Parameter Sets: Id
 Aliases:
 
 Required: True
-Position: 1
-Default value: All breakpoints
+Position: 0
+Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
 ### -PassThru
 
-Returns an object representing the enabled breakpoint.
-By default, this cmdlet does not generate any output.
+Returns an object representing the breakpoint being enabled. By default, this cmdlet doesn't
+generate any output.
 
 ```yaml
 Type: SwitchParameter
@@ -167,7 +164,7 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: False
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
@@ -183,15 +180,14 @@ Aliases: cf
 
 Required: False
 Position: Named
-Default value: None
+Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -WhatIf
 
-Shows what would happen if the cmdlet runs.
-The cmdlet is not run.
+Shows what would happen if the cmdlet runs. The cmdlet isn't run.
 
 ```yaml
 Type: SwitchParameter
@@ -200,34 +196,37 @@ Aliases: wi
 
 Required: False
 Position: Named
-Default value: None
+Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### CommonParameters
 
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
+-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 
 ### System.Management.Automation.Breakpoint
 
-You can pipe a breakpoint object to Enable-PSBreakpoint.
+You can pipe a breakpoint object to `Enable-PSBreakpoint`.
 
 ## OUTPUTS
 
 ### None or System.Management.Automation.Breakpoint
 
-When you use the PassThru parameter, Enable-PSBreakpoint returns a breakpoint object that represent that breakpoint that was enabled.
-Otherwise, this cmdlet does not generate any output.
+When you use the **PassThru** parameter, `Enable-PSBreakpoint` returns a breakpoint object that represents that breakpoint that was enabled. Otherwise, this cmdlet doesn't generate any output.
 
 ## NOTES
 
-- The Enable-PSBreakpoint cmdlet does not generate an error if you try to enable a breakpoint that is already enabled. As such, you can enable all breakpoints without error, even when only a few are disabled.
+- The `Enable-PSBreakpoint` cmdlet doesn't generate an error if you try to enable a breakpoint that
+  is already enabled. As such, you can enable all breakpoints without error, even when only a few
+  are disabled.
 
-  Breakpoints are enabled when you create them by using the Set-PSBreakpoint cmdlet.
-You do not need to enable newly created breakpoints.
+- Breakpoints are enabled when you create them by using the `Set-PSBreakpoint` cmdlet. You don't
+  need to enable newly created breakpoints.
 
 ## RELATED LINKS
 
@@ -240,7 +239,3 @@ You do not need to enable newly created breakpoints.
 [Remove-PSBreakpoint](Remove-PSBreakpoint.md)
 
 [Set-PSBreakpoint](Set-PSBreakpoint.md)
-
-[about_Debuggers](../Microsoft.PowerShell.Core/About/about_Debuggers.md)
-
-