Skip to content

Commit 8374823

Browse files
SteveL-MSFTSteveL-MSFT
authored
Replace msh in public API comment based documentation with PowerShell equivalent (#18483)
1 parent 0a6de46 commit 8374823

File tree

46 files changed

+128
-130
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+128
-130
lines changed

‎src/Microsoft.PowerShell.Commands.Diagnostics/GetEventSnapin.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public override string DescriptionResource
8181
}
8282

8383
/// <summary>
84-
/// Get type files to be used for this mshsnapin.
84+
/// Get type files to be used for this PSSnapin.
8585
/// </summary>
8686
public override string[] Types
8787
{
@@ -94,7 +94,7 @@ public override string[] Types
9494
private string[] _types = new string[] { "getevent.types.ps1xml" };
9595

9696
/// <summary>
97-
/// Get format files to be used for this mshsnapin.
97+
/// Get format files to be used for this PSSnapin.
9898
/// </summary>
9999
public override string[] Formats
100100
{

‎src/Microsoft.PowerShell.Commands.Management/commands/management/ParsePathCommand.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
namespace Microsoft.PowerShell.Commands
1313
{
1414
/// <summary>
15-
/// A command to resolve MSH paths containing glob characters to
16-
/// MSH paths that match the glob strings.
15+
/// A command to resolve PowerShell paths containing glob characters to
16+
/// PowerShell paths that match the glob strings.
1717
/// </summary>
1818
[Cmdlet(VerbsCommon.Split, "Path", DefaultParameterSetName = "ParentSet", SupportsTransactions = true, HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097149")]
1919
[OutputType(typeof(string), ParameterSetName = new[] { leafSet,
@@ -105,7 +105,7 @@ public string[] LiteralPath
105105
/// <value>
106106
/// If true the qualifier of the path will be returned.
107107
/// The qualifier is the drive or provider that is qualifying
108-
/// the MSH path.
108+
/// the PowerShell path.
109109
/// </value>
110110
[Parameter(ParameterSetName = qualifierSet, Mandatory = true, ValueFromPipelineByPropertyName = true)]
111111
public SwitchParameter Qualifier { get; set; }
@@ -116,7 +116,7 @@ public string[] LiteralPath
116116
/// <value>
117117
/// If true the qualifier of the path will be returned.
118118
/// The qualifier is the drive or provider that is qualifying
119-
/// the MSH path.
119+
/// the PowerShell path.
120120
/// </value>
121121
[Parameter(ParameterSetName = noQualifierSet, Mandatory = true, ValueFromPipelineByPropertyName = true)]
122122
public SwitchParameter NoQualifier { get; set; }

‎src/Microsoft.PowerShell.Commands.Management/commands/management/ResolvePathCommand.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
namespace Microsoft.PowerShell.Commands
99
{
1010
/// <summary>
11-
/// A command to resolve MSH paths containing glob characters to
12-
/// MSH paths that match the glob strings.
11+
/// A command to resolve PowerShell paths containing glob characters to
12+
/// PowerShell paths that match the glob strings.
1313
/// </summary>
1414
[Cmdlet(VerbsDiagnostic.Resolve, "Path", DefaultParameterSetName = "Path", SupportsTransactions = true,
1515
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097143")]
@@ -89,7 +89,7 @@ public SwitchParameter Relative
8989
#region Command code
9090

9191
/// <summary>
92-
/// Resolves the path containing glob characters to the MSH paths that it
92+
/// Resolves the path containing glob characters to the PowerShell paths that it
9393
/// represents.
9494
/// </summary>
9595
protected override void ProcessRecord()

‎src/Microsoft.PowerShell.Commands.Management/singleshell/installer/MshManagementMshSnapin.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
namespace Microsoft.PowerShell
88
{
99
/// <summary>
10-
/// MshManagementMshSnapin (or MshManagementMshSnapinInstaller) is a class for facilitating registry
11-
/// of necessary information for monad management mshsnapin.
10+
/// PSManagementPSSnapIn is a class for facilitating registry
11+
/// of necessary information for PowerShell management PSSnapin.
1212
///
1313
/// This class will be built with monad management dll.
1414
/// </summary>
@@ -24,7 +24,7 @@ public PSManagementPSSnapIn()
2424
}
2525

2626
/// <summary>
27-
/// Get name of this mshsnapin.
27+
/// Get name of this PSSnapin.
2828
/// </summary>
2929
public override string Name
3030
{
@@ -35,7 +35,7 @@ public override string Name
3535
}
3636

3737
/// <summary>
38-
/// Get the default vendor string for this mshsnapin.
38+
/// Get the default vendor string for this PSSnapin.
3939
/// </summary>
4040
public override string Vendor
4141
{
@@ -57,7 +57,7 @@ public override string VendorResource
5757
}
5858

5959
/// <summary>
60-
/// Get the default description string for this mshsnapin.
60+
/// Get the default description string for this PSSnapin.
6161
/// </summary>
6262
public override string Description
6363
{

‎src/Microsoft.PowerShell.Commands.Utility/commands/utility/ExportAliasCommand.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public enum ExportAliasFormat
2121
Csv,
2222

2323
/// <summary>
24-
/// Aliases will be exported as an MSH script.
24+
/// Aliases will be exported as a script.
2525
/// </summary>
2626
Script
2727
}

‎src/Microsoft.PowerShell.Commands.Utility/commands/utility/trace/SetTracerCommand.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ public SwitchParameter Debugger
9999
}
100100

101101
/// <summary>
102-
/// If this parameter is specified the Msh Host trace listener will be added.
102+
/// If this parameter is specified the PSHost trace listener will be added.
103103
/// </summary>
104104
/// <value></value>
105105
[Parameter(ParameterSetName = "optionsSet")]

‎src/Microsoft.PowerShell.Commands.Utility/singleshell/installer/MshUtilityMshSnapin.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
namespace Microsoft.PowerShell
88
{
99
/// <summary>
10-
/// MshUtilityMshSnapin (or MshUtilityMshSnapinInstaller) is a class for facilitating registry
11-
/// of necessary information for monad utility mshsnapin.
10+
/// PSUtilityPSSnapIn is a class for facilitating registry
11+
/// of necessary information for monad utility PSSnapin.
1212
///
1313
/// This class will be built with monad utility dll.
1414
/// </summary>
@@ -24,7 +24,7 @@ public PSUtilityPSSnapIn()
2424
}
2525

2626
/// <summary>
27-
/// Get name of this mshsnapin.
27+
/// Get name of this PSSnapin.
2828
/// </summary>
2929
public override string Name
3030
{
@@ -35,7 +35,7 @@ public override string Name
3535
}
3636

3737
/// <summary>
38-
/// Get the default vendor string for this mshsnapin.
38+
/// Get the default vendor string for this PSSnapin.
3939
/// </summary>
4040
public override string Vendor
4141
{
@@ -57,7 +57,7 @@ public override string VendorResource
5757
}
5858

5959
/// <summary>
60-
/// Get the default description string for this mshsnapin.
60+
/// Get the default description string for this PSSnapin.
6161
/// </summary>
6262
public override string Description
6363
{

‎src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleShell.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
namespace Microsoft.PowerShell
1010
{
1111
/// <summary>
12-
/// This class provides an entry point which is called by minishell's main
13-
/// to transfer control to Msh console host implementation.
12+
/// This class provides an entry point which is called
13+
/// to transfer control to console host implementation.
1414
/// </summary>
1515
public static class ConsoleShell
1616
{

‎src/Microsoft.PowerShell.ConsoleHost/host/msh/ManagedEntrance.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@
1616
namespace Microsoft.PowerShell
1717
{
1818
/// <summary>
19-
/// Defines an entry point from unmanaged code to managed Msh.
19+
/// Defines an entry point from unmanaged code to PowerShell.
2020
/// </summary>
2121
public sealed class UnmanagedPSEntry
2222
{
2323
/// <summary>
24-
/// Starts managed MSH.
24+
/// Starts PowerShell.
2525
/// </summary>
2626
/// <param name="consoleFilePath">
27-
/// Deprecated: Console file used to create a runspace configuration to start MSH
27+
/// Deprecated: Console file used to create a runspace configuration to start PowerShell
2828
/// </param>
2929
/// <param name="args">
30-
/// Command line arguments to the managed MSH
30+
/// Command line arguments to the PowerShell
3131
/// </param>
3232
/// <param name="argc">
3333
/// Length of the passed in argument array.
@@ -39,10 +39,10 @@ public static int Start(string consoleFilePath, [MarshalAs(UnmanagedType.LPArray
3939
}
4040

4141
/// <summary>
42-
/// Starts managed MSH.
42+
/// Starts PowerShell.
4343
/// </summary>
4444
/// <param name="args">
45-
/// Command line arguments to the managed MSH
45+
/// Command line arguments to PowerShell
4646
/// </param>
4747
/// <param name="argc">
4848
/// Length of the passed in argument array.

‎src/Microsoft.PowerShell.ConsoleHost/singleshell/installer/MshHostMshSnapin.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
namespace Microsoft.PowerShell
88
{
99
/// <summary>
10-
/// PSHostMshSnapin (or PSHostMshSnapinInstaller) is a class for facilitating registry
11-
/// of necessary information for monad host mshsnapin.
10+
/// PSHostPSSnapIn is a class for facilitating registry
11+
/// of necessary information for monad host PSSnapin.
1212
///
1313
/// This class will be built with monad host engine dll
1414
/// (Microsoft.PowerShell.ConsoleHost.dll).
@@ -25,7 +25,7 @@ public PSHostPSSnapIn()
2525
}
2626

2727
/// <summary>
28-
/// Get name of this mshsnapin.
28+
/// Get name of this PSSnapin.
2929
/// </summary>
3030
public override string Name
3131
{
@@ -36,7 +36,7 @@ public override string Name
3636
}
3737

3838
/// <summary>
39-
/// Get the default vendor string for this mshsnapin.
39+
/// Get the default vendor string for this PSSnapin.
4040
/// </summary>
4141
public override string Vendor
4242
{
@@ -58,7 +58,7 @@ public override string VendorResource
5858
}
5959

6060
/// <summary>
61-
/// Get the default description string for this mshsnapin.
61+
/// Get the default description string for this PSSnapin.
6262
/// </summary>
6363
public override string Description
6464
{

0 commit comments

Comments
 (0)