Skip to content

Commit

Permalink
Replace msh in public API comment based documentation with PowerShe…
Browse files Browse the repository at this point in the history
…ll equivalent (#18483)
  • Loading branch information
SteveL-MSFT committed Nov 8, 2022
1 parent 0a6de46 commit 8374823
Show file tree
Hide file tree
Showing 46 changed files with 128 additions and 130 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public override string DescriptionResource
}

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

/// <summary>
/// Get format files to be used for this mshsnapin.
/// Get format files to be used for this PSSnapin.
/// </summary>
public override string[] Formats
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// A command to resolve MSH paths containing glob characters to
/// MSH paths that match the glob strings.
/// A command to resolve PowerShell paths containing glob characters to
/// PowerShell paths that match the glob strings.
/// </summary>
[Cmdlet(VerbsCommon.Split, "Path", DefaultParameterSetName = "ParentSet", SupportsTransactions = true, HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097149")]
[OutputType(typeof(string), ParameterSetName = new[] { leafSet,
Expand Down Expand Up @@ -105,7 +105,7 @@ public string[] LiteralPath
/// <value>
/// If true the qualifier of the path will be returned.
/// The qualifier is the drive or provider that is qualifying
/// the MSH path.
/// the PowerShell path.
/// </value>
[Parameter(ParameterSetName = qualifierSet, Mandatory = true, ValueFromPipelineByPropertyName = true)]
public SwitchParameter Qualifier { get; set; }
Expand All @@ -116,7 +116,7 @@ public string[] LiteralPath
/// <value>
/// If true the qualifier of the path will be returned.
/// The qualifier is the drive or provider that is qualifying
/// the MSH path.
/// the PowerShell path.
/// </value>
[Parameter(ParameterSetName = noQualifierSet, Mandatory = true, ValueFromPipelineByPropertyName = true)]
public SwitchParameter NoQualifier { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// A command to resolve MSH paths containing glob characters to
/// MSH paths that match the glob strings.
/// A command to resolve PowerShell paths containing glob characters to
/// PowerShell paths that match the glob strings.
/// </summary>
[Cmdlet(VerbsDiagnostic.Resolve, "Path", DefaultParameterSetName = "Path", SupportsTransactions = true,
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097143")]
Expand Down Expand Up @@ -89,7 +89,7 @@ public SwitchParameter Relative
#region Command code

/// <summary>
/// Resolves the path containing glob characters to the MSH paths that it
/// Resolves the path containing glob characters to the PowerShell paths that it
/// represents.
/// </summary>
protected override void ProcessRecord()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
namespace Microsoft.PowerShell
{
/// <summary>
/// MshManagementMshSnapin (or MshManagementMshSnapinInstaller) is a class for facilitating registry
/// of necessary information for monad management mshsnapin.
/// PSManagementPSSnapIn is a class for facilitating registry
/// of necessary information for PowerShell management PSSnapin.
///
/// This class will be built with monad management dll.
/// </summary>
Expand All @@ -24,7 +24,7 @@ public PSManagementPSSnapIn()
}

/// <summary>
/// Get name of this mshsnapin.
/// Get name of this PSSnapin.
/// </summary>
public override string Name
{
Expand All @@ -35,7 +35,7 @@ public override string Name
}

/// <summary>
/// Get the default vendor string for this mshsnapin.
/// Get the default vendor string for this PSSnapin.
/// </summary>
public override string Vendor
{
Expand All @@ -57,7 +57,7 @@ public override string VendorResource
}

/// <summary>
/// Get the default description string for this mshsnapin.
/// Get the default description string for this PSSnapin.
/// </summary>
public override string Description
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public enum ExportAliasFormat
Csv,

/// <summary>
/// Aliases will be exported as an MSH script.
/// Aliases will be exported as a script.
/// </summary>
Script
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ public SwitchParameter Debugger
}

/// <summary>
/// If this parameter is specified the Msh Host trace listener will be added.
/// If this parameter is specified the PSHost trace listener will be added.
/// </summary>
/// <value></value>
[Parameter(ParameterSetName = "optionsSet")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
namespace Microsoft.PowerShell
{
/// <summary>
/// MshUtilityMshSnapin (or MshUtilityMshSnapinInstaller) is a class for facilitating registry
/// of necessary information for monad utility mshsnapin.
/// PSUtilityPSSnapIn is a class for facilitating registry
/// of necessary information for monad utility PSSnapin.
///
/// This class will be built with monad utility dll.
/// </summary>
Expand All @@ -24,7 +24,7 @@ public PSUtilityPSSnapIn()
}

/// <summary>
/// Get name of this mshsnapin.
/// Get name of this PSSnapin.
/// </summary>
public override string Name
{
Expand All @@ -35,7 +35,7 @@ public override string Name
}

/// <summary>
/// Get the default vendor string for this mshsnapin.
/// Get the default vendor string for this PSSnapin.
/// </summary>
public override string Vendor
{
Expand All @@ -57,7 +57,7 @@ public override string VendorResource
}

/// <summary>
/// Get the default description string for this mshsnapin.
/// Get the default description string for this PSSnapin.
/// </summary>
public override string Description
{
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleShell.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
namespace Microsoft.PowerShell
{
/// <summary>
/// This class provides an entry point which is called by minishell's main
/// to transfer control to Msh console host implementation.
/// This class provides an entry point which is called
/// to transfer control to console host implementation.
/// </summary>
public static class ConsoleShell
{
Expand Down
12 changes: 6 additions & 6 deletions src/Microsoft.PowerShell.ConsoleHost/host/msh/ManagedEntrance.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@
namespace Microsoft.PowerShell
{
/// <summary>
/// Defines an entry point from unmanaged code to managed Msh.
/// Defines an entry point from unmanaged code to PowerShell.
/// </summary>
public sealed class UnmanagedPSEntry
{
/// <summary>
/// Starts managed MSH.
/// Starts PowerShell.
/// </summary>
/// <param name="consoleFilePath">
/// Deprecated: Console file used to create a runspace configuration to start MSH
/// Deprecated: Console file used to create a runspace configuration to start PowerShell
/// </param>
/// <param name="args">
/// Command line arguments to the managed MSH
/// Command line arguments to the PowerShell
/// </param>
/// <param name="argc">
/// Length of the passed in argument array.
Expand All @@ -39,10 +39,10 @@ public static int Start(string consoleFilePath, [MarshalAs(UnmanagedType.LPArray
}

/// <summary>
/// Starts managed MSH.
/// Starts PowerShell.
/// </summary>
/// <param name="args">
/// Command line arguments to the managed MSH
/// Command line arguments to PowerShell
/// </param>
/// <param name="argc">
/// Length of the passed in argument array.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
namespace Microsoft.PowerShell
{
/// <summary>
/// PSHostMshSnapin (or PSHostMshSnapinInstaller) is a class for facilitating registry
/// of necessary information for monad host mshsnapin.
/// PSHostPSSnapIn is a class for facilitating registry
/// of necessary information for monad host PSSnapin.
///
/// This class will be built with monad host engine dll
/// (Microsoft.PowerShell.ConsoleHost.dll).
Expand All @@ -25,7 +25,7 @@ public PSHostPSSnapIn()
}

/// <summary>
/// Get name of this mshsnapin.
/// Get name of this PSSnapin.
/// </summary>
public override string Name
{
Expand All @@ -36,7 +36,7 @@ public override string Name
}

/// <summary>
/// Get the default vendor string for this mshsnapin.
/// Get the default vendor string for this PSSnapin.
/// </summary>
public override string Vendor
{
Expand All @@ -58,7 +58,7 @@ public override string VendorResource
}

/// <summary>
/// Get the default description string for this mshsnapin.
/// Get the default description string for this PSSnapin.
/// </summary>
public override string Description
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace Microsoft.PowerShell.Commands
/// <summary>
/// Defines the implementation of the 'get-credential' cmdlet.
/// The get-credential Cmdlet establishes a credential object called a
/// Msh credential, by pairing a given username with
/// PSCredential, by pairing a given username with
/// a prompted password. That credential object can then be used for other
/// operations involving security.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
namespace Microsoft.PowerShell
{
/// <summary>
/// MshSecurityMshSnapin (or MshSecurityMshSnapinInstaller) is a class for facilitating registry
/// of necessary information for monad security mshsnapin.
/// PSSecurityPSSnapIn is a class for facilitating registry
/// of necessary information for monad security PSSnapin.
///
/// This class will be built with monad security dll.
/// </summary>
Expand All @@ -33,7 +33,7 @@ public PSSecurityPSSnapIn()
}

/// <summary>
/// Get name of this mshsnapin.
/// Get name of this PSSnapin.
/// </summary>
public override string Name
{
Expand All @@ -44,7 +44,7 @@ public override string Name
}

/// <summary>
/// Get the default vendor string for this mshsnapin.
/// Get the default vendor string for this PSSnapin.
/// </summary>
public override string Vendor
{
Expand All @@ -66,7 +66,7 @@ public override string VendorResource
}

/// <summary>
/// Get the default description string for this mshsnapin.
/// Get the default description string for this PSSnapin.
/// </summary>
public override string Description
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ namespace Microsoft.PowerShell.Cim
/// Implementing the PropertyOnlyAdapter for the time being as CimInstanceTypeAdapter currently
/// supports only properties. If method support is needed in future, this should derive from
/// Adapter class.
///
/// The Adapter registration is done in monad\src\singleshell\installer\MshManagementMshSnapin.cs
/// </remarks>
public sealed class CimInstanceAdapter : PSPropertyAdapter
{
Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/engine/AutomationNull.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace System.Management.Automation.Internal
/// <remarks>
/// It's a singleton class. Sealed to prevent subclassing. Any operation that
/// returns no actual value should return this object AutomationNull.Value.
/// Anything that evaluates an MSH expression should be prepared to deal
/// Anything that evaluates a PowerShell expression should be prepared to deal
/// with receiving this result and discarding it. When received in an
/// evaluation where a value is required, it should be replaced with null.
/// </remarks>
Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/engine/CmdletInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
namespace System.Management.Automation
{
/// <summary>
/// The command information for MSH cmdlets that are directly executable by MSH.
/// The command information for cmdlets that are directly executable by PowerShell.
/// </summary>
public class CmdletInfo : CommandInfo
{
Expand Down
4 changes: 2 additions & 2 deletions src/System.Management.Automation/engine/CommandBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -397,11 +397,11 @@ public enum ConfirmImpact
/// deriving from the PSCmdlet base class. The Cmdlet base class is the primary means by
/// which users create their own Cmdlets. Extending this class provides support for the most
/// common functionality, including object output and record processing.
/// If your Cmdlet requires access to the MSH Runtime (for example, variables in the session state,
/// If your Cmdlet requires access to the PowerShell Runtime (for example, variables in the session state,
/// access to the host, or information about the current Cmdlet Providers,) then you should instead
/// derive from the PSCmdlet base class.
/// The public members defined by the PSCmdlet class are not designed to be overridden; instead, they
/// provided access to different aspects of the MSH runtime.
/// provided access to different aspects of the PowerShell runtime.
/// In both cases, users should first develop and implement an object model to accomplish their
/// task, extending the Cmdlet or PSCmdlet classes only as a thin management layer.
/// </remarks>
Expand Down
4 changes: 2 additions & 2 deletions src/System.Management.Automation/engine/CommandInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
namespace System.Management.Automation
{
/// <summary>
/// Defines the types of commands that MSH can execute.
/// Defines the types of commands that PowerShell can execute.
/// </summary>
[Flags]
public enum CommandTypes
Expand Down Expand Up @@ -52,7 +52,7 @@ public enum CommandTypes
Cmdlet = 0x0008,

/// <summary>
/// An MSH script (*.ps1 file)
/// An PowerShell script (*.ps1 file)
/// </summary>
ExternalScript = 0x0010,

Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/engine/Credential.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
namespace System.Management.Automation
{
/// <summary>
/// Defines the valid types of MSH credentials. Used by PromptForCredential calls.
/// Defines the valid types of PSCredentials. Used by PromptForCredential calls.
/// </summary>
[Flags]
public enum PSCredentialTypes
Expand Down
6 changes: 3 additions & 3 deletions src/System.Management.Automation/engine/DataStoreAdapter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ protected PSDriveInfo(PSDriveInfo driveInfo)
}

/// <summary>
/// Constructs a drive that maps an MSH Path in
/// Constructs a drive that maps a PowerShell Path in
/// the shell to a Cmdlet Provider.
/// </summary>
/// <param name="name">
Expand Down Expand Up @@ -366,7 +366,7 @@ protected PSDriveInfo(PSDriveInfo driveInfo)
}

/// <summary>
/// Constructs a drive that maps an MSH Path in
/// Constructs a drive that maps a PowerShell Path in
/// the shell to a Cmdlet Provider.
/// </summary>
/// <param name="name">
Expand Down Expand Up @@ -408,7 +408,7 @@ protected PSDriveInfo(PSDriveInfo driveInfo)
}

/// <summary>
/// Constructs a drive that maps an MSH Path in
/// Constructs a drive that maps a PowerShell Path in
/// the shell to a Cmdlet Provider.
/// </summary>
/// <param name="name">
Expand Down

0 comments on commit 8374823

Please sign in to comment.