Skip to content

Commit 5304a26

Browse files
committed
Add documentation comments for the MarkerCorreciton class
1 parent 0aaddda commit 5304a26

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/PowerShellEditorServices/Workspace/ScriptFileMarker.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,19 @@
1212

1313
namespace Microsoft.PowerShell.EditorServices
1414
{
15+
/// <summary>
16+
/// Contains details for a code correction which can be applied from a ScriptFileMarker.
17+
/// </summary>
1518
public class MarkerCorrection
1619
{
20+
/// <summary>
21+
/// Gets or sets the display name of the code correction.
22+
/// </summary>
1723
public string Name { get; set; }
1824

25+
/// <summary>
26+
/// Gets or sets the list of ScriptRegions that define the edits to be made by the correction.
27+
/// </summary>
1928
public ScriptRegion[] Edits { get; set; }
2029
}
2130

@@ -64,6 +73,9 @@ public class ScriptFileMarker
6473
/// </summary>
6574
public ScriptRegion ScriptRegion { get; set; }
6675

76+
/// <summary>
77+
/// Gets or sets an optional code correction that can be applied based on this marker.
78+
/// </summary>
6779
public MarkerCorrection Correction { get; set; }
6880

6981
#endregion

0 commit comments

Comments
 (0)