diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs index 1db9132ed..e721735af 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs @@ -547,12 +547,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region private members /// - /// lock object. + /// Lock object. /// private readonly object myLock = new object(); /// - /// number of active operations. + /// Number of active operations. /// private UInt32 operationCount = 0; @@ -569,12 +569,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private ConcurrentQueue actionQueue; /// - /// lock object. + /// Lock object. /// private readonly object cimSessionProxyCacheLock = new object(); /// - /// cache all objects related to + /// Cache all objects related to /// the current operation. /// private List cimSessionProxyCache; diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs index c223a72c8..c76fb8196 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs @@ -124,12 +124,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region members /// - /// action completed event. + /// Action completed event. /// private ManualResetEventSlim completeEvent; /// - /// response result. + /// Response result. /// protected CimResponseType responseType; diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs index 7648a8f0d..9b8b69fe6 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs @@ -25,7 +25,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal class ParameterDefinitionEntry { /// - /// constructor. + /// Constructor. /// /// /// @@ -36,7 +36,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// property ParameterSetName. + /// Property ParameterSetName. /// internal string ParameterSetName { @@ -70,7 +70,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal class ParameterSetEntry { /// - /// constructor. + /// Constructor. /// /// internal ParameterSetEntry(UInt32 mandatoryParameterCount) @@ -81,7 +81,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// constructor. + /// Constructor. /// /// internal ParameterSetEntry(ParameterSetEntry toClone) @@ -92,7 +92,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// constructor. + /// Constructor. /// /// /// @@ -104,7 +104,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// reset the internal status. + /// Reset the internal status. /// internal void reset() { @@ -113,7 +113,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// property DefaultParameterSet + /// Property DefaultParameterSet /// internal bool IsDefaultParameterSet { @@ -126,7 +126,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private readonly bool isDefaultParameterSet = false; /// - /// property MandatoryParameterCount + /// Property MandatoryParameterCount /// internal UInt32 MandatoryParameterCount { @@ -139,7 +139,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private readonly UInt32 mandatoryParameterCount = 0; /// - /// property IsValueSet + /// Property IsValueSet /// internal bool IsValueSet { @@ -157,7 +157,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private bool isValueSet = false; /// - /// property IsValueSetAtBeginProcess + /// Property IsValueSetAtBeginProcess /// internal bool IsValueSetAtBeginProcess { @@ -175,7 +175,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private bool isValueSetAtBeginProcess = false; /// - /// property SetMandatoryParameterCount + /// Property SetMandatoryParameterCount /// internal UInt32 SetMandatoryParameterCount { @@ -193,7 +193,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private UInt32 setMandatoryParameterCount = 0; /// - /// property SetMandatoryParameterCountAtBeginProcess + /// Property SetMandatoryParameterCountAtBeginProcess /// internal UInt32 SetMandatoryParameterCountAtBeginProcess { @@ -217,7 +217,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal class ParameterBinder { /// - /// constructor. + /// Constructor. /// /// /// @@ -568,7 +568,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructors /// - /// constructor. + /// Constructor. /// internal CimBaseCommand() { @@ -577,7 +577,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// constructor. + /// Constructor. /// internal CimBaseCommand(Dictionary> parameters, Dictionary sets) @@ -686,7 +686,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private CimAsyncOperation operation; /// - /// lock object. + /// Lock object. /// private readonly object myLock = new object(); @@ -780,37 +780,37 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region internal const strings /// - /// alias CN - computer name. + /// Alias CN - computer name. /// internal const string AliasCN = "CN"; /// - /// alias ServerName - computer name. + /// Alias ServerName - computer name. /// internal const string AliasServerName = "ServerName"; /// - /// alias OT - operation timeout. + /// Alias OT - operation timeout. /// internal const string AliasOT = "OT"; /// - /// session set name. + /// Session set name. /// internal const string SessionSetName = "SessionSet"; /// - /// computer set name. + /// Computer set name. /// internal const string ComputerSetName = "ComputerSet"; /// - /// class name computer set name. + /// Class name computer set name. /// internal const string ClassNameComputerSet = "ClassNameComputerSet"; /// - /// resource Uri computer set name. + /// Resource Uri computer set name. /// internal const string ResourceUriComputerSet = "ResourceUriComputerSet"; @@ -820,17 +820,17 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal const string CimInstanceComputerSet = "CimInstanceComputerSet"; /// - /// query computer set name. + /// Query computer set name. /// internal const string QueryComputerSet = "QueryComputerSet"; /// - /// class name session set name. + /// Class name session set name. /// internal const string ClassNameSessionSet = "ClassNameSessionSet"; /// - /// resource Uri session set name. + /// Resource Uri session set name. /// internal const string ResourceUriSessionSet = "ResourceUriSessionSet"; @@ -840,7 +840,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal const string CimInstanceSessionSet = "CimInstanceSessionSet"; /// - /// query session set name. + /// Query session set name. /// internal const string QuerySessionSet = "QuerySessionSet"; @@ -872,12 +872,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// credential parameter set. + /// Credential parameter set. /// internal const string CredentialParameterSet = "CredentialParameterSet"; /// - /// certificate parameter set. + /// Certificate parameter set. /// internal const string CertificateParameterSet = "CertificateParameterSet"; diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs index 3a60532f8..9178fd873 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs @@ -15,7 +15,7 @@ using System.Text; namespace Microsoft.Management.Infrastructure.CimCmdlets { /// - /// a class used to add pstypename to partial ciminstance + /// A class used to add pstypename to partial ciminstance /// for , if -KeyOnly /// or -SelectProperties is been specified, then add a pstypename: /// "Microsoft.Management.Infrastructure.CimInstance#__PartialCIMInstance" @@ -527,12 +527,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region const strings /// - /// wql query format with where clause. + /// Wql query format with where clause. /// private const string queryWithWhere = @"SELECT {0} FROM {1} WHERE {2}"; /// - /// wql query format without where clause. + /// Wql query format without where clause. /// private const string queryWithoutWhere = @"SELECT {0} FROM {1}"; #endregion diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimIndicationWatcher.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimIndicationWatcher.cs index 04917ae95..16cefeac4 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimIndicationWatcher.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimIndicationWatcher.cs @@ -137,7 +137,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets public class CimIndicationWatcher { /// - /// status of object. + /// Status of object. /// internal enum Status { @@ -364,12 +364,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private CimRegisterCimIndication cimRegisterCimIndication; /// - /// the status of object. + /// The status of object. /// private Status status; /// - /// lock started field. + /// Lock started field. /// private object myLock; diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimInvokeCimMethod.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimInvokeCimMethod.cs index b4c1891b7..19dcbf378 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimInvokeCimMethod.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimInvokeCimMethod.cs @@ -461,12 +461,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region const strings /// - /// operation target. + /// Operation target. /// private const string targetClass = @"{0}"; /// - /// action. + /// Action. /// private const string actionTemplate = @"Invoke-CimMethod: {0}"; #endregion diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs index dc2e9a41f..906fb4b3f 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs @@ -362,7 +362,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region const strings /// - /// action. + /// Action. /// private const string action = @"New-CimInstance"; #endregion diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimPromptUser.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimPromptUser.cs index 56951d8d2..2ebebfec1 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimPromptUser.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimPromptUser.cs @@ -119,7 +119,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region members /// - /// prompt message. + /// Prompt message. /// public string Message { @@ -132,7 +132,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private string message; /// - /// prompt type -Normal or Critical. + /// Prompt type -Normal or Critical. /// private CimPromptType prompt; diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs index 9045c436a..20da97bbc 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs @@ -271,7 +271,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// block the ps thread until ACK message or Error happened. + /// Block the ps thread until ACK message or Error happened. /// private void WaitForAckMessage() { @@ -315,7 +315,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// target computername. + /// Target computername. /// internal string TargetComputerName { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRemoveCimInstance.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRemoveCimInstance.cs index 2979be4d0..1cff9b68e 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRemoveCimInstance.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRemoveCimInstance.cs @@ -143,7 +143,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region const strings /// - /// action. + /// Action. /// private const string action = @"Remove-CimInstance"; #endregion diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs index 796fa0e19..815812d8d 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs @@ -32,7 +32,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal class CimResultContext { /// - /// constructor. + /// Constructor. /// /// internal CimResultContext(object ErrorSource) @@ -355,7 +355,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private CimSession session; /// - /// async operation that can be observed. + /// Async operation that can be observed. /// private IObservable observable; @@ -372,7 +372,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal class CimSubscriptionResultObserver : CimResultObserver { /// - /// constructor. + /// Constructor. /// /// /// @@ -382,7 +382,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// constructor. + /// Constructor. /// /// /// @@ -411,7 +411,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal class CimMethodResultObserver : CimResultObserver { /// - /// constructor. + /// Constructor. /// /// /// @@ -421,7 +421,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// constructor. + /// Constructor. /// /// /// @@ -480,7 +480,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// methodname. + /// Methodname. /// internal string MethodName { @@ -489,7 +489,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// classname. + /// Classname. /// internal string ClassName { @@ -504,7 +504,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal class IgnoreResultObserver : CimResultObserver { /// - /// constructor. + /// Constructor. /// /// /// diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs index e2d9f78b5..f41b65882 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs @@ -22,7 +22,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region members /// - /// id of the cimsession. + /// Id of the cimsession. /// public uint SessionId { @@ -35,7 +35,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private uint sessionId; /// - /// instanceId of the cimsession. + /// InstanceId of the cimsession. /// public Guid InstanceId { @@ -48,7 +48,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private Guid instanceId; /// - /// name of the cimsession. + /// Name of the cimsession. /// public string Name { @@ -61,7 +61,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private string name; /// - /// computer name of the cimsession. + /// Computer name of the cimsession. /// public string ComputerName { @@ -74,7 +74,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private string computerName; /// - /// wrapped cimsession object. + /// Wrapped cimsession object. /// public CimSession CimSession { @@ -87,7 +87,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private CimSession cimSession; /// - /// computer name of the cimsession. + /// Computer name of the cimsession. /// public string Protocol { @@ -1126,7 +1126,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal class CimGetSession : CimSessionBase { /// - /// constructor. + /// Constructor. /// public CimGetSession() : base() { @@ -1208,7 +1208,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal static string RemoveCimSessionActionName = "Remove CimSession"; /// - /// constructor. + /// Constructor. /// public CimRemoveSession() : base() { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs index 485c7706e..bc3178d6f 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs @@ -22,7 +22,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region Context base class /// - /// context base class for cross operations + /// Context base class for cross operations /// for example, some cmdlets need to query instance first and then /// remove instance, those scenarios need context object transferred /// from one operation to another. @@ -59,7 +59,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// class provides all information regarding the + /// Class provides all information regarding the /// current invocation to .net api. /// internal class InvocationContext @@ -119,8 +119,8 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region Preprocessing of result object interface /// - /// Defines a method to preprocessing an result object before sending to - /// output pipeline. + /// Defines a method to preprocessing an result object before sending to + /// output pipeline. /// [ComVisible(false)] internal interface IObjectPreProcess @@ -160,7 +160,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal sealed class OperationEventArgs : EventArgs { /// - /// constructor. + /// Constructor. /// /// Object used to cancel the operation. /// Async observable operation. @@ -198,7 +198,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private static long gOperationCounter = 0; /// - /// temporary CimSession cache lock. + /// Temporary CimSession cache lock. /// private static readonly object temporarySessionCacheLock = new object(); @@ -1113,7 +1113,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// delete a cim instance asynchronously. + /// Delete a cim instance asynchronously. /// /// /// @@ -1549,33 +1549,33 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// lock object used to lock + /// Lock object used to lock /// operation & cancelOperation members. /// private readonly object stateLock = new object(); /// - /// the operation issued by cimSession. + /// The operation issued by cimSession. /// private IObservable operation; /// - /// the current operation name. + /// The current operation name. /// private string operationName; /// - /// the current operation parameters. + /// The current operation parameters. /// private Hashtable operationParameters = new Hashtable(); /// - /// handler used to cancel operation. + /// Handler used to cancel operation. /// private IDisposable _cancelOperation; /// - /// cancelOperation disposed flag. + /// CancelOperation disposed flag. /// private int _cancelOperationDisposed = 0; @@ -1615,7 +1615,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// current protocol name + /// Current protocol name /// DCOM or WSMAN. /// internal ProtocolType Protocol @@ -1629,7 +1629,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private ProtocolType protocol; /// - /// cross operation context object. + /// Cross operation context object. /// internal XOperationContextBase ContextObject { @@ -1647,12 +1647,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private XOperationContextBase contextObject; /// - /// invocation context object. + /// Invocation context object. /// private InvocationContext invocationContextObject; /// - /// a preprocess object to pre-processing the result object, + /// A preprocess object to pre-processing the result object, /// for example, adding PSTypeName, etc. /// internal IObjectPreProcess ObjectPreProcess diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSetCimInstance.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSetCimInstance.cs index 76daf60ad..eb651744f 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSetCimInstance.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSetCimInstance.cs @@ -312,7 +312,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region const strings /// - /// action. + /// Action. /// private const string action = @"Set-CimInstance"; #endregion diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteMessage.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteMessage.cs index f694d3fbe..ec8b1c6f8 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteMessage.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteMessage.cs @@ -20,12 +20,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region members /// - /// channel id. + /// Channel id. /// private UInt32 channel; /// - /// message to write to the channel. + /// Message to write to the channel. /// private string message; #endregion diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteProgress.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteProgress.cs index 8e6a6f869..5bf1f5357 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteProgress.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteProgress.cs @@ -100,22 +100,22 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets private int activityID; /// - /// current operation text of the given activity. + /// Current operation text of the given activity. /// private string currentOperation; /// - /// status description of the given activity. + /// Status description of the given activity. /// private string statusDescription; /// - /// percentage completed of the given activity. + /// Percentage completed of the given activity. /// private UInt32 percentageCompleted; /// - /// how many seconds remained for the given activity. + /// How many seconds remained for the given activity. /// private UInt32 secondsRemaining; diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteResultObject.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteResultObject.cs index 49cc6791a..57ce642c3 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteResultObject.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteResultObject.cs @@ -37,7 +37,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region members /// - /// result object. + /// Result object. /// internal object Result { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimAssociatedInstanceCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimAssociatedInstanceCommand.cs index 4cd003bc0..753487de7 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimAssociatedInstanceCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimAssociatedInstanceCommand.cs @@ -32,7 +32,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// constructor. + /// Constructor. /// public GetCimAssociatedInstanceCommand() : base(parameters, parameterSets) @@ -316,7 +316,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -345,7 +345,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimClassCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimClassCommand.cs index bbd89d70b..a12da58c3 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimClassCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimClassCommand.cs @@ -30,7 +30,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// constructor. + /// Constructor. /// public GetCimClassCommand() : base(parameters, parameterSets) @@ -289,7 +289,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -307,7 +307,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimInstanceCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimInstanceCommand.cs index 4392e152a..e9c296194 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimInstanceCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimInstanceCommand.cs @@ -25,7 +25,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// constructor. + /// Constructor. /// public GetCimInstanceCommand() : base(parameters, parameterSets) @@ -513,7 +513,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// check argument value. + /// Check argument value. /// private void CheckArgument() { @@ -550,7 +550,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -654,7 +654,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimSessionCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimSessionCommand.cs index bd012412f..f621f249e 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimSessionCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/GetCimSessionCommand.cs @@ -22,7 +22,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// constructor. + /// Constructor. /// public GetCimSessionCommand() : base(parameters, parameterSets) @@ -171,7 +171,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -198,7 +198,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/InvokeCimMethodCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/InvokeCimMethodCommand.cs index e9a7a30db..3585c464e 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/InvokeCimMethodCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/InvokeCimMethodCommand.cs @@ -27,7 +27,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// constructor. + /// Constructor. /// public InvokeCimMethodCommand() : base(parameters, parameterSets) @@ -437,7 +437,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// check argument value. + /// Check argument value. /// private void CheckArgument() { @@ -471,7 +471,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -558,7 +558,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimInstanceCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimInstanceCommand.cs index 5634694b5..058ddcd3c 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimInstanceCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimInstanceCommand.cs @@ -28,7 +28,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// constructor. + /// Constructor. /// public NewCimInstanceCommand() : base(parameters, parameterSets) @@ -405,7 +405,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// check argument value. + /// Check argument value. /// private void CheckArgument() { @@ -437,7 +437,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -500,7 +500,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimSessionOptionCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimSessionOptionCommand.cs index 9faf965b1..f22cd2a8b 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimSessionOptionCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimSessionOptionCommand.cs @@ -42,7 +42,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// constructor. + /// Constructor. /// public NewCimSessionOptionCommand() : base(parameters, parameterSets) @@ -707,7 +707,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -808,7 +808,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/RegisterCimIndicationCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/RegisterCimIndicationCommand.cs index 2e621cdaa..17da1ae33 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/RegisterCimIndicationCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/RegisterCimIndicationCommand.cs @@ -281,7 +281,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region private members /// - /// check argument value. + /// Check argument value. /// private void CheckArgument() { @@ -317,7 +317,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -354,7 +354,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/RemoveCimInstanceCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/RemoveCimInstanceCommand.cs index 109eac3ca..c54249990 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/RemoveCimInstanceCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/RemoveCimInstanceCommand.cs @@ -26,7 +26,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// constructor. + /// Constructor. /// public RemoveCimInstanceCommand() : base(parameters, parameterSets) @@ -320,7 +320,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -369,7 +369,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/RemoveCimSessionCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/RemoveCimSessionCommand.cs index ba572d588..b84795884 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/RemoveCimSessionCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/RemoveCimSessionCommand.cs @@ -29,7 +29,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// constructor. + /// Constructor. /// public RemoveCimSessionCommand() : base(parameters, parameterSets) @@ -197,7 +197,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -229,7 +229,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/SetCimInstanceCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/SetCimInstanceCommand.cs index c1190361e..abad4702e 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/SetCimInstanceCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/SetCimInstanceCommand.cs @@ -28,7 +28,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// constructor. + /// Constructor. /// public SetCimInstanceCommand() : base(parameters, parameterSets) @@ -378,7 +378,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #endregion /// - /// static parameter definition entries. + /// Static parameter definition entries. /// static Dictionary> parameters = new Dictionary> { @@ -435,7 +435,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets }; /// - /// static parameter set entries. + /// Static parameter set entries. /// static Dictionary parameterSets = new Dictionary { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/Utils.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/Utils.cs index b6ce7c238..b2c59c6af 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/Utils.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/Utils.cs @@ -305,7 +305,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// Format the message. + /// Format the message. /// /// /// diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs index 9aa3edf51..52e2cdca1 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs @@ -1086,7 +1086,7 @@ $result } /// - /// to implement ^C. + /// To implement ^C. /// protected override void StopProcessing() { @@ -1114,7 +1114,7 @@ $result #region Stop-Computer /// - /// cmdlet to stop computer. + /// Cmdlet to stop computer. /// [Cmdlet(VerbsLifecycle.Stop, "Computer", SupportsShouldProcess = true, HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135263", RemotingCapability = RemotingCapability.SupportedByCommand)] @@ -1206,7 +1206,7 @@ $result } /// - /// to implement ^C. + /// To implement ^C. /// protected override void StopProcessing() { diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Eventlog.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Eventlog.cs index eaef4b830..63a65fd2f 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Eventlog.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Eventlog.cs @@ -119,7 +119,7 @@ namespace Microsoft.PowerShell.Commands private string[] _username; /// - /// match eventlog entries by the InstanceIds + /// Match eventlog entries by the InstanceIds /// gets or sets an array of instanceIds. /// [Parameter(Position = 1, ParameterSetName = "LogName")] @@ -140,7 +140,7 @@ namespace Microsoft.PowerShell.Commands private long[] _instanceIds = null; /// - /// match eventlog entries by the Index + /// Match eventlog entries by the Index /// gets or sets an array of indexes. /// [Parameter(ParameterSetName = "LogName")] @@ -161,7 +161,7 @@ namespace Microsoft.PowerShell.Commands private int[] _indexes = null; /// - /// match eventlog entries by the EntryType + /// Match eventlog entries by the EntryType /// gets or sets an array of EntryTypes. /// [Parameter(ParameterSetName = "LogName")] @@ -183,7 +183,7 @@ namespace Microsoft.PowerShell.Commands private string[] _entryTypes = null; /// - /// get or sets an array of Source. + /// Get or sets an array of Source. /// [Parameter(ParameterSetName = "LogName")] [ValidateNotNullOrEmpty()] @@ -226,7 +226,7 @@ namespace Microsoft.PowerShell.Commands private string _message; /// - /// returns Log Entry as base object. + /// Returns Log Entry as base object. /// [Parameter(ParameterSetName = "LogName")] public SwitchParameter AsBaseObject { get; set; } @@ -1091,7 +1091,7 @@ namespace Microsoft.PowerShell.Commands #region Parameters /// - /// show eventviewer of this computer. + /// Show eventviewer of this computer. /// [Parameter(Position = 0)] [Alias("CN")] diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs index 9bb553352..6914b491e 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs @@ -2239,7 +2239,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// The ComputerInfo class is output to the PowerShell pipeline. + /// The ComputerInfo class is output to the PowerShell pipeline. /// public class ComputerInfo { @@ -3820,7 +3820,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// hardware security settings for the reset button on a computer. + /// Hardware security settings for the reset button on a computer. /// public enum FrontPanelResetStatus { @@ -3963,7 +3963,7 @@ namespace Microsoft.PowerShell.Commands Encrypt128Bits = 1, /// - /// n-bit encryption. + /// N-bit encryption. /// EncryptNBits = 2 } diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Hotfix.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Hotfix.cs index c355cc4c6..4a57acda7 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Hotfix.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Hotfix.cs @@ -170,7 +170,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// to implement ^C. + /// To implement ^C. /// protected override void StopProcessing() { diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Navigation.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Navigation.cs index 111bb6799..b615207d8 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Navigation.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Navigation.cs @@ -1160,7 +1160,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// new-psdrive always supports ShouldProcess. + /// New-psdrive always supports ShouldProcess. /// /// protected override bool ProviderSupportsShouldProcess => true; diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs index c0f48ec5c..6700a582d 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs @@ -159,7 +159,7 @@ namespace Microsoft.PowerShell.Commands internal string[] serviceNames = null; /// - /// gets/sets an array of display names for services. + /// Gets/sets an array of display names for services. /// [Parameter(ParameterSetName = "DisplayName", Mandatory = true)] public string[] DisplayName @@ -541,7 +541,7 @@ namespace Microsoft.PowerShell.Commands { #region Parameters /// - /// gets/sets an array of service names. + /// Gets/sets an array of service names. /// /// /// The ServiceName parameter is declared in subclasses, @@ -737,7 +737,7 @@ namespace Microsoft.PowerShell.Commands { #region Parameters /// - /// gets/sets an array of service names. + /// Gets/sets an array of service names. /// /// /// The ServiceName parameter is declared in subclasses, @@ -1467,7 +1467,7 @@ namespace Microsoft.PowerShell.Commands #region Parameters /// - /// service name. + /// Service name. /// /// [Parameter(Mandatory = true, ParameterSetName = "Name", Position = 0, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)] @@ -2465,7 +2465,7 @@ namespace Microsoft.PowerShell.Commands { #region ctors /// - /// unimplemented standard constructor. + /// Unimplemented standard constructor. /// /// Doesn't return. public ServiceCommandException() @@ -2475,7 +2475,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// standard constructor. + /// Standard constructor. /// /// /// Constructed object. @@ -2485,7 +2485,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// standard constructor. + /// Standard constructor. /// /// /// @@ -2497,7 +2497,7 @@ namespace Microsoft.PowerShell.Commands #region Serialization /// - /// serialization constructor. + /// Serialization constructor. /// /// /// diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/TimeZoneCommands.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/TimeZoneCommands.cs index a391a8be4..6961fc623 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/TimeZoneCommands.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/TimeZoneCommands.cs @@ -756,7 +756,7 @@ namespace Microsoft.PowerShell.Commands #endif /// - /// static Helper class for working with system time zones. + /// Static Helper class for working with system time zones. /// internal static class TimeZoneHelper { diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs index 32fe98e36..c5f41d29a 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs @@ -89,7 +89,7 @@ namespace Microsoft.PowerShell.Commands private int _cmdCount = 1; private PSWmiChildJob _job; /// - /// current operation state. + /// Current operation state. /// internal WmiState State { @@ -1607,7 +1607,7 @@ namespace Microsoft.PowerShell.Commands private bool _moreData = false; /// - /// indicates if more data is available. + /// Indicates if more data is available. /// /// /// This has more data if any of the child jobs have more data. @@ -1865,7 +1865,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// it receives Management objects. + /// It receives Management objects. /// private void NewObject(object sender, ObjectReadyEventArgs obj) { diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/WebServiceProxy.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/WebServiceProxy.cs index 91996c7cc..90c994fd9 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/WebServiceProxy.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/WebServiceProxy.cs @@ -75,7 +75,7 @@ namespace Microsoft.PowerShell.Commands private string _class; /// - /// namespace. + /// Namespace. /// [Parameter(Position = 2)] [ValidateNotNullOrEmpty] @@ -112,7 +112,7 @@ namespace Microsoft.PowerShell.Commands private PSCredential _credential; /// - /// use default credential.. + /// Use default credential.. /// [Parameter(ParameterSetName = "UseDefaultCredential")] [ValidateNotNull] @@ -143,7 +143,7 @@ namespace Microsoft.PowerShell.Commands private static Dictionary s_srccodeCache = new Dictionary(); /// - /// holds the hash code of the source generated. + /// Holds the hash code of the source generated. /// private int _sourceHash; /// diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/common/WriteFormatDataCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/common/WriteFormatDataCommand.cs index 2ecddc517..768111dc6 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/common/WriteFormatDataCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/common/WriteFormatDataCommand.cs @@ -147,7 +147,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// writes out the formatting directives from the + /// Writes out the formatting directives from the /// collection to the specified XML file. /// protected override void EndProcessing() diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-file/Out-File.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-file/Out-File.cs index 57fc1a879..1b373fa61 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-file/Out-File.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-file/Out-File.cs @@ -303,7 +303,7 @@ namespace Microsoft.PowerShell.Commands private StreamWriter _sw = null; /// - /// indicate whether the ProcessRecord method was executed. + /// Indicate whether the ProcessRecord method was executed. /// When the Out-File is used in a redirection pipelineProcessor, /// its ProcessRecord method may not be called when nothing is written to the /// output pipe, for example: diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-printer/PrinterLineOutput.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-printer/PrinterLineOutput.cs index 776c6f71b..312734c04 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-printer/PrinterLineOutput.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-printer/PrinterLineOutput.cs @@ -176,7 +176,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// internal helper to verify that the font is fixed pitch. If the test fails, + /// Internal helper to verify that the font is fixed pitch. If the test fails, /// it reverts to the default font. /// /// GDI+ graphics object needed for verification. diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-string/out-string.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-string/out-string.cs index fd403980b..6a4da5c7f 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-string/out-string.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/out-string/out-string.cs @@ -163,7 +163,7 @@ namespace Microsoft.PowerShell.Commands private StreamingTextWriter _writer = null; /// - /// Buffer used when buffering until the end. + /// Buffer used when buffering until the end. /// private StringBuilder _buffer = new StringBuilder(); } diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs index c91bd709c..fa163dafd 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs @@ -587,7 +587,7 @@ namespace Microsoft.PowerShell.Commands internal const int KEY_EVENT = 0x0001; /// - /// input buffer event type. + /// Input buffer event type. /// internal ushort EventType; diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/StartSleepCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/StartSleepCommand.cs index 91d3d07a7..b99476917 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/StartSleepCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/StartSleepCommand.cs @@ -18,7 +18,7 @@ namespace Microsoft.PowerShell.Commands #region IDisposable /// - /// Dispose method of IDisposable interface. + /// Dispose method of IDisposable interface. /// public void Dispose() { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/InvokeRestMethodCommand.Common.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/InvokeRestMethodCommand.Common.cs index f05930881..80743dcde 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/InvokeRestMethodCommand.Common.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/InvokeRestMethodCommand.Common.cs @@ -222,7 +222,7 @@ namespace Microsoft.PowerShell.Commands #endregion /// - /// enum for rest return type. + /// Enum for rest return type. /// public enum RestReturnType { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs index bbbe9a56b..51ab80e5f 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs @@ -60,7 +60,7 @@ namespace Microsoft.PowerShell.Commands public enum WebSslProtocol { /// - /// No SSL protocol will be set and the system defaults will be used. + /// No SSL protocol will be set and the system defaults will be used. /// Default = 0, @@ -70,7 +70,7 @@ namespace Microsoft.PowerShell.Commands Tls = SslProtocols.Tls, /// - /// Specifies the TLS 1.1 security protocol. The TLS protocol is defined in IETF RFC 4346. + /// Specifies the TLS 1.1 security protocol. The TLS protocol is defined in IETF RFC 4346. /// Tls11 = SslProtocols.Tls11, @@ -1445,7 +1445,7 @@ namespace Microsoft.PowerShell.Commands #region Overrides /// - /// the main execution method for cmdlets derived from WebRequestPSCmdlet. + /// The main execution method for cmdlets derived from WebRequestPSCmdlet. /// protected override void ProcessRecord() { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertFromJsonCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertFromJsonCommand.cs index f08d182bc..95ef144b4 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertFromJsonCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertFromJsonCommand.cs @@ -41,7 +41,7 @@ namespace Microsoft.PowerShell.Commands #region overrides /// - /// Buffers InputObjet contents available in the pipeline. + /// Buffers InputObjet contents available in the pipeline. /// protected override void ProcessRecord() { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs index b18e8072e..d179a8c4f 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs @@ -48,7 +48,7 @@ namespace Microsoft.PowerShell.Commands public int Depth { get { return _depth; } set { _depth = value; } } /// - /// gets or sets the Compress property. + /// Gets or sets the Compress property. /// If the Compress property is set to be true, the Json string will /// be output in the compressed way. Otherwise, the Json string will /// be output with indentations. @@ -57,7 +57,7 @@ namespace Microsoft.PowerShell.Commands public SwitchParameter Compress { get; set; } /// - /// gets or sets the EnumsAsStrings property. + /// Gets or sets the EnumsAsStrings property. /// If the EnumsAsStrings property is set to true, enum values will /// be converted to their string equivalent. Otherwise, enum values /// will be converted to their numeric equivalent. diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/WebRequestMethod.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/WebRequestMethod.cs index 2bbdaaaf2..1ed35bd95 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/WebRequestMethod.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/WebRequestMethod.cs @@ -4,7 +4,7 @@ namespace Microsoft.PowerShell.Commands { /// - /// enums for web request method. + /// Enums for web request method. /// public enum WebRequestMethod { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/convert-HTML.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/convert-HTML.cs index e338f10e3..89debd225 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/convert-HTML.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/convert-HTML.cs @@ -751,7 +751,7 @@ namespace Microsoft.PowerShell.Commands #region private /// - /// list of incoming objects to compare. + /// List of incoming objects to compare. /// private bool _isTHWritten; private StringCollection _propertyCollector; diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/new-object.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/new-object.cs index 9ea4889df..a8cee4d5d 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/new-object.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/new-object.cs @@ -58,7 +58,7 @@ namespace Microsoft.PowerShell.Commands // Updated from Hashtable to IDictionary to support the work around ordered hashtables. /// - /// gets the properties to be set. + /// Gets the properties to be set. /// [Parameter] [ValidateTrustedData] diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs index 66601dfff..c372985ec 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs @@ -409,7 +409,7 @@ namespace Microsoft.PowerShell.Commands public sealed class ThrowErrorCommand : WriteOrThrowErrorCommand { /// - /// constructor. + /// Constructor. /// public ThrowErrorCommand() { diff --git a/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs b/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs index 1f162b94a..2040c905a 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs @@ -19,7 +19,7 @@ namespace Microsoft.PowerShell public Guid FormatId { get; } /// - /// Property identifier (PID) + /// Property identifier (PID) /// public Int32 PropertyId { get; } diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs index b54d5b746..b9f323ef4 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs @@ -625,7 +625,7 @@ namespace Microsoft.PowerShell #region Mode /// - /// flags used by ConsoleControl.GetMode and ConsoleControl.SetMode. + /// Flags used by ConsoleControl.GetMode and ConsoleControl.SetMode. /// [Flags] internal enum ConsoleModes : uint @@ -961,7 +961,7 @@ namespace Microsoft.PowerShell } /// - /// set the output buffer's size. + /// Set the output buffer's size. /// /// /// diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs index fa6f0970a..749c1ede1 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs @@ -57,7 +57,7 @@ namespace Microsoft.PowerShell // NTRAID#Windows Out Of Band Releases-915506-2005/09/09 // Removed HandleUnexpectedExceptions infrastructure /// - /// internal Entry point in msh console host implementation. + /// Internal Entry point in msh console host implementation. /// /// /// Banner text to be displayed by ConsoleHost @@ -2046,12 +2046,12 @@ namespace Microsoft.PowerShell } /// - /// raised when the host pops a runspace. + /// Raised when the host pops a runspace. /// internal event EventHandler RunspacePopped; /// - /// raised when the host pushes a runspace. + /// Raised when the host pushes a runspace. /// internal event EventHandler RunspacePushed; diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostRawUserInterface.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostRawUserInterface.cs index df66ecf0c..9026739db 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostRawUserInterface.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostRawUserInterface.cs @@ -20,7 +20,7 @@ using DWORD = System.UInt32; namespace Microsoft.PowerShell { /// - /// implementation of RawConsole for powershell. + /// Implementation of RawConsole for powershell. /// internal sealed diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs index e62ba8884..d735428d1 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs @@ -122,7 +122,7 @@ namespace Microsoft.PowerShell // } /// - /// true if command completion is currently running. + /// True if command completion is currently running. /// internal bool IsCommandCompletionRunning @@ -135,13 +135,13 @@ namespace Microsoft.PowerShell } /// - /// true if the Read* functions should read from the stdin stream instead of from the win32 console. + /// True if the Read* functions should read from the stdin stream instead of from the win32 console. /// internal bool ReadFromStdin { get; set; } /// - /// true if the host shouldn't write out prompts. + /// True if the host shouldn't write out prompts. /// internal bool NoPrompt { get; set; } diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/Serialization.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/Serialization.cs index 82e293776..d65c545a3 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/Serialization.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/Serialization.cs @@ -25,7 +25,7 @@ namespace Microsoft.PowerShell internal enum DataFormat { /// - /// text format -- i.e. stream text just as out-default would display it. + /// Text format -- i.e. stream text just as out-default would display it. /// Text = 0, diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/Telemetry.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/Telemetry.cs index 835844b9c..0a827ba10 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/Telemetry.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/Telemetry.cs @@ -15,7 +15,7 @@ using System.IO; namespace Microsoft.PowerShell { /// - /// send up telemetry for startup. + /// Send up telemetry for startup. /// internal static class ApplicationInsightsTelemetry { diff --git a/src/Microsoft.PowerShell.CoreCLR.Eventing/DotNetCode/Eventing/Reader/EventLogPropertySelector.cs b/src/Microsoft.PowerShell.CoreCLR.Eventing/DotNetCode/Eventing/Reader/EventLogPropertySelector.cs index f1ba68016..b86ba48ac 100644 --- a/src/Microsoft.PowerShell.CoreCLR.Eventing/DotNetCode/Eventing/Reader/EventLogPropertySelector.cs +++ b/src/Microsoft.PowerShell.CoreCLR.Eventing/DotNetCode/Eventing/Reader/EventLogPropertySelector.cs @@ -18,9 +18,9 @@ using System.Collections.Generic; namespace System.Diagnostics.Eventing.Reader { /// - /// Encapsulates the information for fast access to Event Values - /// of an EventLogRecord. An instance of this class is constructed - /// and then passed to EventLogRecord.GetEventPropertyValues. + /// Encapsulates the information for fast access to Event Values + /// of an EventLogRecord. An instance of this class is constructed + /// and then passed to EventLogRecord.GetEventPropertyValues. /// public class EventLogPropertySelector : IDisposable { diff --git a/src/Microsoft.PowerShell.CoreCLR.Eventing/DotNetCode/Eventing/Reader/EventLogReader.cs b/src/Microsoft.PowerShell.CoreCLR.Eventing/DotNetCode/Eventing/Reader/EventLogReader.cs index ef1e27929..372e7ab89 100644 --- a/src/Microsoft.PowerShell.CoreCLR.Eventing/DotNetCode/Eventing/Reader/EventLogReader.cs +++ b/src/Microsoft.PowerShell.CoreCLR.Eventing/DotNetCode/Eventing/Reader/EventLogReader.cs @@ -30,7 +30,7 @@ namespace System.Diagnostics.Eventing.Reader private EventLogHandle _handle; /// - /// events buffer holds batched event (handles). + /// Events buffer holds batched event (handles). /// private IntPtr[] _eventsBuffer; /// diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs index 17ce54711..724954f50 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs @@ -402,8 +402,8 @@ namespace Microsoft.PowerShell.ScheduledJob } /// - /// Returns the directory path for job run output for the specified - /// scheduled job definition. + /// Returns the directory path for job run output for the specified + /// scheduled job definition. /// /// Definition name. /// Directory Path. diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs index 6f68cb8d8..755617afb 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs @@ -73,7 +73,7 @@ namespace Microsoft.PowerShell.ScheduledJob } /// - /// Trigger frequency. + /// Trigger frequency. /// public TriggerFrequency Frequency { diff --git a/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs b/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs index 660e50d23..10bc7d822 100644 --- a/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs +++ b/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs @@ -41,7 +41,7 @@ namespace Microsoft.PowerShell.Commands internal sealed class CertificateProviderCodeSigningDynamicParameters { /// - /// switch that controls whether we only return + /// Switch that controls whether we only return /// code signing certs. /// [Parameter()] @@ -63,7 +63,7 @@ namespace Microsoft.PowerShell.Commands public struct DnsNameRepresentation { /// - /// punycode version of DNS name. + /// Punycode version of DNS name. /// private string _punycodeName; @@ -73,7 +73,7 @@ namespace Microsoft.PowerShell.Commands private string _unicodeName; /// - /// ambiguous constructor of a DnsNameRepresentation. + /// Ambiguous constructor of a DnsNameRepresentation. /// public DnsNameRepresentation(string inputDnsName) { @@ -82,7 +82,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// specific constructor of a DnsNameRepresentation. + /// Specific constructor of a DnsNameRepresentation. /// [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Punycode")] public DnsNameRepresentation( @@ -94,7 +94,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// value comparison. + /// Value comparison. /// public bool Equals(DnsNameRepresentation dnsName) { @@ -119,7 +119,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// get property of Punycode. + /// Get property of Punycode. /// [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Punycode")] public string Punycode @@ -131,7 +131,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// get property of Unicode. + /// Get property of Unicode. /// public string Unicode { @@ -142,7 +142,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// get display string. + /// Get display string. /// public override string ToString() { @@ -166,7 +166,7 @@ namespace Microsoft.PowerShell.Commands internal sealed class ProviderRemoveItemDynamicParameters { /// - /// switch that controls whether we should delete private key + /// Switch that controls whether we should delete private key /// when remove a certificate. /// [Parameter()] @@ -405,7 +405,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// native IntPtr store handle. + /// Native IntPtr store handle. /// public IntPtr StoreHandle @@ -428,7 +428,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// string store name. + /// String store name. /// public string StoreName { @@ -439,7 +439,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// true if a real store is open. + /// True if a real store is open. /// public bool Valid @@ -502,7 +502,7 @@ namespace Microsoft.PowerShell.Commands #region tracer /// - /// tracer for certificate provider. + /// Tracer for certificate provider. /// [TraceSource("CertificateProvider", "The core command provider for certificates")] @@ -517,21 +517,21 @@ namespace Microsoft.PowerShell.Commands private bool _hasAttemptedToLoadPkiModule = false; /// - /// lock that guards access to the following static members + /// Lock that guards access to the following static members /// -- storeLocations /// -- pathCache. /// private static object s_staticLock = new object(); /// - /// list of store locations. They do not change once initialized. + /// List of store locations. They do not change once initialized. /// /// Synchronized on staticLock. /// private static List s_storeLocations = null; /// - /// cache that stores paths and their associated objects. + /// Cache that stores paths and their associated objects. /// /// key is full path to store-location/store/certificate /// value is X509StoreLocation/X509NativeStore/X509Certificate2 object @@ -541,12 +541,12 @@ namespace Microsoft.PowerShell.Commands private static Hashtable s_pathCache = null; /// - /// we allow either / or \ to be the path separator. + /// We allow either / or \ to be the path separator. /// private static readonly char[] s_pathSeparators = new char[] { '/', '\\' }; /// - /// regex pattern that defines a valid cert path. + /// Regex pattern that defines a valid cert path. /// private const string certPathPattern = @"^\\((?CurrentUser|LocalMachine)(\\(?[a-zA-Z]+)(\\(?[0-9a-f]{40}))?)?)?$"; @@ -1939,7 +1939,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// fetches the store-location/store/certificate at the + /// Fetches the store-location/store/certificate at the /// specified path. /// /// Path to the item. @@ -2357,7 +2357,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// get the name of the specified certificate. + /// Get the name of the specified certificate. /// /// /// Cert name . @@ -2423,7 +2423,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// get X509StoreLocation object at path. + /// Get X509StoreLocation object at path. /// /// /// X509StoreLocation object. @@ -2445,7 +2445,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// get the X509NativeStore object at path. + /// Get the X509NativeStore object at path. /// /// Path to store. /// True if this should be a test for path existence. Returns True or False. @@ -2472,7 +2472,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// gets the X509NativeStore at the specified path. + /// Gets the X509NativeStore at the specified path. /// Adds to cache if not already there. /// /// Path to the store. @@ -2509,7 +2509,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// gets X509NativeStore objects or their name at the specified path. + /// Gets X509NativeStore objects or their name at the specified path. /// /// Path to the store. /// Recursively return all items if true. @@ -2900,7 +2900,7 @@ namespace Microsoft.PowerShell.Commands private string _oid; /// - /// constructor of an EnhancedKeyUsageRepresentation. + /// Constructor of an EnhancedKeyUsageRepresentation. /// [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Oid")] @@ -2912,7 +2912,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// value comparison. + /// Value comparison. /// public bool Equals(EnhancedKeyUsageRepresentation keyUsage) { @@ -2936,7 +2936,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// get property of friendlyName. + /// Get property of friendlyName. /// public string FriendlyName { @@ -2947,7 +2947,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// get property of oid. + /// Get property of oid. /// public string ObjectId { @@ -2958,7 +2958,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// get display string. + /// Get display string. /// public override string ToString() { @@ -2969,14 +2969,14 @@ namespace Microsoft.PowerShell.Commands } /// - /// class for SendAsTrustedIssuer. + /// Class for SendAsTrustedIssuer. /// [SuppressMessage("Microsoft.Design", "CA1053:StaticHolderTypesShouldNotHaveConstructors")] public sealed class SendAsTrustedIssuerProperty { /// - /// get property of SendAsTrustedIssuer. + /// Get property of SendAsTrustedIssuer. /// [SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] @@ -3012,7 +3012,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// set property of SendAsTrustedIssuer. + /// Set property of SendAsTrustedIssuer. /// [SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] @@ -3125,7 +3125,7 @@ namespace Microsoft.PowerShell.Commands } } /// - /// class for ekulist. + /// Class for ekulist. /// public sealed class EnhancedKeyUsageProperty @@ -3133,7 +3133,7 @@ namespace Microsoft.PowerShell.Commands private List _ekuList = new List(); /// - /// get property of EKUList. + /// Get property of EKUList. /// public List EnhancedKeyUsageList { @@ -3144,7 +3144,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// constructor for EnhancedKeyUsageProperty. + /// Constructor for EnhancedKeyUsageProperty. /// public EnhancedKeyUsageProperty(X509Certificate2 cert) { @@ -3169,7 +3169,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// class for DNSNameList. + /// Class for DNSNameList. /// public sealed class DnsNameProperty @@ -3180,7 +3180,7 @@ namespace Microsoft.PowerShell.Commands private const string distinguishedNamePrefix = "CN="; /// - /// get property of DnsNameList. + /// Get property of DnsNameList. /// public List DnsNameList { @@ -3191,7 +3191,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// constructor for EkuList. + /// Constructor for EkuList. /// public DnsNameProperty(X509Certificate2 cert) { @@ -3258,7 +3258,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// downlevel helper function to determine if the OS is WIN8 and above. + /// Downlevel helper function to determine if the OS is WIN8 and above. /// internal static class DownLevelHelper { @@ -3372,12 +3372,12 @@ namespace Microsoft.PowerShell.Commands } /// - /// container for helper functions that use pinvoke into crypt32.dll. + /// Container for helper functions that use pinvoke into crypt32.dll. /// internal static class Crypt32Helpers { /// - /// lock that guards access to the following static members + /// Lock that guards access to the following static members /// -- storeNames. /// private static object s_staticLock = new object(); @@ -3385,7 +3385,7 @@ namespace Microsoft.PowerShell.Commands internal static List storeNames = new List(); /// - /// get a list of store names at the specified location. + /// Get a list of store names at the specified location. /// [ArchitectureSensitive] internal static List GetStoreNamesAtLocation(StoreLocation location) @@ -3430,7 +3430,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// call back function used by CertEnumSystemStore + /// Call back function used by CertEnumSystemStore /// /// Currently, there is no managed support for enumerating store /// names on a machine. We use the win32 function CertEnumSystemStore() diff --git a/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs b/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs index 70f33308f..029eba8bc 100644 --- a/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs +++ b/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs @@ -602,7 +602,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// association between SigningOption.* values and the + /// Association between SigningOption.* values and the /// corresponding string names. /// private static readonly SigningOptionInfo[] s_sigOptionInfo = @@ -613,7 +613,7 @@ namespace Microsoft.PowerShell.Commands }; /// - /// get SigningOption value corresponding to a string name. + /// Get SigningOption value corresponding to a string name. /// /// Name of option. /// SigningOption. diff --git a/src/Microsoft.PowerShell.Security/security/Utils.cs b/src/Microsoft.PowerShell.Security/security/Utils.cs index 92af1f454..75481ff29 100644 --- a/src/Microsoft.PowerShell.Security/security/Utils.cs +++ b/src/Microsoft.PowerShell.Security/security/Utils.cs @@ -13,7 +13,7 @@ namespace Microsoft.PowerShell internal static class SecurityUtils { /// - /// gets the size of a file. + /// Gets the size of a file. /// /// Path to file. /// File size. @@ -30,7 +30,7 @@ namespace Microsoft.PowerShell } /// - /// present a prompt for a SecureString data. + /// Present a prompt for a SecureString data. /// /// Ref to host ui interface. /// Prompt text. @@ -143,7 +143,7 @@ namespace Microsoft.PowerShell } /// - /// convert the specified provider path to a provider path + /// Convert the specified provider path to a provider path /// and make sure that all of the following is true: /// -- it represents a FileSystem path /// -- it points to a file diff --git a/src/Microsoft.WSMan.Management/ConfigProvider.cs b/src/Microsoft.WSMan.Management/ConfigProvider.cs index 7f3faf4a1..237c3eb11 100644 --- a/src/Microsoft.WSMan.Management/ConfigProvider.cs +++ b/src/Microsoft.WSMan.Management/ConfigProvider.cs @@ -1968,7 +1968,7 @@ namespace Microsoft.WSMan.Management #region Private /// - /// this method creates the connection to new machine in wsman provider. + /// This method creates the connection to new machine in wsman provider. /// This is called from New-Item. /// /// @@ -2004,7 +2004,7 @@ namespace Microsoft.WSMan.Management } /// - /// this method creates the Listener or ClientCertificate in wsman provider. + /// This method creates the Listener or ClientCertificate in wsman provider. /// This is called from New-Item. /// /// @@ -2050,7 +2050,7 @@ namespace Microsoft.WSMan.Management } /// - /// this method creates the Plugin and its child items in wsman provider. + /// This method creates the Plugin and its child items in wsman provider. /// This is called from New-Item. /// /// @@ -4147,7 +4147,7 @@ namespace Microsoft.WSMan.Management } /// - /// for the recurse operation of Get-ChildItems. + /// For the recurse operation of Get-ChildItems. /// /// /// @@ -6378,7 +6378,7 @@ namespace Microsoft.WSMan.Management internal const string containerWinrs = "Winrs"; /// - /// certmapping Container - Exposed as ClientCertificate in the provider. + /// Certmapping Container - Exposed as ClientCertificate in the provider. /// internal const string containerCertMapping = "Service/certmapping"; diff --git a/src/Microsoft.WSMan.Management/CredSSP.cs b/src/Microsoft.WSMan.Management/CredSSP.cs index d1ce79c6a..765a21a74 100644 --- a/src/Microsoft.WSMan.Management/CredSSP.cs +++ b/src/Microsoft.WSMan.Management/CredSSP.cs @@ -336,7 +336,7 @@ namespace Microsoft.WSMan.Management } #endregion private /// - /// begin processing method. + /// Begin processing method. /// protected override void BeginProcessing() { @@ -357,7 +357,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -367,7 +367,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void @@ -401,7 +401,7 @@ namespace Microsoft.WSMan.Management public class EnableWSManCredSSPCommand : WSManCredSSPCommandBase, IDisposable/*, IDynamicParameters*/ { /// - /// delegate parameter. + /// Delegate parameter. /// [Parameter(Position = 1)] [ValidateNotNullOrEmpty] @@ -709,7 +709,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -718,7 +718,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void @@ -755,7 +755,7 @@ namespace Microsoft.WSMan.Management #region private WSManHelper helper = null; /// - /// method to get the values. + /// Method to get the values. /// private string GetDelegateSettings(string applicationname) { @@ -909,7 +909,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -918,7 +918,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void diff --git a/src/Microsoft.WSMan.Management/InvokeWSManAction.cs b/src/Microsoft.WSMan.Management/InvokeWSManAction.cs index 0b94aab52..67d2cc8ef 100644 --- a/src/Microsoft.WSMan.Management/InvokeWSManAction.cs +++ b/src/Microsoft.WSMan.Management/InvokeWSManAction.cs @@ -309,7 +309,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -319,7 +319,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void diff --git a/src/Microsoft.WSMan.Management/PingWSMan.cs b/src/Microsoft.WSMan.Management/PingWSMan.cs index 14305dbe1..8f14c8ec9 100644 --- a/src/Microsoft.WSMan.Management/PingWSMan.cs +++ b/src/Microsoft.WSMan.Management/PingWSMan.cs @@ -178,7 +178,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -188,7 +188,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void diff --git a/src/Microsoft.WSMan.Management/Set-QuickConfig.cs b/src/Microsoft.WSMan.Management/Set-QuickConfig.cs index 12df9676d..5525599f8 100644 --- a/src/Microsoft.WSMan.Management/Set-QuickConfig.cs +++ b/src/Microsoft.WSMan.Management/Set-QuickConfig.cs @@ -268,7 +268,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -278,7 +278,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void diff --git a/src/Microsoft.WSMan.Management/WSManConnections.cs b/src/Microsoft.WSMan.Management/WSManConnections.cs index 2ab8354fd..a0f5e931c 100644 --- a/src/Microsoft.WSMan.Management/WSManConnections.cs +++ b/src/Microsoft.WSMan.Management/WSManConnections.cs @@ -111,7 +111,7 @@ namespace Microsoft.WSMan.Management #region Connect-WsMan /// - /// connect wsman cmdlet. + /// Connect wsman cmdlet. /// [Cmdlet(VerbsCommunications.Connect, "WSMan", DefaultParameterSetName = "ComputerName", HelpUri = "https://go.microsoft.com/fwlink/?LinkId=141437")] public class ConnectWSManCommand : AuthenticatingWSManCommand @@ -325,7 +325,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -335,7 +335,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void diff --git a/src/Microsoft.WSMan.Management/WSManInstance.cs b/src/Microsoft.WSMan.Management/WSManInstance.cs index 069140307..5ab3e64b1 100644 --- a/src/Microsoft.WSMan.Management/WSManInstance.cs +++ b/src/Microsoft.WSMan.Management/WSManInstance.cs @@ -598,7 +598,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -608,7 +608,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void @@ -974,7 +974,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -984,7 +984,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void @@ -1257,7 +1257,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -1267,7 +1267,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void @@ -1566,7 +1566,7 @@ namespace Microsoft.WSMan.Management #region IDisposable Members /// - /// public dispose method. + /// Public dispose method. /// public void @@ -1576,7 +1576,7 @@ namespace Microsoft.WSMan.Management GC.SuppressFinalize(this); } /// - /// public dispose method. + /// Public dispose method. /// public void diff --git a/src/Microsoft.WSMan.Management/WsManHelper.cs b/src/Microsoft.WSMan.Management/WsManHelper.cs index 782b4f54f..ce871b4f6 100644 --- a/src/Microsoft.WSMan.Management/WsManHelper.cs +++ b/src/Microsoft.WSMan.Management/WsManHelper.cs @@ -91,7 +91,7 @@ namespace Microsoft.WSMan.Management internal class Sessions { /// - /// dictionary object to store the connection. + /// Dictionary object to store the connection. /// internal static Dictionary SessionObjCache = new Dictionary(); @@ -200,7 +200,7 @@ namespace Microsoft.WSMan.Management } /// - /// add a session to dictionary. + /// Add a session to dictionary. /// /// Connection string. /// Session object. diff --git a/src/Microsoft.WSMan.Runtime/WSManSessionOption.cs b/src/Microsoft.WSMan.Runtime/WSManSessionOption.cs index 350f294d4..8fbb84e3a 100644 --- a/src/Microsoft.WSMan.Runtime/WSManSessionOption.cs +++ b/src/Microsoft.WSMan.Runtime/WSManSessionOption.cs @@ -28,7 +28,7 @@ namespace Microsoft.WSMan.Management { /// - /// property. + /// Property. /// public bool SkipCACheck { @@ -43,7 +43,7 @@ namespace Microsoft.WSMan.Management private bool _SkipCACheck; /// - /// property. + /// Property. /// public bool SkipCNCheck { @@ -58,7 +58,7 @@ namespace Microsoft.WSMan.Management private bool _SkipCNCheck; /// - /// property. + /// Property. /// public bool SkipRevocationCheck { @@ -74,7 +74,7 @@ namespace Microsoft.WSMan.Management private bool _SkipRevocationCheck; /// - /// property. + /// Property. /// public bool UseEncryption { @@ -89,7 +89,7 @@ namespace Microsoft.WSMan.Management private bool _useencryption = true; /// - /// property. + /// Property. /// public bool UseUtf16 { @@ -104,7 +104,7 @@ namespace Microsoft.WSMan.Management private bool _UTF16; /// - /// property. + /// Property. /// public ProxyAuthentication ProxyAuthentication { @@ -119,7 +119,7 @@ namespace Microsoft.WSMan.Management private ProxyAuthentication _ProxyAuthentication; /// - /// property. + /// Property. /// [SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "SPN")] public int SPNPort @@ -135,7 +135,7 @@ namespace Microsoft.WSMan.Management private int _SPNPort; /// - /// property. + /// Property. /// public int OperationTimeout { @@ -150,7 +150,7 @@ namespace Microsoft.WSMan.Management private int _OperationTimeout; /// - /// property. + /// Property. /// public NetworkCredential ProxyCredential { @@ -165,7 +165,7 @@ namespace Microsoft.WSMan.Management private NetworkCredential _ProxyCredential; /// - /// property. + /// Property. /// public ProxyAccessType ProxyAccessType { @@ -181,45 +181,45 @@ namespace Microsoft.WSMan.Management } /// - /// property. + /// Property. /// public enum ProxyAccessType { /// - /// property. + /// Property. /// ProxyIEConfig = 0, /// - /// property. + /// Property. /// ProxyWinHttpConfig = 1, /// - /// property. + /// Property. /// ProxyAutoDetect = 2, /// - /// property. + /// Property. /// ProxyNoProxyServer = 3 } /// - /// property. + /// Property. /// [SuppressMessage("Microsoft.Design", "CA1027:MarkEnumsWithFlags")] [SuppressMessage("Microsoft.Design", "CA1008:EnumsShouldHaveZeroValue")] public enum ProxyAuthentication { /// - /// property. + /// Property. /// Negotiate = 1, /// - /// property. + /// Property. /// Basic = 2, /// - /// property. + /// Property. /// Digest = 4 } diff --git a/src/System.Management.Automation/CoreCLR/CorePsPlatform.cs b/src/System.Management.Automation/CoreCLR/CorePsPlatform.cs index a44d9229d..e79713b1c 100644 --- a/src/System.Management.Automation/CoreCLR/CorePsPlatform.cs +++ b/src/System.Management.Automation/CoreCLR/CorePsPlatform.cs @@ -231,7 +231,7 @@ namespace System.Management.Automation } /// - /// function for choosing directory location of PowerShell for profile loading. + /// Function for choosing directory location of PowerShell for profile loading. /// public static string SelectProductNameForDirectory(Platform.XDG_Type dirpath) { diff --git a/src/System.Management.Automation/DscSupport/CimDSCParser.cs b/src/System.Management.Automation/DscSupport/CimDSCParser.cs index 34e809d16..8e0586ab3 100644 --- a/src/System.Management.Automation/DscSupport/CimDSCParser.cs +++ b/src/System.Management.Automation/DscSupport/CimDSCParser.cs @@ -282,7 +282,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration public sealed class ArgumentToConfigurationDataTransformationAttribute : ArgumentTransformationAttribute { /// - /// convert a file of ConfigurationData into a hashtable. + /// Convert a file of ConfigurationData into a hashtable. /// /// /// @@ -985,7 +985,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal } /// - /// get text from SecureString. + /// Get text from SecureString. /// /// Value of SecureString. /// Decoded string. @@ -1477,7 +1477,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal } /// - /// update range restriction for meta configuration keywords + /// Update range restriction for meta configuration keywords /// the restrictions are for /// ConfigurationModeFrequency: 15-44640 /// RefreshFrequency: 30-44640. @@ -3306,7 +3306,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal } /// - /// if a partial configuration is in 'Pull' Mode, it needs a configuration source. + /// If a partial configuration is in 'Pull' Mode, it needs a configuration source. /// /// /// @@ -3334,7 +3334,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal } /// - /// Returns an error record to use in the case of a malformed resource reference in the DependsOn list. + /// Returns an error record to use in the case of a malformed resource reference in the DependsOn list. /// /// The duplicate resource identifier. /// The node being defined. @@ -3441,7 +3441,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal } /// - /// Return an error to indicate a value is out of range for a dynamic keyword property. + /// Return an error to indicate a value is out of range for a dynamic keyword property. /// /// /// diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs index 710de2a85..19be44842 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs @@ -10,7 +10,7 @@ using System.Management.Automation.Language; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// facade class to provide context information to process + /// Facade class to provide context information to process /// exceptions. /// internal sealed class TerminatingErrorContext @@ -31,7 +31,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper class to invoke a command in a secondary pipeline. + /// Helper class to invoke a command in a secondary pipeline. /// NOTE: this implementation does not return any error messages /// that invoked pipelines might generate. /// @@ -51,7 +51,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// add a parameter to the command invocation. + /// Add a parameter to the command invocation. /// It needs to be called before any execution takes place. /// /// Name of the parameter. @@ -66,7 +66,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// send an object to the pipeline. + /// Send an object to the pipeline. /// /// Object to process. /// Array of objects out of the success pipeline. @@ -83,7 +83,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// shut down the pipeline. + /// Shut down the pipeline. /// /// Array of objects out of the success pipeline. internal Array ShutDown() @@ -118,7 +118,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// just dispose the pipeline processor. + /// Just dispose the pipeline processor. /// public void Dispose() { @@ -139,7 +139,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// base class for the command-let's we expose + /// Base class for the command-let's we expose /// it contains a reference to the implementation /// class it wraps. /// @@ -155,7 +155,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #endregion /// - /// hook up the calls from the implementation object + /// Hook up the calls from the implementation object /// and then call the implementation's Begin() /// protected override void BeginProcessing() @@ -171,7 +171,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// call the implementation. + /// Call the implementation. /// protected override void ProcessRecord() { @@ -179,7 +179,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// call the implementation. + /// Call the implementation. /// protected override void EndProcessing() { @@ -187,7 +187,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// call the implementation. + /// Call the implementation. /// protected override void StopProcessing() { @@ -195,7 +195,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// callback for the implementation to obtain a reference to the Cmdlet object. + /// Callback for the implementation to obtain a reference to the Cmdlet object. /// /// Cmdlet reference. protected virtual PSCmdlet OuterCmdletCall() @@ -204,7 +204,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// callback for the implementation to get the current pipeline object. + /// Callback for the implementation to get the current pipeline object. /// /// Current object from the pipeline. protected virtual PSObject InputObjectCall() @@ -214,7 +214,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// callback for the implementation to write objects. + /// Callback for the implementation to write objects. /// /// Object to be written. protected virtual void WriteObjectCall(object value) @@ -224,7 +224,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// reference to the implementation command that this class + /// Reference to the implementation command that this class /// is wrapping. /// internal ImplementationCommandBase implementation = null; @@ -232,7 +232,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region IDisposable Implementation /// - /// default implementation just delegates to internal helper. + /// Default implementation just delegates to internal helper. /// /// This method calls GC.SuppressFinalize public void Dispose() @@ -269,41 +269,41 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// implementation class to be called by the outer command + /// Implementation class to be called by the outer command /// In order to properly work, the callbacks have to be properly set by the outer command. /// internal class ImplementationCommandBase : IDisposable { /// - /// inner version of CommandBase.BeginProcessing() + /// Inner version of CommandBase.BeginProcessing() /// internal virtual void BeginProcessing() { } /// - /// inner version of CommandBase.ProcessRecord() + /// Inner version of CommandBase.ProcessRecord() /// internal virtual void ProcessRecord() { } /// - /// inner version of CommandBase.EndProcessing() + /// Inner version of CommandBase.EndProcessing() /// internal virtual void EndProcessing() { } /// - /// inner version of CommandBase.StopProcessing() + /// Inner version of CommandBase.StopProcessing() /// internal virtual void StopProcessing() { } /// - /// retrieve the current input pipeline object. + /// Retrieve the current input pipeline object. /// internal virtual PSObject ReadObject() { @@ -313,7 +313,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write an object to the pipeline. + /// Write an object to the pipeline. /// /// Object to write to the pipeline. internal virtual void WriteObject(object o) @@ -325,7 +325,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format // callback methods to get to the outer Monad Cmdlet /// - /// get a hold of the Monad outer Cmdlet. + /// Get a hold of the Monad outer Cmdlet. /// /// internal virtual PSCmdlet OuterCmdlet() @@ -343,40 +343,40 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// delegate definition to get to the outer command-let. + /// Delegate definition to get to the outer command-let. /// internal delegate PSCmdlet OuterCmdletCallback(); /// - /// callback to get to the outer command-let. + /// Callback to get to the outer command-let. /// internal OuterCmdletCallback OuterCmdletCall; // callback to the methods to get an object and write an object /// - /// delegate definition to get to the current pipeline input object. + /// Delegate definition to get to the current pipeline input object. /// internal delegate PSObject InputObjectCallback(); /// - /// delegate definition to write object. + /// Delegate definition to write object. /// internal delegate void WriteObjectCallback(object o); /// - /// callback to read object. + /// Callback to read object. /// internal InputObjectCallback InputObjectCall; /// - /// callback to write object. + /// Callback to write object. /// internal WriteObjectCallback WriteObjectCall; #region IDisposable Implementation /// - /// default implementation just delegates to internal helper. + /// Default implementation just delegates to internal helper. /// /// This method calls GC.SuppressFinalize public void Dispose() diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs index 452c9e0b8..e95aa8da3 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs @@ -19,7 +19,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal class InnerFormatShapeCommandBase : ImplementationCommandBase { /// - /// constructor to set up the formatting context. + /// Constructor to set up the formatting context. /// internal InnerFormatShapeCommandBase() { @@ -27,24 +27,24 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// enum listing the possible states the context is in. + /// Enum listing the possible states the context is in. /// internal enum FormattingContextState { none, document, group } /// - /// context manager: stack to keep track in which context + /// Context manager: stack to keep track in which context /// the formatter is. /// protected Stack contextManager = new Stack(); } /// - /// core inner implementation for format/xxx commands. + /// Core inner implementation for format/xxx commands. /// internal class InnerFormatShapeCommand : InnerFormatShapeCommandBase { /// - /// constructor to glue to the CRO. + /// Constructor to glue to the CRO. /// internal InnerFormatShapeCommand(FormatShape shape) { @@ -89,7 +89,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// execution entry point. + /// Execution entry point. /// internal override void ProcessRecord() { @@ -201,7 +201,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// execute formatting on a single object. + /// Execute formatting on a single object. /// /// Object to process. private void ProcessObject(PSObject so) @@ -418,7 +418,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// group transitions: + /// Group transitions: /// none: stay in the same group /// enter: start a new group /// exit: exit from the current group. @@ -426,7 +426,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private enum GroupTransition { none, enter, exit, startNew } /// - /// compute the group transition, given an input object. + /// Compute the group transition, given an input object. /// /// Object received from the input pipeline. /// GroupTransition enumeration. @@ -455,7 +455,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write a payplad object by properly wrapping it into + /// Write a payplad object by properly wrapping it into /// a FormatEntry object. /// /// Object to process. @@ -471,7 +471,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// inject the start group information + /// Inject the start group information /// and push group context on stack. /// /// current pipeline object @@ -484,7 +484,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// inject the end group information + /// Inject the end group information /// and pop group context out of stack. /// private void PopGroup() @@ -495,7 +495,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// the formatting shape this formatter emits. + /// The formatting shape this formatter emits. /// private FormatShape _shape; @@ -529,21 +529,21 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region Command Line Switches /// - /// optional, non positional parameter to specify the + /// Optional, non positional parameter to specify the /// group by property. /// [Parameter] public object GroupBy { get; set; } = null; /// - /// optional, non positional parameter. + /// Optional, non positional parameter. /// /// [Parameter] public string View { get; set; } = null; /// - /// optional, non positional parameter. + /// Optional, non positional parameter. /// /// [Parameter] @@ -562,7 +562,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal bool? showErrorsAsMessages = null; /// - /// optional, non positional parameter. + /// Optional, non positional parameter. /// /// [Parameter] @@ -581,7 +581,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal bool? showErrorsInFormattedOutput = null; /// - /// optional, non positional parameter. + /// Optional, non positional parameter. /// /// [Parameter] @@ -595,7 +595,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private bool _forceFormattingAlsoOnOutOfBand; /// - /// optional, non positional parameter. + /// Optional, non positional parameter. /// /// [Parameter] @@ -663,7 +663,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// it reads the command line switches and collects them into a + /// It reads the command line switches and collects them into a /// FormattingCommandLineParameters instance, ready to pass to the /// inner format command. /// @@ -759,7 +759,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region Command Line Switches /// - /// optional, non positional parameter. + /// Optional, non positional parameter. /// /// [Parameter] @@ -784,7 +784,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format public SwitchParameter RepeatHeader { get; set; } /// - /// optional, non positional parameter. + /// Optional, non positional parameter. /// /// [Parameter] @@ -803,7 +803,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private bool? _hideHeaders = null; /// - /// optional, non positional parameter. + /// Optional, non positional parameter. /// /// [Parameter] diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommandParameters.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommandParameters.cs index b2155b8bb..861489638 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommandParameters.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommandParameters.cs @@ -25,22 +25,22 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal List mshParameterList = new List(); /// - /// name of the group by property, it can be null. + /// Name of the group by property, it can be null. /// internal MshParameter groupByParameter = null; /// - /// name of a view from format.ps1xml, it can be null. + /// Name of a view from format.ps1xml, it can be null. /// internal string viewName = null; /// - /// flag to force a shape even on out of band objects. + /// Flag to force a shape even on out of band objects. /// internal bool forceFormattingAlsoOnOutOfBand = false; /// - /// autosize formatting flag. If true, the output command is instructed + /// Autosize formatting flag. If true, the output command is instructed /// to get the "best fit" for the device screen. /// internal bool? autosize = null; @@ -52,28 +52,28 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal bool repeatHeader = false; /// - /// errors are shown as out of band messages. + /// Errors are shown as out of band messages. /// internal bool? showErrorsAsMessages = null; /// - /// errors are shown in the formatted output. + /// Errors are shown in the formatted output. /// internal bool? showErrorsInFormattedOutput = null; /// - /// expand IEnumerable flag. + /// Expand IEnumerable flag. /// internal EnumerableExpansion? expansion = null; /// - /// extension mechanism for shape specific parameters. + /// Extension mechanism for shape specific parameters. /// internal ShapeSpecificParameters shapeParameters = null; } /// - /// class to derive from to pass shepe specific data. + /// Class to derive from to pass shepe specific data. /// internal abstract class ShapeSpecificParameters { @@ -93,7 +93,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal sealed class ComplexSpecificParameters : ShapeSpecificParameters { /// - /// options for class info display on objects. + /// Options for class info display on objects. /// internal enum ClassInfoDisplay { none, fullName, shortName } @@ -102,7 +102,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal const int maxDepthAllowable = 5; /// - /// max depth of recursion on sub objects. + /// Max depth of recursion on sub objects. /// internal int maxDepth = maxDepthAllowable; } @@ -112,7 +112,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region MshParameter metadata /// - /// specialized class for the "expression" property. + /// Specialized class for the "expression" property. /// internal class ExpressionEntryDefinition : HashtableEntryDefinition { @@ -413,7 +413,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// definitions for hash table keys. + /// Definitions for hash table keys. /// internal static class FormatParameterDefinitionKeys { diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs index 587984430..0b5e3c238 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs @@ -37,7 +37,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// execution entry point override + /// Execution entry point override /// we assume that a LineOutput interface instance already has been acquired /// /// IMPORTANT: it assumes the presence of a pre-processing formatting command. @@ -173,7 +173,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper to return what shape we have to use to format the output. + /// Helper to return what shape we have to use to format the output. /// private FormatShape ActiveFormattingShape { @@ -214,39 +214,39 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// enum describing the state for the output finite state machine. + /// Enum describing the state for the output finite state machine. /// private enum FormattingState { /// - /// we are in the clear state: no formatting in process. + /// We are in the clear state: no formatting in process. /// Reset, /// - /// we received a Format Start message, but we are not inside a group. + /// We received a Format Start message, but we are not inside a group. /// Formatting, /// - /// we are inside a group because we received a Group Start. + /// We are inside a group because we received a Group Start. /// InsideGroup } /// - /// toggle to signal if we are in a formatting sequence. + /// Toggle to signal if we are in a formatting sequence. /// private FormattingState _currentFormattingState = FormattingState.Reset; /// - /// instance of a command wrapper to execute the + /// Instance of a command wrapper to execute the /// default formatter when needed. /// private CommandWrapper _command; /// - /// enumeration to drive the preprocessing stage. + /// Enumeration to drive the preprocessing stage. /// private enum PreprocessingState { raw, processed, error } @@ -255,7 +255,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal const int StackAllocThreshold = 120; /// - /// test if an object coming from the pipeline needs to be + /// Test if an object coming from the pipeline needs to be /// preprocessed by the default formatter. /// /// Object to examine for formatting. @@ -362,7 +362,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// shunt object to the formatting pipeline for preprocessing. + /// Shunt object to the formatting pipeline for preprocessing. /// /// Object to be preprocessed. /// Array of objects returned by the preprocessing step. @@ -378,7 +378,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// class factory for output context. + /// Class factory for output context. /// /// Parent context in the stack. /// Fromat info data received from the pipeline. @@ -444,7 +444,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// callback for Fs processing. + /// Callback for Fs processing. /// /// The context containing the Fs entry. private void ProcessFormatStart(FormatMessagesContextManager.OutputContext c) @@ -454,7 +454,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// callback for Fe processing. + /// Callback for Fe processing. /// /// Fe notification message. /// Current context, with Fs in it. @@ -466,7 +466,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// callback for Gs processing. + /// Callback for Gs processing. /// /// The context containing the Gs entry. private void ProcessGroupStart(FormatMessagesContextManager.OutputContext c) @@ -487,7 +487,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// callback for Ge processing. + /// Callback for Ge processing. /// /// Ge notification message. /// Current context, with Gs in it. @@ -500,7 +500,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// process the current payload object. + /// Process the current payload object. /// /// FormatEntryData to process. /// Currently active context. @@ -591,7 +591,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// the screen host associated with this outputter. + /// The screen host associated with this outputter. /// private LineOutput _lo = null; @@ -616,7 +616,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// retrieve the active FormatOutputContext on the stack + /// Retrieve the active FormatOutputContext on the stack /// by walking up to the top of the stack. /// private FormatOutputContext FormatContext @@ -636,14 +636,14 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// context manager instance to guide the message traversal. + /// Context manager instance to guide the message traversal. /// private FormatMessagesContextManager _ctxManager = new FormatMessagesContextManager(); private FormattedObjectsCache _cache = null; /// - /// handler for processing the caching notification and responsible for + /// Handler for processing the caching notification and responsible for /// setting the value of the formatting hint. /// /// @@ -810,14 +810,14 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// base class for all the formatting hints. + /// Base class for all the formatting hints. /// private abstract class FormattingHint { } /// - /// hint for format-table. + /// Hint for format-table. /// private sealed class TableFormattingHint : FormattingHint { @@ -825,7 +825,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// hint for format-wide. + /// Hint for format-wide. /// private sealed class WideFormattingHint : FormattingHint { @@ -833,12 +833,12 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// variable holding the autosize hint (set by the caching code and reset by the hint consumer. + /// Variable holding the autosize hint (set by the caching code and reset by the hint consumer. /// private FormattingHint _formattingHint = null; /// - /// helper for consuming the formatting hint. + /// Helper for consuming the formatting hint. /// /// private FormattingHint RetrieveFormattingHint() @@ -851,12 +851,12 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private FormatObjectDeserializer _formatObjectDeserializer; /// - /// context for the outer scope of the format sequence. + /// Context for the outer scope of the format sequence. /// private class FormatOutputContext : FormatMessagesContextManager.OutputContext { /// - /// construct a context to push on the stack. + /// Construct a context to push on the stack. /// /// Parent context in the stack. /// Format data to put in the context. @@ -867,18 +867,18 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// retrieve the format data in the context. + /// Retrieve the format data in the context. /// internal FormatStartData Data { get; } = null; } /// - /// context for the currently active group. + /// Context for the currently active group. /// private abstract class GroupOutputContext : FormatMessagesContextManager.OutputContext { /// - /// construct a context to push on the stack. + /// Construct a context to push on the stack. /// internal GroupOutputContext(OutCommandInner cmd, FormatMessagesContextManager.OutputContext parentContext, @@ -890,32 +890,32 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// called at creation time, overrides will initialize here, e.g. + /// Called at creation time, overrides will initialize here, e.g. /// column widths, etc. /// internal virtual void Initialize() { } /// - /// called when a group of data is started, overridden will do + /// Called when a group of data is started, overridden will do /// things such as headers, etc... /// internal virtual void GroupStart() { } /// - /// called when the end of a group is reached, overrides will do + /// Called when the end of a group is reached, overrides will do /// things such as group footers. /// internal virtual void GroupEnd() { } /// - /// called when there is an entry to process, overrides will do + /// Called when there is an entry to process, overrides will do /// things such as writing a row in a table. /// /// FormatEntryData to process. internal virtual void ProcessPayload(FormatEntryData fed) { } /// - /// retrieve the format data in the context. + /// Retrieve the format data in the context. /// internal GroupStartData Data { get; } = null; @@ -925,7 +925,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private class TableOutputContextBase : GroupOutputContext { /// - /// construct a context to push on the stack. + /// Construct a context to push on the stack. /// /// Reference to the OutCommandInner instance who owns this instance. /// Parent context in the stack. @@ -943,7 +943,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format protected TableWriter Writer { get { return _tableWriter; } } /// - /// helper class to properly write a table using text output. + /// Helper class to properly write a table using text output. /// private TableWriter _tableWriter = new TableWriter(); } @@ -957,7 +957,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private bool _repeatHeader = false; /// - /// construct a context to push on the stack. + /// Construct a context to push on the stack. /// /// Reference to the OutCommandInner instance who owns this instance. /// Parent context in the stack. @@ -977,7 +977,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// initialize column widths. + /// Initialize column widths. /// internal override void Initialize() { @@ -1015,7 +1015,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write the headers. + /// Write the headers. /// internal override void GroupStart() { @@ -1037,7 +1037,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write a row into the table. + /// Write a row into the table. /// /// FormatEntryData to process. internal override void ProcessPayload(FormatEntryData fed) @@ -1093,7 +1093,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private sealed class ListOutputContext : GroupOutputContext { /// - /// construct a context to push on the stack. + /// Construct a context to push on the stack. /// /// Reference to the OutCommandInner instance who owns this instance. /// Parent context in the stack. @@ -1106,7 +1106,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// initialize column widths. + /// Initialize column widths. /// internal override void Initialize() { @@ -1150,14 +1150,14 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write the headers. + /// Write the headers. /// internal override void GroupStart() { } /// - /// write a row into the list. + /// Write a row into the list. /// /// FormatEntryData to process. internal override void ProcessPayload(FormatEntryData fed) @@ -1170,12 +1170,12 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// property list currently active. + /// Property list currently active. /// private string[] _properties = null; /// - /// writer to do the actual formatting. + /// Writer to do the actual formatting. /// private ListWriter _listWriter = new ListWriter(); } @@ -1183,7 +1183,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private sealed class WideOutputContext : TableOutputContextBase { /// - /// construct a context to push on the stack. + /// Construct a context to push on the stack. /// /// Reference to the OutCommandInner instance who owns this instance. /// Parent context in the stack. @@ -1198,7 +1198,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private StringValuesBuffer _buffer = null; /// - /// initialize column widths. + /// Initialize column widths. /// internal override void Initialize() { @@ -1237,14 +1237,14 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write the headers. + /// Write the headers. /// internal override void GroupStart() { } /// - /// called when the end of a group is reached, flush the + /// Called when the end of a group is reached, flush the /// write buffer. /// internal override void GroupEnd() @@ -1253,7 +1253,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write a row into the table. + /// Write a row into the table. /// /// FormatEntryData to process. internal override void ProcessPayload(FormatEntryData fed) @@ -1296,13 +1296,13 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper class to accumulate the display values so that when the end + /// Helper class to accumulate the display values so that when the end /// of a line is reached, a full line can be composed. /// private class StringValuesBuffer { /// - /// construct the buffer. + /// Construct the buffer. /// /// Number of entries to cache. internal StringValuesBuffer(int size) @@ -1311,17 +1311,17 @@ namespace Microsoft.PowerShell.Commands.Internal.Format Reset(); } /// - /// get the size of the buffer. + /// Get the size of the buffer. /// internal int Length { get { return _arr.Length; } } /// - /// get the current number of entries in the buffer. + /// Get the current number of entries in the buffer. /// internal int CurrentCount { get { return _lastEmptySpot; } } /// - /// check if the buffer is full. + /// Check if the buffer is full. /// internal bool IsFull { @@ -1329,7 +1329,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// check if the buffer is empty. + /// Check if the buffer is empty. /// internal bool IsEmpty { @@ -1337,12 +1337,12 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// indexer to access the k-th item in the buffer. + /// Indexer to access the k-th item in the buffer. /// internal string this[int k] { get { return _arr[k]; } } /// - /// add an item to the buffer. + /// Add an item to the buffer. /// /// String to add. internal void Add(string s) @@ -1351,7 +1351,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// reset the buffer. + /// Reset the buffer. /// internal void Reset() { @@ -1368,7 +1368,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private sealed class ComplexOutputContext : GroupOutputContext { /// - /// construct a context to push on the stack. + /// Construct a context to push on the stack. /// /// Reference to the OutCommandInner instance who owns this instance. /// Parent context in the stack. @@ -1387,7 +1387,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write a row into the list. + /// Write a row into the list. /// /// FormatEntryData to process. internal override void ProcessPayload(FormatEntryData fed) diff --git a/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs b/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs index 9b2522929..28357039d 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs @@ -6,13 +6,13 @@ using System; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// class providing an algorithm for automatic resizing + /// Class providing an algorithm for automatic resizing /// of table columns. /// internal sealed class ColumnWidthManager { /// - /// class providing an algorithm for automatic resizing. + /// Class providing an algorithm for automatic resizing. /// /// Overall width of the table in characters. /// Minimum usable column width. @@ -25,7 +25,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// calculate the widths by applying some heuristics to get them to fit on the + /// Calculate the widths by applying some heuristics to get them to fit on the /// allotted table width. It first assigns widths to the columns that do not have a specified /// width, then it checks if the total width exceeds the screen widths. If so, it proceeds /// with column elimination, starting from the right most column. @@ -44,7 +44,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// do not remove columns, just assign widths to columns that have a zero width + /// Do not remove columns, just assign widths to columns that have a zero width /// (meaning unassigned) /// /// Columns to process. @@ -126,7 +126,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// trim columns if the total column width is too much for the screen. + /// Trim columns if the total column width is too much for the screen. /// /// Column widths to trim. private void TrimToFit(Span columnWidths) @@ -164,7 +164,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// computes the total table width from the column width array. + /// Computes the total table width from the column width array. /// /// Column widths array. /// @@ -186,7 +186,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// get the last visible column (i.e. with a width >= 0) + /// Get the last visible column (i.e. with a width >= 0) /// /// Column widths array. /// Index of the last visible column, -1 if none. diff --git a/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs b/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs index 8bcbe7bee..3ef86fbd7 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs @@ -12,12 +12,12 @@ using System.Management.Automation.Internal; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// writer class to handle Complex Object formatting. + /// Writer class to handle Complex Object formatting. /// internal sealed class ComplexWriter { /// - /// initialization method to be called before any other operation. + /// Initialization method to be called before any other operation. /// /// LineOutput interfaces to write to. /// Number of columns used to write out. @@ -41,7 +41,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// it interprets a list of format value tokens and outputs it. + /// It interprets a list of format value tokens and outputs it. /// /// List of FormatValue tokens to interpret. internal void WriteObject(List formatValueList) @@ -60,7 +60,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// operate on a single entry. + /// Operate on a single entry. /// /// Entry to process. /// Current depth of recursion. @@ -114,7 +114,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// add a string to the current buffer, waiting for a FlushBuffer() + /// Add a string to the current buffer, waiting for a FlushBuffer() /// /// String to add to buffer. private void AddToBuffer(string s) @@ -123,7 +123,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write to the output interface. + /// Write to the output interface. /// private void WriteToScreen() { @@ -204,22 +204,22 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper object to manage the frame-based indentation and margins. + /// Helper object to manage the frame-based indentation and margins. /// private IndentationManager _indentationManager = new IndentationManager(); /// - /// buffer to accumulate partially constructed text. + /// Buffer to accumulate partially constructed text. /// private StringBuilder _stringBuffer = new StringBuilder(); /// - /// interface to write to. + /// Interface to write to. /// private LineOutput _lo; /// - /// number of columns for the output device. + /// Number of columns for the output device. /// private int _textColumns; @@ -324,7 +324,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// collection of helper functions for string formatting. + /// Collection of helper functions for string formatting. /// internal sealed class StringManipulationHelper { @@ -656,7 +656,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// split a multiline string into an array of strings + /// Split a multiline string into an array of strings /// by honoring both \n and \r\n. /// /// String to split. diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs index 8b6a59000..f874b10a7 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs @@ -22,37 +22,37 @@ using System.Text; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// base exception to be used for all the exceptions that this framework will generate. + /// Base exception to be used for all the exceptions that this framework will generate. /// internal abstract class TypeInfoDataBaseLoaderException : SystemException { } /// - /// exception thrown by the loader when the maximum number of errors is exceeded. + /// Exception thrown by the loader when the maximum number of errors is exceeded. /// internal class TooManyErrorsException : TypeInfoDataBaseLoaderException { /// - /// error count that triggered the exception. + /// Error count that triggered the exception. /// internal int errorCount; } /// - /// entry logged by the loader and made available to external consumers. + /// Entry logged by the loader and made available to external consumers. /// internal class XmlLoaderLoggerEntry { internal enum EntryType { Error, Trace }; /// - /// type of information being logged. + /// Type of information being logged. /// internal EntryType entryType; /// - /// path of the file the info refers to. + /// Path of the file the info refers to. /// internal string filePath = null; @@ -62,18 +62,18 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal string xPath = null; /// - /// message to be displayed to the user. + /// Message to be displayed to the user. /// internal string message = null; /// - /// indicate whether we fail to load the file due to the security reason. + /// Indicate whether we fail to load the file due to the security reason. /// internal bool failToLoadFile = false; } /// - /// logger object used by the loader (class XmlLoaderBase) to write log entries. + /// Logger object used by the loader (class XmlLoaderBase) to write log entries. /// It logs to a memory buffer and (optionally) to a text file. /// internal class XmlLoaderLogger : IDisposable @@ -85,7 +85,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #endregion tracer /// - /// log an entry. + /// Log an entry. /// /// Entry to log. internal void LogEntry(XmlLoaderLoggerEntry entry) @@ -147,23 +147,23 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// if true, log entries to memory. + /// If true, log entries to memory. /// private bool _saveInMemory = true; /// - /// list of entries logged if saveInMemory is true. + /// List of entries logged if saveInMemory is true. /// private List _entries = new List(); /// - /// true if we ever logged an error. + /// True if we ever logged an error. /// private bool _hasErrors = false; } /// - /// base class providing XML loading basic functionality (stack management and logging facilities) + /// Base class providing XML loading basic functionality (stack management and logging facilities) /// NOTE: you need to implement to load an actual XML document and traverse it as see fit. /// internal abstract class XmlLoaderBase : IDisposable @@ -174,7 +174,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #endregion tracer /// - /// class representing a stack frame for the XML document tree traversal. + /// Class representing a stack frame for the XML document tree traversal. /// private sealed class XmlLoaderStackFrame : IDisposable { @@ -198,17 +198,17 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// back pointer to the loader, used to pop a stack frame. + /// Back pointer to the loader, used to pop a stack frame. /// private XmlLoaderBase _loader; /// - /// node the stack frame refers to. + /// Node the stack frame refers to. /// internal XmlNode node; /// - /// node index for enumerations, valid only if != -1 + /// Node index for enumerations, valid only if != -1 /// NOTE: this allows to express the XPath construct "foo[0]" /// internal int index = -1; @@ -238,7 +238,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// get the list of log entries. + /// Get the list of log entries. /// /// list of entries logged during a load internal List LogEntries @@ -250,7 +250,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// check if there were errors. + /// Check if there were errors. /// /// true of the log entry list has errors internal bool HasErrors @@ -262,7 +262,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// to be called when starting a stack frame. + /// To be called when starting a stack frame. /// The returned IDisposable should be used in a using(){...} block. /// /// Node to push on the stack. @@ -273,7 +273,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// to be called when starting a stack frame. + /// To be called when starting a stack frame. /// The returned IDisposable should be used in a using(){...} block. /// /// Node to push on the stack. @@ -290,7 +290,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// called by the Dispose code of the XmlLoaderStackFrame object + /// Called by the Dispose code of the XmlLoaderStackFrame object /// to pop a frame off the stack. /// private void RemoveStackFrame() @@ -356,7 +356,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper to compare node names, e.g. "foo" in + /// Helper to compare node names, e.g. "foo" in /// it uses case sensitive, culture invariant compare. /// This is because XML tags are case sensitive. /// @@ -664,7 +664,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #endregion /// - /// file system path for the file we are loading from. + /// File system path for the file we are loading from. /// protected string FilePath { diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData.cs index edf5a842e..beb774bfe 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData.cs @@ -15,17 +15,17 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal enum EnumerableExpansion { /// - /// process core only, ignore IEumerable. + /// Process core only, ignore IEumerable. /// CoreOnly, /// - /// process IEnumerable, ignore core. + /// Process IEnumerable, ignore core. /// EnumOnly, /// - /// process both core and IEnumerable, core first. + /// Process both core and IEnumerable, core first. /// Both, } @@ -41,7 +41,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal FormatControlDefinitionHolder formatControlDefinitionHolder = new FormatControlDefinitionHolder(); /// - /// cache for resource strings in format.ps1xml. + /// Cache for resource strings in format.ps1xml. /// internal DisplayResourceManagerCache displayResourceManagerCache = new DisplayResourceManagerCache(); } @@ -128,7 +128,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal sealed class FormatErrorPolicy { /// - /// if true, display error messages. + /// If true, display error messages. /// internal bool ShowErrorsAsMessages { @@ -151,7 +151,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private bool? _showErrorsAsMessages; /// - /// if true, display an error string in the formatted display + /// If true, display an error string in the formatted display /// (e.g. cell in a table) /// internal bool ShowErrorsInFormattedOutput @@ -175,13 +175,13 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private bool? _showErrorsInFormattedOutput; /// - /// string to display in the formatted display (e.g. cell in a table) + /// String to display in the formatted display (e.g. cell in a table) /// when the evaluation of a PSPropertyExpression fails. /// internal string errorStringInFormattedOutput = "#ERR"; /// - /// string to display in the formatted display (e.g. cell in a table) + /// String to display in the formatted display (e.g. cell in a table) /// when a format operation on a value fails. /// internal string formatErrorStringInFormattedOutput = "#FMTERR"; @@ -250,7 +250,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal string name; /// - /// optional expression for conditional binding. + /// Optional expression for conditional binding. /// internal ExpressionToken conditionToken = null; } @@ -285,12 +285,12 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal sealed class FrameToken : FormatToken { /// - /// item associated with this frame definition. + /// Item associated with this frame definition. /// internal ComplexControlItemDefinition itemDefinition = new ComplexControlItemDefinition(); /// - /// frame info associated with this frame definition. + /// Frame info associated with this frame definition. /// internal FrameInfoDefinition frameInfoDefinition = new FrameInfoDefinition(); } @@ -298,19 +298,19 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal sealed class FrameInfoDefinition { /// - /// left indentation for a frame is relative to the parent frame. + /// Left indentation for a frame is relative to the parent frame. /// it must be a value >=0. /// internal int leftIndentation = 0; /// - /// right indentation for a frame is relative to the parent frame. + /// Right indentation for a frame is relative to the parent frame. /// it must be a value >=0. /// internal int rightIndentation = 0; /// - /// it can have the following values: + /// It can have the following values: /// 0 : ignore /// greater than 0 : it represents the indentation for the first line (i.e. "first line indent"). /// The first line will be indented by the indicated number of characters. @@ -337,7 +337,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal abstract class PropertyTokenBase : FormatToken { /// - /// optional expression for conditional binding. + /// Optional expression for conditional binding. /// internal ExpressionToken conditionToken = null; @@ -348,7 +348,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal sealed class CompoundPropertyToken : PropertyTokenBase { /// - /// an inline control or a reference to a control definition. + /// An inline control or a reference to a control definition. /// internal ControlBase control = null; } @@ -368,7 +368,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region Control Definitions: common data /// - /// root class for all the control types. + /// Root class for all the control types. /// internal abstract class ControlBase { @@ -410,23 +410,23 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// reference to a control. + /// Reference to a control. /// internal sealed class ControlReference : ControlBase { /// - /// name of the control we refer to, it cannot be null. + /// Name of the control we refer to, it cannot be null. /// internal string name = null; /// - /// type of the control we refer to, it cannot be null. + /// Type of the control we refer to, it cannot be null. /// internal Type controlType = null; } /// - /// base class for all control definitions + /// Base class for all control definitions /// NOTE: this is an extensibility point, if a new control /// needs to be created, it has to be derived from this class. /// @@ -444,17 +444,17 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// class to hold a definition of a control. + /// Class to hold a definition of a control. /// internal sealed class ControlDefinition { /// - /// name of the control we define, it cannot be null. + /// Name of the control we define, it cannot be null. /// internal string name = null; /// - /// body of the control we define, it cannot be null. + /// Body of the control we define, it cannot be null. /// internal ControlBody controlBody = null; } @@ -487,62 +487,62 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal sealed class StartGroup { /// - /// expression to be used to select the grouping. + /// Expression to be used to select the grouping. /// internal ExpressionToken expression = null; /// - /// an inline control or a reference to a control definition. + /// An inline control or a reference to a control definition. /// internal ControlBase control = null; /// - /// alternative (and simplified) representation for the control + /// Alternative (and simplified) representation for the control /// RULE: if the control object is null, use this one. /// internal TextToken labelTextToken = null; } /// - /// container for control definitions. + /// Container for control definitions. /// internal sealed class FormatControlDefinitionHolder { /// - /// list of control definitions. + /// List of control definitions. /// internal List controlDefinitionList = new List(); } /// - /// definition of a view. + /// Definition of a view. /// internal sealed class ViewDefinition { internal DatabaseLoadingInfo loadingInfo; /// - /// the name of this view. Must not be null. + /// The name of this view. Must not be null. /// internal string name; /// - /// applicability of the view. Mandatory. + /// Applicability of the view. Mandatory. /// internal AppliesTo appliesTo = new AppliesTo(); /// - /// optional grouping directive. + /// Optional grouping directive. /// internal GroupBy groupBy; /// - /// container for optional local formatting directives. + /// Container for optional local formatting directives. /// internal FormatControlDefinitionHolder formatControlDefinitionHolder = new FormatControlDefinitionHolder(); /// - /// main control for the view (e.g. reference to a control or a control body. + /// Main control for the view (e.g. reference to a control or a control body. /// internal ControlBase mainControl; @@ -566,7 +566,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// base class for all the "shape"-Directive classes. + /// Base class for all the "shape"-Directive classes. /// internal abstract class FormatDirective { @@ -930,22 +930,22 @@ namespace System.Management.Automation public enum Alignment { /// - /// not defined. + /// Not defined. /// Undefined = 0, /// - /// left of the cell, contents will trail with a ... if exceeded - ex "Display..." + /// Left of the cell, contents will trail with a ... if exceeded - ex "Display..." /// Left = 1, /// - /// center of the cell. + /// Center of the cell. /// Center = 2, /// - /// right of the cell, contents will lead with a ... if exceeded - ex "...456" + /// Right of the cell, contents will lead with a ... if exceeded - ex "...456" /// Right = 3, } diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Complex.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Complex.cs index 563a5799d..76a6fe55a 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Complex.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Complex.cs @@ -13,18 +13,18 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region Complex View Definitions /// - /// in line definition of a complex control. + /// In line definition of a complex control. /// internal sealed class ComplexControlBody : ControlBody { /// - /// default list entry definition + /// Default list entry definition /// It's mandatory. /// internal ComplexControlEntryDefinition defaultEntry; /// - /// optional list of list entry definition overrides. It can be empty if there are no overrides. + /// Optional list of list entry definition overrides. It can be empty if there are no overrides. /// internal List optionalEntryList = new List(); } @@ -32,13 +32,13 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal sealed class ComplexControlEntryDefinition { /// - /// applicability clause + /// Applicability clause /// Only valid if not the default definition. /// internal AppliesTo appliesTo = null; /// - /// item associated with this entry definition. + /// Item associated with this entry definition. /// internal ComplexControlItemDefinition itemDefinition = new ComplexControlItemDefinition(); } @@ -46,7 +46,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal sealed class ComplexControlItemDefinition { /// - /// list of tokens the item can contain. + /// List of tokens the item can contain. /// internal List formatTokenList = new List(); } diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_List.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_List.cs index 5defed671..fba42c255 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_List.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_List.cs @@ -13,18 +13,18 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region List View Definitions /// - /// in line definition of a list control. + /// In line definition of a list control. /// internal sealed class ListControlBody : ControlBody { /// - /// default list entry definition + /// Default list entry definition /// It's mandatory. /// internal ListControlEntryDefinition defaultEntryDefinition = null; /// - /// optional list of list entry definition overrides. It can be empty if there are no overrides. + /// Optional list of list entry definition overrides. It can be empty if there are no overrides. /// internal List optionalEntryList = new List(); @@ -47,18 +47,18 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// definition of the data to be displayed in a list entry. + /// Definition of the data to be displayed in a list entry. /// internal sealed class ListControlEntryDefinition { /// - /// applicability clause + /// Applicability clause /// Only valid if not the default definition. /// internal AppliesTo appliesTo = null; /// - /// mandatory list of list view items. + /// Mandatory list of list view items. /// It cannot be empty. /// internal List itemDefinitionList = new List(); @@ -81,24 +81,24 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// cell definition inside a row. + /// Cell definition inside a row. /// internal sealed class ListControlItemDefinition { /// - /// optional expression for conditional binding. + /// Optional expression for conditional binding. /// internal ExpressionToken conditionToken; /// - /// optional label + /// Optional label /// If not present, use the name of the property from the matching /// mandatory item description. /// internal TextToken label = null; /// - /// format directive body telling how to format the cell + /// Format directive body telling how to format the cell /// RULE: the body can only contain /// * TextToken /// * PropertyToken diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Misc.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Misc.cs index fb6bafd05..09a27be34 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Misc.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Misc.cs @@ -7,7 +7,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// in line definition of a format string control. + /// In line definition of a format string control. /// internal sealed class FieldControlBody : ControlBody { diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Table.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Table.cs index bdbc4eb66..6ca0967b1 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Table.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Table.cs @@ -13,7 +13,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region Table View Definitions /// - /// alignment values + /// Alignment values /// NOTE: we do not use an enum because this will have to be /// serialized and ERS/serialization do not support enumerations. /// @@ -26,23 +26,23 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// definition of a table control. + /// Definition of a table control. /// internal sealed class TableControlBody : ControlBody { /// - /// optional, if not present, use data off the default table row definition. + /// Optional, if not present, use data off the default table row definition. /// internal TableHeaderDefinition header = new TableHeaderDefinition(); /// - /// default row definition + /// Default row definition /// It's mandatory. /// internal TableRowDefinition defaultDefinition; /// - /// optional list of row definition overrides. It can be empty if there are no overrides. + /// Optional list of row definition overrides. It can be empty if there are no overrides. /// internal List optionalDefinitionList = new List(); @@ -68,18 +68,18 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// information about the table header + /// Information about the table header /// NOTE: if an instance of this class is present, the list must not be empty. /// internal sealed class TableHeaderDefinition { /// - /// if true, direct the outputter to suppress table header printing. + /// If true, direct the outputter to suppress table header printing. /// internal bool hideHeader; /// - /// mandatory list of column header definitions. + /// Mandatory list of column header definitions. /// internal List columnHeaderDefinitionList = new List(); @@ -103,44 +103,44 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal sealed class TableColumnHeaderDefinition { /// - /// optional label + /// Optional label /// If not present, use the name of the property from the matching /// mandatory row description. /// internal TextToken label = null; /// - /// general alignment for the column + /// General alignment for the column /// If not present, either use the one from the row definition /// or the data driven heuristics. /// internal int alignment = TextAlignment.Undefined; /// - /// width of the column. + /// Width of the column. /// internal int width = 0; // undefined } /// - /// definition of the data to be displayed in a table row. + /// Definition of the data to be displayed in a table row. /// internal sealed class TableRowDefinition { /// - /// applicability clause + /// Applicability clause /// Only valid if not the default definition. /// internal AppliesTo appliesTo; /// - /// if true, the current table row should be allowed + /// If true, the current table row should be allowed /// to wrap to multiple lines, else truncated. /// internal bool multiLine; /// - /// mandatory list of column items. + /// Mandatory list of column items. /// It cannot be empty. /// internal List rowItemDefinitionList = new List(); @@ -166,17 +166,17 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// cell definition inside a row. + /// Cell definition inside a row. /// internal sealed class TableRowItemDefinition { /// - /// optional alignment to override the default one at the header level. + /// Optional alignment to override the default one at the header level. /// internal int alignment = TextAlignment.Undefined; /// - /// format directive body telling how to format the cell + /// Format directive body telling how to format the cell /// RULE: the body can only contain /// * TextToken /// * PropertyToken @@ -285,7 +285,7 @@ namespace System.Management.Automation } /// - /// public constructor for TableControl that only takes 'tableControlRows'. + /// Public constructor for TableControl that only takes 'tableControlRows'. /// /// public TableControl(TableControlRow tableControlRow) : this() @@ -297,7 +297,7 @@ namespace System.Management.Automation } /// - /// public constructor for TableControl that takes both 'tableControlRows' and 'tableControlColumnHeaders'. + /// Public constructor for TableControl that takes both 'tableControlRows' and 'tableControlColumnHeaders'. /// /// /// diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Wide.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Wide.cs index 9638ccd21..63438583b 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Wide.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Wide.cs @@ -13,40 +13,40 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region Wide View Definitions /// - /// in line definition of a wide control. + /// In line definition of a wide control. /// internal sealed class WideControlBody : ControlBody { /// - /// number of columns to use for wide display. + /// Number of columns to use for wide display. /// internal int columns = 0; /// - /// default wide entry definition + /// Default wide entry definition /// It's mandatory. /// internal WideControlEntryDefinition defaultEntryDefinition = null; /// - /// optional list of list entry definition overrides. It can be empty if there are no overrides. + /// Optional list of list entry definition overrides. It can be empty if there are no overrides. /// internal List optionalEntryList = new List(); } /// - /// definition of the data to be displayed in a list entry. + /// Definition of the data to be displayed in a list entry. /// internal sealed class WideControlEntryDefinition { /// - /// applicability clause + /// Applicability clause /// Only valid if not the default definition. /// internal AppliesTo appliesTo = null; /// - /// format directive body telling how to format the cell + /// Format directive body telling how to format the cell /// RULE: the body can only contain /// * TextToken /// * PropertyToken diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayResourceManagerCache.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayResourceManagerCache.cs index 364bb3b34..ed21655b3 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayResourceManagerCache.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayResourceManagerCache.cs @@ -139,13 +139,13 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper class to resolve an assembly name to an assembly reference + /// Helper class to resolve an assembly name to an assembly reference /// The class caches previous results for faster lookup. /// private class AssemblyNameResolver { /// - /// resolve the assembly name against the set of loaded assemblies. + /// Resolve the assembly name against the set of loaded assemblies. /// /// /// diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs index f456c4206..907b23121 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs @@ -15,14 +15,14 @@ using System.Threading; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// class to manage the database instances, do the reloading, etc. + /// Class to manage the database instances, do the reloading, etc. /// internal sealed class TypeInfoDataBaseManager { #region Private Data /// - /// instance of the object holding the format.ps1xml in memory database. + /// Instance of the object holding the format.ps1xml in memory database. /// internal TypeInfoDataBase Database { get; private set; } @@ -297,7 +297,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// load the database + /// Load the database /// NOTE: need to be protected by lock since not thread safe per se. /// /// *.formal.xml files to be loaded. @@ -360,7 +360,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// it loads a database from file(s). + /// It loads a database from file(s). /// /// *.formal.xml files to be loaded. /// Expression factory to validate script blocks. @@ -532,7 +532,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper to to add any pre-load intrinsics to the db. + /// Helper to to add any pre-load intrinsics to the db. /// /// Db being initialized. private static void AddPreLoadIntrinsics(TypeInfoDataBase db) @@ -541,7 +541,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper to to add any post-load intrinsics to the db. + /// Helper to to add any post-load intrinsics to the db. /// /// Db being initialized. private static void AddPostLoadIntrinsics(TypeInfoDataBase db) diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataQuery.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataQuery.cs index 9bd055dec..bd682da28 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataQuery.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataQuery.cs @@ -30,7 +30,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper object holding a generic object and the related + /// Helper object holding a generic object and the related /// "applies to" object. /// It is used in by the inheritance based type match algorithm. /// @@ -57,7 +57,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// algorithm to execute a type match on a list of entities + /// Algorithm to execute a type match on a list of entities /// having an "applies to" associated object. /// internal sealed class TypeMatch @@ -586,7 +586,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// given an appliesTo list, it finds all the types that are contained (following type + /// Given an appliesTo list, it finds all the types that are contained (following type /// group references) /// /// Database to use. diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs index eec0efca2..d7a5f3861 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs @@ -34,7 +34,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// class to load the XML document into data structures. + /// Class to load the XML document into data structures. /// It encapsulates the file format specific code. /// internal sealed partial class TypeInfoDataBaseLoader : XmlLoaderBase @@ -47,7 +47,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #endregion tracer /// - /// table of XML node tags used in the file format. + /// Table of XML node tags used in the file format. /// private static class XmlTags { @@ -151,7 +151,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// table of miscellanea string constant values for XML nodes. + /// Table of miscellanea string constant values for XML nodes. /// private static class XMLStringValues { @@ -168,7 +168,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private bool _suppressValidation = false; /// - /// entry point for the loader algorithm. + /// Entry point for the loader algorithm. /// /// Information needed to load the file. /// Database instance to load the file into. @@ -272,7 +272,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// entry point for the loader algorithm to load formatting data from ExtendedTypeDefinition. + /// Entry point for the loader algorithm to load formatting data from ExtendedTypeDefinition. /// /// The ExtendedTypeDefinition instance to load formatting data from. /// Database instance to load the formatting data into. @@ -329,7 +329,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// load the content of the XML document into the data instance. + /// Load the content of the XML document into the data instance. /// It assumes that the XML document has been successfully loaded. /// /// XML document to load from, cannot be null. @@ -412,7 +412,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region load formatting data from FormatViewDefinition /// - /// load the content of the ExtendedTypeDefinition instance into the db. + /// Load the content of the ExtendedTypeDefinition instance into the db. /// Only support following view controls: /// TableControl /// ListControl @@ -1915,7 +1915,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region Expression Loading /// - /// helper to verify the text of a string block and + /// Helper to verify the text of a string block and /// log an error if an exception is thrown. /// /// Script block string to verify. @@ -1942,7 +1942,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper class to wrap the loading of a script block/property name alternative tag. + /// Helper class to wrap the loading of a script block/property name alternative tag. /// private sealed class ExpressionNodeMatch { @@ -2041,7 +2041,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper class to wrap the loading of an expression (using ExpressionNodeMatch) + /// Helper class to wrap the loading of an expression (using ExpressionNodeMatch) /// plus the formatting string and an alternative text node. /// private sealed class ViewEntryNodeMatch diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Complex.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Complex.cs index 0827f3c04..4dfa9c2fc 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Complex.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Complex.cs @@ -9,7 +9,7 @@ using System.Management.Automation.Internal; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// class to load the XML document into data structures. + /// Class to load the XML document into data structures. /// It encapsulates the file format specific code. /// internal sealed partial class TypeInfoDataBaseLoader : XmlLoaderBase diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_List.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_List.cs index 1061c0e0a..57f61c46e 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_List.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_List.cs @@ -8,7 +8,7 @@ using System.Management.Automation.Internal; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// class to load the XML document into data structures. + /// Class to load the XML document into data structures. /// It encapsulates the file format specific code. /// internal sealed partial class TypeInfoDataBaseLoader : XmlLoaderBase diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Table.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Table.cs index 2a74e2009..67941b877 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Table.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Table.cs @@ -9,7 +9,7 @@ using System.Management.Automation.Internal; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// class to load the XML document into data structures. + /// Class to load the XML document into data structures. /// It encapsulates the file format specific code. /// internal sealed partial class TypeInfoDataBaseLoader : XmlLoaderBase diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Views.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Views.cs index c91b042bf..ee854a68e 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Views.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Views.cs @@ -10,7 +10,7 @@ using System.Management.Automation.Internal; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// class to load the XML document into data structures. + /// Class to load the XML document into data structures. /// It encapsulates the file format specific code. /// internal sealed partial class TypeInfoDataBaseLoader : XmlLoaderBase diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Wide.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Wide.cs index 749309ee3..7b040c0d0 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Wide.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader_Wide.cs @@ -8,7 +8,7 @@ using System.Management.Automation.Internal; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// class to load the XML document into data structures. + /// Class to load the XML document into data structures. /// It encapsulates the file format specific code. /// internal sealed partial class TypeInfoDataBaseLoader : XmlLoaderBase diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs index 7b3fd71a1..90f024573 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs @@ -10,7 +10,7 @@ using System.Globalization; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// internal class to manage the grouping algorithm for the + /// Internal class to manage the grouping algorithm for the /// format-xxx commands. /// internal sealed class GroupingInfoManager @@ -42,7 +42,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// compute the string value of the grouping property. + /// Compute the string value of the grouping property. /// /// Object to use to compute the property value. /// True if there was an update. @@ -101,22 +101,22 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// value of the display label passed in. + /// Value of the display label passed in. /// private string _label = null; /// - /// value of the current active grouping key. + /// Value of the current active grouping key. /// private string _groupingKeyDisplayName = null; /// - /// name of the current grouping key. + /// Name of the current grouping key. /// private PSPropertyExpression _groupingKeyExpression = null; /// - /// the current value of the grouping key. + /// The current value of the grouping key. /// private object _currentGroupingKeyPropertyValue = AutomationNull.Value; } diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatMsgCtxManager.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatMsgCtxManager.cs index 3423973d2..374897f8a 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatMsgCtxManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatMsgCtxManager.cs @@ -48,7 +48,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// the outer context: the context object pushed onto the + /// The outer context: the context object pushed onto the /// stack before the current one. For the first object pushed onto /// the stack it will be null. /// @@ -56,7 +56,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// process an object from an input stream. It manages the context stack and + /// Process an object from an input stream. It manages the context stack and /// calls back on the specified event delegates. /// /// Object to process. @@ -125,7 +125,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// access the active context (top of the stack). It can be null. + /// Access the active context (top of the stack). It can be null. /// internal OutputContext ActiveOutputContext { @@ -133,7 +133,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// internal stack to manage context. + /// Internal stack to manage context. /// private Stack _stack = new Stack(); } diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs index aecf2570b..5596987d5 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs @@ -9,7 +9,7 @@ using System.Management.Automation.Internal; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// base class for the various types of formatting shapes. + /// Base class for the various types of formatting shapes. /// internal abstract class ViewGenerator { @@ -272,7 +272,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// update the current value of the grouping key. + /// Update the current value of the grouping key. /// /// Object to use for the update. /// True if the value of the key changed. diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs index 4f6c26199..d41a119dd 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs @@ -66,7 +66,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// class to process a complex control directive and generate + /// Class to process a complex control directive and generate /// the corresponding formatting tokens. /// internal sealed class ComplexControlGenerator @@ -417,7 +417,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// class to generate a complex view from properties. + /// Class to generate a complex view from properties. /// internal sealed class ComplexViewObjectBrowser { @@ -429,7 +429,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// given an object, generate a tree-like view + /// Given an object, generate a tree-like view /// of the object. /// /// Object to process. @@ -508,7 +508,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// recursive call to display an object. + /// Recursive call to display an object. /// /// Object to display. /// Current level in the traversal. @@ -608,7 +608,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// recursive call to display an object. + /// Recursive call to display an object. /// /// Enumeration to display. /// Current level in the traversal. @@ -666,7 +666,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// display a leaf value. + /// Display a leaf value. /// /// Object to display. /// List of format tokens to add to. @@ -680,7 +680,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// determine if we have to stop the expansion. + /// Determine if we have to stop the expansion. /// /// Object to verify. /// Current level of recursion. @@ -694,7 +694,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// treat as scalar check. + /// Treat as scalar check. /// /// Name of the type to check. /// True if it has to be treated as a scalar. @@ -769,7 +769,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private ComplexSpecificParameters _complexSpecificParameters; /// - /// indentation added to each level in the recursion. + /// Indentation added to each level in the recursion. /// private int _indentationStep = 2; diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs index 013d2160f..baed478cc 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs @@ -62,7 +62,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// class to manage the selection of a desired view type and + /// Class to manage the selection of a desired view type and /// manage state associated to the selected view. /// internal sealed class FormatViewManager @@ -453,13 +453,13 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// the view generator that produced data for a selected shape. + /// The view generator that produced data for a selected shape. /// private ViewGenerator _viewGenerator = null; } /// - /// class to manage the selection of a desired view type + /// Class to manage the selection of a desired view type /// for out of band objects. /// internal static class OutOfBandFormatViewManager @@ -611,7 +611,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// log a failed evaluation of an PSPropertyExpression. + /// Log a failed evaluation of an PSPropertyExpression. /// /// PSPropertyExpressionResult containing the failed evaluation data. /// Object used to evaluate the PSPropertyExpression. @@ -626,7 +626,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// log a failed formatting operation. + /// Log a failed formatting operation. /// /// String format error object. internal void LogStringFormatError(StringFormatError error) @@ -661,7 +661,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// provide a list of ErrorRecord entries + /// Provide a list of ErrorRecord entries /// to be written to the error pipeline and clear the list of pending /// errors. /// @@ -726,7 +726,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private FormatErrorPolicy _formatErrorPolicy; /// - /// current list of failed PSPropertyExpression evaluations. + /// Current list of failed PSPropertyExpression evaluations. /// private List _formattingErrorList = new List(); } diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjects.cs b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjects.cs index 1cf4507f7..6b611d225 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjects.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjects.cs @@ -28,20 +28,20 @@ namespace Microsoft.PowerShell.Commands.Internal.Format { #region Root of Class Hierarchy /// - /// base class from which all the formatting objects + /// Base class from which all the formatting objects /// will derive from. /// It provides the mechanism to preserve type information. /// internal abstract partial class FormatInfoData { /// - /// name of the "get" property that allows access to CLSID information. + /// Name of the "get" property that allows access to CLSID information. /// This is needed by the ERS API's. /// internal const string classidProperty = "ClassId2e4f51ef21dd47e99d3c952918aff9cd"; /// - /// string containing a GUID, to be set by each derived class + /// String containing a GUID, to be set by each derived class /// "get" property to get CLSID information. /// It is named with a GUID like name to avoid potential collisions with /// properties of payload objects. @@ -60,7 +60,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal abstract partial class ControlInfoData : PacketInfoData { /// - /// null by default, present only if grouping specified. + /// Null by default, present only if grouping specified. /// public GroupingEntry groupingEntry = null; } @@ -68,14 +68,14 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal abstract partial class StartData : ControlInfoData { /// - /// it needs to be either on FormatStartData or GroupStartData + /// It needs to be either on FormatStartData or GroupStartData /// but not both or neither. /// public ShapeInfo shapeInfo; } /// - /// sequence start: the very first message sent. + /// Sequence start: the very first message sent. /// internal sealed partial class FormatStartData : StartData { @@ -84,17 +84,17 @@ namespace Microsoft.PowerShell.Commands.Internal.Format public override string ClassId2e4f51ef21dd47e99d3c952918aff9cd { get { return CLSID; } } /// - /// optional. + /// Optional. /// public PageHeaderEntry pageHeaderEntry; /// - /// optional. + /// Optional. /// public PageFooterEntry pageFooterEntry; /// - /// autosize formatting directive. If present, the output command is instructed + /// Autosize formatting directive. If present, the output command is instructed /// to get the autosize "best fit" for the device screen according to the flags /// this object contains. /// @@ -102,7 +102,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// sequence end: the very last message sent. + /// Sequence end: the very last message sent. /// internal sealed class FormatEndData : ControlInfoData { @@ -112,7 +112,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// group start: message marking the beginning of a group. + /// Group start: message marking the beginning of a group. /// internal sealed class GroupStartData : StartData { @@ -122,7 +122,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// group end: message marking the end of a group. + /// Group end: message marking the end of a group. /// internal sealed class GroupEndData : ControlInfoData { @@ -132,7 +132,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// generic entry containing payload data and related formatting info. + /// Generic entry containing payload data and related formatting info. /// internal sealed partial class FormatEntryData : PacketInfoData { @@ -141,7 +141,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format public override string ClassId2e4f51ef21dd47e99d3c952918aff9cd { get { return CLSID; } } /// - /// mandatory, but depending on the shape we send in + /// Mandatory, but depending on the shape we send in /// it must match what got sent in the format start message. /// public FormatEntryInfo formatEntryInfo = null; @@ -199,7 +199,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format public override string ClassId2e4f51ef21dd47e99d3c952918aff9cd { get { return CLSID; } } /// - /// desired number of columns on the screen. + /// Desired number of columns on the screen. /// Advisory, the outputter can decide otherwise /// /// A zero value signifies let the outputter get the @@ -231,7 +231,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format public override string ClassId2e4f51ef21dd47e99d3c952918aff9cd { get { return CLSID; } } /// - /// width of the column: + /// Width of the column: /// == 0 -> let the outputter decide /// > 0 -> user provided value. /// @@ -352,7 +352,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format public override string ClassId2e4f51ef21dd47e99d3c952918aff9cd { get { return CLSID; } } /// - /// number of objects to compute the best fit. + /// Number of objects to compute the best fit. /// Zero: all the objects /// a positive number N: use the first N. /// @@ -407,7 +407,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format public List formatValueList; /// - /// optional information of frame data (indentation, etc.) + /// Optional information of frame data (indentation, etc.) /// public FrameInfo frameInfo; } diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs index cf168d979..2ba857912 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs @@ -11,7 +11,7 @@ using System.Management.Automation.Internal; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// class to deserialize property bags into formatting objects + /// Class to deserialize property bags into formatting objects /// by using ERS functionality. /// internal sealed class FormatObjectDeserializer @@ -19,7 +19,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal TerminatingErrorContext TerminatingErrorContext { get; private set; } /// - /// expansion of TAB character to the following string. + /// Expansion of TAB character to the following string. /// private const string TabExpansionString = " "; @@ -79,7 +79,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// given a raw object out of the pipeline, it deserializes it accordingly to + /// Given a raw object out of the pipeline, it deserializes it accordingly to /// its type. /// If the object is not one of the well known ones (i.e. derived from FormatInfoData) /// it just returns the object unchanged. diff --git a/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs b/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs index 92bde6249..d4534a18f 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs @@ -141,19 +141,19 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal abstract class LineOutput { /// - /// whether the device requires full buffering of formatting + /// Whether the device requires full buffering of formatting /// objects before any processing. /// internal virtual bool RequiresBuffering { get { return false; } } /// - /// delegate the implementor of ExecuteBufferPlayBack should + /// Delegate the implementor of ExecuteBufferPlayBack should /// call to cause the playback to happen when ready to execute. /// internal delegate void DoPlayBackCall(); /// - /// if RequiresBuffering = true, this call will be made to + /// If RequiresBuffering = true, this call will be made to /// start the playback. /// internal virtual void ExecuteBufferPlayBack(DoPlayBackCall playback) { } @@ -183,7 +183,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// handle the stop processing signal. + /// Handle the stop processing signal. /// Set a flag that will be checked during operations. /// internal void StopProcessing() @@ -201,7 +201,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// return an instance of the display helper tear off. + /// Return an instance of the display helper tear off. /// /// internal virtual DisplayCells DisplayCells @@ -215,7 +215,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// singleton used for the default implementation. + /// Singleton used for the default implementation. /// NOTE: derived classes may chose to provide a different /// implementation by overriding. /// @@ -223,7 +223,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper class to provide line breaking (based on device width) + /// Helper class to provide line breaking (based on device width) /// and embedded newline processing /// It needs to be provided with two callbacks for line processing. /// @@ -232,19 +232,19 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region callbacks /// - /// delegate definition. + /// Delegate definition. /// /// String to write. internal delegate void WriteCallback(string s); /// - /// instance of the delegate previously defined + /// Instance of the delegate previously defined /// for line that has EXACTLY this.ncols characters. /// private WriteCallback _writeCall = null; /// - /// instance of the delegate previously defined + /// Instance of the delegate previously defined /// for generic line, less that this.ncols characters. /// private WriteCallback _writeLineCall = null; @@ -254,7 +254,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private bool _lineWrap; /// - /// construct an instance, given the two callbacks + /// Construct an instance, given the two callbacks /// NOTE: if the underlying device treats the two cases as the /// same, the same delegate can be passed twice. /// @@ -276,7 +276,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// main entry point to process a line. + /// Main entry point to process a line. /// /// String to process. /// Width of the device. @@ -286,7 +286,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// internal helper, needed because it might make recursive calls to itself. + /// Internal helper, needed because it might make recursive calls to itself. /// /// String to process. /// Width of the device. @@ -362,7 +362,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region ILineOutput methods /// - /// get the columns on the screen + /// Get the columns on the screen /// for files, it is settable at creation time. /// internal override int ColumnNumber @@ -375,7 +375,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// get the # of rows on the screen: for files + /// Get the # of rows on the screen: for files /// we return -1, meaning infinite. /// internal override int RowNumber @@ -388,7 +388,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write a line by delegating to the writer underneath. + /// Write a line by delegating to the writer underneath. /// /// internal override void WriteLine(string s) @@ -406,7 +406,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #endregion /// - /// initialization of the object. It must be called before + /// Initialization of the object. It must be called before /// attempting any operation. /// /// TextWriter to write to. @@ -418,7 +418,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// initialization of the object. It must be called before + /// Initialization of the object. It must be called before /// attempting any operation. /// /// TextWriter to write to. @@ -449,7 +449,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #endregion tracer /// - /// create an instance by passing a delegate. + /// Create an instance by passing a delegate. /// /// Delegate to write to. /// Culture for this TextWriter. @@ -474,13 +474,13 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #endregion /// - /// delegate definition. + /// Delegate definition. /// /// String to write. internal delegate void WriteLineCallback(string s); /// - /// instance of the delegate previously defined. + /// Instance of the delegate previously defined. /// private WriteLineCallback _writeCall = null; } diff --git a/src/System.Management.Automation/FormatAndOutput/common/ListWriter.cs b/src/System.Management.Automation/FormatAndOutput/common/ListWriter.cs index 1dfe340b2..21ad20bb5 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ListWriter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ListWriter.cs @@ -9,23 +9,23 @@ using System.Management.Automation.Internal; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// class to write object properties in list form by using + /// Class to write object properties in list form by using /// the host screen interfaces. /// internal class ListWriter { /// - /// labels already padded with blanks, separator characters, etc. + /// Labels already padded with blanks, separator characters, etc. /// private string[] _propertyLabels; /// - /// display length of the property labels in the array (all the same length) + /// Display length of the property labels in the array (all the same length) /// private int _propertyLabelsDisplayLength = 0; /// - /// column width of the screen. + /// Column width of the screen. /// private int _columnWidth = 0; @@ -105,7 +105,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write the values of the properties of an object. + /// Write the values of the properties of an object. /// /// Array with the values in form of formatted strings. /// LineOutput interface to write to. @@ -156,7 +156,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper, writing a single property to the screen. + /// Helper, writing a single property to the screen. /// It wraps the value of the property if it is tool long to fit. /// /// Index of property to write. @@ -192,7 +192,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// internal helper to split a line that is too long to fit and pad it to the left + /// Internal helper to split a line that is too long to fit and pad it to the left /// with a given string. /// /// String to add to the left. @@ -227,19 +227,19 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// set to true when the width of the screen is too small to do anything useful. + /// Set to true when the width of the screen is too small to do anything useful. /// private bool _disabled = false; private const string Separator = " : "; /// - /// minimum width for the property label field. + /// Minimum width for the property label field. /// private const int MinLabelWidth = 1; /// - /// minimum width for the property value field. + /// Minimum width for the property value field. /// private const int MinFieldWidth = 1; } diff --git a/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs b/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs index 9b43018db..e1b8a6677 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs @@ -10,7 +10,7 @@ using System.Management.Automation.Internal; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// inner command class used to manage the sub pipelines + /// Inner command class used to manage the sub pipelines /// it determines which command should process the incoming objects /// based on the object type /// @@ -44,7 +44,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #endregion /// - /// handler for processing each object coming through the pipeline + /// Handler for processing each object coming through the pipeline /// it forwards the call to the pipeline manager object. /// internal override void ProcessRecord() @@ -86,7 +86,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// handler for processing shut down. It forwards the call to the + /// Handler for processing shut down. It forwards the call to the /// pipeline manager object. /// internal override void EndProcessing() @@ -110,7 +110,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// make sure we dispose of the sub pipeline manager. + /// Make sure we dispose of the sub pipeline manager. /// protected override void InternalDispose() { @@ -123,7 +123,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// instance of the pipeline manager object. + /// Instance of the pipeline manager object. /// private SubPipelineManager _mgr = null; @@ -139,19 +139,19 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// object managing the sub-pipelines that execute + /// Object managing the sub-pipelines that execute /// different output commands (or different instances of the /// default one) /// internal sealed class SubPipelineManager : IDisposable { /// - /// entry defining a command to be run in a separate pipeline. + /// Entry defining a command to be run in a separate pipeline. /// private sealed class CommandEntry : IDisposable { /// - /// instance of pipeline wrapper object. + /// Instance of pipeline wrapper object. /// internal CommandWrapper command = new CommandWrapper(); @@ -171,7 +171,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// just dispose of the inner command wrapper. + /// Just dispose of the inner command wrapper. /// public void Dispose() { @@ -183,7 +183,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// ordered list of ETS type names this object is handling. + /// Ordered list of ETS type names this object is handling. /// private StringCollection _applicableTypes = new StringCollection(); } @@ -200,7 +200,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// hard wired registration helper for specialized types. + /// Hard wired registration helper for specialized types. /// /// ExecutionContext to pass to the child pipeline. private void InitializeCommandsHardWired(ExecutionContext context) @@ -236,7 +236,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// register the default output command. + /// Register the default output command. /// /// ExecutionContext to pass to the child pipeline. /// Name of the command to execute. @@ -251,7 +251,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// process an incoming parent pipeline object. + /// Process an incoming parent pipeline object. /// /// Pipeline object to process. internal void Process(PSObject so) @@ -266,7 +266,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// shut down the child pipelines. + /// Shut down the child pipelines. /// internal void ShutDown() { @@ -299,7 +299,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// it selects the applicable out command (it can be the default one) + /// It selects the applicable out command (it can be the default one) /// to process the current pipeline object. /// /// Pipeline object to be processed. @@ -320,12 +320,12 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private LineOutput _lo = null; /// - /// list of command entries, each with a set of applicable types. + /// List of command entries, each with a set of applicable types. /// private List _commandEntryList = new List(); /// - /// default command entry to be executed when all type matches fail. + /// Default command entry to be executed when all type matches fail. /// private CommandEntry _defaultCommandEntry = new CommandEntry(); } diff --git a/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs b/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs index bb64d8240..f44804c48 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs @@ -8,14 +8,14 @@ using System.Collections.Generic; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// queue to provide sliding window capabilities for auto size functionality + /// Queue to provide sliding window capabilities for auto size functionality /// It provides caching capabilities (either the first N objects in a group /// or all the objects in a group) /// internal sealed class OutputGroupQueue { /// - /// create a grouping cache. + /// Create a grouping cache. /// /// Notification callback to be called when the desired number of objects is reached. /// Max number of objects to be cached. @@ -26,7 +26,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// create a time-bounded grouping cache. + /// Create a time-bounded grouping cache. /// /// Notification callback to be called when the desired number of objects is reached. /// Max amount of time to cache of objects. @@ -37,7 +37,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// add an object to the cache. + /// Add an object to the cache. /// /// Object to add. /// Objects the cache needs to return. It can be null. @@ -150,7 +150,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// remove a single object from the queue. + /// Remove a single object from the queue. /// /// Object retrieved, null if queue is empty. internal PacketInfoData Dequeue() @@ -162,12 +162,12 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// queue to store the currently cached objects. + /// Queue to store the currently cached objects. /// private Queue _queue = new Queue(); /// - /// number of objects to compute the best fit. + /// Number of objects to compute the best fit. /// Zero: all the objects /// a positive number N: use the first N. /// @@ -182,41 +182,41 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private Stopwatch _groupingTimer = null; /// - /// notification callback to be called when we have accumulated enough + /// Notification callback to be called when we have accumulated enough /// data to compute a hint. /// private FormattedObjectsCache.ProcessCachedGroupNotification _notificationCallBack = null; /// - /// reference kept to be used during notification. + /// Reference kept to be used during notification. /// private FormatStartData _formatStartData = null; /// - /// state flag to signal we are queuing. + /// State flag to signal we are queuing. /// private bool _processingGroup = false; /// - /// current object count. + /// Current object count. /// private int _currentObjectCount = 0; } /// - /// facade class managing the front end and the autosize cache. + /// Facade class managing the front end and the autosize cache. /// internal sealed class FormattedObjectsCache { /// - /// delegate to allow notifications when the autosize queue is about to be drained. + /// Delegate to allow notifications when the autosize queue is about to be drained. /// /// Current Fs control message. /// Enumeration of PacketInfoData objects. internal delegate void ProcessCachedGroupNotification(FormatStartData formatStartData, List objects); /// - /// decide right away if we need a front end cache (e.g. printing) + /// Decide right away if we need a front end cache (e.g. printing) /// /// If true, create a front end cache object. internal FormattedObjectsCache(bool cacheFrontEnd) @@ -226,7 +226,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// if needed, add a back end autosize (grouping) cache. + /// If needed, add a back end autosize (grouping) cache. /// /// Notification callback to be called when the desired number of objects is reached. /// Max number of objects to be cached. @@ -237,7 +237,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// if needed, add a back end autosize (grouping) cache. + /// If needed, add a back end autosize (grouping) cache. /// /// Notification callback to be called when the desired number of objects is reached. /// Max amount of time to cache of objects. @@ -248,7 +248,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// add an object to the cache. the behavior depends on the object added, the + /// Add an object to the cache. the behavior depends on the object added, the /// objects already in the cache and the cache settings. /// /// Object to add. @@ -275,7 +275,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// remove all the objects from the cache. + /// Remove all the objects from the cache. /// /// All the objects that were in the cache. internal List Drain() @@ -325,12 +325,12 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// front end queue (if present, cache ALL, if not, bypass) + /// Front end queue (if present, cache ALL, if not, bypass) /// private Queue _frontEndQueue; /// - /// back end grouping queue. + /// Back end grouping queue. /// private OutputGroupQueue _groupQueue = null; } diff --git a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs index 0e22ed21f..df222bae9 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs @@ -14,7 +14,7 @@ using System.Reflection; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// class containing miscellaneous helpers to deal with + /// Class containing miscellaneous helpers to deal with /// PSObject manipulation. /// internal static class PSObjectHelper @@ -159,7 +159,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// it gets the display name value. + /// It gets the display name value. /// /// Shell object to process. /// Expression factory to create PSPropertyExpression. @@ -269,7 +269,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper to convert an PSObject into a string + /// Helper to convert an PSObject into a string /// It takes into account enumerations (use display name) /// /// Shell object to process. @@ -387,7 +387,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// format an object using a provided format string directive. + /// Format an object using a provided format string directive. /// /// Format directive object to use. /// Object to format. @@ -483,7 +483,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper to retrieve the default property set of a shell object. + /// Helper to retrieve the default property set of a shell object. /// /// Shell object to process. /// Resolved expression; empty list if not found. @@ -530,7 +530,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// helper to retrieve the value of an PSPropertyExpression and to format it. + /// Helper to retrieve the value of an PSPropertyExpression and to format it. /// /// Shell object to process. /// Limit on IEnumerable enumeration. @@ -623,7 +623,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal delegate ScriptBlock CreateScriptBlockFromString(string scriptBlockString); /// - /// helper class to create PSPropertyExpression's from format.ps1xml data structures. + /// Helper class to create PSPropertyExpression's from format.ps1xml data structures. /// internal sealed class PSPropertyExpressionFactory { @@ -634,7 +634,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// create an expression from an expression token. + /// Create an expression from an expression token. /// /// Expression token to use. /// Constructed expression. @@ -645,7 +645,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// create an expression from an expression token. + /// Create an expression from an expression token. /// /// Expression token to use. /// The context from which the file was loaded. diff --git a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs index a473a155e..351d70ec2 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs @@ -12,7 +12,7 @@ using System.Diagnostics.CodeAnalysis; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// normalized parameter class to be constructed from the command line parameters + /// Normalized parameter class to be constructed from the command line parameters /// using the metadata information provided by an instance of CommandParameterDefinition /// it's basically the hash table with the normalized values. /// @@ -39,7 +39,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// metadata base class for hashtable entry definitions + /// Metadata base class for hashtable entry definitions /// it contains the key name and the allowable types /// it also provides hooks for type expansion. /// @@ -113,7 +113,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// metadata abstract base class to contain hash entries definitions. + /// Metadata abstract base class to contain hash entries definitions. /// internal abstract class CommandParameterDefinition { @@ -128,7 +128,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format internal virtual MshParameter CreateInstance() { return new MshParameter(); } /// - /// for a key name, verify it is a legal entry: + /// For a key name, verify it is a legal entry: /// 1. it must match (partial match allowed) /// 2. it must be unambiguous (if partial match) /// If an error condition occurs, an exception will be thrown. @@ -219,7 +219,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// engine to process a generic object[] from the command line and + /// Engine to process a generic object[] from the command line and /// generate a list of MshParameter objects , given the metadata provided by /// a class derived from CommandParameterDefinition. /// diff --git a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameterAssociation.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameterAssociation.cs index 1e65a3adb..d13af1ebf 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameterAssociation.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameterAssociation.cs @@ -9,7 +9,7 @@ using System.Collections.ObjectModel; namespace Microsoft.PowerShell.Commands.Internal.Format { /// - /// helper class to hold a resolved expression and its + /// Helper class to hold a resolved expression and its /// originating parameter. /// internal sealed class MshResolvedExpressionParameterAssociation diff --git a/src/System.Management.Automation/FormatAndOutput/common/Utilities/Mshexpression.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/Mshexpression.cs index 308c312bd..af0cd249c 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/Utilities/Mshexpression.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/Utilities/Mshexpression.cs @@ -13,7 +13,7 @@ using System.Runtime.CompilerServices; namespace Microsoft.PowerShell.Commands { /// - /// class that represents the results from evaluating a PSPropertyExpression against an object. + /// Class that represents the results from evaluating a PSPropertyExpression against an object. /// public class PSPropertyExpressionResult { @@ -53,7 +53,7 @@ namespace Microsoft.PowerShell.Commands public class PSPropertyExpression { /// - /// constructor. + /// Constructor. /// /// Expression. /// diff --git a/src/System.Management.Automation/FormatAndOutput/format-default/format-default.cs b/src/System.Management.Automation/FormatAndOutput/format-default/format-default.cs index f746b80c3..7b0ac40e3 100644 --- a/src/System.Management.Automation/FormatAndOutput/format-default/format-default.cs +++ b/src/System.Management.Automation/FormatAndOutput/format-default/format-default.cs @@ -7,13 +7,13 @@ using Microsoft.PowerShell.Commands.Internal.Format; namespace Microsoft.PowerShell.Commands { /// - /// implementation for the format-default command. + /// Implementation for the format-default command. /// [Cmdlet(VerbsCommon.Format, "Default")] public class FormatDefaultCommand : FrontEndCommandBase { /// - /// constructor to set the inner command. + /// Constructor to set the inner command. /// public FormatDefaultCommand() { diff --git a/src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs b/src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs index 2f668fb32..ee6c17884 100644 --- a/src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs +++ b/src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs @@ -19,7 +19,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #if TEST_MULTICELL_ON_SINGLE_CELL_LOCALE /// - /// test class to provide easily overridable behavior for testing on US machines + /// Test class to provide easily overridable behavior for testing on US machines /// using US data. /// NOTE: the class just forces any uppercase letter [A-Z] to be prepended /// with an underscore (e.g. "A" becomes "_A", but "a" stays the same) @@ -157,7 +157,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region LineOutput implementation /// - /// the # of columns is just the width of the screen buffer (not the + /// The # of columns is just the width of the screen buffer (not the /// width of the window) /// /// @@ -189,7 +189,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// the # of rows is the # of rows visible in the window (and not the # of + /// The # of rows is the # of rows visible in the window (and not the # of /// rows in the screen buffer) /// /// @@ -215,7 +215,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// write a line to the output device. + /// Write a line to the output device. /// /// Line to write. internal override void WriteLine(string s) @@ -243,7 +243,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #endregion /// - /// constructor for the ConsoleLineOutput. + /// Constructor for the ConsoleLineOutput. /// /// PSHostUserInterface to wrap. /// True if we require prompting for page breaks. @@ -295,7 +295,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// callback to be called when ILineOutput.WriteLine() is called by WriteLineHelper. + /// Callback to be called when ILineOutput.WriteLine() is called by WriteLineHelper. /// /// String to write. private void OnWriteLine(string s) @@ -340,7 +340,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// callback to be called when ILineOutput.Write() is called by WriteLineHelper + /// Callback to be called when ILineOutput.Write() is called by WriteLineHelper /// This is called when the WriteLineHelper needs to write a line whose length /// is the same as the width of the screen buffer. /// @@ -377,7 +377,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// called when a line was written to console. + /// Called when a line was written to console. /// private void LineWrittenEvent() { @@ -427,7 +427,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// check if we need to put out a prompt. + /// Check if we need to put out a prompt. /// /// true if we need to prompt private bool NeedToPrompt @@ -461,12 +461,12 @@ namespace Microsoft.PowerShell.Commands.Internal.Format #region Private Members /// - /// object to manage prompting. + /// Object to manage prompting. /// private class PromptHandler { /// - /// prompt handler with the given prompt. + /// Prompt handler with the given prompt. /// /// Prompt string to be used. /// The Cmdlet using this prompt handler. @@ -480,7 +480,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// determine how many rows the prompt should take. + /// Determine how many rows the prompt should take. /// /// Current number of columns on the screen. /// String manipulation helper. @@ -493,7 +493,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// options returned by the PromptUser() call. + /// Options returned by the PromptUser() call. /// internal enum PromptResponse { @@ -503,7 +503,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// do the actual prompting. + /// Do the actual prompting. /// /// PSHostUserInterface instance to prompt to. internal PromptResponse PromptUser(PSHostUserInterface console) @@ -547,12 +547,12 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// cached string(s) valid during a sequence of ComputePromptLines()/PromptUser() + /// Cached string(s) valid during a sequence of ComputePromptLines()/PromptUser() /// private StringCollection _actualPrompt; /// - /// prompt string as passed at initialization. + /// Prompt string as passed at initialization. /// private string _promptString; @@ -563,42 +563,42 @@ namespace Microsoft.PowerShell.Commands.Internal.Format } /// - /// flag to force new lines in CMD.EXE by limiting the + /// Flag to force new lines in CMD.EXE by limiting the /// usable width to N-1 (e.g. 80-1) and forcing a call /// to WriteLine() /// private bool _forceNewLine = true; /// - /// use this if IRawConsole is null; + /// Use this if IRawConsole is null; /// private int _fallbackRawConsoleColumnNumber = 80; /// - /// use this if IRawConsole is null; + /// Use this if IRawConsole is null; /// private int _fallbackRawConsoleRowNumber = 40; private WriteLineHelper _writeLineHelper; /// - /// handler to prompt the user for page breaks + /// Handler to prompt the user for page breaks /// if this handler is not null, we have prompting. /// private PromptHandler _prompt = null; /// - /// conter for the # of lines written when prompting is on. + /// Conter for the # of lines written when prompting is on. /// private long _linesWritten = 0; /// - /// flag to avoid reentrancy on prompting. + /// Flag to avoid reentrancy on prompting. /// private bool _disableLineWrittenEvent = false; /// - /// refecence to the PSHostUserInterface interface we use. + /// Refecence to the PSHostUserInterface interface we use. /// private PSHostUserInterface _console = null; @@ -608,7 +608,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format private DisplayCells _displayCellsPSHost; /// - /// reference to error context to throw Msh exceptions. + /// Reference to error context to throw Msh exceptions. /// private TerminatingErrorContext _errorContext = null; diff --git a/src/System.Management.Automation/FormatAndOutput/out-console/OutConsole.cs b/src/System.Management.Automation/FormatAndOutput/out-console/OutConsole.cs index b81b81b0f..625ba2157 100644 --- a/src/System.Management.Automation/FormatAndOutput/out-console/OutConsole.cs +++ b/src/System.Management.Automation/FormatAndOutput/out-console/OutConsole.cs @@ -34,7 +34,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// implementation for the out-default command + /// Implementation for the out-default command /// this command it implicitly inject by the /// powershell host at the end of the pipeline as the /// default sink (display to console screen) @@ -52,7 +52,7 @@ namespace Microsoft.PowerShell.Commands public SwitchParameter Transcript { get; set; } /// - /// set inner command. + /// Set inner command. /// public OutDefaultCommand() { @@ -60,7 +60,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// just hook up the LineOutput interface. + /// Just hook up the LineOutput interface. /// protected override void BeginProcessing() { @@ -166,7 +166,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// implementation for the out-host command. + /// Implementation for the out-host command. /// [Cmdlet(VerbsData.Out, "Host", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=113365", RemotingCapability = RemotingCapability.None)] public class OutHostCommand : FrontEndCommandBase @@ -174,14 +174,14 @@ namespace Microsoft.PowerShell.Commands #region Command Line Parameters /// - /// non positional parameter to specify paging. + /// Non positional parameter to specify paging. /// private bool _paging; #endregion /// - /// constructor of OutHostCommand. + /// Constructor of OutHostCommand. /// public OutHostCommand() { @@ -189,7 +189,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// optional, non positional parameter to specify paging + /// Optional, non positional parameter to specify paging /// FALSE: names only /// TRUE: full info. /// @@ -202,7 +202,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// just hook up the LineOutput interface. + /// Just hook up the LineOutput interface. /// protected override void BeginProcessing() { diff --git a/src/System.Management.Automation/FormatAndOutput/out-textInterface/OutTextInterface.cs b/src/System.Management.Automation/FormatAndOutput/out-textInterface/OutTextInterface.cs index f612877c9..2956889bc 100644 --- a/src/System.Management.Automation/FormatAndOutput/out-textInterface/OutTextInterface.cs +++ b/src/System.Management.Automation/FormatAndOutput/out-textInterface/OutTextInterface.cs @@ -10,7 +10,7 @@ using Microsoft.PowerShell.Commands.Internal.Format; namespace Microsoft.PowerShell.Commands { /// - /// implementation for the out-lineoutput command + /// Implementation for the out-lineoutput command /// it provides a wrapper for the OutCommandInner class, /// which is the general purpose output command. /// @@ -18,7 +18,7 @@ namespace Microsoft.PowerShell.Commands public class OutLineOutputCommand : FrontEndCommandBase { /// - /// command line switch for ILineOutput communication channel. + /// Command line switch for ILineOutput communication channel. /// /// [Parameter(Mandatory = true, Position = 0)] @@ -32,7 +32,7 @@ namespace Microsoft.PowerShell.Commands private object _lineOutput = null; /// - /// set inner command. + /// Set inner command. /// public OutLineOutputCommand() { diff --git a/src/System.Management.Automation/engine/COM/ComAdapter.cs b/src/System.Management.Automation/engine/COM/ComAdapter.cs index d4af27f33..afee12b53 100644 --- a/src/System.Management.Automation/engine/COM/ComAdapter.cs +++ b/src/System.Management.Automation/engine/COM/ComAdapter.cs @@ -205,7 +205,7 @@ namespace System.Management.Automation } /// - /// get the property signature. + /// Get the property signature. /// /// Property object whose signature we want. /// String representing the signature of the property. diff --git a/src/System.Management.Automation/engine/COM/ComMethod.cs b/src/System.Management.Automation/engine/COM/ComMethod.cs index 4e3fc3195..213924417 100644 --- a/src/System.Management.Automation/engine/COM/ComMethod.cs +++ b/src/System.Management.Automation/engine/COM/ComMethod.cs @@ -42,7 +42,7 @@ namespace System.Management.Automation } /// - /// Defines the name of the method. + /// Defines the name of the method. /// internal string Name { get; } @@ -80,7 +80,7 @@ namespace System.Management.Automation } /// - /// Invokes the method on object. + /// Invokes the method on object. /// /// Represents the instance of the method we want to invoke. /// Parameters to be passed to the method. diff --git a/src/System.Management.Automation/engine/COM/ComProperty.cs b/src/System.Management.Automation/engine/COM/ComProperty.cs index a09437100..0f9a3aa0c 100644 --- a/src/System.Management.Automation/engine/COM/ComProperty.cs +++ b/src/System.Management.Automation/engine/COM/ComProperty.cs @@ -35,14 +35,14 @@ namespace System.Management.Automation } /// - /// Defines the name of the property. + /// Defines the name of the property. /// internal string Name { get; } private Type _cachedType; /// - /// Defines the type of the property. + /// Defines the type of the property. /// internal Type Type { @@ -106,7 +106,7 @@ namespace System.Management.Automation } /// - /// Defines whether the property has parameters or not. + /// Defines whether the property has parameters or not. /// internal bool IsParameterized { get; private set; } = false; @@ -123,7 +123,7 @@ namespace System.Management.Automation } /// - /// Defines whether this property is settable. + /// Defines whether this property is settable. /// internal bool IsSettable { @@ -134,7 +134,7 @@ namespace System.Management.Automation } /// - /// Defines whether this property is gettable. + /// Defines whether this property is gettable. /// internal bool IsGettable { get; private set; } = false; diff --git a/src/System.Management.Automation/engine/COM/ComTypeInfo.cs b/src/System.Management.Automation/engine/COM/ComTypeInfo.cs index 4635a44b4..105a0e124 100644 --- a/src/System.Management.Automation/engine/COM/ComTypeInfo.cs +++ b/src/System.Management.Automation/engine/COM/ComTypeInfo.cs @@ -27,7 +27,7 @@ namespace System.Management.Automation internal const int DISPID_DEFAULTMEMBER = 0; /// - /// Member variables. + /// Member variables. /// private Dictionary _properties = null; private Dictionary _methods = null; @@ -35,7 +35,7 @@ namespace System.Management.Automation private Guid _guid = Guid.Empty; /// - /// Constructor. + /// Constructor. /// /// ITypeInfo object being wrapped by this object. internal ComTypeInfo(COM.ITypeInfo info) @@ -51,7 +51,7 @@ namespace System.Management.Automation } /// - /// Collection of properties in the COM object. + /// Collection of properties in the COM object. /// internal Dictionary Properties { @@ -62,7 +62,7 @@ namespace System.Management.Automation } /// - /// Collection of methods in the COM object. + /// Collection of methods in the COM object. /// internal Dictionary Methods { @@ -73,7 +73,7 @@ namespace System.Management.Automation } /// - /// Returns the string of the GUID for the type information. + /// Returns the string of the GUID for the type information. /// internal string Clsid { @@ -137,7 +137,7 @@ namespace System.Management.Automation } /// - /// Get the typeinfo interface for the given comobject. + /// Get the typeinfo interface for the given comobject. /// /// Reference to com object for which we are getting type information. /// ComTypeInfo object which wraps the ITypeInfo interface of the given COM object. @@ -204,7 +204,7 @@ namespace System.Management.Automation } /// - /// Get TypeAttr for the given type information. + /// Get TypeAttr for the given type information. /// /// Reference to ITypeInfo from which to get TypeAttr. /// diff --git a/src/System.Management.Automation/engine/COM/ComUtil.cs b/src/System.Management.Automation/engine/COM/ComUtil.cs index 3114a7937..e86c391ba 100644 --- a/src/System.Management.Automation/engine/COM/ComUtil.cs +++ b/src/System.Management.Automation/engine/COM/ComUtil.cs @@ -113,7 +113,7 @@ namespace System.Management.Automation } /// - /// Gets the name of the custom type defined in the type library. + /// Gets the name of the custom type defined in the type library. /// /// ITypeInfo interface of the type. /// Reference to the custom type. @@ -244,7 +244,7 @@ namespace System.Management.Automation } /// - /// Determine .net type for the given type descriptor. + /// Determine .net type for the given type descriptor. /// /// COM type descriptor to convert. /// Type represented by the typedesc. diff --git a/src/System.Management.Automation/engine/CmdletParameterBinderController.cs b/src/System.Management.Automation/engine/CmdletParameterBinderController.cs index 1540eea4d..38fd3cedd 100644 --- a/src/System.Management.Automation/engine/CmdletParameterBinderController.cs +++ b/src/System.Management.Automation/engine/CmdletParameterBinderController.cs @@ -4376,7 +4376,7 @@ namespace System.Management.Automation private bool _isChanged; /// - /// check to see if the hashtable has been changed since last check. + /// Check to see if the hashtable has been changed since last check. /// /// True for changed; false for not changed. public bool ChangeSinceLastCheck() @@ -4398,7 +4398,7 @@ namespace System.Management.Automation } /// - /// constructor takes a hash table. + /// Constructor takes a hash table. /// /// /// Check for the keys' formats and make it versionable diff --git a/src/System.Management.Automation/engine/CommandBase.cs b/src/System.Management.Automation/engine/CommandBase.cs index 4dfbd31ab..a6dd78d47 100644 --- a/src/System.Management.Automation/engine/CommandBase.cs +++ b/src/System.Management.Automation/engine/CommandBase.cs @@ -229,7 +229,7 @@ namespace System.Management.Automation.Internal #endregion Override /// - /// throws if the pipeline is stopping. + /// Throws if the pipeline is stopping. /// /// internal void ThrowIfStopping() diff --git a/src/System.Management.Automation/engine/CommandDiscovery.cs b/src/System.Management.Automation/engine/CommandDiscovery.cs index 52b3aa057..2d2af3fa4 100644 --- a/src/System.Management.Automation/engine/CommandDiscovery.cs +++ b/src/System.Management.Automation/engine/CommandDiscovery.cs @@ -513,7 +513,7 @@ namespace System.Management.Automation #endregion /// - /// used to determine compatibility between the versions in the requires statement and + /// Used to determine compatibility between the versions in the requires statement and /// the installed version. The version can be PSSnapin or msh. /// /// Versions in the requires statement. diff --git a/src/System.Management.Automation/engine/CommandInfo.cs b/src/System.Management.Automation/engine/CommandInfo.cs index 49386e1d1..03dbba057 100644 --- a/src/System.Management.Automation/engine/CommandInfo.cs +++ b/src/System.Management.Automation/engine/CommandInfo.cs @@ -298,7 +298,7 @@ namespace System.Management.Automation } /// - /// for diagnostic purposes. + /// For diagnostic purposes. /// /// public override string ToString() diff --git a/src/System.Management.Automation/engine/CoreAdapter.cs b/src/System.Management.Automation/engine/CoreAdapter.cs index 13c2d908e..dccdbb872 100644 --- a/src/System.Management.Automation/engine/CoreAdapter.cs +++ b/src/System.Management.Automation/engine/CoreAdapter.cs @@ -38,7 +38,7 @@ namespace System.Management.Automation internal abstract class Adapter { /// - /// tracer for this and derivate classes. + /// Tracer for this and derivate classes. /// [TraceSource("ETS", "Extended Type System")] protected static PSTraceSource tracer = PSTraceSource.GetTracer("ETS", "Extended Type System"); @@ -1873,7 +1873,7 @@ namespace System.Management.Automation #endregion base } /// - /// ordered and case insensitive hashtable. + /// Ordered and case insensitive hashtable. /// internal class CacheTable { @@ -4094,7 +4094,7 @@ namespace System.Management.Automation } /// - /// this is a flavor of MethodInvokeDotNet to deal with a peculiarity of property setters: + /// This is a flavor of MethodInvokeDotNet to deal with a peculiarity of property setters: /// Tthe setValue is always the last parameter. This enables a parameter after a varargs or optional /// parameters and GetBestMethodAndArguments is not prepared for that. /// This method disregards the last parameter in its call to GetBestMethodAndArguments used in this case @@ -4601,7 +4601,7 @@ namespace System.Management.Automation #endregion virtual } /// - /// adapter for properties in the inside PSObject if it has a null BaseObject. + /// Adapter for properties in the inside PSObject if it has a null BaseObject. /// internal class PSObjectAdapter : MemberRedirectionAdapter { @@ -4659,7 +4659,7 @@ namespace System.Management.Automation #endregion virtual } /// - /// adapter for properties inside a member set. + /// Adapter for properties inside a member set. /// internal class PSMemberSetAdapter : MemberRedirectionAdapter { diff --git a/src/System.Management.Automation/engine/ErrorPackage.cs b/src/System.Management.Automation/engine/ErrorPackage.cs index 30c5f7856..24cb63aa5 100644 --- a/src/System.Management.Automation/engine/ErrorPackage.cs +++ b/src/System.Management.Automation/engine/ErrorPackage.cs @@ -210,7 +210,7 @@ namespace System.Management.Automation } /// - /// text description of the operation which + /// Text description of the operation which /// encountered the error. /// /// text description of the operation @@ -244,7 +244,7 @@ namespace System.Management.Automation } /// - /// text description of the error. + /// Text description of the error. /// /// text description of the error /// @@ -277,7 +277,7 @@ namespace System.Management.Automation private bool _reasonIsExceptionType; /// - /// text description of the target object. + /// Text description of the target object. /// /// text description of the target object /// @@ -317,7 +317,7 @@ namespace System.Management.Automation } /// - /// text description of the type of the target object. + /// Text description of the type of the target object. /// /// text description of the type of the target object /// @@ -350,7 +350,7 @@ namespace System.Management.Automation #region Methods /// - /// concise text description based on + /// Concise text description based on /// /// /// Concise text description. @@ -380,7 +380,7 @@ namespace System.Management.Automation } /// - /// concise text description based on + /// Concise text description based on /// /// /// Culture in which to display message. @@ -499,7 +499,7 @@ namespace System.Management.Automation } /// - /// additional details about an + /// Additional details about an /// /// /// @@ -1063,7 +1063,7 @@ namespace System.Management.Automation #region Remoting /// - /// isSerialized is set to true if this error record is serialized. + /// IsSerialized is set to true if this error record is serialized. /// private bool _isSerialized = false; diff --git a/src/System.Management.Automation/engine/EventManager.cs b/src/System.Management.Automation/engine/EventManager.cs index 30853abcf..7e9a007e1 100644 --- a/src/System.Management.Automation/engine/EventManager.cs +++ b/src/System.Management.Automation/engine/EventManager.cs @@ -2518,7 +2518,7 @@ namespace System.Management.Automation public override string StatusMessage { get; } = null; /// - /// indicates if more data is available. + /// Indicates if more data is available. /// /// /// This has more data if any of the child jobs have more data. diff --git a/src/System.Management.Automation/engine/ExecutionContext.cs b/src/System.Management.Automation/engine/ExecutionContext.cs index 05d06267e..33ac31dce 100644 --- a/src/System.Management.Automation/engine/ExecutionContext.cs +++ b/src/System.Management.Automation/engine/ExecutionContext.cs @@ -375,7 +375,7 @@ namespace System.Management.Automation private PSLanguageMode _languageMode = PSLanguageMode.FullLanguage; /// - /// True if this runspace has ever used constrained language mode. + /// True if this runspace has ever used constrained language mode. /// internal bool HasRunspaceEverUsedConstrainedLanguageMode { get; private set; } diff --git a/src/System.Management.Automation/engine/GetCommandCommand.cs b/src/System.Management.Automation/engine/GetCommandCommand.cs index a118db6b5..10c0314ba 100644 --- a/src/System.Management.Automation/engine/GetCommandCommand.cs +++ b/src/System.Management.Automation/engine/GetCommandCommand.cs @@ -374,7 +374,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// method that implements get-command. + /// Method that implements get-command. /// protected override void ProcessRecord() { diff --git a/src/System.Management.Automation/engine/InitialSessionState.cs b/src/System.Management.Automation/engine/InitialSessionState.cs index fc4bbb303..46103372f 100644 --- a/src/System.Management.Automation/engine/InitialSessionState.cs +++ b/src/System.Management.Automation/engine/InitialSessionState.cs @@ -568,7 +568,7 @@ namespace System.Management.Automation.Runspaces public sealed class SessionStateAliasEntry : SessionStateCommandEntry { /// - /// Define an alias entry to add to the initial session state. + /// Define an alias entry to add to the initial session state. /// /// The name of the alias entry to add. /// The name of the command it resolves to. @@ -580,7 +580,7 @@ namespace System.Management.Automation.Runspaces } /// - /// Define an alias entry to add to the initial session state. + /// Define an alias entry to add to the initial session state. /// /// The name of the alias entry to add. /// The name of the command it resolves to. @@ -594,7 +594,7 @@ namespace System.Management.Automation.Runspaces } /// - /// Define an alias entry to add to the initial session state. + /// Define an alias entry to add to the initial session state. /// /// The name of the alias entry to add. /// The name of the command it resolves to. @@ -610,7 +610,7 @@ namespace System.Management.Automation.Runspaces } /// - /// Define an alias entry to add to the initial session state. + /// Define an alias entry to add to the initial session state. /// /// The name of the alias entry to add. /// The name of the command it resolves to. @@ -1473,7 +1473,7 @@ namespace System.Management.Automation.Runspaces #endregion /// - /// ctor for Custom-Shell - Do we need this? + /// Ctor for Custom-Shell - Do we need this? /// protected InitialSessionState() { @@ -3042,7 +3042,7 @@ namespace System.Management.Automation.Runspaces } /// - /// if is null, import module using . Otherwise, + /// If is null, import module using . Otherwise, /// import module using /// private RunspaceOpenModuleLoadException ProcessOneModule(Runspace initializedRunspace, string name, PSModuleInfo moduleInfoToLoad, string path, HashSet publicCommands) diff --git a/src/System.Management.Automation/engine/InvocationInfo.cs b/src/System.Management.Automation/engine/InvocationInfo.cs index 247d50015..af02544f2 100644 --- a/src/System.Management.Automation/engine/InvocationInfo.cs +++ b/src/System.Management.Automation/engine/InvocationInfo.cs @@ -218,7 +218,7 @@ namespace System.Management.Automation } /// - /// The line number in the executing script that contained this cmdlet. + /// The line number in the executing script that contained this cmdlet. /// /// The script line number or -1 if not executing in a script. public int ScriptLineNumber @@ -323,7 +323,7 @@ namespace System.Management.Automation public int PipelineLength { get; internal set; } /// - /// which element this command was in the containing pipeline. + /// Which element this command was in the containing pipeline. /// /// which element this command was in the containing pipeline public int PipelinePosition { get; internal set; } diff --git a/src/System.Management.Automation/engine/MshCommandRuntime.cs b/src/System.Management.Automation/engine/MshCommandRuntime.cs index 18d554787..de99919db 100644 --- a/src/System.Management.Automation/engine/MshCommandRuntime.cs +++ b/src/System.Management.Automation/engine/MshCommandRuntime.cs @@ -108,7 +108,7 @@ namespace System.Management.Automation } /// - /// for diagnostic purposes. + /// For diagnostic purposes. /// /// public override string ToString() @@ -2235,7 +2235,7 @@ namespace System.Management.Automation #region Internal helpers /// - /// throws if the pipeline is stopping. + /// Throws if the pipeline is stopping. /// /// internal void ThrowIfStopping() @@ -2245,7 +2245,7 @@ namespace System.Management.Automation } /// - /// throws if the caller is trying to call WriteObject/WriteError + /// Throws if the caller is trying to call WriteObject/WriteError /// from the wrong thread, or not during a call to /// BeginProcessing/ProcessRecord/EndProcessing. /// diff --git a/src/System.Management.Automation/engine/MshMemberInfo.cs b/src/System.Management.Automation/engine/MshMemberInfo.cs index c870ae229..d84fe45ce 100644 --- a/src/System.Management.Automation/engine/MshMemberInfo.cs +++ b/src/System.Management.Automation/engine/MshMemberInfo.cs @@ -275,7 +275,7 @@ namespace System.Management.Automation public abstract string TypeNameOfValue { get; } /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public abstract PSMemberInfo Copy(); @@ -433,7 +433,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -844,7 +844,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -1035,7 +1035,7 @@ namespace System.Management.Automation } /// - /// used by the adapters to keep intermediate data used between DoGetProperty and + /// Used by the adapters to keep intermediate data used between DoGetProperty and /// DoGetValue or DoSetValue. /// internal string typeOfValue; @@ -1087,7 +1087,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -1303,7 +1303,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -1444,7 +1444,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo, + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo, /// Note that it returns another reference to the variable, not a reference /// to a new variable... /// @@ -1752,7 +1752,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -2198,7 +2198,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -2426,7 +2426,7 @@ namespace System.Management.Automation } /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -2518,7 +2518,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -2984,7 +2984,7 @@ namespace System.Management.Automation public override string TypeNameOfValue => adapter.BaseParameterizedPropertyType(this); /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -3196,7 +3196,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -3460,7 +3460,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() @@ -3546,7 +3546,7 @@ namespace System.Management.Automation #region virtual implementation /// - /// returns a new PSMemberInfo that is a copy of this PSMemberInfo. + /// Returns a new PSMemberInfo that is a copy of this PSMemberInfo. /// /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() diff --git a/src/System.Management.Automation/engine/MshObject.cs b/src/System.Management.Automation/engine/MshObject.cs index 28ae298a8..b3ae3378e 100644 --- a/src/System.Management.Automation/engine/MshObject.cs +++ b/src/System.Management.Automation/engine/MshObject.cs @@ -1763,7 +1763,7 @@ namespace System.Management.Automation internal const string PSObjectMemberSetName = "psobject"; /// - /// a shortcut to .PSObject.TypeNames. + /// A shortcut to .PSObject.TypeNames. /// /// /// This needs to be Lower cased as it saves some comparison time elsewhere. diff --git a/src/System.Management.Automation/engine/NativeCommandProcessor.cs b/src/System.Management.Automation/engine/NativeCommandProcessor.cs index f62b6732a..babdc6906 100644 --- a/src/System.Management.Automation/engine/NativeCommandProcessor.cs +++ b/src/System.Management.Automation/engine/NativeCommandProcessor.cs @@ -374,7 +374,7 @@ namespace System.Management.Automation private Host.Coordinates _startPosition; /// - /// object used for synchronization between StopProcessing thread and + /// Object used for synchronization between StopProcessing thread and /// Pipeline thread. /// private object _sync = new object(); diff --git a/src/System.Management.Automation/engine/Pipe.cs b/src/System.Management.Automation/engine/Pipe.cs index 7f25fe0a5..a2473d1e4 100644 --- a/src/System.Management.Automation/engine/Pipe.cs +++ b/src/System.Management.Automation/engine/Pipe.cs @@ -88,7 +88,7 @@ namespace System.Management.Automation.Internal private PipelineWriter _externalWriter; /// - /// for diagnostic purposes. + /// For diagnostic purposes. /// /// public override string ToString() diff --git a/src/System.Management.Automation/engine/ScriptInfo.cs b/src/System.Management.Automation/engine/ScriptInfo.cs index 29426c585..26d087254 100644 --- a/src/System.Management.Automation/engine/ScriptInfo.cs +++ b/src/System.Management.Automation/engine/ScriptInfo.cs @@ -93,7 +93,7 @@ namespace System.Management.Automation } /// - /// for diagnostic purposes. + /// For diagnostic purposes. /// /// public override string ToString() diff --git a/src/System.Management.Automation/engine/SecurityManagerBase.cs b/src/System.Management.Automation/engine/SecurityManagerBase.cs index 699336e98..57dd32a3c 100644 --- a/src/System.Management.Automation/engine/SecurityManagerBase.cs +++ b/src/System.Management.Automation/engine/SecurityManagerBase.cs @@ -59,7 +59,7 @@ namespace System.Management.Automation #region methods to use internally /// - /// determine if we should run the specified file. + /// Determine if we should run the specified file. /// /// Info on entity to be run. /// The dispatch origin of a command. diff --git a/src/System.Management.Automation/engine/SessionStateStrings.cs b/src/System.Management.Automation/engine/SessionStateStrings.cs index cb620b46e..41c5208b9 100644 --- a/src/System.Management.Automation/engine/SessionStateStrings.cs +++ b/src/System.Management.Automation/engine/SessionStateStrings.cs @@ -54,7 +54,7 @@ namespace System.Management.Automation internal const string HomePath = "~"; /// - /// name of the global variable table in Variable scopes of session state. + /// Name of the global variable table in Variable scopes of session state. /// internal const string Global = "GLOBAL"; @@ -76,7 +76,7 @@ namespace System.Management.Automation internal const string Script = "SCRIPT"; /// - /// session state string used as resource name in exceptions. + /// Session state string used as resource name in exceptions. /// internal const string SessionState = "SessionState"; diff --git a/src/System.Management.Automation/engine/SessionStateUtils.cs b/src/System.Management.Automation/engine/SessionStateUtils.cs index cdcbe8951..cb13b947c 100644 --- a/src/System.Management.Automation/engine/SessionStateUtils.cs +++ b/src/System.Management.Automation/engine/SessionStateUtils.cs @@ -95,7 +95,7 @@ namespace System.Management.Automation internal const int DefaultDictionaryCapacity = 100; /// - /// default load factor on a hash table. + /// Default load factor on a hash table. /// internal const float DefaultHashTableLoadFactor = 0.25F; } diff --git a/src/System.Management.Automation/engine/SpecialVariables.cs b/src/System.Management.Automation/engine/SpecialVariables.cs index f9ee9e465..b867dfedc 100644 --- a/src/System.Management.Automation/engine/SpecialVariables.cs +++ b/src/System.Management.Automation/engine/SpecialVariables.cs @@ -202,13 +202,13 @@ namespace System.Management.Automation internal static readonly VariablePath ErrorViewVarPath = new VariablePath(ErrorView); /// - /// shell environment variable. + /// Shell environment variable. /// internal const string PSSessionConfigurationName = "PSSessionConfigurationName"; internal static readonly VariablePath PSSessionConfigurationNameVarPath = new VariablePath("global:" + PSSessionConfigurationName); /// - /// environment variable that will define the default + /// Environment variable that will define the default /// application name for the connection uri. /// internal const string PSSessionApplicationName = "PSSessionApplicationName"; diff --git a/src/System.Management.Automation/engine/TypeTable.cs b/src/System.Management.Automation/engine/TypeTable.cs index f5f548933..ca039f862 100644 --- a/src/System.Management.Automation/engine/TypeTable.cs +++ b/src/System.Management.Automation/engine/TypeTable.cs @@ -2637,14 +2637,14 @@ namespace System.Management.Automation.Runspaces /*concurrency*/3, /*capacity*/300, StringComparer.OrdinalIgnoreCase); /// - /// points to a Hashtable from type name to type converter. + /// Points to a Hashtable from type name to type converter. /// private readonly ConcurrentDictionary _typeConverters = new ConcurrentDictionary( /*concurrency*/1, /*capacity*/5, StringComparer.OrdinalIgnoreCase); /// - /// points to a Hashtable from type name to type adapter. + /// Points to a Hashtable from type name to type adapter. /// private readonly ConcurrentDictionary _typeAdapters = new ConcurrentDictionary( diff --git a/src/System.Management.Automation/engine/Utils.cs b/src/System.Management.Automation/engine/Utils.cs index dc553f79c..72e593d42 100644 --- a/src/System.Management.Automation/engine/Utils.cs +++ b/src/System.Management.Automation/engine/Utils.cs @@ -34,7 +34,7 @@ using TypeTable = System.Management.Automation.Runspaces.TypeTable; namespace System.Management.Automation { /// - /// helper fns. + /// Helper fns. /// internal static class Utils { @@ -80,7 +80,7 @@ namespace System.Management.Automation internal static string[] AllowedEditionValues = { "Desktop", "Core" }; /// - /// helper fn to check byte[] arg for null. + /// Helper fn to check byte[] arg for null. /// /// arg to check /// name of the arg @@ -106,7 +106,7 @@ namespace System.Management.Automation } /// - /// helper fn to check arg for empty or null. + /// Helper fn to check arg for empty or null. /// Throws ArgumentNullException on either condition. /// /// arg to check @@ -125,7 +125,7 @@ namespace System.Management.Automation } /// - /// helper fn to check arg for null. + /// Helper fn to check arg for null. /// Throws ArgumentNullException on either condition. /// /// arg to check @@ -140,7 +140,7 @@ namespace System.Management.Automation } /// - /// helper fn to check arg for null. + /// Helper fn to check arg for null. /// /// arg to check /// name of the arg @@ -341,7 +341,7 @@ namespace System.Management.Automation #region Versioning related methods /// - /// returns current major version of monad ( that is running ) in a string + /// Returns current major version of monad ( that is running ) in a string /// format. /// /// String. diff --git a/src/System.Management.Automation/engine/debugger/debugger.cs b/src/System.Management.Automation/engine/debugger/debugger.cs index 7f699dc22..55889abc6 100644 --- a/src/System.Management.Automation/engine/debugger/debugger.cs +++ b/src/System.Management.Automation/engine/debugger/debugger.cs @@ -175,7 +175,7 @@ namespace System.Management.Automation public sealed class PSJobStartEventArgs : EventArgs { /// - /// Job to be started. + /// Job to be started. /// public Job Job { diff --git a/src/System.Management.Automation/engine/hostifaces/Command.cs b/src/System.Management.Automation/engine/hostifaces/Command.cs index c05512ee0..b2b4543ed 100644 --- a/src/System.Management.Automation/engine/hostifaces/Command.cs +++ b/src/System.Management.Automation/engine/hostifaces/Command.cs @@ -190,7 +190,7 @@ namespace System.Management.Automation.Runspaces } /// - /// for diagnostic purposes. + /// For diagnostic purposes. /// /// public override string ToString() diff --git a/src/System.Management.Automation/engine/hostifaces/Connection.cs b/src/System.Management.Automation/engine/hostifaces/Connection.cs index f85f9068d..6b8617287 100644 --- a/src/System.Management.Automation/engine/hostifaces/Connection.cs +++ b/src/System.Management.Automation/engine/hostifaces/Connection.cs @@ -291,7 +291,7 @@ namespace System.Management.Automation.Runspaces #endregion public_properties /// - /// override for ToString() + /// Override for ToString() /// /// public override string ToString() diff --git a/src/System.Management.Automation/engine/hostifaces/History.cs b/src/System.Management.Automation/engine/hostifaces/History.cs index 0c268d47a..93f56e05c 100644 --- a/src/System.Management.Automation/engine/hostifaces/History.cs +++ b/src/System.Management.Automation/engine/hostifaces/History.cs @@ -783,7 +783,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// buffer. + /// Buffer. /// private HistoryInfo[] _buffer; @@ -798,7 +798,7 @@ namespace Microsoft.PowerShell.Commands private int _countEntriesInBuffer; /// - /// total number of entries added till now including those which have + /// Total number of entries added till now including those which have /// been overwritten after buffer got full. This is also number of /// last entry added. /// @@ -812,7 +812,7 @@ namespace Microsoft.PowerShell.Commands #endregion private /// - /// return the ID of the next history item to be added. + /// Return the ID of the next history item to be added. /// internal long GetNextHistoryId() { @@ -1343,7 +1343,7 @@ namespace Microsoft.PowerShell.Commands #endregion parameters /// - /// override for BeginProcessing. + /// Override for BeginProcessing. /// protected override @@ -1361,7 +1361,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// override for ProcessRecord. + /// Override for ProcessRecord. /// protected override @@ -1598,13 +1598,13 @@ namespace Microsoft.PowerShell.Commands } /// - /// id of a history entry. + /// Id of a history entry. /// private int[] _id; /// - /// command line name of an entry in the session history. + /// Command line name of an entry in the session history. /// [Parameter(ParameterSetName = "CommandLineParameter", HelpMessage = "Specifies the name of a command in the session history")] @@ -1624,7 +1624,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// commandline parameter. + /// Commandline parameter. /// private string[] _commandline = null; @@ -1649,12 +1649,12 @@ namespace Microsoft.PowerShell.Commands } /// - /// count of the history entries. + /// Count of the history entries. /// private int _count = 32; /// - /// a boolean variable to indicate if the count parameter specified. + /// A boolean variable to indicate if the count parameter specified. /// private bool _countParameterSpecified = false; @@ -1677,7 +1677,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// switch parameter on the history entries. + /// Switch parameter on the history entries. /// private SwitchParameter _newest; @@ -1960,12 +1960,12 @@ namespace Microsoft.PowerShell.Commands } /// - /// history obj. + /// History obj. /// private History _history; /// - /// array of historyinfo objects. + /// Array of historyinfo objects. /// private HistoryInfo[] _entries; diff --git a/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs b/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs index fbdfc439e..9753530cc 100644 --- a/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs +++ b/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs @@ -1062,7 +1062,7 @@ namespace System.Management.Automation.Runspaces } /// - /// sets the history string to the specified one. + /// Sets the history string to the specified one. /// /// History string to set to. internal override void SetHistoryString(string historyString) @@ -1312,7 +1312,7 @@ namespace System.Management.Automation.Runspaces internal class PipelineStopper { /// - /// stack of current executing pipeline processor. + /// Stack of current executing pipeline processor. /// private Stack _stack = new Stack(); diff --git a/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs b/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs index d93e14b97..13247bd62 100644 --- a/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs +++ b/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs @@ -138,7 +138,7 @@ namespace System.Management.Automation private bool _blockingEnumerator = false; /// - /// whether the ref count was incremented when + /// Whether the ref count was incremented when /// BlockingEnumerator was updated. /// private bool _refCountIncrementedForBlockingEnumerator = false; diff --git a/src/System.Management.Automation/engine/hostifaces/Parameter.cs b/src/System.Management.Automation/engine/hostifaces/Parameter.cs index e9c1d525f..652257825 100644 --- a/src/System.Management.Automation/engine/hostifaces/Parameter.cs +++ b/src/System.Management.Automation/engine/hostifaces/Parameter.cs @@ -68,12 +68,12 @@ namespace System.Management.Automation.Runspaces #region Public properties /// - /// gets the parameter name. + /// Gets the parameter name. /// public string Name { get; } /// - /// gets the value of the parameter. + /// Gets the value of the parameter. /// public object Value { get; } diff --git a/src/System.Management.Automation/engine/hostifaces/Pipeline.cs b/src/System.Management.Automation/engine/hostifaces/Pipeline.cs index 7875c3d1f..5e59b1a15 100644 --- a/src/System.Management.Automation/engine/hostifaces/Pipeline.cs +++ b/src/System.Management.Automation/engine/hostifaces/Pipeline.cs @@ -322,7 +322,7 @@ namespace System.Management.Automation.Runspaces #region properties /// - /// gets the runspace this pipeline is created on. + /// Gets the runspace this pipeline is created on. /// public abstract Runspace Runspace { get; } @@ -346,7 +346,7 @@ namespace System.Management.Automation.Runspaces } /// - /// gets input writer for this pipeline. + /// Gets input writer for this pipeline. /// /// /// When the caller calls Input.Write(), the caller writes to the @@ -368,7 +368,7 @@ namespace System.Management.Automation.Runspaces public abstract PipelineReader Output { get; } /// - /// gets the error output reader for this pipeline. + /// Gets the error output reader for this pipeline. /// /// /// When the caller calls Error.Read(), the caller reads from the @@ -408,13 +408,13 @@ namespace System.Management.Automation.Runspaces } /// - /// gets the unique identifier for this pipeline. This identifier is unique with in + /// Gets the unique identifier for this pipeline. This identifier is unique with in /// the scope of Runspace. /// public long InstanceId { get; } /// - /// gets the collection of commands for this pipeline. + /// Gets the collection of commands for this pipeline. /// public CommandCollection Commands { get; private set; } diff --git a/src/System.Management.Automation/engine/hostifaces/PowerShell.cs b/src/System.Management.Automation/engine/hostifaces/PowerShell.cs index 8e19db175..91c9d3ae7 100644 --- a/src/System.Management.Automation/engine/hostifaces/PowerShell.cs +++ b/src/System.Management.Automation/engine/hostifaces/PowerShell.cs @@ -508,7 +508,7 @@ namespace System.Management.Automation // a BeginStop operation. /// - /// true if AsyncResult monitors Async BeginInvoke(). + /// True if AsyncResult monitors Async BeginInvoke(). /// false otherwise. /// internal bool IsAssociatedWithAsyncInvoke { get; } @@ -4157,7 +4157,7 @@ namespace System.Management.Automation } /// - /// clear the internal reference to remote powershell. + /// Clear the internal reference to remote powershell. /// internal void ClearRemotePowerShell() { diff --git a/src/System.Management.Automation/engine/hostifaces/RunspaceInit.cs b/src/System.Management.Automation/engine/hostifaces/RunspaceInit.cs index 8ecea5684..d96161907 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspaceInit.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspaceInit.cs @@ -14,7 +14,7 @@ namespace System.Management.Automation.Runspaces class LocalRunspace : RunspaceBase { /// - /// initialize default values of preference vars. + /// Initialize default values of preference vars. /// /// Does not return a value. private void InitializeDefaults() diff --git a/src/System.Management.Automation/engine/hostifaces/RunspacePool.cs b/src/System.Management.Automation/engine/hostifaces/RunspacePool.cs index 826000d2b..31e5d533b 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspacePool.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspacePool.cs @@ -228,12 +228,12 @@ namespace System.Management.Automation.Runspaces Disconnecting = 6, /// - /// The RunspacePool has been disconnected. + /// The RunspacePool has been disconnected. /// Disconnected = 7, /// - /// The RunspacePool is being connected. + /// The RunspacePool is being connected. /// Connecting = 8, } @@ -399,7 +399,7 @@ namespace System.Management.Automation.Runspaces #region Internal Properties /// - /// true if AsyncResult monitors Async Open. + /// True if AsyncResult monitors Async Open. /// false otherwise. /// internal bool IsAssociatedWithAsyncOpen { get; } diff --git a/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs b/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs index a984fc716..a609a34a3 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs @@ -180,7 +180,7 @@ namespace System.Management.Automation.Runspaces.Internal } /// - /// default constructor. + /// Default constructor. /// internal RunspacePoolInternal() { } @@ -263,7 +263,7 @@ namespace System.Management.Automation.Runspaces.Internal } /// - /// the connection associated with this runspace pool. + /// The connection associated with this runspace pool. /// public virtual RunspaceConnectionInfo ConnectionInfo { diff --git a/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs b/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs index ea3e286e3..305514f70 100644 --- a/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs +++ b/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs @@ -187,7 +187,7 @@ namespace System.Management.Automation.Runspaces } /// - /// Is this a pulse pipeline (created by the EventManager) + /// Is this a pulse pipeline (created by the EventManager) /// internal bool IsPulsePipeline { get; set; } @@ -963,7 +963,7 @@ namespace System.Management.Automation.Runspaces // can access it. /// - /// if true, this pipeline is added in history. + /// If true, this pipeline is added in history. /// internal bool AddToHistory { get; set; } diff --git a/src/System.Management.Automation/engine/interpreter/LightDelegateCreator.cs b/src/System.Management.Automation/engine/interpreter/LightDelegateCreator.cs index 3916a006a..5c96d2f68 100644 --- a/src/System.Management.Automation/engine/interpreter/LightDelegateCreator.cs +++ b/src/System.Management.Automation/engine/interpreter/LightDelegateCreator.cs @@ -67,7 +67,7 @@ namespace System.Management.Automation.Interpreter } /// - /// true if the compiled delegate has the same type as the lambda; + /// True if the compiled delegate has the same type as the lambda; /// false if the type was changed for interpretation. /// internal bool SameDelegateType diff --git a/src/System.Management.Automation/engine/lang/parserutils.cs b/src/System.Management.Automation/engine/lang/parserutils.cs index 9b3c8bad1..35474a1eb 100644 --- a/src/System.Management.Automation/engine/lang/parserutils.cs +++ b/src/System.Management.Automation/engine/lang/parserutils.cs @@ -427,7 +427,7 @@ namespace System.Management.Automation } /// - /// private method used to call the op_* operations for the math operators. + /// Private method used to call the op_* operations for the math operators. /// /// Left operand. /// Right operand. diff --git a/src/System.Management.Automation/engine/parser/TypeInferenceVisitor.cs b/src/System.Management.Automation/engine/parser/TypeInferenceVisitor.cs index 95223bce4..96c7bdb32 100644 --- a/src/System.Management.Automation/engine/parser/TypeInferenceVisitor.cs +++ b/src/System.Management.Automation/engine/parser/TypeInferenceVisitor.cs @@ -133,7 +133,7 @@ namespace System.Management.Automation } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// The powerShell instance passed need to have a non null Runspace. /// /// The instance of powershell to use for expression evaluation needed for type inference. diff --git a/src/System.Management.Automation/engine/parser/ast.cs b/src/System.Management.Automation/engine/parser/ast.cs index 7ac85f386..1cb699adf 100644 --- a/src/System.Management.Automation/engine/parser/ast.cs +++ b/src/System.Management.Automation/engine/parser/ast.cs @@ -3264,7 +3264,7 @@ namespace System.Management.Automation.Language public ScriptBlockAst Body { get { return _functionDefinitionAst.Body; } } /// - /// Method attribute flags. + /// Method attribute flags. /// public MethodAttributes MethodAttributes { get; private set; } @@ -3674,8 +3674,8 @@ namespace System.Management.Automation.Language } /// - /// Return the help content, if any, for the function. - /// Use this overload when parsing multiple functions within a single scope. + /// Return the help content, if any, for the function. + /// Use this overload when parsing multiple functions within a single scope. /// /// A dictionary that the parser will use to /// map AST nodes to their respective tokens. The parser uses this to improve performance diff --git a/src/System.Management.Automation/engine/parser/tokenizer.cs b/src/System.Management.Automation/engine/parser/tokenizer.cs index 1c1bb06e6..f80350a56 100644 --- a/src/System.Management.Automation/engine/parser/tokenizer.cs +++ b/src/System.Management.Automation/engine/parser/tokenizer.cs @@ -86,7 +86,7 @@ namespace System.Management.Automation.Language private static Dictionary t_dynamicKeywords; /// - /// stack of DynamicKeywords Cache. + /// Stack of DynamicKeywords Cache. /// private static Stack> DynamicKeywordsStack { diff --git a/src/System.Management.Automation/engine/regex.cs b/src/System.Management.Automation/engine/regex.cs index 92f40b2ea..57c068865 100644 --- a/src/System.Management.Automation/engine/regex.cs +++ b/src/System.Management.Automation/engine/regex.cs @@ -70,7 +70,7 @@ namespace System.Management.Automation internal WildcardOptions Options { get; } = WildcardOptions.None; /// - /// wildcard pattern converted to regex pattern. + /// Wildcard pattern converted to regex pattern. /// internal string PatternConvertedToRegex { diff --git a/src/System.Management.Automation/engine/remoting/client/ClientRemotePowerShell.cs b/src/System.Management.Automation/engine/remoting/client/ClientRemotePowerShell.cs index 2d1488226..61cd79f7a 100644 --- a/src/System.Management.Automation/engine/remoting/client/ClientRemotePowerShell.cs +++ b/src/System.Management.Automation/engine/remoting/client/ClientRemotePowerShell.cs @@ -80,7 +80,7 @@ namespace System.Management.Automation.Runspaces.Internal } /// - /// whether input is available when this object is created. + /// Whether input is available when this object is created. /// internal bool NoInput { @@ -132,7 +132,7 @@ namespace System.Management.Automation.Runspaces.Internal } /// - /// data structure handler object. + /// Data structure handler object. /// internal ClientPowerShellDataStructureHandler DataStructureHandler { diff --git a/src/System.Management.Automation/engine/remoting/client/Job.cs b/src/System.Management.Automation/engine/remoting/client/Job.cs index 2c4256ad7..39a5e35ff 100644 --- a/src/System.Management.Automation/engine/remoting/client/Job.cs +++ b/src/System.Management.Automation/engine/remoting/client/Job.cs @@ -34,12 +34,12 @@ namespace System.Management.Automation NotStarted = 0, /// - /// execution of command in progress. + /// Execution of command in progress. /// Running = 1, /// - /// execution of command completed in all + /// Execution of command completed in all /// computernames/runspaces. /// Completed = 2, @@ -283,7 +283,7 @@ namespace System.Management.Automation #endregion public_properties /// - /// override for ToString() + /// Override for ToString() /// /// public override string ToString() @@ -591,7 +591,7 @@ namespace System.Management.Automation } /// - /// unique identifier for this job. + /// Unique identifier for this job. /// public Guid InstanceId { get; } = Guid.NewGuid(); @@ -2193,7 +2193,7 @@ namespace System.Management.Automation private bool _moreData = true; /// - /// indicates if more data is available. + /// Indicates if more data is available. /// /// /// This has more data if any of the child jobs have more data. @@ -2284,7 +2284,7 @@ namespace System.Management.Automation } /// - /// used by Invoke-Command cmdlet to show/hide computername property value. + /// Used by Invoke-Command cmdlet to show/hide computername property value. /// Format and Output has capability to understand RemoteObjects and this property lets /// Format and Output decide whether to show/hide computername. /// Default is true. @@ -2928,12 +2928,12 @@ namespace System.Management.Automation public Runspace Runspace { get; } /// - /// helper associated with this entity. + /// Helper associated with this entity. /// internal ExecutionCmdletHelper Helper { get; } = null; /// - /// used by Invoke-Command cmdlet to show/hide computername property value. + /// Used by Invoke-Command cmdlet to show/hide computername property value. /// Format and Output has capability to understand RemoteObjects and this property lets /// Format and Output decide whether to show/hide computername. /// Default is true. @@ -3689,7 +3689,7 @@ namespace System.Management.Automation } /// - /// register for throttle complete from the specified + /// Register for throttle complete from the specified /// throttlemanager. /// /// @@ -3699,7 +3699,7 @@ namespace System.Management.Automation } /// - /// unregister for throttle complete from the specified + /// Unregister for throttle complete from the specified /// throttle manager. /// /// @@ -4175,7 +4175,7 @@ namespace System.Management.Automation } /// - /// release all resources. + /// Release all resources. /// /// True if called by Dispose(). protected override void Dispose(bool disposing) diff --git a/src/System.Management.Automation/engine/remoting/client/Job2.cs b/src/System.Management.Automation/engine/remoting/client/Job2.cs index f3bc810e4..4e2bc2f02 100644 --- a/src/System.Management.Automation/engine/remoting/client/Job2.cs +++ b/src/System.Management.Automation/engine/remoting/client/Job2.cs @@ -202,7 +202,7 @@ namespace System.Management.Automation #region State Management /// - /// start a job. The job will be started with the parameters + /// Start a job. The job will be started with the parameters /// specified in StartParameters. /// /// It is redundant to have a method named StartJob @@ -722,7 +722,7 @@ namespace System.Management.Automation } /// - /// indicates if more data is available. + /// Indicates if more data is available. /// /// /// This has more data if any of the child jobs have more data. diff --git a/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs b/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs index 9ca59a926..15b49cc2c 100644 --- a/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs +++ b/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs @@ -99,7 +99,7 @@ namespace System.Management.Automation #region Overrides of Job2 /// - /// start a job. The job will be started with the parameters + /// Start a job. The job will be started with the parameters /// specified in StartParameters. /// /// Thrown if the job diff --git a/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs b/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs index 85a215303..82530989e 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs @@ -203,7 +203,7 @@ namespace System.Management.Automation.Runspaces.Internal #region Properties /// - /// the connection associated with this runspace pool. + /// The connection associated with this runspace pool. /// public override RunspaceConnectionInfo ConnectionInfo { diff --git a/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs b/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs index dbc509548..df6d67b5e 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs @@ -28,14 +28,14 @@ namespace System.Management.Automation.Runspaces private OriginInfo _originInfo; /// - /// constructor. + /// Constructor. /// /// The error record that is wrapped. /// Origin information. public RemotingErrorRecord(ErrorRecord errorRecord, OriginInfo originInfo) : this(errorRecord, originInfo, null) { } /// - /// constructor that is used to wrap an error record. + /// Constructor that is used to wrap an error record. /// /// /// @@ -341,7 +341,7 @@ namespace System.Management.Automation.Remoting private Guid _instanceId; /// - /// public constructor. + /// Public constructor. /// /// Machine name. /// Instance id of runspace. @@ -351,7 +351,7 @@ namespace System.Management.Automation.Remoting { } /// - /// public constructor. + /// Public constructor. /// /// Machine name. /// Instance id of runspace. diff --git a/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs b/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs index 4d36496f3..0d5185c2c 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs @@ -270,7 +270,7 @@ namespace System.Management.Automation.Internal } /// - /// dispatch the message to the associated powershell data structure handler. + /// Dispatch the message to the associated powershell data structure handler. /// /// Message received. internal void DispatchMessageToPowerShell(RemoteDataObject rcvdData) @@ -288,7 +288,7 @@ namespace System.Management.Automation.Internal } /// - /// send the host response to the server. + /// Send the host response to the server. /// /// Host response object to send. internal void SendHostResponseToServer(RemoteHostResponse hostResponse) @@ -309,7 +309,7 @@ namespace System.Management.Automation.Internal } /// - /// sent a message to modify the max runspaces of the runspace pool. + /// Sent a message to modify the max runspaces of the runspace pool. /// /// New maxrunspaces to set. /// call id on which the calling method will @@ -951,7 +951,7 @@ namespace System.Management.Automation.Internal #region IDisposable /// - /// public interface for dispose. + /// Public interface for dispose. /// public void Dispose() { @@ -988,7 +988,7 @@ namespace System.Management.Automation.Internal #region Data Structure Handler events /// - /// this event is raised when the state of associated + /// This event is raised when the state of associated /// powershell is terminal and the runspace pool has /// to detach the association. /// @@ -1517,7 +1517,7 @@ namespace System.Management.Automation.Internal } /// - /// transport manager used by this data structure handler. + /// Transport manager used by this data structure handler. /// internal BaseClientCommandTransportManager TransportManager { get; } diff --git a/src/System.Management.Automation/engine/remoting/client/clientremotesession.cs b/src/System.Management.Automation/engine/remoting/client/clientremotesession.cs index ea294145b..ba4573453 100644 --- a/src/System.Management.Automation/engine/remoting/client/clientremotesession.cs +++ b/src/System.Management.Automation/engine/remoting/client/clientremotesession.cs @@ -136,7 +136,7 @@ namespace System.Management.Automation.Remoting private RemoteRunspacePoolInternal _remoteRunspacePool; /// - /// remote runspace pool if used, for this session. + /// Remote runspace pool if used, for this session. /// internal RemoteRunspacePoolInternal RemoteRunspacePoolInternal { diff --git a/src/System.Management.Automation/engine/remoting/client/clientremotesessionprotocolstatemachine.cs b/src/System.Management.Automation/engine/remoting/client/clientremotesessionprotocolstatemachine.cs index ba9470553..a100227c8 100644 --- a/src/System.Management.Automation/engine/remoting/client/clientremotesessionprotocolstatemachine.cs +++ b/src/System.Management.Automation/engine/remoting/client/clientremotesessionprotocolstatemachine.cs @@ -67,19 +67,19 @@ namespace System.Management.Automation.Remoting private Timer _keyExchangeTimer; /// - /// indicates that the client has previously completed the session key exchange. + /// Indicates that the client has previously completed the session key exchange. /// private bool _keyExchanged = false; /// - /// this is to queue up a disconnect request when a key exchange is in process + /// This is to queue up a disconnect request when a key exchange is in process /// the session will be disconnect once the exchange is complete /// intermediate disconnect requests are tracked by this flag. /// private bool _pendingDisconnect = false; /// - /// processes events in the queue. If there are no + /// Processes events in the queue. If there are no /// more events to process, then sets eventsInProcess /// variable to false. This will ensure that another /// thread which raises an event can then take control diff --git a/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs b/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs index c40ef28d8..eff6e0023 100644 --- a/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs +++ b/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs @@ -192,7 +192,7 @@ namespace System.Management.Automation } /// - /// override for creating a copy of pipeline. + /// Override for creating a copy of pipeline. /// /// /// Pipeline object which is copy of this pipeline @@ -251,7 +251,7 @@ namespace System.Management.Automation } /// - /// internal method to set the value of IsNested. This is called + /// Internal method to set the value of IsNested. This is called /// by serializer. /// internal void SetIsNested(bool isNested) @@ -261,7 +261,7 @@ namespace System.Management.Automation } /// - /// internal method to set the value of IsSteppable. This is called + /// Internal method to set the value of IsSteppable. This is called /// during DoConcurrentCheck. /// internal void SetIsSteppable(bool isSteppable) diff --git a/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs b/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs index 292efa404..b390e3f9b 100644 --- a/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs +++ b/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs @@ -221,7 +221,7 @@ namespace System.Management.Automation #region Properties /// - /// initialsessionstate information for this runspace. + /// Initialsessionstate information for this runspace. /// public override InitialSessionState InitialSessionState { @@ -2227,11 +2227,11 @@ namespace System.Management.Automation #region Internal Methods /// - /// Internal method that checks the debug state of - /// the remote session and raises the DebuggerStop event - /// if debugger is in stopped state. - /// This is used internally to help clients get back to - /// debug state when reconnecting to remote session in debug state. + /// Internal method that checks the debug state of + /// the remote session and raises the DebuggerStop event + /// if debugger is in stopped state. + /// This is used internally to help clients get back to + /// debug state when reconnecting to remote session in debug state. /// internal void CheckStateAndRaiseStopEvent() { diff --git a/src/System.Management.Automation/engine/remoting/client/remotingprotocolimplementation.cs b/src/System.Management.Automation/engine/remoting/client/remotingprotocolimplementation.cs index 03a2d7dfc..25d481239 100644 --- a/src/System.Management.Automation/engine/remoting/client/remotingprotocolimplementation.cs +++ b/src/System.Management.Automation/engine/remoting/client/remotingprotocolimplementation.cs @@ -737,7 +737,7 @@ namespace System.Management.Automation.Remoting #region IDisposable /// - /// public method for dispose. + /// Public method for dispose. /// public void Dispose() { @@ -747,7 +747,7 @@ namespace System.Management.Automation.Remoting } /// - /// release all resources. + /// Release all resources. /// /// If true, release all managed resources. protected void Dispose(bool disposing) diff --git a/src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs b/src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs index 56407011d..163ab1606 100644 --- a/src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs +++ b/src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs @@ -2013,7 +2013,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// internal dispose method which does the actual disposing. + /// Internal dispose method which does the actual disposing. /// /// Whether called from dispose or finalize. private void Dispose(bool disposing) @@ -2086,7 +2086,7 @@ namespace System.Management.Automation.Internal private Timer _updateTimer; /// - /// Constructor. + /// Constructor. /// public RobustConnectionProgress() { diff --git a/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs b/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs index b0dd9d741..f4b2aff0b 100644 --- a/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs +++ b/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs @@ -7,7 +7,7 @@ using System.Management.Automation.Remoting; namespace System.Management.Automation { /// - /// class which has list of job objects currently active in the system. + /// Class which has list of job objects currently active in the system. /// public abstract class Repository where T : class { @@ -84,7 +84,7 @@ namespace System.Management.Automation protected abstract Guid GetKey(T item); /// - /// internal constructor. + /// Internal constructor. /// protected Repository(string identifier) { @@ -140,7 +140,7 @@ namespace System.Management.Automation } /// - /// class which has list of job objects currently active in the system. + /// Class which has list of job objects currently active in the system. /// public class JobRepository : Repository { @@ -169,7 +169,7 @@ namespace System.Management.Automation #region Internal Methods /// - /// internal constructor. + /// Internal constructor. /// internal JobRepository() : base("job") { diff --git a/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs b/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs index 88137aa2d..21edc9644 100644 --- a/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs +++ b/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs @@ -189,7 +189,7 @@ namespace Microsoft.PowerShell.Commands protected const string SSHHostHashParameterSet = "SSHHostHashParam"; /// - /// runspace parameter set. + /// Runspace parameter set. /// protected const string SessionParameterSet = "Session"; @@ -199,7 +199,7 @@ namespace Microsoft.PowerShell.Commands protected const string DefaultPowerShellRemoteShellName = System.Management.Automation.Remoting.Client.WSManNativeApi.ResourceURIPrefix + "Microsoft.PowerShell"; /// - /// default application name for the connection uri. + /// Default application name for the connection uri. /// protected const string DefaultPowerShellRemoteShellAppName = "WSMan"; @@ -3181,12 +3181,12 @@ namespace Microsoft.PowerShell.Commands protected const string InstanceIdParameterSet = "InstanceId"; /// - /// session id parameter set. + /// Session id parameter set. /// protected const string IdParameterSet = "Id"; /// - /// name parameter set. + /// Name parameter set. /// protected const string NameParameterSet = "Name"; @@ -4256,7 +4256,7 @@ namespace System.Management.Automation.Remoting /// None = 0, /// - /// use the Internet Explorer proxy configuration for the current user. + /// Use the Internet Explorer proxy configuration for the current user. /// Internet Explorer proxy settings for the current active network connection. /// This option requires the user profile to be loaded, so the option can /// be directly used when called within a process that is running under @@ -4266,7 +4266,7 @@ namespace System.Management.Automation.Remoting /// IEConfig = 1, /// - /// proxy settings configured for WinHTTP, using the ProxyCfg.exe utility. + /// Proxy settings configured for WinHTTP, using the ProxyCfg.exe utility. /// WinHttpConfig = 2, /// @@ -4274,7 +4274,7 @@ namespace System.Management.Automation.Remoting /// AutoDetect = 4, /// - /// do not use a proxy server - resolves all host names locally. + /// Do not use a proxy server - resolves all host names locally. /// NoProxyServer = 8 } diff --git a/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs b/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs index 85f801e8e..52b118af9 100644 --- a/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs +++ b/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs @@ -575,7 +575,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// if we are not stopping, continue writing output + /// If we are not stopping, continue writing output /// as and when they are available. /// protected override void EndProcessing() diff --git a/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs b/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs index 4d9122722..f784cafe7 100644 --- a/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs +++ b/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs @@ -946,7 +946,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// release waiting for jobs. + /// Release waiting for jobs. /// protected override void StopProcessing() { diff --git a/src/System.Management.Automation/engine/remoting/commands/StartJob.cs b/src/System.Management.Automation/engine/remoting/commands/StartJob.cs index e964cc4bc..7e8c160f9 100644 --- a/src/System.Management.Automation/engine/remoting/commands/StartJob.cs +++ b/src/System.Management.Automation/engine/remoting/commands/StartJob.cs @@ -731,7 +731,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// internal dispose method which does the actual disposing. + /// Internal dispose method which does the actual disposing. /// /// Whether called from dispose or finalize. private void Dispose(bool disposing) diff --git a/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs b/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs index 4b04f9a49..a349a4fb1 100644 --- a/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs +++ b/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs @@ -961,7 +961,7 @@ namespace System.Management.Automation.Runspaces } /// - /// constructor to create a WSManConnectionInfo with a + /// Constructor to create a WSManConnectionInfo with a /// uri specified and the default credentials, /// default server life time and default open /// timeout. @@ -1085,12 +1085,12 @@ namespace System.Management.Automation.Runspaces } /// - /// string for http scheme. + /// String for http scheme. /// public const string HttpScheme = "http"; /// - /// string for https scheme. + /// String for https scheme. /// public const string HttpsScheme = "https"; @@ -1245,7 +1245,7 @@ namespace System.Management.Automation.Runspaces } /// - /// returns connection string without the scheme portion. + /// Returns connection string without the scheme portion. /// /// /// The uri from which the string will be extracted @@ -1401,12 +1401,12 @@ namespace System.Management.Automation.Runspaces #endif /// - /// default port for http scheme. + /// Default port for http scheme. /// private const int DefaultPortHttp = 80; /// - /// default port for https scheme. + /// Default port for https scheme. /// private const int DefaultPortHttps = 443; @@ -1418,7 +1418,7 @@ namespace System.Management.Automation.Runspaces private const int DefaultPort = 0; /// - /// default remote host name. + /// Default remote host name. /// private const string DefaultComputerName = "localhost"; diff --git a/src/System.Management.Automation/engine/remoting/common/WireDataFormat/EncodeAndDecode.cs b/src/System.Management.Automation/engine/remoting/common/WireDataFormat/EncodeAndDecode.cs index 1c00bbbba..7938923cd 100644 --- a/src/System.Management.Automation/engine/remoting/common/WireDataFormat/EncodeAndDecode.cs +++ b/src/System.Management.Automation/engine/remoting/common/WireDataFormat/EncodeAndDecode.cs @@ -1838,7 +1838,7 @@ namespace System.Management.Automation } /// - /// decode and obtain the RunspacePool state info from the + /// Decode and obtain the RunspacePool state info from the /// data object specified. /// /// Data object to decode. @@ -1857,7 +1857,7 @@ namespace System.Management.Automation } /// - /// decode and obtain the application private data from the + /// Decode and obtain the application private data from the /// data object specified. /// /// Data object to decode. @@ -1903,7 +1903,7 @@ namespace System.Management.Automation } /// - /// decode and obtain the RunspacePool state info from the + /// Decode and obtain the RunspacePool state info from the /// data object specified. /// /// Data object to decode. @@ -1943,7 +1943,7 @@ namespace System.Management.Automation } /// - /// decode and obtain the minimum runspaces to create in the + /// Decode and obtain the minimum runspaces to create in the /// runspace pool from the data object specified. /// /// Data object to decode. @@ -1959,7 +1959,7 @@ namespace System.Management.Automation } /// - /// decode and obtain the maximum runspaces to create in the + /// Decode and obtain the maximum runspaces to create in the /// runspace pool from the data object specified. /// /// Data object to decode. @@ -1975,7 +1975,7 @@ namespace System.Management.Automation } /// - /// decode and obtain the thread options for the runspaces in the + /// Decode and obtain the thread options for the runspaces in the /// runspace pool from the data object specified. /// /// Data object to decode. @@ -2011,7 +2011,7 @@ namespace System.Management.Automation } /// - /// decode and obtain the thread options for the runspaces in the + /// Decode and obtain the thread options for the runspaces in the /// runspace pool from the data object specified. /// /// Data object to decode. @@ -2027,7 +2027,7 @@ namespace System.Management.Automation } /// - /// decode and obtain the host info for the host + /// Decode and obtain the host info for the host /// associated with the runspace pool. /// /// DataAsPSObject object to decode. diff --git a/src/System.Management.Automation/engine/remoting/common/misc.cs b/src/System.Management.Automation/engine/remoting/common/misc.cs index bec48c5ec..62ebb71b4 100644 --- a/src/System.Management.Automation/engine/remoting/common/misc.cs +++ b/src/System.Management.Automation/engine/remoting/common/misc.cs @@ -176,7 +176,7 @@ namespace System.Management.Automation EstablishedAndKeyReceived = 13, /// - /// for Server - Have sent a request to the remote end to + /// For Server - Have sent a request to the remote end to /// send a public key /// for Client - have received a PK request from server. /// diff --git a/src/System.Management.Automation/engine/remoting/common/psstreamobject.cs b/src/System.Management.Automation/engine/remoting/common/psstreamobject.cs index 8f2d11cf9..454ab415d 100644 --- a/src/System.Management.Automation/engine/remoting/common/psstreamobject.cs +++ b/src/System.Management.Automation/engine/remoting/common/psstreamobject.cs @@ -63,7 +63,7 @@ namespace System.Management.Automation.Remoting.Internal } /// - /// struct which describes whether an object written + /// Struct which describes whether an object written /// to an ObjectStream is of type - output, error, /// verbose, debug. /// PSStreamObject is for internal (PowerShell) consumption diff --git a/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs b/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs index c23564baa..42566593f 100644 --- a/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs +++ b/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs @@ -26,18 +26,18 @@ namespace System.Management.Automation.Remoting } /// - /// class describing event args which a helper class + /// Class describing event args which a helper class /// implementing IThrottleOperation need to throw. /// internal sealed class OperationStateEventArgs : EventArgs { /// - /// operation state. + /// Operation state. /// internal OperationState OperationState { get; set; } /// - /// the original event which actually resulted in this + /// The original event which actually resulted in this /// event being raised. /// internal EventArgs BaseEvent { get; set; } @@ -597,7 +597,7 @@ namespace System.Management.Automation.Remoting #region Private Members /// - /// default throttle limit - the maximum number of operations + /// Default throttle limit - the maximum number of operations /// to be processed at a time. /// private static int s_DEFAULT_THROTTLE_LIMIT = 32; diff --git a/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs b/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs index 035fa4b37..082a88525 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs @@ -346,7 +346,7 @@ namespace System.Management.Automation.Remoting } /// - /// copy the DataReceived event handlers to the supplied transport Manager. + /// Copy the DataReceived event handlers to the supplied transport Manager. /// /// public void MigrateDataReadyEventHandlers(BaseTransportManager transportManager) diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs index 87be6c6ed..0b317f251 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs @@ -300,7 +300,7 @@ namespace System.Management.Automation.Remoting.Client [MarshalAs(UnmanagedType.LPWStr)] internal string userName; /// - /// making password secure. + /// Making password secure. /// [SuppressMessage("Microsoft.Reliability", "CA2006:UseSafeHandleToEncapsulateNativeResources")] internal IntPtr password; @@ -351,7 +351,7 @@ namespace System.Management.Automation.Remoting.Client } /// - /// gets a structure representation (used for marshalling) + /// Gets a structure representation (used for marshalling) /// internal WSManUserNameCredentialStruct CredentialStruct { @@ -456,31 +456,31 @@ namespace System.Management.Automation.Remoting.Client #region TimeOuts /// - /// int - default timeout in ms that applies to all operations on the client side. + /// Int - default timeout in ms that applies to all operations on the client side. /// WSMAN_OPTION_DEFAULT_OPERATION_TIMEOUTMS = 1, /// - /// int - Robust connection maximum retry time in minutes. + /// Int - Robust connection maximum retry time in minutes. /// WSMAN_OPTION_MAX_RETRY_TIME = 11, /// - /// int - timeout in ms for WSManCreateShellEx operations. + /// Int - timeout in ms for WSManCreateShellEx operations. /// WSMAN_OPTION_TIMEOUTMS_CREATE_SHELL = 12, /// - /// int - timeout in ms for WSManReceiveShellOutputEx operations. + /// Int - timeout in ms for WSManReceiveShellOutputEx operations. /// WSMAN_OPTION_TIMEOUTMS_RECEIVE_SHELL_OUTPUT = 14, /// - /// int - timeout in ms for WSManSendShellInputEx operations. + /// Int - timeout in ms for WSManSendShellInputEx operations. /// WSMAN_OPTION_TIMEOUTMS_SEND_SHELL_INPUT = 15, /// - /// int - timeout in ms for WSManSignalShellEx operations. + /// Int - timeout in ms for WSManSignalShellEx operations. /// WSMAN_OPTION_TIMEOUTMS_SIGNAL_SHELL = 16, /// - /// int - timeout in ms for WSManCloseShellOperationEx operations. + /// Int - timeout in ms for WSManCloseShellOperationEx operations. /// WSMAN_OPTION_TIMEOUTMS_CLOSE_SHELL_OPERATION = 17, @@ -489,32 +489,32 @@ namespace System.Management.Automation.Remoting.Client #region Connection Options /// - /// int - 1 to not validate the CA on the server certificate; 0 - default. + /// Int - 1 to not validate the CA on the server certificate; 0 - default. /// WSMAN_OPTION_SKIP_CA_CHECK = 18, /// - /// int - 1 to not validate the CN on the server certificate; 0 - default. + /// Int - 1 to not validate the CN on the server certificate; 0 - default. /// WSMAN_OPTION_SKIP_CN_CHECK = 19, /// - /// int - 1 to not encrypt the messages; 0 - default. + /// Int - 1 to not encrypt the messages; 0 - default. /// WSMAN_OPTION_UNENCRYPTED_MESSAGES = 20, /// - /// int - 1 Send all network packets for remote operations in UTF16; 0 - default is UTF8. + /// Int - 1 Send all network packets for remote operations in UTF16; 0 - default is UTF8. /// WSMAN_OPTION_UTF16 = 21, /// - /// int - 1 When using negotiate, include port number in the connection SPN; 0 - default. + /// Int - 1 When using negotiate, include port number in the connection SPN; 0 - default. /// WSMAN_OPTION_ENABLE_SPN_SERVER_PORT = 22, /// - /// int - Used when not talking to the main OS on a machine but, for instance, a BMC + /// Int - Used when not talking to the main OS on a machine but, for instance, a BMC /// 1 Identify this machine to the server by including the MachineID header; 0 - default. /// WSMAN_OPTION_MACHINE_ID = 23, /// - /// int -1 Enables host process to be created with interactive token. + /// Int -1 Enables host process to be created with interactive token. /// WSMAN_OPTION_USE_INTERACTIVE_TOKEN = 34, @@ -522,11 +522,11 @@ namespace System.Management.Automation.Remoting.Client #region Locale /// - /// string - RFC 3066 language code. + /// String - RFC 3066 language code. /// WSMAN_OPTION_LOCALE = 25, /// - /// string - RFC 3066 language code. + /// String - RFC 3066 language code. /// WSMAN_OPTION_UI_LANGUAGE = 26, @@ -534,7 +534,7 @@ namespace System.Management.Automation.Remoting.Client #region Other /// - /// int - max SOAP envelope size (kb) - default 150kb from winrm config + /// Int - max SOAP envelope size (kb) - default 150kb from winrm config /// (see 'winrm help config' for more details); the client SOAP packet size cannot surpass /// this value; this value will be also sent to the server in the SOAP request as a /// MaxEnvelopeSize header; the server will use min(MaxEnvelopeSizeKb from server configuration, @@ -542,7 +542,7 @@ namespace System.Management.Automation.Remoting.Client /// WSMAN_OPTION_MAX_ENVELOPE_SIZE_KB = 28, /// - /// int (read only) - max data size (kb) provided by the client, guaranteed by + /// Int (read only) - max data size (kb) provided by the client, guaranteed by /// the winrm client implementation to fit into one SOAP packet; this is an /// approximate value calculated based on the WSMAN_OPTION_MAX_ENVELOPE_SIZE_KB (default 150kb), /// the maximum possible size of the SOAP headers and the overhead of the base64 @@ -551,7 +551,7 @@ namespace System.Management.Automation.Remoting.Client /// WSMAN_OPTION_SHELL_MAX_DATA_SIZE_PER_MESSAGE_KB = 29, /// - /// string - + /// String - /// WSMAN_OPTION_REDIRECT_LOCATION = 30, /// @@ -563,8 +563,8 @@ namespace System.Management.Automation.Remoting.Client /// WSMAN_OPTION_ALLOW_NEGOTIATE_IMPLICIT_CREDENTIALS = 32, /// - /// DWORD - When using just a machine name in the connection string use an SSL connection. - /// 0 means HTTP, 1 means HTTPS. Default is 0. + /// DWORD - When using just a machine name in the connection string use an SSL connection. + /// 0 means HTTP, 1 means HTTPS. Default is 0. /// WSMAN_OPTION_USE_SSL = 33 #endregion @@ -600,7 +600,7 @@ namespace System.Management.Automation.Remoting.Client #region WSManData /// - /// types of supported WSMan data. + /// Types of supported WSMan data. /// PowerShell uses only Text and DWORD (in some places). /// internal enum WSManDataType : uint @@ -743,7 +743,7 @@ namespace System.Management.Automation.Remoting.Client } /// - /// implicit IntPtr conversion. + /// Implicit IntPtr conversion. /// /// /// @@ -1321,7 +1321,7 @@ namespace System.Management.Automation.Remoting.Client private struct WSManShellDisconnectInfoInternal { /// - /// new idletimeout for the server shell that overrides the original idletimeout specified in WSManCreateShell. + /// New idletimeout for the server shell that overrides the original idletimeout specified in WSManCreateShell. /// internal uint idleTimeoutMs; } @@ -1346,7 +1346,7 @@ namespace System.Management.Automation.Remoting.Client } /// - /// implicit IntPtr. + /// Implicit IntPtr. /// /// /// @@ -1376,7 +1376,7 @@ namespace System.Management.Automation.Remoting.Client /// internal uint idleTimeoutMs; /// - /// working directory of the shell. + /// Working directory of the shell. /// [MarshalAs(UnmanagedType.LPWStr)] internal string workingDirectory; @@ -1439,7 +1439,7 @@ namespace System.Management.Automation.Remoting.Client } /// - /// implicit IntPtr. + /// Implicit IntPtr. /// /// /// @@ -1594,7 +1594,7 @@ namespace System.Management.Automation.Remoting.Client } /// - /// implicit IntPtr. + /// Implicit IntPtr. /// /// /// @@ -1609,7 +1609,7 @@ namespace System.Management.Automation.Remoting.Client #region WSMan Shell Async /// - /// flags used by all callback functions: WSMAN_COMPLETION_FUNCTION, + /// Flags used by all callback functions: WSMAN_COMPLETION_FUNCTION, /// WSMAN_SUBSCRIPTION_COMPLETION_FUNCTION and WSMAN_SHELL_COMPLETION_FUNCTION. /// internal enum WSManCallbackFlags @@ -1785,15 +1785,15 @@ namespace System.Management.Automation.Remoting.Client { internal int errorCode; /// - /// extended error description from the fault; + /// Extended error description from the fault; /// internal string errorDetail; /// - /// language for error description (RFC 3066 language code); it can be NULL. + /// Language for error description (RFC 3066 language code); it can be NULL. /// internal string language; /// - /// machine id; it can be NULL. + /// Machine id; it can be NULL. /// internal string machineName; diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs index 61f6040cf..e0cf86ce3 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs @@ -82,7 +82,7 @@ namespace System.Management.Automation.Remoting } /// - /// class that holds plugin + shell context information used to handle + /// Class that holds plugin + shell context information used to handle /// shutdown notifications. /// /// Explicit destruction and release of the IntPtrs is not required because @@ -150,7 +150,7 @@ namespace System.Management.Automation.Remoting } /// - /// static constructor to listen to unhandled exceptions + /// Static constructor to listen to unhandled exceptions /// from the AppDomain and log the errors /// Note: It is not necessary to instantiate IWSManNativeApi here because it is not used. /// @@ -502,7 +502,7 @@ namespace System.Management.Automation.Remoting } /// - /// adds shell session to activeShellSessions store and returns the id + /// Adds shell session to activeShellSessions store and returns the id /// at which the session is added. /// /// @@ -860,7 +860,7 @@ namespace System.Management.Automation.Remoting } /// - /// unlock the shell / command specified so that the shell / command + /// Unlock the shell / command specified so that the shell / command /// starts sending data to the client. /// /// @@ -942,7 +942,7 @@ namespace System.Management.Automation.Remoting } /// - /// used to create PSPrincipal object from senderDetails struct. + /// Used to create PSPrincipal object from senderDetails struct. /// /// /// @@ -1119,7 +1119,7 @@ namespace System.Management.Automation.Remoting } /// - /// static func to take care of unmanaged to managed transitions. + /// Static func to take care of unmanaged to managed transitions. /// /// /// @@ -1348,7 +1348,7 @@ namespace System.Management.Automation.Remoting } /// - /// performs deinitialization during shutdown. + /// Performs deinitialization during shutdown. /// /// internal static void PerformShutdown( @@ -1389,7 +1389,7 @@ namespace System.Management.Automation.Remoting #region Utilities /// - /// report operation complete to WSMan and supply a reason (if any) + /// Report operation complete to WSMan and supply a reason (if any) /// /// /// @@ -1411,7 +1411,7 @@ namespace System.Management.Automation.Remoting } /// - /// extract message from exception (if any) and report operation complete with it to WSMan. + /// Extract message from exception (if any) and report operation complete with it to WSMan. /// /// /// diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs index dbd16bbcc..3700da98e 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs @@ -148,7 +148,7 @@ namespace System.Management.Automation.Remoting [MarshalAs(UnmanagedType.LPWStr)] string code); /// - /// Callback that handles shell shutdown notification events. + /// Callback that handles shell shutdown notification events. /// /// /// @@ -343,7 +343,7 @@ namespace System.Management.Automation.Remoting internal class WSManPluginEntryDelegatesInternal { /// - /// wsManPluginShutdownPluginCallbackNative. + /// WsManPluginShutdownPluginCallbackNative. /// [SuppressMessage("Microsoft.Reliability", "CA2006:UseSafeHandleToEncapsulateNativeResources")] internal IntPtr wsManPluginShutdownPluginCallbackNative; diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginTransportManager.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginTransportManager.cs index 31277c5c9..5298bbd6c 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginTransportManager.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginTransportManager.cs @@ -152,7 +152,7 @@ namespace System.Management.Automation.Remoting } /// - /// used by powershell DS handler. notifies transport that powershell is back to running state + /// Used by powershell DS handler. notifies transport that powershell is back to running state /// no payload. /// internal override void ReportExecutionStatusAsRunning() @@ -187,7 +187,7 @@ namespace System.Management.Automation.Remoting } /// - /// if flush is true, data will be sent immediately to the client. This is accomplished + /// If flush is true, data will be sent immediately to the client. This is accomplished /// by using WSMAN_FLAG_RECEIVE_FLUSH flag provided by WSMan API. /// /// diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs index f93831b2a..0edc38331 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs @@ -1658,7 +1658,7 @@ namespace System.Management.Automation.Remoting.Client } /// - /// receive/send operation handles and callback handles should be released/disposed from + /// Receive/send operation handles and callback handles should be released/disposed from /// receive/send callback only. Releasing them after CloseOperation() may not cover all /// the scenarios, as WSMan does not guarantee that a rcv/send callback is not called after /// Close completed callback. @@ -3197,7 +3197,7 @@ namespace System.Management.Automation.Remoting.Client } /// - /// receive/send operation handles and callback handles should be released/disposed from + /// Receive/send operation handles and callback handles should be released/disposed from /// receive/send callback only. Releasing them after CloseOperation() may not cover all /// the scenarios, as WSMan does not guarantee that a rcv/send callback is not called after /// Close completed callback. diff --git a/src/System.Management.Automation/engine/remoting/server/ServerPowerShellDriver.cs b/src/System.Management.Automation/engine/remoting/server/ServerPowerShellDriver.cs index 8a9e5307a..701b7316c 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerPowerShellDriver.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerPowerShellDriver.cs @@ -335,7 +335,7 @@ namespace System.Management.Automation } /// - /// invokes the powershell asynchronously. + /// Invokes the powershell asynchronously. /// internal IAsyncResult Start() { diff --git a/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs b/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs index 8813d62cb..49ca2c282 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs @@ -83,7 +83,7 @@ namespace System.Management.Automation } /// - /// called when session is connected from a new client + /// Called when session is connected from a new client /// call into the sessionconnect handlers for each associated powershell dshandler. /// internal void ProcessConnect() @@ -255,7 +255,7 @@ namespace System.Management.Automation } /// - /// dispatch the message to the associated powershell data structure handler. + /// Dispatch the message to the associated powershell data structure handler. /// /// Message to dispatch. internal void DispatchMessageToPowerShell(RemoteDataObject rcvdData) @@ -597,7 +597,7 @@ namespace System.Management.Automation } /// - /// called when session is connected from a new client + /// Called when session is connected from a new client /// calls into observers of this event. /// observers include corresponding driver that shutdown /// input stream is present. @@ -718,14 +718,14 @@ namespace System.Management.Automation #region Data Structure Handler events /// - /// this event is raised when the state of associated + /// This event is raised when the state of associated /// powershell is terminal and the runspace pool has /// to detach the association. /// internal event EventHandler RemoveAssociation; /// - /// this event is raised when the a message to stop the + /// This event is raised when the a message to stop the /// powershell is received from the client. /// internal event EventHandler StopPowerShellReceived; @@ -743,7 +743,7 @@ namespace System.Management.Automation internal event EventHandler InputEndReceived; /// - /// raised when server session is connected from a new client. + /// Raised when server session is connected from a new client. /// internal event EventHandler OnSessionConnected; @@ -757,7 +757,7 @@ namespace System.Management.Automation #region Internal Methods /// - /// client powershell id. + /// Client powershell id. /// internal Guid PowerShellId { diff --git a/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs b/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs index bdb8aa058..5ed66313f 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs @@ -271,7 +271,7 @@ namespace System.Management.Automation #region Internal Methods /// - /// data structure handler for communicating with client. + /// Data structure handler for communicating with client. /// internal ServerRunspacePoolDataStructureHandler DataStructureHandler { get; } @@ -284,7 +284,7 @@ namespace System.Management.Automation } /// - /// the client runspacepool id. + /// The client runspacepool id. /// internal Guid InstanceId { get; } @@ -703,7 +703,7 @@ namespace System.Management.Automation } /// - /// handler to the runspace pool state changed events. + /// Handler to the runspace pool state changed events. /// /// Sender of this events. /// arguments which describe the @@ -736,7 +736,7 @@ namespace System.Management.Automation } /// - /// handler to the runspace pool psevents. + /// Handler to the runspace pool psevents. /// private void HandleRunspacePoolForwardEvent(object sender, PSEventArgs e) { diff --git a/src/System.Management.Automation/engine/remoting/server/serverremotesessionstatemachine.cs b/src/System.Management.Automation/engine/remoting/server/serverremotesessionstatemachine.cs index c1bb66a97..af5bdff85 100644 --- a/src/System.Management.Automation/engine/remoting/server/serverremotesessionstatemachine.cs +++ b/src/System.Management.Automation/engine/remoting/server/serverremotesessionstatemachine.cs @@ -49,7 +49,7 @@ namespace System.Management.Automation.Remoting private RemoteSessionState _state; /// - /// timer used for key exchange. + /// Timer used for key exchange. /// private Timer _keyExchangeTimer; @@ -213,7 +213,7 @@ namespace System.Management.Automation.Remoting } /// - /// processes events in the queue. If there are no + /// Processes events in the queue. If there are no /// more events to process, then sets eventsInProcess /// variable to false. This will ensure that another /// thread which raises an event can then take control diff --git a/src/System.Management.Automation/engine/serialization.cs b/src/System.Management.Automation/engine/serialization.cs index f1dfddb88..a2d5a04d9 100644 --- a/src/System.Management.Automation/engine/serialization.cs +++ b/src/System.Management.Automation/engine/serialization.cs @@ -2275,7 +2275,7 @@ namespace System.Management.Automation #endregion serialize as string /// - /// compute the serialization depth for an PSObject instance subtree. + /// Compute the serialization depth for an PSObject instance subtree. /// /// PSObject whose serialization depth has to be computed. /// Current depth. @@ -3891,7 +3891,7 @@ namespace System.Management.Automation } /// - /// read note. + /// Read note. /// /// private PSNoteProperty ReadNoteProperty() diff --git a/src/System.Management.Automation/help/HelpSystem.cs b/src/System.Management.Automation/help/HelpSystem.cs index ae4face86..f0c00daf2 100644 --- a/src/System.Management.Automation/help/HelpSystem.cs +++ b/src/System.Management.Automation/help/HelpSystem.cs @@ -543,7 +543,7 @@ namespace System.Management.Automation private ArrayList _helpProviders = new ArrayList(); /// - /// return the list of help providers initialized. + /// Return the list of help providers initialized. /// /// a list of help providers internal ArrayList HelpProviders diff --git a/src/System.Management.Automation/help/MUIFileSearcher.cs b/src/System.Management.Automation/help/MUIFileSearcher.cs index ac0829b07..09e204c6f 100644 --- a/src/System.Management.Automation/help/MUIFileSearcher.cs +++ b/src/System.Management.Automation/help/MUIFileSearcher.cs @@ -89,7 +89,7 @@ namespace System.Management.Automation private Hashtable _uniqueMatches = new Hashtable(StringComparer.OrdinalIgnoreCase); /// - /// search for files using the target, searchPaths member of this class. + /// Search for files using the target, searchPaths member of this class. /// private void SearchForFiles() { diff --git a/src/System.Management.Automation/help/MamlNode.cs b/src/System.Management.Automation/help/MamlNode.cs index c9807f275..0d08d0d08 100644 --- a/src/System.Management.Automation/help/MamlNode.cs +++ b/src/System.Management.Automation/help/MamlNode.cs @@ -91,7 +91,7 @@ namespace System.Management.Automation private PSObject _mshObject; /// - /// mshObject which is converted from XmlNode. + /// MshObject which is converted from XmlNode. /// /// internal PSObject PSObject diff --git a/src/System.Management.Automation/logging/LogProvider.cs b/src/System.Management.Automation/logging/LogProvider.cs index a046476d1..cf352e29b 100644 --- a/src/System.Management.Automation/logging/LogProvider.cs +++ b/src/System.Management.Automation/logging/LogProvider.cs @@ -31,7 +31,7 @@ namespace System.Management.Automation internal abstract class LogProvider { /// - /// constructor. + /// Constructor. /// internal LogProvider() { @@ -283,7 +283,7 @@ namespace System.Management.Automation internal class DummyLogProvider : LogProvider { /// - /// constructor. + /// Constructor. /// internal DummyLogProvider() { diff --git a/src/System.Management.Automation/logging/MshLog.cs b/src/System.Management.Automation/logging/MshLog.cs index 68e784cdc..078f27b56 100644 --- a/src/System.Management.Automation/logging/MshLog.cs +++ b/src/System.Management.Automation/logging/MshLog.cs @@ -1010,7 +1010,7 @@ namespace System.Management.Automation private static int s_nextSequenceNumber = 0; /// - /// generate next sequence id to be attached to current event. + /// Generate next sequence id to be attached to current event. /// /// private static string NextSequenceNumber @@ -1088,7 +1088,7 @@ namespace System.Management.Automation }; /// - /// enum for command states. + /// Enum for command states. /// internal enum CommandState { @@ -1106,7 +1106,7 @@ namespace System.Management.Automation }; /// - /// enum for provider states. + /// Enum for provider states. /// internal enum ProviderState { diff --git a/src/System.Management.Automation/namespaces/FileSystemProvider.cs b/src/System.Management.Automation/namespaces/FileSystemProvider.cs index aa1454128..78817258e 100644 --- a/src/System.Management.Automation/namespaces/FileSystemProvider.cs +++ b/src/System.Management.Automation/namespaces/FileSystemProvider.cs @@ -147,7 +147,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// overrides the method of CmdletProvider, considering the additional + /// Overrides the method of CmdletProvider, considering the additional /// dynamic parameters of FileSystemProvider. /// /// diff --git a/src/System.Management.Automation/namespaces/RegistryProvider.cs b/src/System.Management.Automation/namespaces/RegistryProvider.cs index f696885b1..4357fd03d 100644 --- a/src/System.Management.Automation/namespaces/RegistryProvider.cs +++ b/src/System.Management.Automation/namespaces/RegistryProvider.cs @@ -3177,7 +3177,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// checks if the given path is the top container path (the one containing the hives) + /// Checks if the given path is the top container path (the one containing the hives) /// /// /// path to check @@ -3204,7 +3204,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// checks the container. if the container is the hive container (Registry::\) + /// Checks the container. if the container is the hive container (Registry::\) /// it throws an exception. /// /// Path to check. @@ -3224,7 +3224,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// checks the container. if the container is the hive container (Registry::\) + /// Checks the container. if the container is the hive container (Registry::\) /// it throws an exception. /// /// Source path to check. @@ -3760,7 +3760,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// helper to wrap property values when sent to the pipeline into an PSObject; + /// Helper to wrap property values when sent to the pipeline into an PSObject; /// it adds the name of the property as a note. /// /// The property to be written. @@ -3879,7 +3879,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// helper to infer the RegistryValueKind from an object. + /// Helper to infer the RegistryValueKind from an object. /// /// Object whose RegistryValueKind has to be determined. /// Corresponding RegistryValueKind. @@ -3950,7 +3950,7 @@ namespace Microsoft.PowerShell.Commands } /// - /// helper to read back an existing registry key value. + /// Helper to read back an existing registry key value. /// /// Key to read the value from. /// Name of the value to read. diff --git a/src/System.Management.Automation/security/Authenticode.cs b/src/System.Management.Automation/security/Authenticode.cs index 642e3aac1..92ec5c5cf 100644 --- a/src/System.Management.Automation/security/Authenticode.cs +++ b/src/System.Management.Automation/security/Authenticode.cs @@ -49,7 +49,7 @@ namespace System.Management.Automation internal static class SignatureHelper { /// - /// tracer for SignatureHelper. + /// Tracer for SignatureHelper. /// [Dbg.TraceSource("SignatureHelper", "tracer for SignatureHelper")] diff --git a/src/System.Management.Automation/security/CatalogHelper.cs b/src/System.Management.Automation/security/CatalogHelper.cs index d20511d7f..1ed0a8ef1 100644 --- a/src/System.Management.Automation/security/CatalogHelper.cs +++ b/src/System.Management.Automation/security/CatalogHelper.cs @@ -42,7 +42,7 @@ namespace System.Management.Automation public class CatalogInformation { /// - /// status of catalog. + /// Status of catalog. /// public CatalogValidationStatus Status { get; set; } diff --git a/src/System.Management.Automation/security/SecureStringHelper.cs b/src/System.Management.Automation/security/SecureStringHelper.cs index c4e6f4b00..bc863cb5c 100644 --- a/src/System.Management.Automation/security/SecureStringHelper.cs +++ b/src/System.Management.Automation/security/SecureStringHelper.cs @@ -14,7 +14,7 @@ using System.Text; namespace Microsoft.PowerShell { /// - /// helper class for secure string related functionality. + /// Helper class for secure string related functionality. /// internal static class SecureStringHelper { @@ -63,7 +63,7 @@ namespace Microsoft.PowerShell } /// - /// get the contents of a SecureString as byte[] + /// Get the contents of a SecureString as byte[] /// /// Input string. /// Contents of s (char[]) converted to byte[]. @@ -141,7 +141,7 @@ namespace Microsoft.PowerShell } /// - /// return contents of the SecureString after encrypting + /// Return contents of the SecureString after encrypting /// using DPAPI and encoding the encrypted blob as a string. /// /// SecureString to protect. @@ -198,7 +198,7 @@ namespace Microsoft.PowerShell } /// - /// return contents of the SecureString after encrypting + /// Return contents of the SecureString after encrypting /// using the specified key and encoding the encrypted blob as a string. /// /// Input string to encrypt. @@ -227,7 +227,7 @@ namespace Microsoft.PowerShell } /// - /// return contents of the SecureString after encrypting + /// Return contents of the SecureString after encrypting /// using the specified key and encoding the encrypted blob as a string. /// /// Input string to encrypt. diff --git a/src/System.Management.Automation/security/SecuritySupport.cs b/src/System.Management.Automation/security/SecuritySupport.cs index 32a421016..de43c46bb 100644 --- a/src/System.Management.Automation/security/SecuritySupport.cs +++ b/src/System.Management.Automation/security/SecuritySupport.cs @@ -578,7 +578,7 @@ namespace System.Management.Automation.Internal } /// - /// throw if file does not exist. + /// Throw if file does not exist. /// /// Path to file. /// Does not return a value. @@ -591,7 +591,7 @@ namespace System.Management.Automation.Internal } /// - /// check to see if the specified cert is suitable to be + /// Check to see if the specified cert is suitable to be /// used as a code signing cert. /// /// Certificate object. @@ -607,7 +607,7 @@ namespace System.Management.Automation.Internal } /// - /// check to see if the specified cert is suitable to be + /// Check to see if the specified cert is suitable to be /// used as an encryption cert for PKI encryption. Note /// that this cert doesn't require the private key. /// @@ -656,7 +656,7 @@ namespace System.Management.Automation.Internal } /// - /// check if the specified cert has a private key in it. + /// Check if the specified cert has a private key in it. /// /// Certificate object. /// True on success, false otherwise. @@ -724,7 +724,7 @@ namespace System.Management.Automation.Internal } /// - /// convert an int to a DWORD. + /// Convert an int to a DWORD. /// /// Signed int number. /// DWORD. @@ -735,7 +735,7 @@ namespace System.Management.Automation.Internal } /// - /// convert a DWORD to int. + /// Convert a DWORD to int. /// /// Number. /// Int. @@ -747,7 +747,7 @@ namespace System.Management.Automation.Internal } /// - /// information used for filtering a set of certs. + /// Information used for filtering a set of certs. /// internal sealed class CertificateFilterInfo { @@ -756,7 +756,7 @@ namespace System.Management.Automation.Internal } /// - /// purpose of a certificate. + /// Purpose of a certificate. /// internal CertificatePurpose Purpose { @@ -792,7 +792,7 @@ namespace System.Management.Automation.Internal } /// - /// remaining validity period in days for a certificate. + /// Remaining validity period in days for a certificate. /// internal int ExpiringInDays { @@ -800,7 +800,7 @@ namespace System.Management.Automation.Internal } /// - /// combine properties into a filter string. + /// Combine properties into a filter string. /// internal string FilterString { diff --git a/src/System.Management.Automation/security/nativeMethods.cs b/src/System.Management.Automation/security/nativeMethods.cs index a2940821e..33236bf5e 100644 --- a/src/System.Management.Automation/security/nativeMethods.cs +++ b/src/System.Management.Automation/security/nativeMethods.cs @@ -136,7 +136,7 @@ namespace System.Management.Automation.Security } /// - /// pinvoke methods from crypt32.dll. + /// Pinvoke methods from crypt32.dll. /// internal static partial class NativeMethods { @@ -152,7 +152,7 @@ namespace System.Management.Automation.Security CertEnumSystemStoreCallBackProto fn); /// - /// signature of call back function used by CertEnumSystemStore. + /// Signature of call back function used by CertEnumSystemStore. /// internal delegate bool CertEnumSystemStoreCallBackProto([MarshalAs(UnmanagedType.LPWStr)] @@ -163,7 +163,7 @@ namespace System.Management.Automation.Security IntPtr notUsed3); /// - /// signature of cert enumeration function. + /// Signature of cert enumeration function. /// [DllImport("crypt32.dll", SetLastError = true, CharSet = CharSet.Unicode)] internal static extern @@ -171,7 +171,7 @@ namespace System.Management.Automation.Security IntPtr certContext); /// - /// signature of cert find function. + /// Signature of cert find function. /// [DllImport("crypt32.dll", SetLastError = true, CharSet = CharSet.Unicode)] internal static extern @@ -1447,7 +1447,7 @@ namespace System.Management.Automation.Security } /// - /// pinvoke methods from certca.dll. + /// Pinvoke methods from certca.dll. /// internal static partial class NativeMethods { @@ -1637,7 +1637,7 @@ namespace System.Management.Automation.Security #endregion SAFER_APIs /// - /// pinvoke methods from advapi32.dll. + /// Pinvoke methods from advapi32.dll. /// internal static partial class NativeMethods { @@ -1957,7 +1957,7 @@ namespace System.Management.Automation.Security } /// - /// pinvoke methods from wintrust.dll + /// Pinvoke methods from wintrust.dll /// These are added to Generate and Validate Window Catalog Files. /// internal static partial class NativeMethods @@ -2151,7 +2151,7 @@ namespace System.Management.Automation.Security ); /// - /// signature of call back function used by CryptCATCDFOpen. + /// Signature of call back function used by CryptCATCDFOpen. /// internal delegate void CryptCATCDFOpenCallBack(DWORD NotUsedDWORD1, @@ -2160,7 +2160,7 @@ namespace System.Management.Automation.Security string NotUsedString); /// - /// signature of call back function used by CryptCATCDFEnumMembersByCDFTagEx. + /// Signature of call back function used by CryptCATCDFEnumMembersByCDFTagEx. /// internal delegate void CryptCATCDFEnumMembersByCDFTagExErrorCallBack(DWORD NotUsedDWORD1, diff --git a/src/System.Management.Automation/utils/EncodingUtils.cs b/src/System.Management.Automation/utils/EncodingUtils.cs index a84fb0e18..2ac22b11c 100644 --- a/src/System.Management.Automation/utils/EncodingUtils.cs +++ b/src/System.Management.Automation/utils/EncodingUtils.cs @@ -46,7 +46,7 @@ namespace System.Management.Automation }; /// - /// retrieve the encoding parameter from the command line + /// Retrieve the encoding parameter from the command line /// it throws if the encoding does not match the known ones. /// /// A System.Text.Encoding object (null if no encoding specified). diff --git a/src/System.Management.Automation/utils/ExecutionExceptions.cs b/src/System.Management.Automation/utils/ExecutionExceptions.cs index 38c9a39eb..bb970e8ae 100644 --- a/src/System.Management.Automation/utils/ExecutionExceptions.cs +++ b/src/System.Management.Automation/utils/ExecutionExceptions.cs @@ -603,7 +603,7 @@ namespace System.Management.Automation #region Properties /// - /// see + /// See /// /// ErrorRecord /// @@ -887,7 +887,7 @@ namespace System.Management.Automation #region properties /// - /// see + /// See /// /// /// @@ -996,7 +996,7 @@ namespace System.Management.Automation #region properties /// - /// see + /// See /// /// /// diff --git a/src/System.Management.Automation/utils/MshArgumentException.cs b/src/System.Management.Automation/utils/MshArgumentException.cs index c8433b958..f7adfb599 100644 --- a/src/System.Management.Automation/utils/MshArgumentException.cs +++ b/src/System.Management.Automation/utils/MshArgumentException.cs @@ -140,7 +140,7 @@ namespace System.Management.Automation private string _errorId = "Argument"; /// - /// see + /// See /// /// /// Exception.Message is get-only, but you can effectively diff --git a/src/System.Management.Automation/utils/MshArgumentNullException.cs b/src/System.Management.Automation/utils/MshArgumentNullException.cs index b0f00569a..9789acb2d 100644 --- a/src/System.Management.Automation/utils/MshArgumentNullException.cs +++ b/src/System.Management.Automation/utils/MshArgumentNullException.cs @@ -138,7 +138,7 @@ namespace System.Management.Automation private string _errorId = "ArgumentNull"; /// - /// see + /// See /// /// /// Exception.Message is get-only, but you can effectively diff --git a/src/System.Management.Automation/utils/ObjectReader.cs b/src/System.Management.Automation/utils/ObjectReader.cs index 09fe22b58..8cfcaa49e 100644 --- a/src/System.Management.Automation/utils/ObjectReader.cs +++ b/src/System.Management.Automation/utils/ObjectReader.cs @@ -210,7 +210,7 @@ namespace System.Management.Automation.Internal #region IDisposable /// - /// public method for dispose. + /// Public method for dispose. /// public void Dispose() { @@ -220,7 +220,7 @@ namespace System.Management.Automation.Internal } /// - /// release all resources. + /// Release all resources. /// /// If true, release all managed resources. protected abstract void Dispose(bool disposing); @@ -326,7 +326,7 @@ namespace System.Management.Automation.Internal } /// - /// release all resources. + /// Release all resources. /// /// If true, release all managed resources. protected override void Dispose(bool disposing) @@ -436,7 +436,7 @@ namespace System.Management.Automation.Internal } /// - /// release all resources. + /// Release all resources. /// /// If true, release all managed resources. protected override void Dispose(bool disposing) @@ -608,7 +608,7 @@ namespace System.Management.Automation.Internal } /// - /// release all resources. + /// Release all resources. /// /// If true, release all managed resources. protected override void Dispose(bool disposing) @@ -813,7 +813,7 @@ namespace System.Management.Automation.Internal #region IDisposable /// - /// release all resources. + /// Release all resources. /// /// If true, release all managed resources. protected override void Dispose(bool disposing) diff --git a/src/System.Management.Automation/utils/ObjectStream.cs b/src/System.Management.Automation/utils/ObjectStream.cs index bdcbf44f1..2044ae276 100644 --- a/src/System.Management.Automation/utils/ObjectStream.cs +++ b/src/System.Management.Automation/utils/ObjectStream.cs @@ -326,7 +326,7 @@ namespace System.Management.Automation.Internal #region IDisposable /// - /// public method for dispose. + /// Public method for dispose. /// public void Dispose() { @@ -336,7 +336,7 @@ namespace System.Management.Automation.Internal } /// - /// release all resources. + /// Release all resources. /// /// If true, release all managed resources. protected abstract void Dispose(bool disposing); @@ -1485,7 +1485,7 @@ namespace System.Management.Automation.Internal #region IDisposable /// - /// release all resources. + /// Release all resources. /// /// If true, release all managed resources. protected override void Dispose(bool disposing) @@ -1939,7 +1939,7 @@ namespace System.Management.Automation.Internal #region IDisposable /// - /// release all resources. + /// Release all resources. /// /// If true, release all resources. protected override void Dispose(bool disposing) diff --git a/src/System.Management.Automation/utils/PathUtils.cs b/src/System.Management.Automation/utils/PathUtils.cs index 2ace40815..71d84109b 100644 --- a/src/System.Management.Automation/utils/PathUtils.cs +++ b/src/System.Management.Automation/utils/PathUtils.cs @@ -228,7 +228,7 @@ namespace System.Management.Automation } /// - /// resolve a user provided file name or path (including globbing characters) + /// Resolve a user provided file name or path (including globbing characters) /// to a fully qualified file path, using the file system provider. /// /// @@ -240,7 +240,7 @@ namespace System.Management.Automation } /// - /// resolve a user provided file name or path (including globbing characters) + /// Resolve a user provided file name or path (including globbing characters) /// to a fully qualified file path, using the file system provider. /// /// diff --git a/src/System.Management.Automation/utils/RuntimeException.cs b/src/System.Management.Automation/utils/RuntimeException.cs index e3d661d3d..2035ffec1 100644 --- a/src/System.Management.Automation/utils/RuntimeException.cs +++ b/src/System.Management.Automation/utils/RuntimeException.cs @@ -285,7 +285,7 @@ namespace System.Management.Automation private bool _thrownByThrowStatement; /// - /// fix for BUG: Windows Out Of Band Releases: 906263 and 906264 + /// Fix for BUG: Windows Out Of Band Releases: 906263 and 906264 /// The interpreter prompt CommandBaseStrings:InquireHalt /// should be suppressed when this flag is set. This will be set /// when this prompt has already occurred and Break was chosen, diff --git a/src/System.Management.Automation/utils/Verbs.cs b/src/System.Management.Automation/utils/Verbs.cs index ac45f3fc5..caa7497c6 100644 --- a/src/System.Management.Automation/utils/Verbs.cs +++ b/src/System.Management.Automation/utils/Verbs.cs @@ -201,7 +201,7 @@ namespace System.Management.Automation public static class VerbsData { /// - /// backup. + /// Backup. /// public const string Backup = "Backup"; @@ -457,7 +457,7 @@ namespace System.Management.Automation public const string Debug = "Debug"; /// - /// calculate/identify resources consumed by a specified operation or retrieve statistics about a resource. + /// Calculate/identify resources consumed by a specified operation or retrieve statistics about a resource. /// public const string Measure = "Measure"; diff --git a/src/System.Management.Automation/utils/assert.cs b/src/System.Management.Automation/utils/assert.cs index 995d2c94f..2909c8581 100644 --- a/src/System.Management.Automation/utils/assert.cs +++ b/src/System.Management.Automation/utils/assert.cs @@ -21,7 +21,7 @@ namespace System.Management.Automation internal class AssertException : SystemException { /// - /// calls the base class with message and sets the stack frame. + /// Calls the base class with message and sets the stack frame. /// /// Repassed to the base class. internal AssertException(string message) : base(message) @@ -31,7 +31,7 @@ namespace System.Management.Automation } /// - /// returns the stack trace set in the constructor. + /// Returns the stack trace set in the constructor. /// /// the constructor's stackTrace public override string StackTrace { get; } diff --git a/src/System.Management.Automation/utils/tracing/EtwActivity.cs b/src/System.Management.Automation/utils/tracing/EtwActivity.cs index 665519069..0566b3cc4 100644 --- a/src/System.Management.Automation/utils/tracing/EtwActivity.cs +++ b/src/System.Management.Automation/utils/tracing/EtwActivity.cs @@ -108,7 +108,7 @@ namespace System.Management.Automation.Tracing private AsyncCallback asyncCallback; /// - /// parentActivityId. + /// ParentActivityId. /// protected readonly Guid parentActivityId; private readonly EtwActivity tracer;