diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs index 572d75820b9..9bfddec1c06 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs @@ -50,7 +50,7 @@ public CimAsyncOperation() /// /// object raised the event /// - /// event argument + /// event argument. protected void NewCmdletActionHandler(object cimSession, CmdletActionEventArgs actionArgs) { DebugHelper.WriteLogEx("Disposed {0}, action type = {1}", 0, this._disposed, actionArgs.Action); @@ -83,7 +83,7 @@ protected void NewCmdletActionHandler(object cimSession, CmdletActionEventArgs a /// /// object raised the event /// - /// event argument + /// event argument. protected void OperationCreatedHandler(object cimSession, OperationEventArgs actionArgs) { DebugHelper.WriteLogEx(); @@ -103,7 +103,7 @@ protected void OperationCreatedHandler(object cimSession, OperationEventArgs act /// /// object raised the event /// - /// event argument + /// event argument. protected void OperationDeletedHandler(object cimSession, OperationEventArgs actionArgs) { DebugHelper.WriteLogEx(); @@ -190,7 +190,7 @@ public void ProcessRemainActions(CmdletOperationBase cmdletOperation) /// Get action object from action queue /// /// - /// next action to execute + /// next action to execute. /// True indicates there is an valid action, otherwise false. protected bool GetActionAndRemove(out CimBaseAction action) { @@ -202,8 +202,8 @@ protected bool GetActionAndRemove(out CimBaseAction action) /// Add temporary object to cache. /// /// - /// Computer name of the cimsession - /// cimsession wrapper object + /// Computer name of the cimsession. + /// cimsession wrapper object. protected void AddCimSessionProxy(CimSessionProxy sessionproxy) { lock (cimSessionProxyCacheLock) @@ -382,7 +382,7 @@ protected object GetBaseObject(object value) /// if not thrown exception. /// /// - /// output the cimtype of the value, either Reference or ReferenceArray + /// output the cimtype of the value, either Reference or ReferenceArray. /// protected object GetReferenceOrReferenceArrayObject(object value, ref CimType referenceType) { @@ -480,7 +480,7 @@ public void Dispose() /// other objects. Only unmanaged resources can be disposed. /// /// - /// Whether it is directly called + /// Whether it is directly called. protected virtual void Dispose(bool disposing) { if (Interlocked.CompareExchange(ref this._disposed, 1, 0) == 0) diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs index 35b3e600f80..d3d659527e8 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs @@ -170,7 +170,7 @@ public void Dispose() /// other objects. Only unmanaged resources can be disposed. /// /// - /// Whether it is directly called + /// Whether it is directly called. protected virtual void Dispose(bool disposing) { // Check to see if Dispose has already been called. diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs index 0b970304ece..b3d7260c28a 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs @@ -310,7 +310,7 @@ internal void reset() /// /// /// - /// throw if conflict parameter was set + /// throw if conflict parameter was set. internal void SetParameter(string parameterName, bool isBeginProcess) { DebugHelper.WriteLogEx("ParameterName = {0}, isBeginProcess = {1}", 0, parameterName, isBeginProcess); @@ -635,7 +635,7 @@ public void Dispose() /// other objects. Only unmanaged resources can be disposed. /// /// - /// Whether it is directly called + /// Whether it is directly called. protected void Dispose(bool disposing) { // Check to see if Dispose has already been called. diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetAssociatedInstance.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetAssociatedInstance.cs index 64c2e3b31e8..f6670a32a08 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetAssociatedInstance.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetAssociatedInstance.cs @@ -33,7 +33,7 @@ public CimGetAssociatedInstance() /// Base on parametersetName to retrieve associated ciminstances /// /// - /// object + /// object. public void GetCimAssociatedInstance(GetCimAssociatedInstanceCommand cmdlet) { IEnumerable computerNames = ConstValue.GetComputerNames(cmdlet.ComputerName); diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetCimClass.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetCimClass.cs index 2965cac5ba6..4040e627197 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetCimClass.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetCimClass.cs @@ -121,7 +121,7 @@ public CimGetCimClass() /// Base on parametersetName to retrieve /// /// - /// object + /// object. public void GetCimClass(GetCimClassCommand cmdlet) { List proxys = new List(); diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs index e0fecd62101..36b9034fb4f 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs @@ -66,7 +66,7 @@ public CimGetInstance() : base() /// Base on parametersetName to retrieve ciminstances /// /// - /// object + /// object. public void GetCimInstance(GetCimInstanceCommand cmdlet) { GetCimInstanceInternal(cmdlet); diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimInvokeCimMethod.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimInvokeCimMethod.cs index 2c59d1d32cf..9e42aa7f2a2 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimInvokeCimMethod.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimInvokeCimMethod.cs @@ -88,7 +88,7 @@ public CimInvokeCimMethod() /// Base on parametersetName to retrieve ciminstances /// /// - /// object + /// object. public void InvokeCimMethod(InvokeCimMethodCommand cmdlet) { IEnumerable computerNames = ConstValue.GetComputerNames(cmdlet.ComputerName); @@ -348,8 +348,8 @@ private CimSessionProxy CreateSessionProxy( /// /// /// - /// See CimProperty.Create - /// CimProperty.Create + /// See CimProperty.Create. + /// CimProperty.Create. private CimMethodParametersCollection CreateParametersCollection( IDictionary parameters, CimClass cimClass, diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs index 2babc5e2484..b0a807320db 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs @@ -59,7 +59,7 @@ public CimNewCimInstance() /// either remotely or locally /// /// - /// object + /// object. public void NewCimInstance(NewCimInstanceCommand cmdlet) { DebugHelper.WriteLogEx(); @@ -261,8 +261,8 @@ private CimSessionProxy CreateSessionProxy( /// /// /// - /// See CimProperty.Create - /// CimProperty.Create + /// See CimProperty.Create. + /// CimProperty.Create. private CimInstance CreateCimInstance( string className, string cimNamespace, @@ -328,8 +328,8 @@ private CimInstance CreateCimInstance( /// /// /// - /// See CimProperty.Create - /// CimProperty.Create + /// See CimProperty.Create. + /// CimProperty.Create. private CimInstance CreateCimInstance( CimClass cimClass, IDictionary properties, diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs index a0bd2ebfb4c..d2ba9a6ec2d 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs @@ -132,7 +132,7 @@ public CimRegisterCimIndication() /// /// Start an indication subscription target to the given computer. /// - /// null stands for localhost + /// null stands for localhost. /// /// /// @@ -154,12 +154,12 @@ public void RegisterCimIndication( /// /// Start an indication subscription through a given . /// - /// Cannot be null + /// Cannot be null. /// /// /// /// - /// throw if cimSession is null + /// throw if cimSession is null. public void RegisterCimIndication( CimSession cimSession, string nameSpace, @@ -206,7 +206,7 @@ protected override void SubscribeToCimSessionProxyEvent(CimSessionProxy proxy) /// /// object raised the event /// - /// event argument + /// event argument. private void CimIndicationHandler(object cimSession, CmdletActionEventArgs actionArgs) { DebugHelper.WriteLogEx("action is {0}. Disposed {1}", 0, actionArgs.Action, this.Disposed); diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRemoveCimInstance.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRemoveCimInstance.cs index 9c6d5687667..5824a48ce47 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRemoveCimInstance.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRemoveCimInstance.cs @@ -55,7 +55,7 @@ public CimRemoveCimInstance() /// Base on parametersetName to retrieve ciminstances /// /// - /// object + /// object. public void RemoveCimInstance(RemoveCimInstanceCommand cmdlet) { DebugHelper.WriteLogEx(); diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs index cc7ee1f35d8..a365571895d 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs @@ -121,7 +121,7 @@ internal class AsyncResultCompleteEventArgs : AsyncResultEventArgsBase /// Constructor /// /// - /// object + /// object. /// public AsyncResultCompleteEventArgs( CimSession session, @@ -220,8 +220,8 @@ internal class CimResultObserver : IObserver /// Define delegate that handles new cmdlet action come from /// the operations related to the current CimSession object. /// - /// cimSession object, which raised the event - /// Event args + /// cimSession object, which raised the event. + /// Event args. public delegate void ResultEventHandler( object observer, AsyncResultEventArgsBase resultArgs); @@ -234,8 +234,8 @@ public delegate void ResultEventHandler( /// /// Constructor /// - /// object that issued the operation - /// Operation that can be observed + /// object that issued the operation. + /// Operation that can be observed. public CimResultObserver(CimSession session, IObservable observable) { this.session = session; @@ -245,8 +245,8 @@ public CimResultObserver(CimSession session, IObservable observable) /// /// Constructor /// - /// object that issued the operation - /// Operation that can be observed + /// object that issued the operation. + /// Operation that can be observed. public CimResultObserver(CimSession session, IObservable observable, CimResultContext cimResultContext) @@ -285,7 +285,7 @@ public virtual void OnCompleted() /// Operation completed with an error /// /// - /// error object + /// error object. public virtual void OnError(Exception error) { try @@ -326,7 +326,7 @@ protected void OnNextCore(object value) /// Operation got a new result object /// /// - /// result object + /// result object. public virtual void OnNext(T value) { DebugHelper.WriteLogEx("value = {0}.", 1, value); diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs index 582732402da..40fb54ed63f 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs @@ -339,7 +339,7 @@ public void Dispose() /// other objects. Only unmanaged resources can be disposed. /// /// - /// Whether it is directly called + /// Whether it is directly called. protected virtual void Dispose(bool disposing) { if (!this._disposed) @@ -858,8 +858,8 @@ public static CimSessionState GetCimSessionState() /// clean up the dictionaries if the runspace is closed or broken. /// /// - /// Runspace - /// Event args + /// Runspace. + /// Event args. private static void DefaultRunspace_StateChanged(object sender, RunspaceStateEventArgs e) { Runspace runspace = (Runspace)sender; @@ -1097,7 +1097,7 @@ public void Dispose() /// other objects. Only unmanaged resources can be disposed. /// /// - /// Whether it is directly called + /// Whether it is directly called. protected virtual void Dispose(bool disposing) { if (!this._disposed) diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs index 7805833bcd0..7f4de014f1e 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs @@ -145,7 +145,7 @@ internal sealed class CmdletActionEventArgs : EventArgs /// /// Constructor /// - /// CimBaseAction object bound to the event + /// CimBaseAction object bound to the event. public CmdletActionEventArgs(CimBaseAction action) { this.Action = action; @@ -162,8 +162,8 @@ internal sealed class OperationEventArgs : EventArgs /// /// constructor /// - /// Object used to cancel the operation - /// Async observable operation + /// Object used to cancel the operation. + /// Async observable operation. public OperationEventArgs(IDisposable operationCancellation, IObservable operation, bool theSuccess) @@ -227,7 +227,7 @@ internal class CimSessionProxy : IDisposable /// otherwise insert it into the cache. /// /// - /// CimSession to be added + /// CimSession to be added. internal static void AddCimSessionToTemporaryCache(CimSession session) { if (session != null) @@ -252,7 +252,7 @@ internal static void AddCimSessionToTemporaryCache(CimSession session) /// Wrapper function to remove CimSession from cache /// /// - /// Whether need to dispose the object + /// Whether need to dispose the object. private static void RemoveCimSessionFromTemporaryCache(CimSession session, bool dispose) { @@ -295,7 +295,7 @@ private static void RemoveCimSessionFromTemporaryCache(CimSession session, /// If refcount became 0, call dispose on the object. /// /// - /// CimSession to be added + /// CimSession to be added. internal static void RemoveCimSessionFromTemporaryCache(CimSession session) { RemoveCimSessionFromTemporaryCache(session, true); @@ -308,8 +308,8 @@ internal static void RemoveCimSessionFromTemporaryCache(CimSession session) /// Define delegate that handles new cmdlet action come from /// the operations related to the current CimSession object. /// - /// cimSession object, which raised the event - /// Event args + /// cimSession object, which raised the event. + /// Event args. public delegate void NewCmdletActionHandler( object cimSession, CmdletActionEventArgs actionArgs); @@ -323,8 +323,8 @@ public delegate void NewCmdletActionHandler( /// Define delegate that handles operation creation and complete /// issued by the current CimSession object. /// - /// cimSession object, which raised the event - /// Event args + /// cimSession object, which raised the event. + /// Event args. public delegate void OperationEventHandler( object cimSession, OperationEventArgs actionArgs); @@ -430,7 +430,7 @@ public CimSessionProxy(string computerName, CimInstance cimInstance) /// /// /// - /// Used when create async operation + /// Used when create async operation. public CimSessionProxy(string computerName, CimSessionOptions sessionOptions, CimOperationOptions operOptions) { CreateSetSession(computerName, null, sessionOptions, operOptions, false); @@ -442,7 +442,7 @@ public CimSessionProxy(string computerName, CimSessionOptions sessionOptions, Ci /// Then create wrapper object. /// /// - /// Used when create async operation + /// Used when create async operation. public CimSessionProxy(string computerName, CimOperationOptions operOptions) { CreateSetSession(computerName, null, null, operOptions, false); @@ -462,7 +462,7 @@ public CimSessionProxy(CimSession session) /// Create wrapper object by given session object /// /// - /// Used when create async operation + /// Used when create async operation. public CimSessionProxy(CimSession session, CimOperationOptions operOptions) { CreateSetSession(null, session, null, operOptions, false); @@ -982,8 +982,8 @@ public CimResponseType PromptUser(string message, CimPromptType prompt) /// Handle async event triggered by /// /// - /// object triggered the event - /// async result event argument + /// object triggered the event. + /// async result event argument. internal void ResultEventHandler( object observer, AsyncResultEventArgsBase resultArgs) @@ -2288,7 +2288,7 @@ internal class CimSessionProxySetCimInstance : CimSessionProxy /// Then create wrapper object. /// /// object to clone. - /// PassThru, true means output the modified instance; otherwise does not output + /// PassThru, true means output the modified instance; otherwise does not output. public CimSessionProxySetCimInstance(CimSessionProxy originalProxy, bool passThru) : base(originalProxy) { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSetCimInstance.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSetCimInstance.cs index aba46b4095b..17282ecdea8 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSetCimInstance.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSetCimInstance.cs @@ -102,7 +102,7 @@ public CimSetCimInstance() /// Base on parametersetName to set ciminstances /// /// - /// object + /// object. public void SetCimInstance(SetCimInstanceCommand cmdlet) { IEnumerable computerNames = ConstValue.GetComputerNames( diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteError.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteError.cs index ac2bb33f001..118c3bc3034 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteError.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteError.cs @@ -29,7 +29,7 @@ internal sealed class ErrorToErrorRecord /// /// /// - /// the context starting the operation, which generated the error + /// the context starting the operation, which generated the error. /// the CimResultContext used to provide ErrorSource, etc. info. /// internal static ErrorRecord ErrorRecordFromAnyException( diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/Utils.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/Utils.cs index 29355086902..92c373fe4d2 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/Utils.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/Utils.cs @@ -415,7 +415,7 @@ public static void ValidateNoNullorWhiteSpaceArgument(string obj, string argumen /// /// /// - /// Throw if the given value is not a valid name (class name or property name) + /// Throw if the given value is not a valid name (class name or property name). public static string ValidateArgumentIsValidName(string parameterName, string value) { DebugHelper.WriteLogEx(); @@ -443,7 +443,7 @@ public static string ValidateArgumentIsValidName(string parameterName, string va /// /// /// - /// Throw if the given value contains any invalid name (class name or property name) + /// Throw if the given value contains any invalid name (class name or property name). public static String[] ValidateArgumentIsValidName(string parameterName, String[] value) { if (value != null) diff --git a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/SessionBasedWrapper.cs b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/SessionBasedWrapper.cs index 6916508b02e..0e8505b04ae 100644 --- a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/SessionBasedWrapper.cs +++ b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/SessionBasedWrapper.cs @@ -118,8 +118,8 @@ public SwitchParameter AsJob /// /// Creates a object that performs a query against the wrapped object model. /// - /// Remote session to query - /// Query parameters + /// Remote session to query. + /// Query parameters. /// /// /// This method shouldn't do any processing or interact with the remote session. @@ -167,10 +167,10 @@ private StartableJob DoCreateQueryJob(TSession sessionForJob, QueryBuilder query /// /// Creates a object that invokes an instance method in the wrapped object model. /// - /// Remote session to invoke the method in - /// The object on which to invoke the method - /// Method invocation details - /// true if successful method invocations should emit downstream the being operated on + /// Remote session to invoke the method in. + /// The object on which to invoke the method. + /// Method invocation details. + /// true if successful method invocations should emit downstream the being operated on. /// /// /// This method shouldn't do any processing or interact with the remote session. @@ -204,8 +204,8 @@ private StartableJob DoCreateInstanceMethodInvocationJob(TSession sessionForJob, /// /// Creates a object that invokes a static method in the wrapped object model. /// - /// Remote session to invoke the method in - /// Method invocation details + /// Remote session to invoke the method in. + /// Method invocation details. /// /// /// This method shouldn't do any processing or interact with the remote session. @@ -372,7 +372,7 @@ private static void DiscardJobOutputs(Job job, JobOutputs jobOutputsToDiscard) /// /// Queries for object instances in the object model. /// - /// Query parameters + /// Query parameters. /// A lazy evaluated collection of object instances. public override void ProcessRecord(QueryBuilder query) { @@ -397,9 +397,9 @@ public override void ProcessRecord(QueryBuilder query) /// /// Queries for instance and invokes an instance method /// - /// Query parameters - /// Method invocation details - /// true if successful method invocations should emit downstream the object instance being operated on + /// Query parameters. + /// Method invocation details. + /// true if successful method invocations should emit downstream the object instance being operated on. public override void ProcessRecord(QueryBuilder query, MethodInvocationInfo methodInvocationInfo, bool passThru) { _parentJob.DisableFlowControlForPendingJobsQueue(); @@ -576,9 +576,9 @@ private TSession GetImpliedSession() /// /// Invokes an instance method in the object model. /// - /// The object on which to invoke the method - /// Method invocation details - /// true if successful method invocations should emit downstream the being operated on + /// The object on which to invoke the method. + /// Method invocation details. + /// true if successful method invocations should emit downstream the being operated on. public override void ProcessRecord(TObjectInstance objectInstance, MethodInvocationInfo methodInvocationInfo, bool passThru) { if (objectInstance == null) throw new ArgumentNullException("objectInstance"); @@ -604,7 +604,7 @@ public override void ProcessRecord(TObjectInstance objectInstance, MethodInvocat /// /// Invokes a static method in the object model. /// - /// Method invocation details + /// Method invocation details. public override void ProcessRecord(MethodInvocationInfo methodInvocationInfo) { if (methodInvocationInfo == null) throw new ArgumentNullException("methodInvocationInfo"); diff --git a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimConverter.cs b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimConverter.cs index cc435687849..15cb016415a 100644 --- a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimConverter.cs +++ b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimConverter.cs @@ -231,7 +231,7 @@ internal static Type GetCimType(Type dotNetType) internal static class CimValueConverter { - /// The only kind of exception this method can throw + /// The only kind of exception this method can throw. internal static object ConvertFromDotNetToCim(object dotNetObject) { if (dotNetObject == null) @@ -347,7 +347,7 @@ internal static object ConvertFromDotNetToCim(object dotNetObject) CmdletizationResources.CimConversion_CimIntrinsicValue); } - /// The only kind of exception this method can throw + /// The only kind of exception this method can throw. internal static object ConvertFromCimToDotNet(object cimObject, Type expectedDotNetType) { if (expectedDotNetType == null) { throw new ArgumentNullException("expectedDotNetType"); } diff --git a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimQuery.cs b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimQuery.cs index 8b6feaaa5e4..b97ed83b9fd 100644 --- a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimQuery.cs +++ b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimQuery.cs @@ -193,8 +193,8 @@ private static string GetMatchCondition(string propertyName, IEnumerable propert /// /// Modifies the query, so that it only returns objects with a given property value /// - /// Property name to query on - /// Property values to accept in the query + /// Property name to query on. + /// Property values to accept in the query. /// /// true if should be treated as a containing a wildcard pattern; /// false otherwise @@ -216,8 +216,8 @@ public override void FilterByProperty(string propertyName, IEnumerable allowedPr /// /// Modifies the query, so that it does not return objects with a given property value /// - /// Property name to query on - /// Property values to reject in the query + /// Property name to query on. + /// Property values to reject in the query. /// /// true if should be treated as a containing a wildcard pattern; /// false otherwise @@ -243,8 +243,8 @@ public override void ExcludeByProperty(string propertyName, IEnumerable excluded /// /// Modifies the query, so that it returns only objects that have a property value greater than or equal to a threshold /// - /// Property name to query on - /// Minimum property value + /// Property name to query on. + /// Minimum property value. /// /// Describes how to handle filters that didn't match any objects /// @@ -267,8 +267,8 @@ public override void FilterByMinPropertyValue(string propertyName, object minPro /// /// Modifies the query, so that it returns only objects that have a property value less than or equal to a threshold /// - /// Property name to query on - /// Maximum property value + /// Property name to query on. + /// Maximum property value. /// /// Describes how to handle filters that didn't match any objects /// @@ -291,10 +291,10 @@ public override void FilterByMaxPropertyValue(string propertyName, object maxPro /// /// Modifies the query, so that it returns only objects associated with /// - /// object that query results have to be associated with - /// name of the association - /// name of the role that has in the association - /// name of the role that query results have in the association + /// object that query results have to be associated with. + /// name of the association. + /// name of the role that has in the association. + /// name of the role that query results have in the association. /// /// Describes how to handle filters that didn't match any objects /// diff --git a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimWrapper.cs b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimWrapper.cs index d4100c5d3fa..c6d5ba1063e 100644 --- a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimWrapper.cs +++ b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimWrapper.cs @@ -165,8 +165,8 @@ private CimJobContext CreateJobContext(CimSession session, object targetObject) /// /// Creates a object that performs a query against the wrapped object model. /// - /// Remote session to query - /// Query parameters + /// Remote session to query. + /// Query parameters. /// object that performs a query against the wrapped object model. internal override StartableJob CreateQueryJob(CimSession session, QueryBuilder baseQuery) { @@ -196,10 +196,10 @@ internal override StartableJob CreateQueryJob(CimSession session, QueryBuilder b /// /// Creates a object that invokes an instance method in the wrapped object model. /// - /// Remote session to invoke the method in - /// The object on which to invoke the method - /// Method invocation details - /// true if successful method invocations should emit downstream the being operated on + /// Remote session to invoke the method in. + /// The object on which to invoke the method. + /// Method invocation details. + /// true if successful method invocations should emit downstream the being operated on. /// internal override StartableJob CreateInstanceMethodInvocationJob(CimSession session, CimInstance objectInstance, MethodInvocationInfo methodInvocationInfo, bool passThru) { @@ -300,8 +300,8 @@ private bool IsSupportedSession(CimSession cimSession, TerminatingErrorTracker t /// (of the class named by ) /// in the wrapped object model. /// - /// Remote session to invoke the method in - /// Method invocation details + /// Remote session to invoke the method in. + /// Method invocation details. internal override StartableJob CreateStaticMethodInvocationJob(CimSession session, MethodInvocationInfo methodInvocationInfo) { TerminatingErrorTracker tracker = TerminatingErrorTracker.GetTracker(this.CmdletInvocationInfo, isStaticCmdlet: true); diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/CIMHelper.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/CIMHelper.cs index 28f4e97f43e..1fae90e1344 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/CIMHelper.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/CIMHelper.cs @@ -252,9 +252,9 @@ internal static class CIMExtensions /// .QueryInstances /// method that takes only the namespace and query string as a parameters /// - /// The CimSession to be queried - /// A string containing the namespace to run the query against - /// A string containing the query to be run + /// The CimSession to be queried. + /// A string containing the namespace to run the query against. + /// A string containing the query to be run. /// /// An IEnumerable interface that can be used to enumerate the instances /// @@ -266,9 +266,9 @@ internal static IEnumerable QueryInstances(this CimSession session, /// /// Execute a CIM query and return only the first instance in the result. /// - /// The CimSession to be queried - /// A string containing the namespace to run the query against - /// A string containing the query to be run + /// The CimSession to be queried. + /// A string containing the namespace to run the query against. + /// A string containing the query to be run. /// /// A object /// representing the first instance in a query result if successful, null @@ -295,8 +295,8 @@ internal static CimInstance QueryFirstInstance(this CimSession session, string n /// /// Execute a CIM query and return only the first instance in the result. /// - /// The CimSession to be queried - /// A string containing the query to be run + /// The CimSession to be queried. + /// A string containing the query to be run. /// /// A object /// representing the first instance in a query result if successful, null diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs index 08be291403d..df910a8f67a 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs @@ -2066,15 +2066,15 @@ internal static bool SkipSystemRestoreOperationForARMPlatform(PSCmdlet cmdlet) /// over a CIMSession. The flags parameter determines the type of shutdown operation /// such as shutdown, reboot, force etc. /// - /// Cmdlet host for reporting errors - /// True if local host computer - /// Target computer - /// Win32Shutdown flags - /// Optional credential - /// Optional authentication - /// Error message format string that takes two parameters - /// Fully qualified error Id - /// Cancel token + /// Cmdlet host for reporting errors. + /// True if local host computer. + /// Target computer. + /// Win32Shutdown flags. + /// Optional credential. + /// Optional authentication. + /// Error message format string that takes two parameters. + /// Fully qualified error Id. + /// Cancel token. /// True on success. internal static bool InvokeWin32ShutdownUsingWsman( PSCmdlet cmdlet, @@ -2188,7 +2188,7 @@ internal static bool InvokeWin32ShutdownUsingWsman( /// /// Returns valid computer name or null on failure. /// - /// Computer name to validate + /// Computer name to validate. /// /// /// diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs index d4b486d2d6e..e223c502360 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs @@ -5134,7 +5134,7 @@ private static class PInvokeDllNames /// /// Import WINAPI function PowerDeterminePlatformRoleEx /// - /// The version of the POWER_PLATFORM_ROLE enumeration for the platform + /// The version of the POWER_PLATFORM_ROLE enumeration for the platform. /// POWER_PLATFORM_ROLE enumeration. [DllImport(PInvokeDllNames.PowerDeterminePlatformRoleExDllName, EntryPoint = "PowerDeterminePlatformRoleEx", CharSet = CharSet.Ansi)] public static extern uint PowerDeterminePlatformRoleEx(uint version); @@ -5163,8 +5163,8 @@ private static class PInvokeDllNames /// /// Convert a Local Identifier to a Locale name /// - /// The Locale ID (LCID) to be converted - /// Destination of the Locale name + /// The Locale ID (LCID) to be converted. + /// Destination of the Locale name. /// Capacity of /// /// diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs index 4bba884fa0b..cd8f15553d1 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs @@ -140,8 +140,8 @@ internal List MatchingProcesses() /// /// Sort function to sort by Name first, then Id. /// - /// first Process object - /// second Process object + /// first Process object. + /// second Process object. /// /// As String.Compare: returns less than zero if x less than y, /// greater than 0 if x greater than y, 0 if x == y. @@ -291,7 +291,7 @@ internal Process[] AllProcesses /// We use a Dictionary to optimize the check whether the object /// is already in the list. /// - /// process to add to list + /// process to add to list. private void AddIdempotent( Process process) { @@ -1387,7 +1387,7 @@ private void StopDependentService(Process process) /// /// Stops the given process throws non terminating error if can't. - /// process to be stopped + /// process to be stopped. /// True if process stopped successfully else false. /// private void StopProcess(Process process) @@ -2952,8 +2952,8 @@ protected ProcessCommandException( /// /// Serializer /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute( SecurityAction.Demand, SerializationFormatter = true)] diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs index a52772872db..522c592d873 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs @@ -31,7 +31,7 @@ public abstract class ServiceBaseCommand : Cmdlet /// /// Confirm that the operation should proceed /// - /// service object to be acted on + /// service object to be acted on. /// True if operation should continue, false otherwise. protected bool ShouldProcessServiceOperation(ServiceController service) { @@ -43,8 +43,8 @@ protected bool ShouldProcessServiceOperation(ServiceController service) /// /// Confirm that the operation should proceed /// - /// display name of service to be acted on - /// service name of service to be acted on + /// display name of service to be acted on. + /// service name of service to be acted on. /// True if operation should continue, false otherwise. protected bool ShouldProcessServiceOperation( string displayName, string serviceName) @@ -475,9 +475,9 @@ private List MatchingServicesByInput() /// and (if ) if it is not /// already on . /// - /// list of services - /// service to add to list - /// check list for duplicates + /// list of services. + /// service to add to list. + /// check list for duplicates. private void IncludeExcludeAdd( List list, ServiceController service, @@ -792,8 +792,8 @@ public string[] Name /// Waits forever for the service to reach the desired status, but /// writes a string to WriteWarning every 2 seconds. /// - /// service on which to operate - /// desired status + /// service on which to operate. + /// desired status. /// /// This is the expected status while the operation is incomplete. /// If the service is in some other state, this means that the @@ -863,7 +863,7 @@ internal bool DoWaitForStatus( /// /// This will start the service. /// - /// service to start + /// service to start. /// True iff the service was started. internal bool DoStartService(ServiceController serviceController) { @@ -918,8 +918,8 @@ internal bool DoStartService(ServiceController serviceController) /// /// This will stop the service. /// - /// service to stop - /// stop dependent services + /// service to stop. + /// stop dependent services. /// /// True iff the service was stopped. internal List DoStopService(ServiceController serviceController, bool force, bool waitForServiceToStop) @@ -1068,7 +1068,7 @@ private bool HaveAllDependentServicesStopped(ICollection depe /// /// This removes all services that are not stopped from a list of services /// - /// a list of services + /// a list of services. internal void RemoveNotStoppedServices(List services) { foreach (ServiceController service in services) @@ -1084,7 +1084,7 @@ internal void RemoveNotStoppedServices(List services) /// /// This will pause the service. /// - /// service to pause + /// service to pause. /// True iff the service was paused. internal bool DoPauseService(ServiceController serviceController) { @@ -1165,7 +1165,7 @@ internal bool DoPauseService(ServiceController serviceController) /// /// This will resume the service. /// - /// service to resume + /// service to resume. /// True iff the service was resumed. internal bool DoResumeService(ServiceController serviceController) { @@ -2515,8 +2515,8 @@ protected ServiceCommandException(SerializationInfo info, StreamingContext conte /// /// Serializer /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/SetClipboardCommand.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/SetClipboardCommand.cs index 2852f255ab4..5ee07d19f9b 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/SetClipboardCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/SetClipboardCommand.cs @@ -308,7 +308,7 @@ private void CopyFilesToClipboard(List fileList, bool append, bool isLit /// /// Generate HTML fragment data string with header that is required for the clipboard. /// - /// the html to generate for + /// the html to generate for. /// The resulted string. private static string GetHtmlDataString(string html) { @@ -406,9 +406,9 @@ private static string GetHtmlDataString(string html) /// /// Calculates the number of bytes produced by encoding the string in the string builder in UTF-8 and not .NET default string encoding. /// - /// the string builder to count its string - /// optional: the start index to calculate from (default - start of string) - /// optional: the end index to calculate to (default - end of string) + /// the string builder to count its string. + /// optional: the start index to calculate from (default - start of string). + /// optional: the end index to calculate to (default - end of string). /// The number of bytes required to encode the string in UTF-8. private static int GetByteCount(StringBuilder sb, int start = 0, int end = -1) { diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs index 56d8c7c4a9e..cd188dc8e95 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs @@ -54,10 +54,10 @@ internal class WmiAsyncCmdletHelper : AsyncCmdletHelper /// /// Internal Constructor /// - /// Job associated with this operation - /// object associated with this operation - /// computer on which the operation is invoked - /// sink to get wmi objects + /// Job associated with this operation. + /// object associated with this operation. + /// computer on which the operation is invoked. + /// sink to get wmi objects. internal WmiAsyncCmdletHelper(PSWmiChildJob childJob, Cmdlet wmiObject, string computerName, ManagementOperationObserver results) { _wmiObject = wmiObject; @@ -71,11 +71,11 @@ internal WmiAsyncCmdletHelper(PSWmiChildJob childJob, Cmdlet wmiObject, string c /// Internal Constructor. This variant takes a count parameter that determines how many times /// the WMI command is executed. /// - /// Job associated with this operation - /// Object associated with this operation - /// Computer on which the operation is invoked - /// Sink to return wmi objects - /// Number of times the WMI command is executed + /// Job associated with this operation. + /// Object associated with this operation. + /// Computer on which the operation is invoked. + /// Sink to return wmi objects. + /// Number of times the WMI command is executed. internal WmiAsyncCmdletHelper(PSWmiChildJob childJob, Cmdlet wmiObject, string computerName, ManagementOperationObserver results, int count) : this(childJob, wmiObject, computerName, results) { @@ -1735,7 +1735,7 @@ private void CommonInit(int throttleLimit) /// count of blocked child jobs. When count reaches 0, sets the /// state of the parent job to running /// - /// sender of this event, unused + /// sender of this event, unused. /// event arguments, should be empty in this /// case private void HandleJobUnblocked(object sender, EventArgs eventArgs) @@ -2050,8 +2050,8 @@ private void HandleWMIState(object sender, WmiJobStateEventArgs stateEventArgs) /// /// Handle a throttle complete event /// - /// sender of this event - /// not used in this method + /// sender of this event. + /// not used in this method. private void HandleThrottleComplete(object sender, EventArgs eventArgs) { if (_helper.State == WmiState.NotStarted) diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/WriteContentCommandBase.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/WriteContentCommandBase.cs index 315e6084113..63c206c4d8f 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/WriteContentCommandBase.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/WriteContentCommandBase.cs @@ -325,8 +325,8 @@ internal List GetContentWriters( /// /// Gets the list of paths accepted by the user /// - /// The list of unfiltered paths - /// The current context + /// The list of unfiltered paths. + /// The current context. /// The list of paths accepted by the user. private string[] GetAcceptedPaths(string[] unfilteredPaths, CmdletProviderContext currentContext) { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CSVCommands.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CSVCommands.cs index 3a550e0ec50..d00952444c4 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CSVCommands.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CSVCommands.cs @@ -877,7 +877,7 @@ internal class ExportCsvHelper : IDisposable /// /// /// - /// throw if cmdlet is null + /// throw if cmdlet is null. internal ExportCsvHelper(PSCmdlet cmdlet, char delimiter) { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CustomSerialization.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CustomSerialization.cs index b5dba74b1a6..5cf288cdb7a 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CustomSerialization.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CustomSerialization.cs @@ -883,7 +883,7 @@ private void WriteEnumerable(IEnumerable enumerable, int depth) /// /// Serializes IDictionary. /// - /// dictionary which is serialized + /// dictionary which is serialized. /// private void WriteDictionary(IDictionary dictionary, int depth) { @@ -1008,8 +1008,8 @@ private static bool SerializeAsString(PSObject source) /// /// Compute the serialization depth for an PSObject instance subtree. /// - /// PSObject whose serialization depth has to be computed - /// current depth + /// PSObject whose serialization depth has to be computed. + /// current depth. /// private static int GetDepthOfSerialization(PSObject source, int depth) { @@ -1100,9 +1100,9 @@ private void WriteObjectString( /// Writes an item or property in Monad namespace. /// /// The XmlWriter stream to which the object is serialized. - /// name of property. Pass null for item - /// object to be written - /// serialization information about source + /// name of property. Pass null for item. + /// object to be written. + /// serialization information about source. private void WriteOnePrimitiveKnownType( XmlWriter writer, string property, object source, TypeSerializationInfo entry) @@ -1118,7 +1118,7 @@ private void WriteOnePrimitiveKnownType( /// Writes start element in Monad namespace. /// /// - /// tag of element + /// tag of element. internal static void WriteStartElement(XmlWriter writer, string elementTag) { writer.WriteStartElement(elementTag); @@ -1128,8 +1128,8 @@ internal static void WriteStartElement(XmlWriter writer, string elementTag) /// Writes attribute in monad namespace. /// /// - /// name of attribute - /// value of attribute + /// name of attribute. + /// value of attribute. internal static void WriteAttribute(XmlWriter writer, string name, string value) { writer.WriteAttributeString(name, value); diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/EnableDisableRunspaceDebugCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/EnableDisableRunspaceDebugCommand.cs index b3c644a87d4..92dcae2d056 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/EnableDisableRunspaceDebugCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/EnableDisableRunspaceDebugCommand.cs @@ -69,10 +69,10 @@ public int RunspaceId /// /// Constructor. /// - /// Enable debugger option - /// BreakAll option - /// Runspace name - /// Runspace local Id + /// Enable debugger option. + /// BreakAll option. + /// Runspace name. + /// Runspace local Id. public PSRunspaceDebug(bool enabled, bool breakAll, string runspaceName, int runspaceId) { if (string.IsNullOrEmpty(runspaceName)) { throw new PSArgumentNullException("runspaceName"); } @@ -250,7 +250,7 @@ protected IReadOnlyList GetRunspaces() /// /// Returns Runspace Debugger. /// - /// Runspace + /// Runspace. /// Debugger. protected System.Management.Automation.Debugger GetDebuggerFromRunspace(Runspace runspace) { @@ -278,8 +278,8 @@ protected System.Management.Automation.Debugger GetDebuggerFromRunspace(Runspace /// /// SetDebugPreferenceHelper is a helper method used to enable/disable debug preference. /// - /// Process Name - /// App Domain Name + /// Process Name. + /// App Domain Name. /// Indicates if debug preference has to be enabled or disabled. /// FullyQualifiedErrorId to be used on error. protected void SetDebugPreferenceHelper(string processName, string[] appDomainName, bool enable, string fullyQualifiedErrorId) diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/ColumnInfo.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/ColumnInfo.cs index 7efa872677d..ef09640532b 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/ColumnInfo.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/ColumnInfo.cs @@ -44,7 +44,7 @@ internal Type GetValueType(PSObject liveObject, out object columnValue) /// /// Auxiliar used in GetValue methods since the list does not deal well with unlimited sized lines. /// - /// source string + /// source string. /// The source string limited in the number of lines. internal static object LimitString(object src) { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/OutGridViewCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/OutGridViewCommand.cs index 38fc2cefd1c..cbc4948c924 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/OutGridViewCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/OutGridViewCommand.cs @@ -238,7 +238,7 @@ internal string ConvertToString(PSObject liveObject) /// /// Execute formatting on a single object. /// - /// object to process + /// object to process. private void ProcessObject(PSObject input) { // Make sure the OGV window is not closed. @@ -470,7 +470,7 @@ internal override void ProcessInputObject(PSObject input) /// /// Implements IDisposable logic. /// - /// true if being called from Dispose + /// true if being called from Dispose. private void Dispose(bool isDisposing) { if (isDisposing) diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/OutWindowProxy.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/OutWindowProxy.cs index c0f3021c0ec..654b881c2bf 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/OutWindowProxy.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/OutWindowProxy.cs @@ -239,7 +239,7 @@ internal void BlockUntillClosed() /// /// Implements IDisposable logic. /// - /// true if being called from Dispose + /// true if being called from Dispose. private void Dispose(bool isDisposing) { if (isDisposing) 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 ea1ddb881fb..0861777fead 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 @@ -58,7 +58,7 @@ internal override int RowNumber /// /// Write a line to the output device. /// - /// line to write + /// line to write. internal override void WriteLine(string s) { CheckStopProcessing(); @@ -83,7 +83,7 @@ static PrinterLineOutput() /// /// Constructor for the class. /// - /// name of printer, if null use default printer + /// name of printer, if null use default printer. internal PrinterLineOutput(string printerName) { _printerName = printerName; @@ -98,7 +98,7 @@ internal PrinterLineOutput(string printerName) /// /// Callback to be called when IConsole.WriteLine() is called by WriteLineHelper. /// - /// string to write + /// string to write. private void OnWriteLine(string s) { _lines.Enqueue(s); @@ -109,7 +109,7 @@ private void OnWriteLine(string s) /// This is called when the WriteLineHelper needs to write a line whose length /// is the same as the width of the screen buffer. /// - /// string to write + /// string to write. private void OnWrite(string s) { _lines.Enqueue(s); @@ -152,7 +152,7 @@ private void DoPrint() /// If the font object exists, it does nothing. /// Else, the a new object is created and verified. /// - /// GDI+ graphics object needed for verification + /// GDI+ graphics object needed for verification. private void CreateFont(Graphics g) { if (_printFont != null) @@ -179,7 +179,7 @@ private void CreateFont(Graphics g) /// 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 + /// GDI+ graphics object needed for verification. private void VerifyFont(Graphics g) { // check if the font is fixed pitch @@ -206,8 +206,8 @@ private void VerifyFont(Graphics g) /// /// Event fired for each page to print. /// - /// sender, not used - /// print page event + /// sender, not used. + /// print page event. private void pd_PrintPage(object sender, PrintPageEventArgs ev) { float yPos = 0; // GDI+ coordinate down the page diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetRandomCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetRandomCommand.cs index d54110f26ed..a1ebb9cac3e 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetRandomCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetRandomCommand.cs @@ -624,7 +624,7 @@ internal int Next(int maxValue) /// Returns a random integer that is within a specified range. /// /// The inclusive lower bound of the random number returned. - /// The exclusive upper bound of the random number returned. maxValue must be greater than or equal to minValue + /// The exclusive upper bound of the random number returned. maxValue must be greater than or equal to minValue. /// public int Next(int minValue, int maxValue) { @@ -650,7 +650,7 @@ public int Next(int minValue, int maxValue) /// /// Fills the elements of a specified array of bytes with random numbers. /// - /// The array to be filled + /// The array to be filled. internal void NextBytes(byte[] buffer) { if (_cryptographicGenerator != null) diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs index d57562859f0..e211d984e7e 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs @@ -1102,7 +1102,7 @@ private Dictionary RehydrateDictionary(string commandName, PSObject /// Validates that a name or identifier is safe to use in generated code /// (i.e. it can't be used for code injection attacks). /// - /// name to validate + /// name to validate. /// true if the name is safe; false otherwise. private static bool IsSafeNameOrIdentifier(string name) { @@ -1120,7 +1120,7 @@ private static bool IsSafeNameOrIdentifier(string name) /// Validates that a parameter name is safe to use in generated code /// (i.e. it can't be used for code injection attacks). /// - /// parameter name to validate + /// parameter name to validate. /// true if the name is safe; false otherwise. private static bool IsSafeParameterName(string parameterName) { @@ -1131,7 +1131,7 @@ private static bool IsSafeParameterName(string parameterName) /// Validates that a type can be safely used as a type constraint /// (i.e. it doesn't introduce any side effects on the client). /// - /// type to validate + /// type to validate. /// true if the type is safe; false otherwise. private static bool IsSafeTypeConstraint(Type type) { @@ -1174,7 +1174,7 @@ private static bool IsSafeTypeConstraint(Type type) /// Validates that command metadata returned from the (potentially malicious) server is safe. /// Writes error messages if necessary. Modifies command metadata to make it safe if necessary. /// - /// command metadata to verify + /// command metadata to verify. /// true if the command metadata is safe; false otherwise. private bool IsSafeCommandMetadata(CommandMetadata commandMetadata) { @@ -1392,9 +1392,9 @@ private int GetCommandTypePriority(CommandTypes commandType) /// /// Converts remote (deserialized) CommandInfo objects into CommandMetadata equivalents. /// - /// Dictionary where rehydrated CommandMetadata are going to be stored - /// Dictionary mapping alias names to resolved command names - /// Remote (deserialized) CommandInfo object + /// Dictionary where rehydrated CommandMetadata are going to be stored. + /// Dictionary mapping alias names to resolved command names. + /// Remote (deserialized) CommandInfo object. /// CommandMetadata equivalents. private void AddRemoteCommandMetadata( Dictionary name2commandMetadata, @@ -1859,13 +1859,13 @@ private void WriteProgress(DateTime startTime, int currentCount, int expectedCou /// /// Generates a proxy module in the given directory. /// - /// base directory for the module - /// fileName prefix for module files - /// encoding of generated files - /// whether to overwrite files - /// remote commands to generate proxies for - /// dictionary mapping alias names to resolved command names - /// remote format data to generate format.ps1xml for + /// base directory for the module. + /// fileName prefix for module files. + /// encoding of generated files. + /// whether to overwrite files. + /// remote commands to generate proxies for. + /// dictionary mapping alias names to resolved command names. + /// remote format data to generate format.ps1xml for. /// Paths to generated files. internal List GenerateProxyModule( DirectoryInfo moduleRootDirectory, @@ -3012,14 +3012,14 @@ private void GenerateFormatFile(TextWriter writer, List /// /// Generates a proxy module in the given directory. /// - /// base directory for the module - /// filename prefix for module files - /// encoding of generated files - /// whether to overwrite files - /// remote commands to generate proxies for - /// dictionary mapping alias names to resolved command names - /// remote format data to generate format.ps1xml for - /// certificate with which to sign the format files + /// base directory for the module. + /// filename prefix for module files. + /// encoding of generated files. + /// whether to overwrite files. + /// remote commands to generate proxies for. + /// dictionary mapping alias names to resolved command names. + /// remote format data to generate format.ps1xml for. + /// certificate with which to sign the format files. /// Path to the created files. internal List GenerateProxyModule( DirectoryInfo moduleRootDirectory, diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Measure-Object.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Measure-Object.cs index 4024dc4dd8e..ef7a08cfb1b 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Measure-Object.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Measure-Object.cs @@ -175,7 +175,7 @@ internal MeasureObjectDictionary() : base(StringComparer.OrdinalIgnoreCase) /// the key with a new value created via the value type's /// default constructor. /// - /// The key to look up + /// The key to look up. /// /// The existing value, or a newly-created value. /// @@ -650,8 +650,8 @@ private static class TextCountUtilities /// /// Count chars in inStr. /// - /// string whose chars are counted - /// true to discount white space + /// string whose chars are counted. + /// true to discount white space. /// Number of chars in inStr. internal static int CountChar(string inStr, bool ignoreWhiteSpace) { @@ -680,7 +680,7 @@ internal static int CountChar(string inStr, bool ignoreWhiteSpace) /// /// Count words in inStr. /// - /// string whose words are counted + /// string whose words are counted. /// Number of words in inStr. internal static int CountWord(string inStr) { @@ -714,7 +714,7 @@ internal static int CountWord(string inStr) /// /// Count lines in inStr. /// - /// string whose lines are counted + /// string whose lines are counted. /// Number of lines in inStr. internal static int CountLine(string inStr) { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/OrderObjectBase.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/OrderObjectBase.cs index bbe080b6f1c..c6194ff0acf 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/OrderObjectBase.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/OrderObjectBase.cs @@ -490,7 +490,7 @@ internal OrderByProperty() /// /// Utility function used to create OrderByPropertyEntry for the supplied input object. /// - /// PSCmdlet + /// PSCmdlet. /// Input Object. /// Indicates if the Property value comparisons need to be case sensitive or not. /// Culture Info that needs to be used for comparison. 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 a6b2cff1641..79426a5d211 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs @@ -125,7 +125,7 @@ public SwitchParameter PassThru /// /// Executes a PowerShell script, writing the output objects to the pipeline. /// - /// Script to execute + /// Script to execute. public void RunScript(string script) { if (_showCommandProxy == null || string.IsNullOrEmpty(script)) @@ -270,7 +270,7 @@ protected override void StopProcessing() /// Runs the script in a new PowerShell instance and hooks up error stream to potentially display error popup. /// This method has the inconvenience of not showing to the console user the script being executed. /// - /// script to be run + /// script to be run. private void RunScriptSilentlyAndWithErrorHookup(string script) { // errors are not created here, because there is a field for it used in the final pop up @@ -317,8 +317,8 @@ private void IssueErrorForMoreThanOneCommand() /// /// Called from CommandProcessRecord to run the command that will get the CommandInfo and list of modules. /// - /// command to be retrieved - /// list of loaded modules + /// command to be retrieved. + /// list of loaded modules. private void GetCommandInfoAndModules(out CommandInfo command, out Dictionary modules) { command = null; @@ -456,8 +456,8 @@ private void WaitForWindowClosedOrHelpNeeded() /// /// Writes the output of a script being run into the pipeline. /// - /// output collection - /// output event + /// output collection. + /// output event. private void Output_DataAdded(object sender, DataAddedEventArgs e) { this.WriteObject(((PSDataCollection)sender)[e.Index]); @@ -466,8 +466,8 @@ private void Output_DataAdded(object sender, DataAddedEventArgs e) /// /// Writes the errors of a script being run into the pipeline. /// - /// error collection - /// error event + /// error collection. + /// error event. private void Error_DataAdded(object sender, DataAddedEventArgs e) { this.WriteError(((PSDataCollection)sender)[e.Index]); @@ -476,7 +476,7 @@ private void Error_DataAdded(object sender, DataAddedEventArgs e) /// /// Implements IDisposable logic. /// - /// true if being called from Dispose + /// true if being called from Dispose. private void Dispose(bool isDisposing) { if (isDisposing) @@ -503,8 +503,8 @@ internal static class ConsoleInputWithNativeMethods /// /// Adds a string to the console input buffer. /// - /// string to add to console input buffer - /// true to add Enter after the string + /// string to add to console input buffer. + /// true to add Enter after the string. /// True if it was successful in adding all characters to console input buffer. internal static bool AddToConsoleInputBuffer(string str, bool newLine) { @@ -555,7 +555,7 @@ internal static bool AddToConsoleInputBuffer(string str, bool newLine) /// /// Gets the console handle. /// - /// which console handle to get + /// which console handle to get. /// The console handle. [DllImport("kernel32.dll", SetLastError = true)] internal static extern IntPtr GetStdHandle(int nStdHandle); @@ -563,10 +563,10 @@ internal static bool AddToConsoleInputBuffer(string str, bool newLine) /// /// Writes to the console input buffer. /// - /// console handle - /// inputs to be written - /// number of inputs to be written - /// returned number of inputs actually written + /// console handle. + /// inputs to be written. + /// number of inputs to be written. + /// returned number of inputs actually written. /// 0 if the function fails. [DllImport("kernel32.dll", SetLastError = true)] [return: MarshalAs(UnmanagedType.Bool)] @@ -600,8 +600,8 @@ internal struct INPUT_RECORD /// /// Sets the necessary fields of for a KeyDown event for the /// - /// input record to be set - /// character to set the record with + /// input record to be set. + /// character to set the record with. internal static void SetInputRecord(ref INPUT_RECORD inputRecord, char character) { inputRecord.EventType = INPUT_RECORD.KEY_EVENT; 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 91986a9e89b..fd3c1368d81 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 @@ -843,8 +843,8 @@ public sealed class HttpResponseException : HttpRequestException /// /// Constructor for HttpResponseException. /// - /// Message for the exception - /// Response from the HTTP server + /// Message for the exception. + /// Response from the HTTP server. public HttpResponseException(string message, HttpResponseMessage response) : base(message) { Response = response; @@ -891,7 +891,7 @@ public abstract partial class WebRequestPSCmdlet : PSCmdlet /// /// Read the supplied WebResponse object and push the resulting output into the pipeline. /// - /// Instance of a WebResponse object to be processed + /// Instance of a WebResponse object to be processed. internal abstract void ProcessResponse(HttpResponseMessage response); #endregion Abstract Methods @@ -1633,7 +1633,7 @@ protected override void StopProcessing() /// /// Sets the ContentLength property of the request and writes the specified content to the request's RequestStream. /// - /// The WebRequest who's content is to be set + /// The WebRequest who's content is to be set. /// A byte array containing the content data. /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property. /// @@ -1656,7 +1656,7 @@ internal long SetRequestContent(HttpRequestMessage request, byte[] content) /// /// Sets the ContentLength property of the request and writes the specified content to the request's RequestStream. /// - /// The WebRequest who's content is to be set + /// The WebRequest who's content is to be set. /// A String object containing the content data. /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property. /// @@ -1742,7 +1742,7 @@ internal long SetRequestContent(HttpRequestMessage request, XmlNode xmlNode) /// /// Sets the ContentLength property of the request and writes the specified content to the request's RequestStream. /// - /// The WebRequest who's content is to be set + /// The WebRequest who's content is to be set. /// A Stream object containing the content data. /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property. /// @@ -1765,7 +1765,7 @@ internal long SetRequestContent(HttpRequestMessage request, Stream contentStream /// /// Sets the ContentLength property of the request and writes the specified content to the request's RequestStream. /// - /// The WebRequest who's content is to be set + /// The WebRequest who's content is to be set. /// A MultipartFormDataContent object containing multipart/form-data content. /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property. /// @@ -1898,8 +1898,8 @@ private void AddMultipartContent(object fieldName, object fieldValue, MultipartF /// /// Gets a from the supplied field name and field value. Uses to convert the objects to strings. /// - /// The Field Name to use for the . - /// The Field Value to use for the . + /// The Field Name to use for the + /// The Field Value to use for the private StringContent GetMultipartStringContent(Object fieldName, object fieldValue) { var contentDisposition = new ContentDispositionHeaderValue("form-data"); @@ -1915,8 +1915,8 @@ private StringContent GetMultipartStringContent(Object fieldName, object fieldVa /// /// Gets a from the supplied field name and . Uses to convert the fieldname to a string. /// - /// The Field Name to use for the . - /// The to use for the . + /// The Field Name to use for the + /// The to use for the private StreamContent GetMultipartStreamContent(Object fieldName, Stream stream) { var contentDisposition = new ContentDispositionHeaderValue("form-data"); @@ -1933,8 +1933,8 @@ private StreamContent GetMultipartStreamContent(Object fieldName, Stream stream) /// /// Gets a from the supplied field name and file. Calls to create the and then sets the file name. /// - /// The Field Name to use for the . - /// The file to use for the . + /// The Field Name to use for the + /// The file to use for the private StreamContent GetMultipartFileContent(Object fieldName, FileInfo file) { var result = GetMultipartStreamContent(fieldName: fieldName, stream: new FileStream(file.FullName, FileMode.Open)); 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 a8dca7cee6e..215e3243a3d 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs @@ -163,8 +163,8 @@ protected override void EndProcessing() /// that properties that cannot be evaluated are treated as having the value null. /// Primitive types are returned verbatim. Aggregate types are processed recursively. /// - /// The object to be processed - /// The current depth into the object graph + /// The object to be processed. + /// The current depth into the object graph. /// An object suitable for serializing to JSON. private object ProcessValue(object obj, int depth) { @@ -273,11 +273,11 @@ private object ProcessValue(object obj, int depth) /// /// Add to a base object any properties that might have been added to an object (via PSObject) through the Add-Member cmdlet. /// - /// The containing PSObject, or null if the base object was not contained in a PSObject - /// The base object that might have been decorated with additional properties - /// The current depth into the object graph - /// the processed object is a pure PSObject - /// the processed object is a custom object + /// The containing PSObject, or null if the base object was not contained in a PSObject. + /// The base object that might have been decorated with additional properties. + /// The current depth into the object graph. + /// the processed object is a pure PSObject. + /// the processed object is a custom object. /// /// The original base object if no additional properties had been added, /// otherwise a dictionary containing the value of the original base object in the "value" key @@ -319,10 +319,10 @@ private object AddPsProperties(object psobj, object obj, int depth, bool isPureP /// When the object is a pure PSObject, it also gets processed in "ProcessCustomObject" before reaching this method, so we will /// iterate both extended and adapted properties for it. Since it's a pure PSObject, there will be no adapted properties. /// - /// The containing PSObject, or null if the base object was not contained in a PSObject - /// The dictionary to which any additional properties will be appended - /// The current depth into the object graph - /// The processed object is a custom object + /// The containing PSObject, or null if the base object was not contained in a PSObject. + /// The dictionary to which any additional properties will be appended. + /// The current depth into the object graph. + /// The processed object is a custom object. private void AppendPsProperties(PSObject psobj, IDictionary receiver, int depth, bool isCustomObject) { // serialize only Extended and Adapted properties.. diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/JsonObject.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/JsonObject.cs index 71b50a5a8ec..5f341a77b2b 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/JsonObject.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/JsonObject.cs @@ -44,7 +44,7 @@ public static object ConvertFromJson(string input, out ErrorRecord error) /// /// The json text to convert. /// True if the result should be returned as a - /// instead of a . + /// instead of a /// An error record if the conversion failed. /// A or a /// if the parameter is true. diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/StreamHelper.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/StreamHelper.cs index 093cee8b8c0..392255c0745 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/StreamHelper.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/StreamHelper.cs @@ -33,7 +33,7 @@ internal class WebResponseContentMemoryStream : MemoryStream /// /// /// - /// Owner cmdlet if any + /// Owner cmdlet if any. internal WebResponseContentMemoryStream(Stream stream, int initialCapacity, Cmdlet cmdlet) : base(initialCapacity) { 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 c0f05a4f0de..4663ff62e83 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/convert-HTML.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/convert-HTML.cs @@ -335,7 +335,7 @@ protected override void SetEntries() /// /// Create a list of MshParameter from properties. /// - /// can be a string, ScriptBlock, or Hashtable + /// can be a string, ScriptBlock, or Hashtable. /// private List ProcessParameter(object[] properties) { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/select-object.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/select-object.cs index 3a2811cb440..7d97d46b812 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/select-object.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/select-object.cs @@ -19,7 +19,7 @@ internal sealed class PSPropertyExpressionFilter /// /// Construct the class, using an array of patterns. /// - /// array of pattern strings to use + /// array of pattern strings to use. internal PSPropertyExpressionFilter(string[] wildcardPatternsStrings) { if (wildcardPatternsStrings == null) @@ -38,7 +38,7 @@ internal PSPropertyExpressionFilter(string[] wildcardPatternsStrings) /// Try to match the expression against the array of wildcard patterns. /// The first match shortcircuits the search. /// - /// PSPropertyExpression to test against + /// PSPropertyExpression to test against. /// True if there is a match, else false. internal bool IsMatch(PSPropertyExpression expression) { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/trace/TraceExpressionCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/trace/TraceExpressionCommand.cs index ff5efc1b8b8..4a1cf839c71 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/trace/TraceExpressionCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/trace/TraceExpressionCommand.cs @@ -428,7 +428,7 @@ public override void Flush() /// /// Write a single object into the underlying stream. /// - /// The object to add to the stream + /// The object to add to the stream. /// /// One, if the write was successful, otherwise; /// zero if the stream was closed before the object could be written, @@ -462,7 +462,7 @@ public override int Write(object obj) /// /// Write objects to the underlying stream. /// - /// object or enumeration to read from + /// object or enumeration to read from. /// /// If enumerateCollection is true, and /// is an enumeration according to LanguagePrimitives.GetEnumerable, diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs index 76f538d226e..5a53c73e510 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs @@ -469,8 +469,8 @@ public WriteErrorException(string message, /// /// Serialization constructor for class WriteErrorException. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected WriteErrorException(SerializationInfo info, StreamingContext context) diff --git a/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs b/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs index 1a56a5e8323..a23805b8a89 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs @@ -30,8 +30,8 @@ internal struct PropertyKey : IEquatable /// /// PropertyKey Constructor /// - /// A unique GUID for the property - /// Property identifier (PID) + /// A unique GUID for the property. + /// Property identifier (PID). internal PropertyKey(Guid formatId, Int32 propertyId) { this.FormatId = formatId; @@ -96,7 +96,7 @@ public override bool Equals(object obj) /// /// Implements the != (inequality) operator. /// - /// First property key to compare + /// First property key to compare. /// Second property key to compare. /// True if object a does not equal object b. false otherwise. public static bool operator !=(PropertyKey propKey1, PropertyKey propKey2) diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs index c8702a68977..1422ac8e761 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs @@ -446,7 +446,7 @@ internal enum KeyboardFlag : uint /// Code to control the display properties of the a window... /// /// The window to show... - /// The command to do + /// The command to do. /// True it it was successful. [DllImport("user32.dll")] internal static extern bool ShowWindow(IntPtr hWnd, Int32 nCmdShow); @@ -1214,7 +1214,7 @@ private enum BufferCellArrayRowType : uint /// /// /// - /// must be within the screen buffer + /// must be within the screen buffer. /// /// /// diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs index 71c34d47bd2..22074d584fe 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs @@ -609,8 +609,8 @@ public void PushRunspace(Runspace newRunspace) /// gets into a broken or closed state, writes a message and pops out the /// runspace /// - /// not sure - /// arguments describing this event + /// not sure. + /// arguments describing this event. private void HandleRemoteRunspaceStateChanged(object sender, RunspaceStateEventArgs eventArgs) { RunspaceState state = eventArgs.RunspaceStateInfo.State; @@ -2311,8 +2311,8 @@ private void HandleRunspacePushed(object sender, EventArgs e) /// When a runspace is popped, we need to reevaluate the /// prompt /// - /// sender of this event, unused - /// arguments describing this event, unused + /// sender of this event, unused. + /// arguments describing this event, unused. private void HandleRunspacePopped(object sender, EventArgs eventArgs) { lock (_syncObject) diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostRawUserInterface.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostRawUserInterface.cs index e4a8ecffdab..8d79f56398e 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostRawUserInterface.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostRawUserInterface.cs @@ -568,8 +568,8 @@ private PipelineStoppedException NewPipelineStoppedException() /// /// Used by ReadKey, cache KeyEvent based on if input.RepeatCount > 1 /// - /// Input key event record - /// Cache key event + /// Input key event record. + /// Cache key event. private static void CacheKeyEvent(ConsoleControl.KEY_EVENT_RECORD input, ref ConsoleControl.KEY_EVENT_RECORD cache) { if (input.RepeatCount > 1) diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs index 4f6b2da8efc..1db09710b7c 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs @@ -503,7 +503,7 @@ private void WriteBackSpace(Coordinates originalCursorPosition) /// /// Blank out at and move rawui.CursorPosition to /// - /// Position to blank out + /// Position to blank out. private void BlankAtCursor(Coordinates cursorPosition) { _rawui.CursorPosition = cursorPosition; @@ -1717,7 +1717,7 @@ private string ReadLineFromConsole(bool endOnTab, string initialContent, bool ca /// /// Get the character at the cursor when the user types 'tab' in the middle of line. /// - /// the cursor position where 'tab' is hit + /// the cursor position where 'tab' is hit. /// private char GetCharacterUnderCursor(Coordinates cursorPosition) { @@ -1746,7 +1746,7 @@ private char GetCharacterUnderCursor(Coordinates cursorPosition) /// /// Strip nulls from a string... /// - /// The string to process + /// The string to process. /// The string with any \0 characters removed... private string RemoveNulls(string input) { diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs index 70aad5a993b..873d44edc6d 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs @@ -334,12 +334,12 @@ out object convertedObj /// /// Called by Prompt. Reads user input and processes tilde commands. /// - /// prompt written to host for the field - /// the field to be read - /// true to echo user input - /// true if the field is a list - /// valid only if listInput is true. set to true if the input signals end of list input - /// true iff the input is canceled, e.g., by Ctrl-C or Ctrl-Break + /// prompt written to host for the field. + /// the field to be read. + /// true to echo user input. + /// true if the field is a list. + /// valid only if listInput is true. set to true if the input signals end of list input. + /// true iff the input is canceled, e.g., by Ctrl-C or Ctrl-Break. /// Processed input string to be converted with LanguagePrimitives.ConvertTo. private string PromptReadInput(string fieldPrompt, FieldDescription desc, bool fieldEchoOnPrompt, bool listInput, out bool endListInput, out bool cancelled) @@ -398,9 +398,9 @@ private string PromptReadInput(string fieldPrompt, FieldDescription desc, bool f /// Uses LanguagePrimitives.ConvertTo to parse inputString for fieldType. Handles two most common parse /// exceptions: OverflowException and FormatException. /// - /// the type that inputString is to be interpreted - /// is the call coming from a remote host - /// the string to be converted + /// the type that inputString is to be interpreted. + /// is the call coming from a remote host. + /// the string to be converted. /// if there's no error in the conversion, the converted object will be assigned here; /// otherwise, this will be the same as the inputString /// An object of type fieldType that inputString represents. diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfaceSecurity.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfaceSecurity.cs index ce1b29cc2b6..34b011b18f2 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfaceSecurity.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfaceSecurity.cs @@ -24,7 +24,7 @@ class ConsoleHostUserInterface : System.Management.Automation.Host.PSHostUserInt /// if so configured. /// /// name of the user whose creds are to be prompted for. If set to null or empty string, the function will prompt for user name first. - /// name of the target for which creds are being collected + /// name of the target for which creds are being collected. /// message to be displayed. /// caption for the message. /// PSCredential object. @@ -47,11 +47,11 @@ public override PSCredential PromptForCredential( /// Prompt for credentials. /// /// name of the user whose creds are to be prompted for. If set to null or empty string, the function will prompt for user name first. - /// name of the target for which creds are being collected + /// name of the target for which creds are being collected. /// message to be displayed. /// caption for the message. - /// what type of creds can be supplied by the user - /// options that control the cred gathering UI behavior + /// what type of creds can be supplied by the user. + /// options that control the cred gathering UI behavior. /// PSCredential object, or null if input was cancelled (or if reading from stdin and stdin at EOF). public override PSCredential PromptForCredential( diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleShell.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleShell.cs index ec3b1044b62..6eb9059df18 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleShell.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleShell.cs @@ -15,7 +15,7 @@ public static class ConsoleShell { /// Entry point in to ConsoleShell. This method is called by main of minishell. - /// Banner text to be displayed by ConsoleHost + /// Banner text to be displayed by ConsoleHost. /// Help text for minishell. This is displayed on 'minishell -?'. /// Commandline parameters specified by user. /// An integer value which should be used as exit code for the process. diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJob.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJob.cs index da837ecbe05..f343904b175 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJob.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJob.cs @@ -127,9 +127,9 @@ internal bool AllowSetShouldExit /// /// Constructor. /// - /// Job command string for display - /// Name of job - /// ScheduledJobDefinition defining job to run + /// Job command string for display. + /// Name of job. + /// ScheduledJobDefinition defining job to run. public ScheduledJob( string command, string name, @@ -385,8 +385,8 @@ public override void SuspendJobAsync(bool force, string reason) /// /// Deserialize constructor. /// - /// SerializationInfo - /// StreamingContext + /// SerializationInfo. + /// StreamingContext. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] private ScheduledJob( SerializationInfo info, @@ -405,8 +405,8 @@ private ScheduledJob( /// /// Serialize method. /// - /// SerializationInfo - /// StreamingContext + /// SerializationInfo. + /// StreamingContext. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public void GetObjectData( SerializationInfo info, diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs index 6bce67fdf30..7c0e73e629c 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs @@ -200,10 +200,10 @@ private ScheduledJobDefinition() /// /// Constructor. /// - /// Information to invoke Job - /// ScheduledJobTriggers - /// ScheduledJobOptions - /// Credential + /// Information to invoke Job. + /// ScheduledJobTriggers. + /// ScheduledJobOptions. + /// Credential. public ScheduledJobDefinition( JobInvocationInfo invocationInfo, IEnumerable triggers, @@ -233,8 +233,8 @@ public ScheduledJobDefinition( /// /// Serialization constructor. /// - /// SerializationInfo - /// StreamingContext + /// SerializationInfo. + /// StreamingContext. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] private ScheduledJobDefinition( SerializationInfo info, @@ -273,8 +273,8 @@ private ScheduledJobDefinition( /// /// Serialization constructor. /// - /// SerializationInfo - /// StreamingContext + /// SerializationInfo. + /// StreamingContext. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -507,7 +507,7 @@ private void UpdateJobStore() /// /// Updates definition file permissions for provided user account. /// - /// Account user name + /// Account user name. private void UpdateFilePermissions(string user) { Exception ex = null; @@ -658,7 +658,7 @@ private void UpdateJobRunNames( /// /// Handles known Task Scheduler COM error codes. /// - /// COMException + /// COMException. /// Error message. private string ConvertCOMErrorCode(System.Runtime.InteropServices.COMException e) { @@ -725,7 +725,7 @@ internal void SyncWithWTS() /// /// Renames scheduled job definition, store directory and task scheduler task. /// - /// New name of job definition + /// New name of job definition. internal void RenameAndSave(string newName) { if (InvocationInfo.Name.Equals(newName, StringComparison.OrdinalIgnoreCase)) @@ -1236,8 +1236,8 @@ public void RunAsTask() /// /// Adds new ScheduledJobTriggers. /// - /// Collection of ScheduledJobTrigger objects - /// Update Windows Task Scheduler and save to store + /// Collection of ScheduledJobTrigger objects. + /// Update Windows Task Scheduler and save to store. public void AddTriggers( IEnumerable triggers, bool save) @@ -1272,8 +1272,8 @@ public void AddTriggers( /// /// Removes triggers matching passed in trigger Ids. /// - /// Trigger Ids to remove - /// Update Windows Task Scheduler and save to store + /// Trigger Ids to remove. + /// Update Windows Task Scheduler and save to store. /// Trigger Ids not found. public List RemoveTriggers( IEnumerable triggerIds, @@ -1332,8 +1332,8 @@ public List RemoveTriggers( /// Updates triggers with provided trigger objects, matching passed in /// trigger Id with existing trigger Id. /// - /// Collection of ScheduledJobTrigger objects to update - /// Update Windows Task Scheduler and save to store + /// Collection of ScheduledJobTrigger objects to update. + /// Update Windows Task Scheduler and save to store. /// Trigger Ids not found. public List UpdateTriggers( IEnumerable triggers, @@ -1382,8 +1382,8 @@ public List UpdateTriggers( /// /// Creates a new set of ScheduledJobTriggers for this object. /// - /// Array of ScheduledJobTrigger objects to set - /// Update Windows Task Scheduler and save to store + /// Array of ScheduledJobTrigger objects to set. + /// Update Windows Task Scheduler and save to store. public void SetTriggers( IEnumerable newTriggers, bool save) @@ -1424,8 +1424,8 @@ public void SetTriggers( /// to the passed in trigger Ids. Also returns an array of trigger Ids /// that were not found in an out parameter. /// - /// List of trigger Ids - /// List of not found trigger Ids + /// List of trigger Ids. + /// List of not found trigger Ids. /// List of ScheduledJobTrigger objects. public List GetTriggers( IEnumerable triggerIds, @@ -1476,7 +1476,7 @@ public List GetTriggers( /// Finds and returns a copy of the ScheduledJobTrigger corresponding to /// the passed in trigger Id. /// - /// Trigger Id + /// Trigger Id. /// ScheduledJobTrigger object. public ScheduledJobTrigger GetTrigger( Int32 triggerId) @@ -1498,8 +1498,8 @@ public ScheduledJobTrigger GetTrigger( /// /// Updates scheduled job options. /// - /// ScheduledJobOptions or null for default - /// Update Windows Task Scheduler and save to store + /// ScheduledJobOptions or null for default. + /// Update Windows Task Scheduler and save to store. public void UpdateOptions( ScheduledJobOptions options, bool save) @@ -1524,8 +1524,8 @@ public void UpdateOptions( /// /// Sets the execution history length property. /// - /// execution history length - /// Save to store + /// execution history length. + /// Save to store. public void SetExecutionHistoryLength( int executionHistoryLength, bool save) @@ -1554,8 +1554,8 @@ public void ClearExecutionHistory() /// /// Updates the JobInvocationInfo object. /// - /// JobInvocationInfo - /// Save to store + /// JobInvocationInfo. + /// Save to store. public void UpdateJobInvocationInfo( JobInvocationInfo jobInvocationInfo, bool save) @@ -1579,8 +1579,8 @@ public void UpdateJobInvocationInfo( /// /// Sets the enabled state of this object. /// - /// True if enabled - /// Update Windows Task Scheduler and save to store + /// True if enabled. + /// Update Windows Task Scheduler and save to store. public void SetEnabled( bool enabled, bool save) @@ -1598,8 +1598,8 @@ public void SetEnabled( /// /// Sets the name of this scheduled job definition. /// - /// Name - /// Update Windows Task Scheduler and save to store + /// Name. + /// Update Windows Task Scheduler and save to store. public void SetName( string name, bool save) @@ -1721,8 +1721,8 @@ internal static Dictionary RefreshRepositoryFromStore( /// Reads a ScheduledJobDefinition object from file and /// returns object. /// - /// Name of definition to load - /// Path to definition file + /// Name of definition to load. + /// Path to definition file. /// ScheduledJobDefinition object. internal static ScheduledJobDefinition LoadDefFromStore( string definitionName, @@ -1851,7 +1851,7 @@ public static ScheduledJobDefinition LoadFromStore( /// Internal helper method to remove a scheduled job definition /// by name from job store and Task Scheduler. /// - /// Scheduled job definition name + /// Scheduled job definition name. internal static void RemoveDefinition( string definitionName) { @@ -2216,7 +2216,7 @@ public void Remove(ScheduledJobDefinition jobDef) /// Checks to see if a ScheduledJobDefinition object exists with /// the provided definition name. /// - /// Definition name + /// Definition name. /// True if definition exists. public bool Contains(string jobDefName) { @@ -2342,8 +2342,8 @@ public sealed class ScheduledJobInvocationInfo : JobInvocationInfo /// /// Constructor. /// - /// JobDefinition - /// Dictionary of parameters + /// JobDefinition. + /// Dictionary of parameters. public ScheduledJobInvocationInfo(JobDefinition definition, Dictionary parameters) : base(definition, parameters) { @@ -2396,8 +2396,8 @@ public ScheduledJobInvocationInfo(JobDefinition definition, Dictionary /// Serialization constructor. /// - /// SerializationInfo - /// StreamingContext + /// SerializationInfo. + /// StreamingContext. internal ScheduledJobInvocationInfo( SerializationInfo info, StreamingContext context) @@ -2413,8 +2413,8 @@ internal ScheduledJobInvocationInfo( /// /// Serialization implementation. /// - /// SerializationInfo - /// StreamingContext + /// SerializationInfo. + /// StreamingContext. public override void GetObjectData(SerializationInfo info, StreamingContext context) { if (info == null) diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobOptions.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobOptions.cs index 0c9913da894..84f73845685 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobOptions.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobOptions.cs @@ -259,7 +259,7 @@ internal ScheduledJobOptions( /// /// Copy Constructor. /// - /// Copy from + /// Copy from. internal ScheduledJobOptions( ScheduledJobOptions copyOptions) { @@ -292,8 +292,8 @@ internal ScheduledJobOptions( /// /// Serialization constructor. /// - /// SerializationInfo - /// StreamingContext + /// SerializationInfo. + /// StreamingContext. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] private ScheduledJobOptions( SerializationInfo info, @@ -325,8 +325,8 @@ private ScheduledJobOptions( /// /// GetObjectData for ISerializable implementation. /// - /// SerializationInfo - /// StreamingContext + /// SerializationInfo. + /// StreamingContext. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs index e31b561b318..b0103d327c3 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs @@ -68,7 +68,7 @@ public ScheduledJobSourceAdapter() /// /// Create a new Job2 results instance. /// - /// Job specification + /// Job specification. /// Job2. public override Job2 NewJob(JobInvocationInfo specification) { @@ -92,8 +92,8 @@ public override Job2 NewJob(JobInvocationInfo specification) /// null then a default location will be used to find the /// job definition by name. /// - /// ScheduledJob definition name - /// ScheduledJob definition file path + /// ScheduledJob definition name. + /// ScheduledJob definition file path. /// Job2 object. public override Job2 NewJob(string definitionName, string definitionPath) { @@ -172,7 +172,7 @@ public override IList GetJobsByName(string name, bool recurse) /// /// Get list of jobs that run the specified command /// - /// command to match + /// command to match. /// /// Collection of jobs that match the specified /// criteria. @@ -201,7 +201,7 @@ public override IList GetJobsByCommand(string command, bool recurse) /// /// Get job that has the specified id /// - /// Guid to match + /// Guid to match. /// /// Job with the specified guid. public override Job2 GetJobByInstanceId(Guid instanceId, bool recurse) @@ -222,7 +222,7 @@ public override Job2 GetJobByInstanceId(Guid instanceId, bool recurse) /// /// Get job that has specific session id /// - /// Id to match + /// Id to match. /// /// Job with the specified id. public override Job2 GetJobBySessionId(int id, bool recurse) @@ -243,7 +243,7 @@ public override Job2 GetJobBySessionId(int id, bool recurse) /// /// Get list of jobs that are in the specified state /// - /// state to match + /// state to match. /// /// Collection of jobs with the specified /// state. @@ -304,7 +304,7 @@ public override IList GetJobsByFilter(Dictionary filter, b /// /// Remove a job from the store /// - /// job object to remove + /// job object to remove. public override void RemoveJob(Job2 job) { if (job == null) @@ -332,7 +332,7 @@ public override void RemoveJob(Job2 job) /// /// Saves job to scheduled job run store. /// - /// ScheduledJob + /// ScheduledJob. public override void PersistJob(Job2 job) { if (job == null) @@ -350,7 +350,7 @@ public override void PersistJob(Job2 job) /// /// Serializes a ScheduledJob and saves it to store. /// - /// ScheduledJob + /// ScheduledJob. internal static void SaveJobToStore(ScheduledJob job) { string outputPath = job.Definition.OutputPath; @@ -403,8 +403,8 @@ internal static void SaveJobToStore(ScheduledJob job) /// Writes the job status information to the provided /// file stream. /// - /// ScheduledJob job to save - /// FileStream + /// ScheduledJob job to save. + /// FileStream. private static void SaveStatusToFile(ScheduledJob job, FileStream fs) { StatusInfo statusInfo = new StatusInfo( @@ -428,8 +428,8 @@ private static void SaveStatusToFile(ScheduledJob job, FileStream fs) /// Writes the job (which implements ISerializable) to the provided /// file stream. /// - /// ScheduledJob job to save - /// FileStream + /// ScheduledJob job to save. + /// FileStream. private static void SaveResultsToFile(ScheduledJob job, FileStream fs) { XmlObjectSerializer serializer = new System.Runtime.Serialization.NetDataContractSerializer(); @@ -441,8 +441,8 @@ private static void SaveResultsToFile(ScheduledJob job, FileStream fs) /// Check the job store results and if maximum number of results exist /// remove the oldest results folder to make room for these new results. /// - /// Output path - /// Maximum size of stored job results + /// Output path. + /// Maximum size of stored job results. private static void CheckJobStoreResults(string outputPath, int executionHistoryLength) { // Get current results for this job definition. @@ -476,8 +476,8 @@ private static void CheckJobStoreResults(string outputPath, int executionHistory /// Finds and load the Job associated with this ScheduledJobDefinition object /// having the job run date time provided. /// - /// DateTime of job run to load - /// ScheduledJobDefinition name + /// DateTime of job run to load. + /// ScheduledJobDefinition name. /// Job2 job loaded from store. internal static Job2 LoadJobFromStore(string definitionName, DateTime jobRun) { @@ -562,7 +562,7 @@ internal static Job2 LoadJobFromStore(string definitionName, DateTime jobRun) /// /// Loads the Job2 object from provided files stream. /// - /// FileStream from which to read job object + /// FileStream from which to read job object. /// Created Job2 from file stream. private static Job2 LoadResultsFromFile(FileStream fs) { @@ -577,7 +577,7 @@ private static Job2 LoadResultsFromFile(FileStream fs) /// /// Adds a Job2 object to the repository. /// - /// Job2 + /// Job2. internal static void AddToRepository(Job2 job) { if (job == null) @@ -916,7 +916,7 @@ public int Count /// /// Add Job2 to repository. /// - /// Job2 to add + /// Job2 to add. public void Add(Job2 job) { if (job == null) @@ -939,7 +939,7 @@ public void Add(Job2 job) /// /// Add or replace passed in Job2 object to repository. /// - /// Job2 to add + /// Job2 to add. public void AddOrReplace(Job2 job) { if (job == null) @@ -995,7 +995,7 @@ public void Clear() /// /// Gets the latest job run Date/Time for the given definition name. /// - /// ScheduledJobDefinition name + /// ScheduledJobDefinition name. /// Job Run DateTime. public DateTime GetLatestJobRun(string definitionName) { @@ -1048,8 +1048,8 @@ public void SetLatestJobRun(string definitionName, DateTime jobRun) /// /// Search repository for specific job run. /// - /// Definition name - /// Job run DateTime + /// Definition name. + /// Job run DateTime. /// Scheduled job if found. public ScheduledJob GetJob(string definitionName, DateTime jobRun) { diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs index 1d07a475b1e..94cb8d7554d 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs @@ -118,7 +118,7 @@ public static FileStream GetFileForJobDefinition( /// Checks the provided path against the the default path of scheduled jobs /// for the current user. /// - /// Path for scheduled job definitions + /// Path for scheduled job definitions. /// True if paths are equal. public static bool IsDefaultUserPath(string definitionPath) { @@ -162,9 +162,9 @@ public static IEnumerable GetJobDefinitions() /// Scheduled job definition name. /// DateTime of job run start time. /// Job run item. - /// File access - /// File mode - /// File share + /// File access. + /// File mode. + /// File share. /// FileStream object. public static FileStream GetFileForJobRunItem( string definitionName, @@ -263,7 +263,7 @@ public static Collection GetJobRunsForDefinitionPath( /// /// Remove the job definition and all job runs from job store. /// - /// Scheduled Job Definition name + /// Scheduled Job Definition name. public static void RemoveJobDefinition( string definitionName) { @@ -281,8 +281,8 @@ public static void RemoveJobDefinition( /// Renames the directory containing the old job definition name /// to the new name provided. /// - /// Existing job definition directory - /// Renamed job definition directory + /// Existing job definition directory. + /// Renamed job definition directory. public static void RenameScheduledJobDefDir( string oldDefName, string newDefName) @@ -305,8 +305,8 @@ public static void RenameScheduledJobDefDir( /// /// Remove a single job definition job run from the job store. /// - /// Scheduled Job Definition name - /// DateTime of job run + /// Scheduled Job Definition name. + /// DateTime of job run. public static void RemoveJobRun( string definitionName, DateTime runStart) @@ -324,8 +324,8 @@ public static void RemoveJobRun( /// /// Remove a single job definition job run from the job store. /// - /// Scheduled Job Definition Output path - /// DateTime of job run + /// Scheduled Job Definition Output path. + /// DateTime of job run. public static void RemoveJobRunFromOutputPath( string definitionOutputPath, DateTime runStart) @@ -343,7 +343,7 @@ public static void RemoveJobRunFromOutputPath( /// /// Remove all job runs for this job definition. /// - /// Scheduled Job Definition name + /// Scheduled Job Definition name. public static void RemoveAllJobRuns( string definitionName) { @@ -363,8 +363,8 @@ public static void RemoveAllJobRuns( /// /// Set read access on provided definition file for specified user. /// - /// Definition name - /// Account user name + /// Definition name. + /// Account user name. public static void SetReadAccessOnDefinitionFile( string definitionName, string user) @@ -391,8 +391,8 @@ public static void SetReadAccessOnDefinitionFile( /// Set write access on Output directory for provided definition for /// specified user. /// - /// Definition name - /// Account user name + /// Definition name. + /// Account user name. public static void SetWriteAccessOnJobRunOutput( string definitionName, string user) @@ -405,7 +405,7 @@ public static void SetWriteAccessOnJobRunOutput( /// Returns the directory path for job run output for the specified /// scheduled job definition. /// - /// Definition name + /// Definition name. /// Directory Path. public static string GetJobRunOutputDirectory( string definitionName) @@ -467,8 +467,8 @@ private static string GetDirectoryPath() /// ...\ScheduledJobs\definitionName\fileName.xml /// ...\ScheduledJobs\definitionName\Output\ /// - /// Definition name - /// File name + /// Definition name. + /// File name. /// File path/name. private static string CreateFilePathName(string definitionName, string fileName) { @@ -489,8 +489,8 @@ private static string CreateFilePathName(string definitionName, string fileName) /// /// Returns a file path/name for an existing Scheduled job definition directory. /// - /// Definition name - /// File name + /// Definition name. + /// File name. /// File path/name. private static string GetFilePathName(string definitionName, string fileName) { @@ -501,7 +501,7 @@ private static string GetFilePathName(string definitionName, string fileName) /// /// Gets the directory path for a Scheduled Job Definition. /// - /// Scheduled job definition name + /// Scheduled job definition name. /// Directory Path. private static string GetJobDefinitionPath(string definitionName) { @@ -517,8 +517,8 @@ private static string GetJobDefinitionPath(string definitionName) /// /// Returns a directory path for an existing ScheduledJob run result directory. /// - /// Definition name - /// File name + /// Definition name. + /// File name. /// Directory Path. private static string GetRunDirectory( string definitionName, @@ -533,8 +533,8 @@ private static string GetRunDirectory( /// Returns a directory path for an existing ScheduledJob run based on /// provided definition Output directory path. /// - /// Output directory path - /// File name + /// Output directory path. + /// File name. /// Directory Path. private static string GetRunDirectoryFromPath( string definitionOutputPath, @@ -548,9 +548,9 @@ private static string GetRunDirectoryFromPath( /// Returns a file path/name for a run result file. Will create the /// job run directory if it does not exist. /// - /// Definition name - /// Result type - /// Run date + /// Definition name. + /// Result type. + /// Run date. /// File path/name. private static string GetRunFilePathName( string definitionName, @@ -570,9 +570,9 @@ private static string GetRunFilePathName( /// job run output path. Will create the job run directory if it does not /// exist. /// - /// Definition job run output path - /// Result type - /// Run date + /// Definition job run output path. + /// Result type. + /// Run date. /// private static string GetRunFilePathNameFromPath( string outputPath, diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs index 24ad7d858b4..7edcb390e9a 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs @@ -175,16 +175,16 @@ public ScheduledJobTrigger() /// /// Constructor. /// - /// Enabled - /// Trigger frequency - /// Trigger time - /// Weekly days of week - /// Daily or Weekly interval - /// Random delay - /// Repetition interval - /// Repetition duration - /// Logon user - /// Trigger id + /// Enabled. + /// Trigger frequency. + /// Trigger time. + /// Weekly days of week. + /// Daily or Weekly interval. + /// Random delay. + /// Repetition interval. + /// Repetition duration. + /// Logon user. + /// Trigger id. private ScheduledJobTrigger( bool enabled, TriggerFrequency frequency, @@ -212,7 +212,7 @@ private ScheduledJobTrigger( /// /// Copy constructor. /// - /// ScheduledJobTrigger + /// ScheduledJobTrigger. internal ScheduledJobTrigger(ScheduledJobTrigger copyTrigger) { if (copyTrigger == null) @@ -237,8 +237,8 @@ internal ScheduledJobTrigger(ScheduledJobTrigger copyTrigger) /// /// Serialization constructor /// - /// SerializationInfo - /// StreamingContext + /// SerializationInfo. + /// StreamingContext. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] private ScheduledJobTrigger( SerializationInfo info, @@ -474,12 +474,12 @@ internal void CopyTo(ScheduledJobTrigger targetTrigger) /// /// Creates a one time ScheduledJobTrigger object. /// - /// DateTime when trigger activates - /// Random delay - /// Repetition interval - /// Repetition duration - /// Trigger Id - /// Trigger enabled state + /// DateTime when trigger activates. + /// Random delay. + /// Repetition interval. + /// Repetition duration. + /// Trigger Id. + /// Trigger enabled state. /// ScheduledJobTrigger. public static ScheduledJobTrigger CreateOnceTrigger( DateTime time, @@ -505,11 +505,11 @@ public static ScheduledJobTrigger CreateOnceTrigger( /// /// Creates a daily ScheduledJobTrigger object. /// - /// Time of day when trigger activates - /// Days interval for trigger activation - /// Random delay - /// Trigger Id - /// Trigger enabled state + /// Time of day when trigger activates. + /// Days interval for trigger activation. + /// Random delay. + /// Trigger Id. + /// Trigger enabled state. /// ScheduledJobTrigger. public static ScheduledJobTrigger CreateDailyTrigger( DateTime time, @@ -534,12 +534,12 @@ public static ScheduledJobTrigger CreateDailyTrigger( /// /// Creates a weekly ScheduledJobTrigger object. /// - /// Time of day when trigger activates - /// Weeks interval for trigger activation - /// Days of the week for trigger activation - /// Random delay - /// Trigger Id - /// Trigger enabled state + /// Time of day when trigger activates. + /// Weeks interval for trigger activation. + /// Days of the week for trigger activation. + /// Random delay. + /// Trigger Id. + /// Trigger enabled state. /// ScheduledJobTrigger. public static ScheduledJobTrigger CreateWeeklyTrigger( DateTime time, @@ -567,10 +567,10 @@ public static ScheduledJobTrigger CreateWeeklyTrigger( /// /// Creates a trigger that activates after user log on. /// - /// Name of user - /// Random delay - /// Trigger Id - /// Trigger enabled state + /// Name of user. + /// Random delay. + /// Trigger Id. + /// Trigger enabled state. /// ScheduledJobTrigger. public static ScheduledJobTrigger CreateAtLogOnTrigger( string user, @@ -594,9 +594,9 @@ public static ScheduledJobTrigger CreateAtLogOnTrigger( /// /// Creates a trigger that activates after OS boot. /// - /// Random delay - /// Trigger Id - /// Trigger enabled state + /// Random delay. + /// Trigger Id. + /// Trigger enabled state. /// ScheduledJobTrigger. public static ScheduledJobTrigger CreateAtStartupTrigger( TimeSpan delay, @@ -705,8 +705,8 @@ public sealed class JobTriggerToCimInstanceConverter : PSTypeConverter /// /// Determines if the converter can convert the parameter to the parameter. /// - /// The value to convert from - /// The type to convert to + /// The value to convert from. + /// The type to convert to. /// True if the converter can convert the parameter to the parameter, otherwise false. public override bool CanConvertFrom(object sourceValue, Type destinationType) { @@ -721,12 +721,12 @@ public override bool CanConvertFrom(object sourceValue, Type destinationType) /// /// Converts the parameter to the parameter using formatProvider and ignoreCase /// - /// The value to convert from - /// The type to convert to - /// The format provider to use like in IFormattable's ToString - /// true if case should be ignored + /// The value to convert from. + /// The type to convert to. + /// The format provider to use like in IFormattable's ToString. + /// true if case should be ignored. /// The parameter converted to the parameter using formatProvider and ignoreCase. - /// if no conversion was possible + /// if no conversion was possible. public override object ConvertFrom(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { if (destinationType == null) @@ -767,8 +767,8 @@ public override object ConvertFrom(object sourceValue, Type destinationType, IFo /// /// Returns true if the converter can convert the parameter to the parameter /// - /// The value to convert from - /// The type to convert to + /// The value to convert from. + /// The type to convert to. /// True if the converter can convert the parameter to the parameter, otherwise false. public override bool CanConvertTo(object sourceValue, Type destinationType) { @@ -778,12 +778,12 @@ public override bool CanConvertTo(object sourceValue, Type destinationType) /// /// Converts the parameter to the parameter using formatProvider and ignoreCase /// - /// The value to convert from - /// The type to convert to - /// The format provider to use like in IFormattable's ToString - /// true if case should be ignored + /// The value to convert from. + /// The type to convert to. + /// The format provider to use like in IFormattable's ToString. + /// true if case should be ignored. /// SourceValue converted to the parameter using formatProvider and ignoreCase. - /// if no conversion was possible + /// if no conversion was possible. public override object ConvertTo(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { throw new NotImplementedException(); diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobWTS.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobWTS.cs index 36684189a7f..52b4e432566 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobWTS.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobWTS.cs @@ -65,7 +65,7 @@ public ScheduledJobWTS() /// /// Retrieves job triggers from WTS with provided task Id. /// - /// Task Id + /// Task Id. /// Task not found. /// ScheduledJobTriggers. public Collection GetJobTriggers( @@ -101,7 +101,7 @@ public Collection GetJobTriggers( /// /// Retrieves options for the provided task Id. /// - /// Task Id + /// Task Id. /// Task not found. /// ScheduledJobOptions. public ScheduledJobOptions GetJobOptions( @@ -139,7 +139,7 @@ public bool GetTaskEnabled( /// /// Creates a new task in WTS with information from ScheduledJobDefinition. /// - /// ScheduledJobDefinition + /// ScheduledJobDefinition. public void CreateTask( ScheduledJobDefinition definition) { @@ -204,8 +204,8 @@ public void CreateTask( /// Throws error if one or more instances of this task are running. /// Force parameter will stop all running instances and remove task. /// - /// ScheduledJobDefinition - /// Force running instances to stop and remove task + /// ScheduledJobDefinition. + /// Force running instances to stop and remove task. public void RemoveTask( ScheduledJobDefinition definition, bool force = false) @@ -222,9 +222,9 @@ public void RemoveTask( /// Removes a Task Scheduler task from the PowerShell/ScheduledJobs folder /// based on a task name. /// - /// Task Scheduler task name - /// Force running instances to stop and remove task - /// First check for existence of task + /// Task Scheduler task name. + /// Force running instances to stop and remove task. + /// First check for existence of task. public void RemoveTaskByName( string taskName, bool force, @@ -277,7 +277,7 @@ public void RemoveTaskByName( /// /// Starts task running from Task Scheduler. /// - /// ScheduledJobDefinition + /// ScheduledJobDefinition. /// /// public void RunTask( @@ -294,7 +294,7 @@ public void RunTask( /// Updates an existing task in WTS with information from /// ScheduledJobDefinition. /// - /// ScheduledJobDefinition + /// ScheduledJobDefinition. public void UpdateTask( ScheduledJobDefinition definition) { @@ -358,8 +358,8 @@ public void UpdateTask( /// Creates a new WTS trigger based on the provided ScheduledJobTrigger object /// and adds it to the provided ITaskDefinition object. /// - /// ITaskDefinition - /// ScheduledJobTrigger + /// ITaskDefinition. + /// ScheduledJobTrigger. private void AddTaskTrigger( ITaskDefinition iTaskDefinition, ScheduledJobTrigger jobTrigger) @@ -466,7 +466,7 @@ private void AddTaskTrigger( /// /// Creates a ScheduledJobTrigger object based on a provided WTS ITrigger. /// - /// ITrigger + /// ITrigger. /// ScheduledJobTrigger. private ScheduledJobTrigger CreateJobTrigger( ITrigger iTrigger) @@ -587,7 +587,7 @@ private void AddTaskAction( /// Gets and returns the unsecured password for the provided /// PSCredential object. /// - /// PSCredential + /// PSCredential. /// Unsecured password string. private string GetCredentialPassword(PSCredential credential) { @@ -648,7 +648,7 @@ private ITaskFolder GetRootFolder() /// Finds a task with the provided Task Id and returns it as /// a ITaskDefinition object. /// - /// Task Id + /// Task Id. /// ITaskDefinition. private ITaskDefinition FindTask(string taskId) { @@ -696,7 +696,7 @@ private Int32 ConvertStringId(string triggerId) /// "nM" - minute value. /// "nS" - second value. /// - /// Formatted time string + /// Formatted time string. /// TimeSpan. private TimeSpan ParseWTSTime(string wtsTime) { @@ -792,7 +792,7 @@ private TimeSpan ParseWTSTime(string wtsTime) /// /// Creates WTS formatted time string based on TimeSpan parameter. /// - /// TimeSpan + /// TimeSpan. /// WTS time string. internal static string ConvertTimeSpanToWTSString(TimeSpan time) { @@ -808,7 +808,7 @@ internal static string ConvertTimeSpanToWTSString(TimeSpan time) /// /// Converts DateTime to string for WTS. /// - /// DateTime + /// DateTime. /// DateTime string. internal static string ConvertDateTimeToString(DateTime? dt) { @@ -826,7 +826,7 @@ internal static string ConvertDateTimeToString(DateTime? dt) /// Returns a bitmask representing days of week as /// required by Windows Task Scheduler API. /// - /// Array of DayOfWeek + /// Array of DayOfWeek. /// WTS days of week mask. internal static short ConvertDaysOfWeekToMask(IEnumerable daysOfWeek) { @@ -871,7 +871,7 @@ internal static short ConvertDaysOfWeekToMask(IEnumerable daysOfWeek) /// /// Converts WTS days of week mask to an array of DayOfWeek type. /// - /// WTS days of week mask + /// WTS days of week mask. /// Days of week as List. private List ConvertMaskToDaysOfWeekArray(short mask) { diff --git a/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs b/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs index 907e33ae6d4..e1b87ed0ded 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs @@ -45,8 +45,8 @@ internal void FindAllJobDefinitions( /// Returns a single ScheduledJobDefinition object from the local /// scheduled job definition repository corresponding to the provided id. /// - /// Local repository scheduled job definition id - /// Errors/warnings are written to host + /// Local repository scheduled job definition id. + /// Errors/warnings are written to host. /// ScheduledJobDefinition object. internal ScheduledJobDefinition GetJobDefinitionById( Int32 id, @@ -76,8 +76,8 @@ internal ScheduledJobDefinition GetJobDefinitionById( /// Returns an array of ScheduledJobDefinition objects from the local /// scheduled job definition repository corresponding to the provided Ids. /// - /// Local repository scheduled job definition ids - /// Errors/warnings are written to host + /// Local repository scheduled job definition ids. + /// Errors/warnings are written to host. /// List of ScheduledJobDefinition objects. internal List GetJobDefinitionsById( Int32[] ids, @@ -112,9 +112,9 @@ internal List GetJobDefinitionsById( /// /// Makes delegate callback call for each scheduledjob definition object found. /// - /// Local repository scheduled job definition ids + /// Local repository scheduled job definition ids. /// Callback delegate for each discovered item. - /// Errors/warnings are written to host + /// Errors/warnings are written to host. internal void FindJobDefinitionsById( Int32[] ids, Action itemFound, @@ -146,8 +146,8 @@ internal void FindJobDefinitionsById( /// Returns an array of ScheduledJobDefinition objects from the local /// scheduled job definition repository corresponding to the given name. /// - /// Scheduled job definition name - /// Errors/warnings are written to host + /// Scheduled job definition name. + /// Errors/warnings are written to host. /// ScheduledJobDefinition object. internal ScheduledJobDefinition GetJobDefinitionByName( string name, @@ -187,8 +187,8 @@ internal ScheduledJobDefinition GetJobDefinitionByName( /// Returns an array of ScheduledJobDefinition objects from the local /// scheduled job definition repository corresponding to the given names. /// - /// Scheduled job definition names - /// Errors/warnings are written to host + /// Scheduled job definition names. + /// Errors/warnings are written to host. /// List of ScheduledJobDefinition objects. internal List GetJobDefinitionsByName( string[] names, @@ -234,9 +234,9 @@ internal List GetJobDefinitionsByName( /// /// Makes delegate callback call for each scheduledjob definition object found. /// - /// Scheduled job definition names + /// Scheduled job definition names. /// Callback delegate for each discovered item. - /// Errors/warnings are written to host + /// Errors/warnings are written to host. internal void FindJobDefinitionsByName( string[] names, Action itemFound, @@ -292,9 +292,9 @@ internal void FindJobDefinitionsByName( /// /// Writes a "Trigger not found" error to host. /// - /// Trigger Id not found - /// ScheduledJobDefinition name - /// Error object + /// Trigger Id not found. + /// ScheduledJobDefinition name. + /// Error object. internal void WriteTriggerNotFoundError( Int32 notFoundId, string definitionName, @@ -309,7 +309,7 @@ internal void WriteTriggerNotFoundError( /// /// Writes a "Definition not found for Id" error to host. /// - /// Definition Id + /// Definition Id. internal void WriteDefinitionNotFoundByIdError( Int32 defId) { @@ -322,7 +322,7 @@ internal void WriteDefinitionNotFoundByIdError( /// /// Writes a "Definition not found for Name" error to host. /// - /// Definition Name + /// Definition Name. internal void WriteDefinitionNotFoundByNameError( string name) { @@ -335,8 +335,8 @@ internal void WriteDefinitionNotFoundByNameError( /// /// Writes a "Load from job store" error to host. /// - /// Scheduled job definition name - /// Exception thrown during loading + /// Scheduled job definition name. + /// Exception thrown during loading. internal void WriteErrorLoadingDefinition(string name, Exception error) { string msg = StringUtil.Format(ScheduledJobErrorStrings.CantLoadDefinitionFromStore, name); @@ -350,9 +350,9 @@ internal void WriteErrorLoadingDefinition(string name, Exception error) /// infinite duration, and adds the trigger to the provided scheduled job /// definition object. /// - /// ScheduledJobDefinition - /// rep interval - /// save definition change + /// ScheduledJobDefinition. + /// rep interval. + /// save definition change. internal static void AddRepetitionJobTriggerToDefinition( ScheduledJobDefinition definition, TimeSpan repInterval, diff --git a/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs b/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs index af4d4319c41..ae72b04a04d 100644 --- a/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs +++ b/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs @@ -1558,7 +1558,7 @@ private static string[] GetPathElements(string path) /// /// Delete private key /// - /// key prov info + /// key prov info. /// No return. [SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults", MessageId = "System.Management.Automation.Security.NativeMethods.NCryptSetProperty(System.IntPtr,System.String,System.Void*,System.Int32,System.Int32)")] @@ -1685,9 +1685,9 @@ private void DoDeleteKey(IntPtr pProvInfo) /// Delete the cert store; if -DeleteKey is specified, we also delete /// the associated private key /// - /// the store name - /// boolean to specify whether or not to delete private key - /// source path + /// the store name. + /// boolean to specify whether or not to delete private key. + /// source path. /// No return. private void RemoveCertStore(string storeName, bool fDeleteKey, string sourcePath) @@ -1747,10 +1747,10 @@ private void RemoveCertStore(string storeName, bool fDeleteKey, string sourcePat /// Delete the a single cert from the store; if -DeleteKey is specified, we also delete /// the associated private key /// - /// an X509Certificate2 object - /// boolean to specify whether or not to delete private key - /// machine context or user - /// source path + /// an X509Certificate2 object. + /// boolean to specify whether or not to delete private key. + /// machine context or user. + /// source path. /// No return. private void RemoveCertItem(X509Certificate2 cert, bool fDeleteKey, bool fMachine, string sourcePath) { @@ -1782,10 +1782,10 @@ private void RemoveCertItem(X509Certificate2 cert, bool fDeleteKey, bool fMachin /// Delete the cert from the store; if -DeleteKey is specified, we also delete /// the associated private key /// - /// an X509Certificate2 object - /// boolean to specify whether or not to delete private key - /// machine context or user - /// source path + /// an X509Certificate2 object. + /// boolean to specify whether or not to delete private key. + /// machine context or user. + /// source path. /// No return. [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults")] @@ -1864,7 +1864,7 @@ private void DoRemove(X509Certificate2 cert, bool fDeleteKey, bool fMachine, str /// /// Commit store for UserDS store /// - /// an IntPtr for store handle + /// an IntPtr for store handle. /// No return. private void CommitUserDS(IntPtr storeHandle) { @@ -1881,10 +1881,10 @@ private void CommitUserDS(IntPtr storeHandle) /// /// Delete the cert from the original store and add to the destination store /// - /// destination path - /// an X509Certificate2 - /// an X509NativeStore - /// source path + /// destination path. + /// an X509Certificate2. + /// an X509NativeStore. + /// source path. /// No return. [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults")] private void DoMove(string destination, X509Certificate2 cert, X509NativeStore store, string sourcePath) @@ -1942,9 +1942,9 @@ private void DoMove(string destination, X509Certificate2 cert, X509NativeStore s /// fetches the store-location/store/certificate at the /// specified path. /// - /// path to the item + /// path to the item. /// True if this is to only for an ItemExists call. Returns True / False. - /// set to true if item exists and is a container + /// set to true if item exists and is a container. /// Item at the path. private object GetItemAtPath(string path, bool test, out bool isContainer) { @@ -2243,14 +2243,14 @@ protected override object GetChildItemsDynamicParameters(string path, bool recur /// Helper function to get store-location/store/cert at /// the specified path. /// - /// path to the item - /// whether we need to recursively find all + /// path to the item. + /// whether we need to recursively find all. /// /// Determines if all containers should be returned or only those containers that match the /// filter(s). /// - /// whether we only need the names - /// filter info + /// whether we only need the names. + /// filter info. /// Does not return a value. private void GetChildItemsOrNames( string path, @@ -2370,10 +2370,10 @@ private static string GetCertName(X509Certificate2 cert) /// /// Get cert objects or their name at the specified path /// - /// path to cert - /// path elements - /// whether we should return only the names (instead of objects) - /// filter info + /// path to cert. + /// path elements. + /// whether we should return only the names (instead of objects). + /// filter info. /// Does not return a value. private void GetCertificatesOrNames(string path, string[] pathElements, @@ -2447,9 +2447,9 @@ private X509StoreLocation GetStoreLocation(string path) /// /// get the X509NativeStore object at path /// - /// path to store - /// True if this should be a test for path existence. Returns True or False - /// path elements + /// path to store. + /// True if this should be a test for path existence. Returns True or False. + /// path elements. /// X509NativeStore object. private X509NativeStore GetStore(string path, bool test, string[] pathElements) { @@ -2475,9 +2475,9 @@ private X509NativeStore GetStore(string path, bool test, string[] pathElements) /// gets the X509NativeStore at the specified path. /// Adds to cache if not already there. /// - /// path to the store - /// name of store (path leaf element) - /// location of store (CurrentUser or LocalMachine) + /// path to the store. + /// name of store (path leaf element). + /// location of store (CurrentUser or LocalMachine). /// X509NativeStore object. private X509NativeStore GetStore(string storePath, string storeName, @@ -2511,10 +2511,10 @@ private X509NativeStore GetStore(string storePath, /// /// gets X509NativeStore objects or their name at the specified path. /// - /// path to the store - /// recursively return all items if true + /// path to the store. + /// recursively return all items if true. /// - /// filter info + /// filter info. /// Does not return a value. private void GetStoresOrNames( string path, diff --git a/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs b/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs index 7fdae74bab8..edf4b8cd95c 100644 --- a/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs +++ b/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs @@ -288,7 +288,7 @@ protected override Signature PerformAction(string filePath) /// /// Gets the signature from the specified file contents. /// - /// The file type associated with the contents + /// The file type associated with the contents. /// /// The contents of the file on which to perform the action. /// @@ -615,7 +615,7 @@ internal SigningOptionInfo(SigningOption o, string n) /// /// get SigningOption value corresponding to a string name /// - /// name of option + /// name of option. /// SigningOption. private static SigningOption GetSigningOption(string optionName) { diff --git a/src/Microsoft.PowerShell.Security/security/Utils.cs b/src/Microsoft.PowerShell.Security/security/Utils.cs index 3639e4f7ac6..17a2988507d 100644 --- a/src/Microsoft.PowerShell.Security/security/Utils.cs +++ b/src/Microsoft.PowerShell.Security/security/Utils.cs @@ -15,7 +15,7 @@ internal static class SecurityUtils /// /// gets the size of a file /// - /// path to file + /// path to file. /// File size. internal static long GetFileSize(string filePath) { @@ -32,8 +32,8 @@ internal static long GetFileSize(string filePath) /// /// present a prompt for a SecureString data /// - /// ref to host ui interface - /// prompt text + /// ref to host ui interface. + /// prompt text. /// user input as secure string. internal static SecureString PromptForSecureString(PSHostUserInterface hostUI, string prompt) @@ -49,9 +49,9 @@ internal static SecureString PromptForSecureString(PSHostUserInterface hostUI, /// /// - /// resource string - /// error identifier - /// replacement params for resource string formatting + /// resource string. + /// error identifier. + /// replacement params for resource string formatting. /// internal static ErrorRecord CreateFileNotFoundErrorRecord(string resourceStr, @@ -78,8 +78,8 @@ ErrorRecord CreateFileNotFoundErrorRecord(string resourceStr, /// /// - /// path that was not found - /// error identifier + /// path that was not found. + /// error identifier. /// ErrorRecord instance. internal static ErrorRecord CreatePathNotFoundErrorRecord(string path, @@ -100,9 +100,9 @@ ErrorRecord CreatePathNotFoundErrorRecord(string path, /// /// Create an error record for 'operation not supported' condition /// - /// resource string - /// error identifier - /// replacement params for resource string formatting + /// resource string. + /// error identifier. + /// replacement params for resource string formatting. /// internal static ErrorRecord CreateNotSupportedErrorRecord(string resourceStr, @@ -126,8 +126,8 @@ ErrorRecord CreateNotSupportedErrorRecord(string resourceStr, /// /// Create an error record for 'operation not supported' condition /// - /// exception to include in ErrorRecord - /// error identifier + /// exception to include in ErrorRecord. + /// error identifier. /// internal static ErrorRecord CreateInvalidArgumentErrorRecord(Exception e, @@ -149,8 +149,8 @@ ErrorRecord CreateInvalidArgumentErrorRecord(Exception e, /// -- it points to a file /// -- the file exists /// - /// cmdlet instance - /// provider path + /// cmdlet instance. + /// provider path. /// /// filesystem path if all conditions are true, /// null otherwise diff --git a/src/Microsoft.WSMan.Management/ConfigProvider.cs b/src/Microsoft.WSMan.Management/ConfigProvider.cs index d955cf83688..d673cee31d2 100644 --- a/src/Microsoft.WSMan.Management/ConfigProvider.cs +++ b/src/Microsoft.WSMan.Management/ConfigProvider.cs @@ -5224,7 +5224,7 @@ private object ValidateAndGetUserObject(string configurationName, object value) /// Appends the plain text value of a SecureString variable to the StringBuilder. /// if the propertyValue provided is not SecureString appends empty string. /// - /// Value to append + /// Value to append. private string GetStringFromSecureString(object propertyValue) { SecureString value = propertyValue as SecureString; diff --git a/src/Microsoft.WSMan.Management/WsManHelper.cs b/src/Microsoft.WSMan.Management/WsManHelper.cs index edadaf16a75..8c55db2421e 100644 --- a/src/Microsoft.WSMan.Management/WsManHelper.cs +++ b/src/Microsoft.WSMan.Management/WsManHelper.cs @@ -202,8 +202,8 @@ private static string FormatResourceMsgFromResourcetextS( /// /// add a session to dictionary /// - /// connection string - /// session object + /// connection string. + /// session object. internal void AddtoDictionary(string key, object value) { key = key.ToLowerInvariant(); diff --git a/src/System.Management.Automation/CoreCLR/CorePsAssemblyLoadContext.cs b/src/System.Management.Automation/CoreCLR/CorePsAssemblyLoadContext.cs index 5dc3ab315d6..70734a37f41 100644 --- a/src/System.Management.Automation/CoreCLR/CorePsAssemblyLoadContext.cs +++ b/src/System.Management.Automation/CoreCLR/CorePsAssemblyLoadContext.cs @@ -418,8 +418,8 @@ private bool TryGetAssemblyFromCache(AssemblyName assemblyName, out Assembly asm /// /// Check if the loaded assembly matches the request /// - /// AssemblyName of the requested assembly - /// AssemblyName of the loaded assembly + /// AssemblyName of the requested assembly. + /// AssemblyName of the loaded assembly. /// private bool IsAssemblyMatching(AssemblyName requestedAssembly, AssemblyName loadedAssembly) { diff --git a/src/System.Management.Automation/CoreCLR/EventResource.cs b/src/System.Management.Automation/CoreCLR/EventResource.cs index b0890e7ee05..19d446f0308 100755 --- a/src/System.Management.Automation/CoreCLR/EventResource.cs +++ b/src/System.Management.Automation/CoreCLR/EventResource.cs @@ -40,7 +40,7 @@ public static string GetMissingEventMessage(out int parameterCount) /// Gets the message resource id for the specified event id /// /// The event id for the message resource to retrieve. - /// The number of parameters required by the message resource + /// The number of parameters required by the message resource. /// The string resource id of the associated event message; otherwise, a null reference if the event id is not valid. public static string GetMessage(int eventId, out int parameterCount) { diff --git a/src/System.Management.Automation/DscSupport/CimDSCParser.cs b/src/System.Management.Automation/DscSupport/CimDSCParser.cs index be034b8240a..226c8fd86f8 100644 --- a/src/System.Management.Automation/DscSupport/CimDSCParser.cs +++ b/src/System.Management.Automation/DscSupport/CimDSCParser.cs @@ -628,7 +628,7 @@ public static void Initialize() /// Initialize the class cache with the default classes in $ENV:SystemDirectory\Configuration. /// /// Collection of any errors encountered during initialization. - /// List of module path from where DSC PS modules will be loaded + /// List of module path from where DSC PS modules will be loaded. public static void Initialize(Collection errors, List modulePathList) { s_tracer.WriteLine("Initializing DSC class cache force={0}"); @@ -757,7 +757,7 @@ public static void Initialize(Collection errors, List moduleP /// Load DSC resources into Cache from moduleFolderPath. /// /// Collection of any errors encountered during initialization. - /// Module path from where DSC PS modules will be loaded + /// Module path from where DSC PS modules will be loaded. /// /// if module is inbox. /// @@ -987,7 +987,7 @@ public static List ImportClasses(string path, Tuple m /// /// get text from SecureString /// - /// value of SecureString + /// value of SecureString. /// Decoded string. public static string GetStringFromSecureString(SecureString value) { @@ -1031,8 +1031,8 @@ private static string GetModuleQualifiedResourceName(string moduleName, string m /// /// Finds resources in the that which matches the specified class and module name. /// - /// Module name - /// Resource type name + /// Module name. + /// Resource type name. /// List of found resources in the form of Dictionary{moduleQualifiedName, cimClass}, otherwise empty list. private static List>> FindResourceInCache(string moduleName, string className) { @@ -1253,7 +1253,7 @@ public static Collection GetCachedKeywords() /// /// /// If true, don't define the keywords, just create the functions. - /// To Specify RunAsBehavior of the class + /// To Specify RunAsBehavior of the class. private static void CreateAndRegisterKeywordFromCimClass(string moduleName, Version moduleVersion, Microsoft.Management.Infrastructure.CimClass cimClass, Dictionary functionsToDefine, DSCResourceRunAsCredential runAsBehavior) { var keyword = CreateKeywordFromCimClass(moduleName, moduleVersion, cimClass, functionsToDefine, runAsBehavior); @@ -1291,7 +1291,7 @@ private static void CreateAndRegisterKeywordFromCimClass(string moduleName, Vers /// /// /// If true, don't define the keywords, just create the functions. - /// To specify RunAs behavior of the class + /// To specify RunAs behavior of the class. private static DynamicKeyword CreateKeywordFromCimClass(string moduleName, Version moduleVersion, Microsoft.Management.Infrastructure.CimClass cimClass, Dictionary functionsToDefine, DSCResourceRunAsCredential runAsBehavior) { var resourceName = cimClass.CimSystemProperties.ClassName; @@ -1521,7 +1521,7 @@ public static void LoadDefaultCimKeywords() /// /// Load the default system CIM classes and create the corresponding keywords. /// - /// List of module path from where DSC PS modules will be loaded + /// List of module path from where DSC PS modules will be loaded. public static void LoadDefaultCimKeywords(List modulePathList) { LoadDefaultCimKeywords(null, null, modulePathList, false); @@ -1538,7 +1538,7 @@ public static void LoadDefaultCimKeywords(Collection errors) /// /// Load the default system CIM classes and create the corresponding keywords. - /// A dictionary to add the defined functions to, may be null + /// A dictionary to add the defined functions to, may be null. /// public static void LoadDefaultCimKeywords(Dictionary functionsToDefine) { @@ -1558,10 +1558,10 @@ public static void LoadDefaultCimKeywords(Collection errors, bool cac /// /// Load the default system CIM classes and create the corresponding keywords. /// - /// A dictionary to add the defined functions to, may be null + /// A dictionary to add the defined functions to, may be null. /// Collection of any errors encountered while loading keywords. - /// List of module path from where DSC PS modules will be loaded - /// Allow caching the resources from multiple versions of modules + /// List of module path from where DSC PS modules will be loaded. + /// Allow caching the resources from multiple versions of modules. private static void LoadDefaultCimKeywords(Dictionary functionsToDefine, Collection errors, List modulePathList, bool cacheResourcesFromMultipleModuleVersions) { @@ -1907,10 +1907,10 @@ private static ParseError[] CheckMandatoryPropertiesPresent(DynamicKeywordStatem /// /// Load DSC resources from specified module. /// - /// Script statement loading the module, can be null + /// Script statement loading the module, can be null. /// Module information, can be null. - /// Name of the resource to be loaded from module - /// List of errors reported by the method + /// Name of the resource to be loaded from module. + /// List of errors reported by the method. public static void LoadResourcesFromModule(IScriptExtent scriptExtent, ModuleSpecification[] moduleSpecifications, string[] resourceNames, @@ -3141,7 +3141,7 @@ public static bool ImportCimKeywordsFromModule(PSModuleInfo module, string resou /// /// Full path of the loaded schema file... /// - /// error reported during deserialization + /// error reported during deserialization. /// public static bool ImportCimKeywordsFromModule(PSModuleInfo module, string resourceName, out string schemaFilePath, Dictionary functionsToDefine, Collection errors) { @@ -3278,8 +3278,8 @@ public static bool ImportScriptKeywordsFromModule(PSModuleInfo module, string re /// /// Returns an error record to use in the case of a malformed resource reference in the DependsOn list /// - /// the malformed resource - /// The referencing resource instance + /// the malformed resource. + /// The referencing resource instance. /// public static ErrorRecord GetBadlyFormedRequiredResourceIdErrorRecord(string badDependsOnReference, string definingResource) { @@ -3293,8 +3293,8 @@ public static ErrorRecord GetBadlyFormedRequiredResourceIdErrorRecord(string bad /// /// Returns an error record to use in the case of a malformed resource reference in the exclusive resources list /// - /// the malformed resource - /// The referencing resource instance + /// the malformed resource. + /// The referencing resource instance. /// public static ErrorRecord GetBadlyFormedExclusiveResourceIdErrorRecord(string badExclusiveResourcereference, string definingResource) { @@ -3336,7 +3336,7 @@ public static ErrorRecord DisabledRefreshModeNotValidForPartialConfig(string res /// /// Returns an error record to use in the case of a malformed resource reference in the DependsOn list /// - /// The duplicate resource identifier + /// The duplicate resource identifier. /// the node being defined. /// The error record to use. public static ErrorRecord DuplicateResourceIdInNodeStatementErrorRecord(string duplicateResourceId, string nodeName) @@ -3461,7 +3461,7 @@ public static ErrorRecord ValueNotInRangeErrorRecord(string property, string nam /// /// Returns an error record to use when composite resource and its resource instances both has PsDscRunAsCredentials value /// - /// resourceId of resource + /// resourceId of resource. /// public static ErrorRecord PsDscRunAsCredentialMergeErrorForCompositeResources(string resourceId) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs index a89f3ffa2b2..62476d3fd15 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs @@ -40,9 +40,9 @@ internal sealed class CommandWrapper : IDisposable /// /// Initialize the command before executing /// - /// ExecutionContext used to create sub pipeline - /// name of the command to run - /// Type of the command to run + /// ExecutionContext used to create sub pipeline. + /// name of the command to run. + /// Type of the command to run. internal void Initialize(ExecutionContext execContext, string nameOfCommand, Type typeOfCommand) { _context = execContext; @@ -54,8 +54,8 @@ internal void Initialize(ExecutionContext execContext, string nameOfCommand, Typ /// add a parameter to the command invocation. /// It needs to be called before any execution takes place /// - /// name of the parameter - /// value of the parameter + /// name of the parameter. + /// value of the parameter. internal void AddNamedParameter(string parameterName, object parameterValue) { _commandParameterList.Add( @@ -68,7 +68,7 @@ internal void AddNamedParameter(string parameterName, object parameterValue) /// /// send an object to the pipeline /// - /// object to process + /// object to process. /// Array of objects out of the success pipeline. internal Array Process(object o) { @@ -216,7 +216,7 @@ protected virtual PSObject InputObjectCall() /// /// callback for the implementation to write objects /// - /// object to be written + /// object to be written. protected virtual void WriteObjectCall(object value) { // just call Monad API @@ -315,7 +315,7 @@ internal virtual PSObject ReadObject() /// /// write an object to the pipeline /// - /// object to write to the pipeline + /// object to write to the pipeline. internal virtual void WriteObject(object o) { // delegate to the front end object diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs index 2d0867a7184..46fbd0e4152 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs @@ -203,7 +203,7 @@ private void SendCommentOutOfBand(string msg) /// /// execute formatting on a single object /// - /// object to process + /// object to process. private void ProcessObject(PSObject so) { // we do protect against reentrancy, assuming @@ -428,7 +428,7 @@ private enum GroupTransition { none, enter, exit, startNew } /// /// compute the group transition, given an input object /// - /// object received from the input pipeline + /// object received from the input pipeline. /// GroupTransition enumeration. private GroupTransition ComputeGroupTransition(PSObject so) { @@ -458,7 +458,7 @@ private void WriteFormatStartData(PSObject so) /// write a payplad object by properly wrapping it into /// a FormatEntry object /// - /// object to process + /// object to process. private void WritePayloadObject(PSObject so) { Diagnostics.Assert(so != null, "object so cannot be null"); diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs index 9af926e8b79..83ab47e043a 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs @@ -258,7 +258,7 @@ private enum PreprocessingState { raw, processed, error } /// test if an object coming from the pipeline needs to be /// preprocessed by the default formatter /// - /// object to examine for formatting + /// object to examine for formatting. /// Whether the object needs to be shunted to preprocessing. private bool NeedsPreprocessing(object o) { @@ -364,7 +364,7 @@ private void ValidateCurrentFormattingState(FormattingState expectedFormattingSt /// /// shunt object to the formatting pipeline for preprocessing /// - /// object to be preprocessed + /// object to be preprocessed. /// Array of objects returned by the preprocessing step. private Array ApplyFormatting(object o) { @@ -380,8 +380,8 @@ private Array ApplyFormatting(object o) /// /// class factory for output context /// - /// parent context in the stack - /// fromat info data received from the pipeline + /// parent context in the stack. + /// fromat info data received from the pipeline. /// private FormatMessagesContextManager.OutputContext CreateOutputContext( FormatMessagesContextManager.OutputContext parentContext, @@ -446,7 +446,7 @@ private FormatMessagesContextManager.OutputContext CreateOutputContext( /// /// callback for Fs processing /// - /// the context containing the Fs entry + /// the context containing the Fs entry. private void ProcessFormatStart(FormatMessagesContextManager.OutputContext c) { // we just add an empty line to the display @@ -456,8 +456,8 @@ private void ProcessFormatStart(FormatMessagesContextManager.OutputContext c) /// /// callback for Fe processing /// - /// Fe notification message - /// current context, with Fs in it + /// Fe notification message. + /// current context, with Fs in it. private void ProcessFormatEnd(FormatEndData fe, FormatMessagesContextManager.OutputContext c) { //Console.WriteLine("ProcessFormatEnd"); @@ -468,7 +468,7 @@ private void ProcessFormatEnd(FormatEndData fe, FormatMessagesContextManager.Out /// /// callback for Gs processing /// - /// the context containing the Gs entry + /// the context containing the Gs entry. private void ProcessGroupStart(FormatMessagesContextManager.OutputContext c) { //Console.WriteLine("ProcessGroupStart"); @@ -489,8 +489,8 @@ private void ProcessGroupStart(FormatMessagesContextManager.OutputContext c) /// /// callback for Ge processing /// - /// Ge notification message - /// current context, with Gs in it + /// Ge notification message. + /// current context, with Gs in it. private void ProcessGroupEnd(GroupEndData ge, FormatMessagesContextManager.OutputContext c) { //Console.WriteLine("ProcessGroupEnd"); @@ -502,8 +502,8 @@ private void ProcessGroupEnd(GroupEndData ge, FormatMessagesContextManager.Outpu /// /// process the current payload object /// - /// FormatEntryData to process - /// currently active context + /// FormatEntryData to process. + /// currently active context. private void ProcessPayload(FormatEntryData fed, FormatMessagesContextManager.OutputContext c) { // we assume FormatEntryData as a standard wrapper @@ -858,8 +858,8 @@ private class FormatOutputContext : FormatMessagesContextManager.OutputContext /// /// construct a context to push on the stack /// - /// parent context in the stack - /// format data to put in the context + /// parent context in the stack. + /// format data to put in the context. internal FormatOutputContext(FormatMessagesContextManager.OutputContext parentContext, FormatStartData formatData) : base(parentContext) { @@ -911,7 +911,7 @@ internal virtual void GroupEnd() { } /// called when there is an entry to process, overrides will do /// things such as writing a row in a table /// - /// FormatEntryData to process + /// FormatEntryData to process. internal virtual void ProcessPayload(FormatEntryData fed) { } /// @@ -927,9 +927,9 @@ private class TableOutputContextBase : GroupOutputContext /// /// construct a context to push on the stack /// - /// reference to the OutCommandInner instance who owns this instance - /// parent context in the stack - /// format data to put in the context + /// reference to the OutCommandInner instance who owns this instance. + /// parent context in the stack. + /// format data to put in the context. internal TableOutputContextBase(OutCommandInner cmd, FormatMessagesContextManager.OutputContext parentContext, GroupStartData formatData) @@ -959,9 +959,9 @@ private sealed class TableOutputContext : TableOutputContextBase /// /// construct a context to push on the stack /// - /// reference to the OutCommandInner instance who owns this instance - /// parent context in the stack - /// format data to put in the context + /// reference to the OutCommandInner instance who owns this instance. + /// parent context in the stack. + /// format data to put in the context. internal TableOutputContext(OutCommandInner cmd, FormatMessagesContextManager.OutputContext parentContext, GroupStartData formatData) @@ -1039,7 +1039,7 @@ internal override void GroupStart() /// /// write a row into the table /// - /// FormatEntryData to process + /// FormatEntryData to process. internal override void ProcessPayload(FormatEntryData fed) { int headerColumns = this.CurrentTableHeaderInfo.tableColumnInfoList.Count; @@ -1095,9 +1095,9 @@ private sealed class ListOutputContext : GroupOutputContext /// /// construct a context to push on the stack /// - /// reference to the OutCommandInner instance who owns this instance - /// parent context in the stack - /// format data to put in the context + /// reference to the OutCommandInner instance who owns this instance. + /// parent context in the stack. + /// format data to put in the context. internal ListOutputContext(OutCommandInner cmd, FormatMessagesContextManager.OutputContext parentContext, GroupStartData formatData) @@ -1159,7 +1159,7 @@ internal override void GroupStart() /// /// write a row into the list /// - /// FormatEntryData to process + /// FormatEntryData to process. internal override void ProcessPayload(FormatEntryData fed) { ListViewEntry lve = fed.formatEntryInfo as ListViewEntry; @@ -1185,9 +1185,9 @@ private sealed class WideOutputContext : TableOutputContextBase /// /// construct a context to push on the stack /// - /// reference to the OutCommandInner instance who owns this instance - /// parent context in the stack - /// format data to put in the context + /// reference to the OutCommandInner instance who owns this instance. + /// parent context in the stack. + /// format data to put in the context. internal WideOutputContext(OutCommandInner cmd, FormatMessagesContextManager.OutputContext parentContext, GroupStartData formatData) @@ -1255,7 +1255,7 @@ internal override void GroupEnd() /// /// write a row into the table /// - /// FormatEntryData to process + /// FormatEntryData to process. internal override void ProcessPayload(FormatEntryData fed) { WideViewEntry wve = fed.formatEntryInfo as WideViewEntry; @@ -1304,7 +1304,7 @@ private class StringValuesBuffer /// /// construct the buffer /// - /// number of entries to cache + /// number of entries to cache. internal StringValuesBuffer(int size) { _arr = new string[size]; @@ -1344,7 +1344,7 @@ internal bool IsEmpty /// /// add an item to the buffer /// - /// string to add + /// string to add. internal void Add(string s) { _arr[_lastEmptySpot++] = s; @@ -1370,9 +1370,9 @@ private sealed class ComplexOutputContext : GroupOutputContext /// /// construct a context to push on the stack /// - /// reference to the OutCommandInner instance who owns this instance - /// parent context in the stack - /// format data to put in the context + /// reference to the OutCommandInner instance who owns this instance. + /// parent context in the stack. + /// format data to put in the context. internal ComplexOutputContext(OutCommandInner cmd, FormatMessagesContextManager.OutputContext parentContext, GroupStartData formatData) @@ -1389,7 +1389,7 @@ internal override void Initialize() /// /// write a row into the list /// - /// FormatEntryData to process + /// FormatEntryData to process. internal override void ProcessPayload(FormatEntryData fed) { ComplexViewEntry cve = fed.formatEntryInfo as ComplexViewEntry; diff --git a/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs b/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs index 24bdf0af0d9..34a4f4fce02 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs @@ -14,9 +14,9 @@ internal sealed class ColumnWidthManager /// /// class providing an algorithm for automatic resizing /// - /// overall width of the table in characters - /// minimum usable column width - /// number of separator characters + /// overall width of the table in characters. + /// minimum usable column width. + /// number of separator characters. internal ColumnWidthManager(int tableWidth, int minimumColumnWidth, int separatorWidth) { _tableWidth = tableWidth; @@ -30,7 +30,7 @@ internal ColumnWidthManager(int tableWidth, int minimumColumnWidth, int separato /// 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 /// - /// array of column widths to appropriately size + /// array of column widths to appropriately size. internal void CalculateColumnWidths(Span columnWidths) { if (AssignColumnWidths(columnWidths)) @@ -47,7 +47,7 @@ internal void CalculateColumnWidths(Span columnWidths) /// do not remove columns, just assign widths to columns that have a zero width /// (meaning unassigned) /// - /// columns to process + /// columns to process. /// True if there was a fit, false if there is need for trimming. private bool AssignColumnWidths(Span columnWidths) { @@ -128,7 +128,7 @@ private bool AssignColumnWidths(Span columnWidths) /// /// trim columns if the total column width is too much for the screen. /// - /// column widths to trim + /// column widths to trim. private void TrimToFit(Span columnWidths) { while (true) @@ -166,7 +166,7 @@ private void TrimToFit(Span columnWidths) /// /// computes the total table width from the column width array /// - /// column widths array + /// column widths array. /// private int CurrentTableWidth(Span columnWidths) { @@ -188,7 +188,7 @@ private int CurrentTableWidth(Span columnWidths) /// /// get the last visible column (i.e. with a width >= 0) /// - /// column widths array + /// column widths array. /// Index of the last visible column, -1 if none. private static int GetLastVisibleColumn(Span columnWidths) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs b/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs index 1c0fb54e93a..4cadafd855d 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs @@ -19,8 +19,8 @@ internal sealed class ComplexWriter /// /// initialization method to be called before any other operation /// - /// LineOutput interfaces to write to - /// number of columns used to write out + /// LineOutput interfaces to write to. + /// number of columns used to write out. internal void Initialize(LineOutput lineOutput, int numberOfTextColumns) { _lo = lineOutput; @@ -43,7 +43,7 @@ internal void WriteString(string s) /// /// it interprets a list of format value tokens and outputs it /// - /// list of FormatValue tokens to interpret + /// list of FormatValue tokens to interpret. internal void WriteObject(List formatValueList) { // we always start with no indentation @@ -62,8 +62,8 @@ internal void WriteObject(List formatValueList) /// /// operate on a single entry /// - /// entry to process - /// current depth of recursion + /// entry to process. + /// current depth of recursion. private void GenerateFormatEntryDisplay(FormatEntry fe, int currentDepth) { foreach (object obj in fe.formatValueList) @@ -116,7 +116,7 @@ private void GenerateFormatEntryDisplay(FormatEntry fe, int currentDepth) /// /// add a string to the current buffer, waiting for a FlushBuffer() /// - /// string to add to buffer + /// string to add to buffer. private void AddToBuffer(string s) { _stringBuffer.Append(s); @@ -348,7 +348,7 @@ static StringManipulationHelper() /// TODO: we might be able to improve this function in the future /// so that we do not break paths etc. /// - /// input string + /// input string. /// A collection of words. private static IEnumerable GetWords(string s) { @@ -659,7 +659,7 @@ private static StringCollection GenerateLinesWithWordWrap(DisplayCells displayCe /// split a multiline string into an array of strings /// by honoring both \n and \r\n /// - /// string to split + /// string to split. /// String array with the values. internal static string[] SplitLines(string s) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/FormatTable.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/FormatTable.cs index 3706dab2d25..cf9ef6e4d37 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/FormatTable.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/FormatTable.cs @@ -106,8 +106,8 @@ protected FormatTableLoadException(SerializationInfo info, StreamingContext cont /// /// Serializes the exception data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs index ffe37851059..8e3d6c9f9fe 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs @@ -87,7 +87,7 @@ internal class XmlLoaderLogger : IDisposable /// /// log an entry /// - /// entry to log + /// entry to log. internal void LogEntry(XmlLoaderLoggerEntry entry) { if (entry.entryType == XmlLoaderLoggerEntry.EntryType.Error) @@ -265,7 +265,7 @@ internal bool HasErrors /// to be called when starting a stack frame. /// The returned IDisposable should be used in a using(){...} block /// - /// node to push on the stack + /// node to push on the stack. /// Object to dispose when exiting the frame. protected IDisposable StackFrame(XmlNode n) { @@ -276,8 +276,8 @@ protected IDisposable StackFrame(XmlNode n) /// to be called when starting a stack frame. /// The returned IDisposable should be used in a using(){...} block /// - /// node to push on the stack - /// index of the node of the same name in a collection + /// node to push on the stack. + /// index of the node of the same name in a collection. /// Object to dispose when exiting the frame. protected IDisposable StackFrame(XmlNode n, int index) { @@ -360,9 +360,9 @@ internal string GetMandatoryAttributeValue(XmlAttribute a) /// it uses case sensitive, culture invariant compare. /// This is because XML tags are case sensitive. /// - /// XmlNode whose name is to compare - /// string to compare the node name to - /// if true, accept the presence of attributes on the node + /// XmlNode whose name is to compare. + /// string to compare the node name to. + /// if true, accept the presence of attributes on the node. /// True if there is a match. private bool MatchNodeNameHelper(XmlNode n, string s, bool allowAttributes) { 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 71a936e1ef1..2a9c896d8d8 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Table.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Table.cs @@ -349,9 +349,9 @@ public TableControlColumnHeader() /// /// Public constructor for TableControlColumnHeader. /// - /// Could be null if no label to specify - /// The Value should be non-negative - /// The default value is Alignment.Undefined + /// Could be null if no label to specify. + /// The Value should be non-negative. + /// The default value is Alignment.Undefined. public TableControlColumnHeader(string label, int width, Alignment alignment) { if (width < 0) diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs index 2a54410f1df..57fb259198e 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs @@ -262,7 +262,7 @@ internal void Update(AuthorizationManager authorizationManager, PSHost host) /// the old database is unchanged. /// The reference returned should NOT be modified by any means by the caller /// - /// files to be loaded and errors to be updated + /// files to be loaded and errors to be updated. /// /// Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) /// @@ -300,9 +300,9 @@ bool preValidated /// load the database /// NOTE: need to be protected by lock since not thread safe per se /// - /// *.formal.xml files to be loaded - /// expression factory to validate script blocks - /// if true, load the database even if there are loading errors + /// *.formal.xml files to be loaded. + /// expression factory to validate script blocks. + /// if true, load the database even if there are loading errors. /// /// Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) /// @@ -362,8 +362,8 @@ internal bool LoadFromFile( /// /// it loads a database from file(s). /// - /// *.formal.xml files to be loaded - /// expression factory to validate script blocks + /// *.formal.xml files to be loaded. + /// expression factory to validate script blocks. /// /// Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) /// @@ -374,8 +374,8 @@ internal bool LoadFromFile( /// True if the format data has been pre-validated (build time, manual testing, etc) so that validation can be /// skipped at runtime. /// - /// list of logger entries (errors, etc.) to return to the caller - /// true if no error occurred + /// list of logger entries (errors, etc.) to return to the caller. + /// true if no error occurred. /// A database instance loaded from file(s). private static TypeInfoDataBase LoadFromFileHelper( Collection files, @@ -534,7 +534,7 @@ private static void ProcessBuiltinFormatViewDefinitions( /// /// helper to to add any pre-load intrinsics to the db /// - /// db being initialized + /// db being initialized. private static void AddPreLoadIntrinsics(TypeInfoDataBase db) { // NOTE: nothing to add for the time being. Add here if needed. @@ -543,7 +543,7 @@ private static void AddPreLoadIntrinsics(TypeInfoDataBase db) /// /// helper to to add any post-load intrinsics to the db /// - /// db being initialized + /// db being initialized. private static void AddPostLoadIntrinsics(TypeInfoDataBase db) { // add entry for the output of update-formatdata diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataQuery.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataQuery.cs index 28519c1288d..4f6958a50f7 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataQuery.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataQuery.cs @@ -589,8 +589,8 @@ private static bool IsOutOfBandView(ViewDefinition vd) /// given an appliesTo list, it finds all the types that are contained (following type /// group references) /// - /// database to use - /// object to lookup + /// database to use. + /// object to lookup. /// internal static AppliesTo GetAllApplicableTypes(TypeInfoDataBase db, AppliesTo appliesTo) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs index ead6ecad74b..31bcaa23960 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs @@ -170,9 +170,9 @@ private static class XMLStringValues /// /// entry point for the loader algorithm /// - /// information needed to load the file - /// database instance to load the file into - /// expression factory to validate script blocks + /// information needed to load the file. + /// database instance to load the file into. + /// expression factory to validate script blocks. /// /// Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) /// @@ -274,11 +274,11 @@ internal bool LoadXmlFile( /// /// 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 - /// expression factory to validate the script block + /// the ExtendedTypeDefinition instance to load formatting data from. + /// database instance to load the formatting data into. + /// expression factory to validate the script block. /// do we implicitly trust the script blocks (so they should run in full langauge mode)? - /// true when the view is for help output + /// true when the view is for help output. /// internal bool LoadFormattingData( ExtendedTypeDefinition typeDefinition, @@ -332,8 +332,8 @@ internal bool LoadFormattingData( /// 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 - /// instance of the databaseto load into + /// XML document to load from, cannot be null. + /// instance of the databaseto load into. private void LoadData(XmlDocument doc, TypeInfoDataBase db) { if (doc == null) @@ -419,9 +419,9 @@ private void LoadData(XmlDocument doc, TypeInfoDataBase db) /// WideControl /// CustomControl /// - /// ExtendedTypeDefinition instances to load from, cannot be null - /// instance of the database to load into - /// true if the formatter is used for formatting help objects + /// ExtendedTypeDefinition instances to load from, cannot be null. + /// instance of the database to load into. + /// true if the formatter is used for formatting help objects. private void LoadData(ExtendedTypeDefinition typeDefinition, TypeInfoDataBase db, bool isForHelpOutput) { if (typeDefinition == null) @@ -453,7 +453,7 @@ private void LoadData(ExtendedTypeDefinition typeDefinition, TypeInfoDataBase db /// /// Load the view into a ViewDefinition /// - /// the TypeName tag under SelectedBy tag + /// the TypeName tag under SelectedBy tag. /// /// /// @@ -1918,7 +1918,7 @@ private void ReportStringResourceFailure(StringResourceReference resource, /// helper to verify the text of a string block and /// log an error if an exception is thrown /// - /// script block string to verify + /// script block string to verify. /// True if parsed correctly, false if failed. internal bool VerifyScriptBlock(string scriptBlockText) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs index cf09e5488e4..a97dac07cc1 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs @@ -18,8 +18,8 @@ internal sealed class GroupingInfoManager /// /// Initialize with the grouping property data /// - /// name of the grouping property - /// display name of the property + /// name of the grouping property. + /// display name of the property. internal void Initialize(PSPropertyExpression groupingExpression, string displayLabel) { _groupingKeyExpression = groupingExpression; @@ -44,7 +44,7 @@ internal string GroupingKeyDisplayName /// /// compute the string value of the grouping property /// - /// object to use to compute the property value + /// object to use to compute the property value. /// True if there was an update. internal bool UpdateGroupingKeyValue(PSObject so) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatMsgCtxManager.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatMsgCtxManager.cs index 1c5ba9f78b7..13b90a7f1e1 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatMsgCtxManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatMsgCtxManager.cs @@ -41,7 +41,7 @@ internal abstract class OutputContext { /// /// - /// parent context in the stack, it can be null + /// parent context in the stack, it can be null. internal OutputContext(OutputContext parentContextInStack) { ParentContext = parentContextInStack; @@ -59,7 +59,7 @@ internal OutputContext(OutputContext parentContextInStack) /// process an object from an input stream. It manages the context stack and /// calls back on the specified event delegates /// - /// object to process + /// object to process. internal void Process(object o) { PacketInfoData formatData = o as PacketInfoData; diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs index c4adcd5faf1..265005cd42d 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs @@ -274,7 +274,7 @@ internal GroupStartData GenerateGroupStartData(PSObject firstObjectInGroup, int /// /// update the current value of the grouping key /// - /// object to use for the update + /// object to use for the update. /// True if the value of the key changed. internal bool UpdateGroupingKeyValue(PSObject so) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs index 8224fa39d99..eecb9596a45 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs @@ -432,8 +432,8 @@ internal ComplexViewObjectBrowser(FormatErrorManager resultErrorManager, PSPrope /// given an object, generate a tree-like view /// of the object /// - /// object to process - /// parameters from the command line + /// object to process. + /// parameters from the command line. /// Complex view entry to send to the output command. internal ComplexViewEntry GenerateView(PSObject so, FormattingCommandLineParameters inputParameters) { @@ -510,10 +510,10 @@ private void DisplayRawObject(PSObject so, List formatValueList) /// /// recursive call to display an object /// - /// object to display - /// current level in the traversal - /// list of parameters from the command line - /// list of format tokens to add to + /// object to display. + /// current level in the traversal. + /// list of parameters from the command line. + /// list of format tokens to add to. private void DisplayObject(PSObject so, TraversalInfo currentLevel, List parameterList, List formatValueList) { @@ -610,9 +610,9 @@ private void ProcessActiveAssociationList(PSObject so, /// /// recursive call to display an object /// - /// enumeration to display - /// current level in the traversal - /// list of format tokens to add to + /// enumeration to display. + /// current level in the traversal. + /// list of format tokens to add to. private void DisplayEnumeration(IEnumerable e, TraversalInfo level, List formatValueList) { AddPrologue(formatValueList, "[", null); @@ -668,8 +668,8 @@ private void DisplayEnumerationInner(IEnumerable e, TraversalInfo level, List /// display a leaf value /// - /// object to display - /// list of format tokens to add to + /// object to display. + /// list of format tokens to add to. private void DisplayLeaf(object val, List formatValueList) { FormatPropertyField fpf = new FormatPropertyField(); @@ -682,8 +682,8 @@ private void DisplayLeaf(object val, List formatValueList) /// /// determine if we have to stop the expansion /// - /// object to verify - /// current level of recursion + /// object to verify. + /// current level of recursion. /// private static bool TreatAsLeafNode(object val, TraversalInfo level) { @@ -696,7 +696,7 @@ private static bool TreatAsLeafNode(object val, TraversalInfo level) /// /// treat as scalar check /// - /// name of the type to check + /// name of the type to check. /// True if it has to be treated as a scalar. private static bool TreatAsScalarType(Collection typeNames) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs index 4e6c696ca47..d397ef85f52 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs @@ -613,8 +613,8 @@ internal FormatErrorManager(FormatErrorPolicy formatErrorPolicy) /// /// log a failed evaluation of an PSPropertyExpression /// - /// PSPropertyExpressionResult containing the failed evaluation data - /// object used to evaluate the PSPropertyExpression + /// PSPropertyExpressionResult containing the failed evaluation data. + /// object used to evaluate the PSPropertyExpression. internal void LogPSPropertyExpressionFailedResult(PSPropertyExpressionResult result, object sourceObject) { if (!_formatErrorPolicy.ShowErrorsAsMessages) @@ -628,7 +628,7 @@ internal void LogPSPropertyExpressionFailedResult(PSPropertyExpressionResult res /// /// log a failed formatting operation /// - /// string format error object + /// string format error object. internal void LogStringFormatError(StringFormatError error) { if (!_formatErrorPolicy.ShowErrorsAsMessages) @@ -686,7 +686,7 @@ internal List DrainFailedResultList() /// /// Conversion between an error internal representation and ErrorRecord /// - /// internal error object + /// internal error object. /// Corresponding ErrorRecord instance. private static ErrorRecord GenerateErrorRecord(FormattingError error) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatXMLWriter.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatXMLWriter.cs index 75fee263755..25dd42797f0 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatXMLWriter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatXMLWriter.cs @@ -23,13 +23,13 @@ private FormatXmlWriter() { } /// /// Writes a collection of format view definitions to XML file /// - /// collection of PSTypeDefinition - /// path to XML file - /// cmdlet from which this si used - /// true - to force write the file - /// true - to export scriptblocks - /// true - do not overwrite the file - /// true - bypass wildcard expansion on the file name + /// collection of PSTypeDefinition. + /// path to XML file. + /// cmdlet from which this si used. + /// true - to force write the file. + /// true - to export scriptblocks. + /// true - do not overwrite the file. + /// true - bypass wildcard expansion on the file name. internal static void WriteToPs1Xml(PSCmdlet cmdlet, List typeDefinitions, string filepath, bool force, bool noclobber, bool writeScriptBlock, bool isLiteralPath) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjects.cs b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjects.cs index 8f75f692a75..5cb2d56809c 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjects.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjects.cs @@ -154,7 +154,7 @@ internal sealed partial class FormatEntryData : PacketInfoData /// Helper method to set the WriteStreamType property /// based on note properties of a PSObject object. /// - /// PSObject + /// PSObject. internal void SetStreamTypeFromPSObject( System.Management.Automation.PSObject so) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs index fb8506a6999..b2bbc59f7a2 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs @@ -84,7 +84,7 @@ fid is GroupEndData || /// If the object is not one of the well known ones (i.e. derived from FormatInfoData) /// it just returns the object unchanged /// - /// object to deserialize + /// object to deserialize. /// Deserialized object or null. internal object Deserialize(PSObject so) { @@ -164,8 +164,8 @@ it. We retail it because future schema extensions might require it /// /// ERS helper to reconstitute a string[] out of IEnumerable property /// - /// object to process - /// property to look up + /// object to process. + /// property to look up. /// String[] representation of the property. private static string[] ReadStringArrayHelper (object rawObject, string propertyName) { @@ -262,8 +262,8 @@ private object DeserializeMemberVariable(PSObject so, string property, System.Ty /// /// Deserialization of string without TAB expansion (RAW) /// - /// object whose the property belongs to - /// name of the string property + /// object whose the property belongs to. + /// name of the string property. /// String out of the MsObject. internal string DeserializeStringMemberVariableRaw(PSObject so, string property) { @@ -273,8 +273,8 @@ internal string DeserializeStringMemberVariableRaw(PSObject so, string property) /// /// Deserialization of string performing TAB expansion /// - /// object whose the property belongs to - /// name of the string property + /// object whose the property belongs to. + /// name of the string property. /// String out of the MsObject. internal string DeserializeStringMemberVariable(PSObject so, string property) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs b/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs index a4da0936f38..5a2c9affa19 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs @@ -62,10 +62,10 @@ internal virtual int GetTailSplitLength(string str, int offset, int displayCells /// Given a string and a number of display cells, it computes how many /// characters would fit starting from the beginning or end of the string /// - /// string to be displayed - /// offset inside the string - /// number of display cells - /// if true compute from the head (i.e. k++) else from the tail (i.e. k--) + /// string to be displayed. + /// offset inside the string. + /// number of display cells. + /// if true compute from the head (i.e. k++) else from the tail (i.e. k--). /// Number of characters that would fit. protected int GetSplitLengthInternalHelper(string str, int offset, int displayCells, bool head) { @@ -234,7 +234,7 @@ internal class WriteLineHelper /// /// delegate definition /// - /// string to write + /// string to write. internal delegate void WriteCallback(string s); /// @@ -258,10 +258,10 @@ internal class WriteLineHelper /// NOTE: if the underlying device treats the two cases as the /// same, the same delegate can be passed twice /// - /// true if we require line wrapping - /// delegate for WriteLine(), must ben non null - /// delegate for Write(), if null, use the first parameter - /// helper object for manipulating strings + /// true if we require line wrapping. + /// delegate for WriteLine(), must ben non null. + /// delegate for Write(), if null, use the first parameter. + /// helper object for manipulating strings. internal WriteLineHelper(bool lineWrap, WriteCallback wlc, WriteCallback wc, DisplayCells displayCells) { if (wlc == null) @@ -278,8 +278,8 @@ internal WriteLineHelper(bool lineWrap, WriteCallback wlc, WriteCallback wc, Dis /// /// main entry point to process a line /// - /// string to process - /// width of the device + /// string to process. + /// width of the device. internal void WriteLine(string s, int cols) { WriteLineInternal(s, cols); @@ -288,8 +288,8 @@ internal void WriteLine(string s, int cols) /// /// internal helper, needed because it might make recursive calls to itself /// - /// string to process - /// width of the device + /// string to process. + /// width of the device. private void WriteLineInternal(string val, int cols) { if (string.IsNullOrEmpty(val)) @@ -409,8 +409,8 @@ internal override void WriteLine(string s) /// initialization of the object. It must be called before /// attempting any operation /// - /// TextWriter to write to - /// max columns widths for the text + /// TextWriter to write to. + /// max columns widths for the text. internal TextWriterLineOutput(TextWriter writer, int columns) { _writer = writer; @@ -421,9 +421,9 @@ internal TextWriterLineOutput(TextWriter writer, int columns) /// initialization of the object. It must be called before /// attempting any operation /// - /// TextWriter to write to - /// max columns widths for the text - /// false to add a newline to the end of the output string, true if not + /// TextWriter to write to. + /// max columns widths for the text. + /// false to add a newline to the end of the output string, true if not. internal TextWriterLineOutput(TextWriter writer, int columns, bool suppressNewline) : this(writer, columns) { @@ -451,8 +451,8 @@ internal class StreamingTextWriter : TextWriter /// /// create an instance by passing a delegate /// - /// delegate to write to - /// culture for this TextWriter + /// delegate to write to. + /// culture for this TextWriter. internal StreamingTextWriter(WriteLineCallback writeCall, CultureInfo culture) : base(culture) { @@ -476,7 +476,7 @@ public override void WriteLine(string s) /// /// delegate definition /// - /// string to write + /// string to write. internal delegate void WriteLineCallback(string s); /// diff --git a/src/System.Management.Automation/FormatAndOutput/common/ListWriter.cs b/src/System.Management.Automation/FormatAndOutput/common/ListWriter.cs index 2de56219e6f..8a1f4643e0d 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ListWriter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ListWriter.cs @@ -31,9 +31,9 @@ internal class ListWriter /// /// - /// names of the properties to display - /// column width of the screen - /// instance of the DisplayCells helper object + /// names of the properties to display. + /// column width of the screen. + /// instance of the DisplayCells helper object. internal void Initialize(string[] propertyNames, int screenColumnWidth, DisplayCells dc) { _columnWidth = screenColumnWidth; @@ -107,8 +107,8 @@ internal void Initialize(string[] propertyNames, int screenColumnWidth, DisplayC /// /// write the values of the properties of an object /// - /// array with the values in form of formatted strings - /// LineOutput interface to write to + /// array with the values in form of formatted strings. + /// LineOutput interface to write to. internal void WriteProperties(string[] values, LineOutput lo) { if (_disabled) @@ -159,9 +159,9 @@ internal void WriteProperties(string[] values, LineOutput lo) /// 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 - /// string value of the property to write - /// LineOutput interface to write to + /// index of property to write. + /// string value of the property to write. + /// LineOutput interface to write to. private void WriteProperty(int k, string propertyValue, LineOutput lo) { if (propertyValue == null) @@ -195,9 +195,9 @@ private void WriteProperty(int k, string propertyValue, LineOutput lo) /// 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 - /// line to print - /// LineOuput to write to + /// string to add to the left. + /// line to print. + /// LineOuput to write to. private void WriteSingleLineHelper(string prependString, string line, LineOutput lo) { if (line == null) diff --git a/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs b/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs index d40f39d3766..b984473c2a5 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs @@ -157,7 +157,7 @@ private sealed class CommandEntry : IDisposable /// /// - /// ETS type name of the object to process + /// ETS type name of the object to process. /// True if there is a match. internal bool AppliesToType(string typeName) { @@ -191,8 +191,8 @@ public void Dispose() /// /// Initialize the pipeline manager before any object is processed /// - /// LineOutput to pass to the child pipelines - /// ExecutionContext to pass to the child pipelines + /// LineOutput to pass to the child pipelines. + /// ExecutionContext to pass to the child pipelines. internal void Initialize(LineOutput lineOutput, ExecutionContext context) { _lo = lineOutput; @@ -202,7 +202,7 @@ internal void Initialize(LineOutput lineOutput, ExecutionContext context) /// /// hard wired registration helper for specialized types /// - /// ExecutionContext to pass to the child pipeline + /// ExecutionContext to pass to the child pipeline. private void InitializeCommandsHardWired(ExecutionContext context) { // set the default handler @@ -238,9 +238,9 @@ private void RegisterCommandForTypes (ExecutionContext context, string commandNa /// /// register the default output command /// - /// ExecutionContext to pass to the child pipeline - /// name of the command to execute - /// Type of the command to execute + /// ExecutionContext to pass to the child pipeline. + /// name of the command to execute. + /// Type of the command to execute. private void RegisterCommandDefault(ExecutionContext context, string commandName, Type commandType) { CommandEntry ce = new CommandEntry(); @@ -253,7 +253,7 @@ private void RegisterCommandDefault(ExecutionContext context, string commandName /// /// process an incoming parent pipeline object /// - /// pipeline object to process + /// pipeline object to process. internal void Process(PSObject so) { // select which pipeline should handle the object @@ -302,7 +302,7 @@ public void Dispose() /// it selects the applicable out command (it can be the default one) /// to process the current pipeline object /// - /// pipeline object to be processed + /// pipeline object to be processed. /// Applicable command entry. private CommandEntry GetActiveCommandEntry(PSObject so) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs b/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs index 6859335d4bb..164e601d787 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs @@ -17,8 +17,8 @@ internal sealed class OutputGroupQueue /// /// create a grouping cache /// - /// notification callback to be called when the desired number of objects is reached - /// max number of objects to be cached + /// notification callback to be called when the desired number of objects is reached. + /// max number of objects to be cached. internal OutputGroupQueue(FormattedObjectsCache.ProcessCachedGroupNotification callBack, int objectCount) { _notificationCallBack = callBack; @@ -28,8 +28,8 @@ internal OutputGroupQueue(FormattedObjectsCache.ProcessCachedGroupNotification c /// /// 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 + /// notification callback to be called when the desired number of objects is reached. + /// max amount of time to cache of objects. internal OutputGroupQueue(FormattedObjectsCache.ProcessCachedGroupNotification callBack, TimeSpan groupingDuration) { _notificationCallBack = callBack; @@ -39,7 +39,7 @@ internal OutputGroupQueue(FormattedObjectsCache.ProcessCachedGroupNotification c /// /// add an object to the cache /// - /// object to add + /// object to add. /// Objects the cache needs to return. It can be null. internal List Add(PacketInfoData o) { @@ -211,14 +211,14 @@ internal sealed class FormattedObjectsCache /// /// delegate to allow notifications when the autosize queue is about to be drained /// - /// current Fs control message - /// enumeration of PacketInfoData objects + /// 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) /// - /// if true, create a front end cache object + /// if true, create a front end cache object. internal FormattedObjectsCache(bool cacheFrontEnd) { if (cacheFrontEnd) @@ -228,8 +228,8 @@ internal FormattedObjectsCache(bool cacheFrontEnd) /// /// 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 + /// notification callback to be called when the desired number of objects is reached. + /// max number of objects to be cached. internal void EnableGroupCaching(ProcessCachedGroupNotification callBack, int objectCount) { if (callBack != null) @@ -239,8 +239,8 @@ internal void EnableGroupCaching(ProcessCachedGroupNotification callBack, int ob /// /// 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 + /// notification callback to be called when the desired number of objects is reached. + /// max amount of time to cache of objects. internal void EnableGroupCaching(ProcessCachedGroupNotification callBack, TimeSpan groupingDuration) { if (callBack != null) @@ -251,7 +251,7 @@ internal void EnableGroupCaching(ProcessCachedGroupNotification callBack, TimeSp /// 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 + /// object to add. /// List of objects the cache is flushing. internal List Add(PacketInfoData o) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/TableWriter.cs b/src/System.Management.Automation/FormatAndOutput/common/TableWriter.cs index e0682a8a029..b17a5a645a8 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/TableWriter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/TableWriter.cs @@ -77,12 +77,12 @@ internal static int ComputeWideViewBestItemsPerRowFit(int stringLen, int screenC /// /// Initialize the table specifying the width of each column. /// - /// Left margin indentation - /// Number of character columns on the screen - /// Array of specified column widths - /// Array of alignment flags - /// If true, suppress header printing - /// Number of rows on the screen + /// Left margin indentation. + /// Number of character columns on the screen. + /// Array of specified column widths. + /// Array of alignment flags. + /// If true, suppress header printing. + /// Number of rows on the screen. internal void Initialize(int leftMarginIndent, int screenColumns, Span columnWidths, ReadOnlySpan alignment, bool suppressHeader, int screenRows = int.MaxValue) { if (leftMarginIndent < 0) diff --git a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs index 5680f1a9475..bde9034e78f 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs @@ -114,8 +114,8 @@ internal static bool IsStreamType(PSObject so, string streamFlag) /// Retrieve the display name. It looks for a well known property and, /// if not found, it uses some heuristics to get a "close" match /// - /// shell object to process - /// expression factory to create PSPropertyExpression + /// shell object to process. + /// expression factory to create PSPropertyExpression. /// Resolved PSPropertyExpression; null if no match was found. internal static PSPropertyExpression GetDisplayNameExpression(PSObject target, PSPropertyExpressionFactory expressionFactory) { @@ -161,8 +161,8 @@ internal static PSPropertyExpression GetDisplayNameExpression(PSObject target, P /// /// it gets the display name value /// - /// shell object to process - /// expression factory to create PSPropertyExpression + /// shell object to process. + /// expression factory to create PSPropertyExpression. /// PSPropertyExpressionResult if successful; null otherwise. internal static PSPropertyExpressionResult GetDisplayName(PSObject target, PSPropertyExpressionFactory expressionFactory) { @@ -186,7 +186,7 @@ internal static PSPropertyExpressionResult GetDisplayName(PSObject target, PSPro /// /// This is necessary only to consider IDictionaries as IEnumerables, since LanguagePrimitives.GetEnumerable does not. /// - /// object to extract the IEnumerable from + /// object to extract the IEnumerable from. internal static IEnumerable GetEnumerable(object obj) { PSObject mshObj = obj as PSObject; @@ -272,10 +272,10 @@ private static string GetObjectName(object x, PSPropertyExpressionFactory expres /// helper to convert an PSObject into a string /// It takes into account enumerations (use display name) /// - /// shell object to process - /// expression factory to create PSPropertyExpression - /// limit on IEnumerable enumeration - /// stores errors during string conversion + /// shell object to process. + /// expression factory to create PSPropertyExpression. + /// limit on IEnumerable enumeration. + /// stores errors during string conversion. /// String representation. internal static string SmartToString(PSObject so, PSPropertyExpressionFactory expressionFactory, int enumerationLimit, StringFormatError formatErrorObject) { @@ -389,11 +389,11 @@ internal static PSObject AsPSObject(object obj) /// /// format an object using a provided format string directive /// - /// format directive object to use - /// object to format - /// limit on IEnumerable enumeration - /// formatting error object, if present - /// expression factory to create PSPropertyExpression + /// format directive object to use. + /// object to format. + /// limit on IEnumerable enumeration. + /// formatting error object, if present. + /// expression factory to create PSPropertyExpression. /// String representation. internal static string FormatField(FieldFormattingDirective directive, object val, int enumerationLimit, StringFormatError formatErrorObject, PSPropertyExpressionFactory expressionFactory) @@ -485,7 +485,7 @@ private static List GetDefaultPropertySet(PSMemberSet stan /// /// helper to retrieve the default property set of a shell object /// - /// shell object to process + /// shell object to process. /// Resolved expression; empty list if not found. internal static List GetDefaultPropertySet(PSObject so) { @@ -532,13 +532,13 @@ private static PSPropertyExpression GetDefaultNameExpression(PSObject so) /// /// helper to retrieve the value of an PSPropertyExpression and to format it /// - /// shell object to process - /// limit on IEnumerable enumeration - /// expression to use for retrieval - /// format directive to use for formatting + /// shell object to process. + /// limit on IEnumerable enumeration. + /// expression to use for retrieval. + /// format directive to use for formatting. /// - /// expression factory to create PSPropertyExpression - /// not null if an error condition arose + /// expression factory to create PSPropertyExpression. + /// not null if an error condition arose. /// Formatted string. internal static string GetExpressionDisplayValue( PSObject so, @@ -636,7 +636,7 @@ internal void VerifyScriptBlockText(string scriptText) /// /// create an expression from an expression token /// - /// expression token to use + /// expression token to use. /// Constructed expression. /// internal PSPropertyExpression CreateFromExpressionToken(ExpressionToken et) @@ -647,8 +647,8 @@ internal PSPropertyExpression CreateFromExpressionToken(ExpressionToken et) /// /// create an expression from an expression token /// - /// expression token to use - /// The context from which the file was loaded + /// expression token to use. + /// The context from which the file was loaded. /// Constructed expression. /// internal PSPropertyExpression CreateFromExpressionToken(ExpressionToken et, DatabaseLoadingInfo loadingInfo) diff --git a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs index 4a21946e58e..d5bb6d8fc16 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs @@ -133,8 +133,8 @@ internal CommandParameterDefinition() /// 2. it must be unambiguous (if partial match) /// If an error condition occurs, an exception will be thrown /// - /// key to verify - /// invocation context for error reporting + /// key to verify. + /// invocation context for error reporting. /// Matching hash table entry. /// internal HashtableEntryDefinition MatchEntry(string keyName, TerminatingErrorContext invocationContext) diff --git a/src/System.Management.Automation/FormatAndOutput/common/Utilities/Mshexpression.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/Mshexpression.cs index abd825b00b8..756186dae22 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/Utilities/Mshexpression.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/Utilities/Mshexpression.cs @@ -55,7 +55,7 @@ public class PSPropertyExpression /// /// constructor /// - /// expression + /// expression. /// public PSPropertyExpression(string s) : this(s, false) @@ -66,7 +66,7 @@ public PSPropertyExpression(string s) /// Create a property expression with a wildcard pattern. /// /// Property name pattern to match. - /// true if no further attempts should be made to resolve wildcards + /// true if no further attempts should be made to resolve wildcards. /// public PSPropertyExpression(string s, bool isResolved) { @@ -344,7 +344,7 @@ private PSPropertyExpressionResult GetValue(PSObject target, bool eatExceptions) } } } - + private PSObject IfHashtableWrapAsPSCustomObject(PSObject target) { // If the object passed in is a hashtable, then turn it into a PSCustomObject so diff --git a/src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs b/src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs index efc87b5bab8..8f11684a8c0 100644 --- a/src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs +++ b/src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs @@ -217,7 +217,7 @@ internal override int RowNumber /// /// write a line to the output device /// - /// line to write + /// line to write. internal override void WriteLine(string s) { CheckStopProcessing(); @@ -245,9 +245,9 @@ internal override DisplayCells DisplayCells /// /// constructor for the ConsoleLineOutput /// - /// PSHostUserInterface to wrap - /// true if we require prompting for page breaks - /// error context to throw exceptions + /// PSHostUserInterface to wrap. + /// true if we require prompting for page breaks. + /// error context to throw exceptions. internal ConsoleLineOutput(PSHostUserInterface hostConsole, bool paging, TerminatingErrorContext errorContext) { if (hostConsole == null) @@ -297,7 +297,7 @@ internal ConsoleLineOutput(PSHostUserInterface hostConsole, bool paging, Termina /// /// callback to be called when ILineOutput.WriteLine() is called by WriteLineHelper /// - /// string to write + /// string to write. private void OnWriteLine(string s) { #if TEST_MULTICELL_ON_SINGLE_CELL_LOCALE @@ -344,7 +344,7 @@ private void OnWriteLine(string s) /// This is called when the WriteLineHelper needs to write a line whose length /// is the same as the width of the screen buffer /// - /// string to write + /// string to write. private void OnWrite(string s) { #if TEST_MULTICELL_ON_SINGLE_CELL_LOCALE @@ -468,8 +468,8 @@ private class PromptHandler /// /// prompt handler with the given prompt /// - /// prompt string to be used - /// the Cmdlet using this prompt handler + /// prompt string to be used. + /// the Cmdlet using this prompt handler. internal PromptHandler(string s, ConsoleLineOutput cmdlet) { if (string.IsNullOrEmpty(s)) @@ -482,8 +482,8 @@ internal PromptHandler(string s, ConsoleLineOutput cmdlet) /// /// determine how many rows the prompt should take. /// - /// current number of columns on the screen - /// string manipulation helper + /// current number of columns on the screen. + /// string manipulation helper. /// internal int ComputePromptLines(DisplayCells displayCells, int cols) { @@ -505,7 +505,7 @@ internal enum PromptResponse /// /// do the actual prompting /// - /// PSHostUserInterface instance to prompt to + /// PSHostUserInterface instance to prompt to. internal PromptResponse PromptUser(PSHostUserInterface console) { // NOTE: assume the values passed to ComputePromptLines are still valid diff --git a/src/System.Management.Automation/cimSupport/cmdletization/MethodInvocationInfo.cs b/src/System.Management.Automation/cimSupport/cmdletization/MethodInvocationInfo.cs index 9e40b087ebc..0e68f8a3afd 100644 --- a/src/System.Management.Automation/cimSupport/cmdletization/MethodInvocationInfo.cs +++ b/src/System.Management.Automation/cimSupport/cmdletization/MethodInvocationInfo.cs @@ -16,9 +16,9 @@ public sealed class MethodInvocationInfo /// /// Creates a new instance of MethodInvocationInfo /// - /// Name of the method to invoke - /// Method parameters - /// Return value of the method (ok to pass null if the method doesn't return anything) + /// Name of the method to invoke. + /// Method parameters. + /// Return value of the method (ok to pass null if the method doesn't return anything). public MethodInvocationInfo(string name, IEnumerable parameters, MethodParameter returnValue) { if (name == null) throw new ArgumentNullException("name"); diff --git a/src/System.Management.Automation/cimSupport/cmdletization/ObjectModelWrapper.cs b/src/System.Management.Automation/cimSupport/cmdletization/ObjectModelWrapper.cs index 1296c25dfa2..4177f86a61a 100644 --- a/src/System.Management.Automation/cimSupport/cmdletization/ObjectModelWrapper.cs +++ b/src/System.Management.Automation/cimSupport/cmdletization/ObjectModelWrapper.cs @@ -85,7 +85,7 @@ public virtual QueryBuilder GetQueryBuilder() /// /// Queries for object instances in the object model. /// - /// Query parameters + /// Query parameters. /// A lazy evaluated collection of object instances. public virtual void ProcessRecord(QueryBuilder query) { @@ -125,9 +125,9 @@ public virtual void StopProcessing() /// /// Invokes an instance method in the object model. /// - /// The object on which to invoke the method - /// Method invocation details - /// true if successful method invocations should emit downstream the being operated on + /// The object on which to invoke the method. + /// Method invocation details. + /// true if successful method invocations should emit downstream the being operated on. public virtual void ProcessRecord(TObjectInstance objectInstance, MethodInvocationInfo methodInvocationInfo, bool passThru) { throw new NotImplementedException(); @@ -136,9 +136,9 @@ public virtual void ProcessRecord(TObjectInstance objectInstance, MethodInvocati /// /// Combines and . /// - /// Query parameters - /// Method invocation details - /// true if successful method invocations should emit downstream the object instance being operated on + /// Query parameters. + /// Method invocation details. + /// true if successful method invocations should emit downstream the object instance being operated on. public virtual void ProcessRecord(QueryBuilder query, MethodInvocationInfo methodInvocationInfo, bool passThru) { throw new NotImplementedException(); @@ -147,7 +147,7 @@ public virtual void ProcessRecord(QueryBuilder query, MethodInvocationInfo metho /// /// Invokes a static method in the object model. /// - /// Method invocation details + /// Method invocation details. public virtual void ProcessRecord( MethodInvocationInfo methodInvocationInfo) { diff --git a/src/System.Management.Automation/cimSupport/cmdletization/QueryBuilder.cs b/src/System.Management.Automation/cimSupport/cmdletization/QueryBuilder.cs index 2bc67139a33..10508eb95a5 100644 --- a/src/System.Management.Automation/cimSupport/cmdletization/QueryBuilder.cs +++ b/src/System.Management.Automation/cimSupport/cmdletization/QueryBuilder.cs @@ -49,8 +49,8 @@ public abstract class QueryBuilder /// /// Modifies the query, so that it only returns objects with a given property value /// - /// Property name to query on - /// Property values to accept in the query + /// Property name to query on. + /// Property values to accept in the query. /// /// true if should be treated as a containing a wildcard pattern; /// false otherwise @@ -66,8 +66,8 @@ public virtual void FilterByProperty(string propertyName, IEnumerable allowedPro /// /// Modifies the query, so that it does not return objects with a given property value /// - /// Property name to query on - /// Property values to reject in the query + /// Property name to query on. + /// Property values to reject in the query. /// /// true if should be treated as a containing a wildcard pattern; /// false otherwise @@ -83,8 +83,8 @@ public virtual void ExcludeByProperty(string propertyName, IEnumerable excludedP /// /// Modifies the query, so that it returns only objects that have a property value greater than or equal to a threshold /// - /// Property name to query on - /// Minimum property value + /// Property name to query on. + /// Minimum property value. /// /// Describes how to handle filters that didn't match any objects /// @@ -96,8 +96,8 @@ public virtual void FilterByMinPropertyValue(string propertyName, object minProp /// /// Modifies the query, so that it returns only objects that have a property value less than or equal to a threshold /// - /// Property name to query on - /// Maximum property value + /// Property name to query on. + /// Maximum property value. /// /// Describes how to handle filters that didn't match any objects /// @@ -109,10 +109,10 @@ public virtual void FilterByMaxPropertyValue(string propertyName, object maxProp /// /// Modifies the query, so that it returns only objects associated with /// - /// object that query results have to be associated with - /// name of the association - /// name of the role that has in the association - /// name of the role that query results have in the association + /// object that query results have to be associated with. + /// name of the association. + /// name of the role that has in the association. + /// name of the role that query results have in the association. /// /// Describes how to handle filters that didn't match any objects /// diff --git a/src/System.Management.Automation/engine/Attributes.cs b/src/System.Management.Automation/engine/Attributes.cs index 415cd45c39f..b9edd1e43e1 100644 --- a/src/System.Management.Automation/engine/Attributes.cs +++ b/src/System.Management.Automation/engine/Attributes.cs @@ -121,7 +121,7 @@ public abstract class ValidateArgumentsAttribute : CmdletMetadataAttribute /// /// Overridden by subclasses to implement the validation of the parameter arguments /// - /// argument value to validate + /// argument value to validate. /// /// The engine APIs for the context under which the prerequisite is being /// evaluated. @@ -131,13 +131,13 @@ public abstract class ValidateArgumentsAttribute : CmdletMetadataAttribute /// and throw /// if it is invalid. /// - /// should be thrown for any validation failure + /// should be thrown for any validation failure. protected abstract void Validate(object arguments, EngineIntrinsics engineIntrinsics); /// /// Method that the command processor calls for data validate processing /// - /// object to validate + /// object to validate. /// /// The engine APIs for the context under which the prerequisite is being /// evaluated. @@ -147,7 +147,7 @@ public abstract class ValidateArgumentsAttribute : CmdletMetadataAttribute /// Whenever any exception occurs during data validate. /// All the system exceptions are wrapped in ValidationMetadataException /// - /// for invalid arguments + /// for invalid arguments. internal void InternalValidate(object o, EngineIntrinsics engineIntrinsics) { Validate(o, engineIntrinsics); @@ -218,14 +218,14 @@ protected ValidateEnumeratedArgumentsAttribute() : base() /// /// if it is invalid. /// - /// one of the parameter arguments - /// should be thrown for any validation failure + /// one of the parameter arguments. + /// should be thrown for any validation failure. protected abstract void ValidateElement(object element); /// /// Calls ValidateElement in each element in the enumeration argument value. /// - /// object to validate + /// object to validate. /// /// The engine APIs for the context under which the prerequisite is being /// evaluated. @@ -233,7 +233,7 @@ protected ValidateEnumeratedArgumentsAttribute() : base() /// /// PSSnapins should override instead. /// - /// should be thrown for any validation failure + /// should be thrown for any validation failure. protected sealed override void Validate(object arguments, EngineIntrinsics engineIntrinsics) { if (arguments == null || arguments == AutomationNull.Value) @@ -424,9 +424,9 @@ public sealed class CmdletAttribute : CmdletCommonMetadataAttribute /// /// Initializes a new instance of the CmdletAttribute class /// - /// verb for the command - /// noun for the command - /// for invalid arguments + /// verb for the command. + /// noun for the command. + /// for invalid arguments. public CmdletAttribute(string verbName, string nounName) { //NounName,VerbName have to be Non-Null strings @@ -487,7 +487,7 @@ internal OutputTypeAttribute(string typeName) /// /// Construct the attribute from an array of System.Type /// - /// The types output by the cmdlet + /// The types output by the cmdlet. public OutputTypeAttribute(params Type[] type) { if (type != null && type.Length > 0) @@ -507,7 +507,7 @@ public OutputTypeAttribute(params Type[] type) /// /// Construct the attribute from an array of names of types. /// - /// The types output by the cmdlet + /// The types output by the cmdlet. public OutputTypeAttribute(params string[] type) { if (type != null && type.Length > 0) @@ -592,8 +592,8 @@ public IList AliasNames /// /// Initializes a new instance of the AliasAttribute class /// - /// The name for this alias - /// for invalid arguments + /// The name for this alias. + /// for invalid arguments. public AliasAttribute(params string[] aliasNames) { if (aliasNames == null) @@ -726,7 +726,7 @@ public string ParameterSetName /// /// Gets and sets a short description for this parameter, suitable for presentation as a tool tip. /// - /// for a null or empty value when setting + /// for a null or empty value when setting. public string HelpMessage { get @@ -749,7 +749,7 @@ public string HelpMessage /// Gets and sets the base name of the resource for a help message. When this field is specified, /// HelpMessageResourceId must also be specified. /// - /// for a null or empty value when setting + /// for a null or empty value when setting. public string HelpMessageBaseName { get @@ -772,7 +772,7 @@ public string HelpMessageBaseName /// Gets and sets the Id of the resource for a help message. When this field is specified, /// HelpMessageBaseName must also be specified. /// - /// for a null or empty value when setting + /// for a null or empty value when setting. public string HelpMessageResourceId { get @@ -896,10 +896,10 @@ public sealed class ValidateLengthAttribute : ValidateEnumeratedArgumentsAttribu /// Validates that the length of each parameter argument's Length falls in the range /// specified by MinLength and MaxLength /// - /// object to validate + /// object to validate. /// if is not a string /// with length between minLength and maxLength - /// for invalid arguments + /// for invalid arguments. protected override void ValidateElement(object element) { string objectString = element as string; @@ -929,10 +929,10 @@ protected override void ValidateElement(object element) /// /// Initializes a new instance of the ValidateLengthAttribute class /// - /// Minimum required length - /// Maximum required length - /// for invalid arguments - /// if maxLength is less than minLength + /// Minimum required length. + /// Maximum required length. + /// for invalid arguments. + /// if maxLength is less than minLength. public ValidateLengthAttribute(int minLength, int maxLength) : base() { if (minLength < 0) @@ -1014,7 +1014,7 @@ public sealed class ValidateRangeAttribute : ValidateEnumeratedArgumentsAttribut /// Validates that each parameter argument falls in the range /// specified by MinRange and MaxRange /// - /// object to validate + /// object to validate. /// /// Thrown if the object to be validated does not implement IComparable, /// if the element type is not the same of MinRange, MaxRange, @@ -1051,7 +1051,7 @@ protected override void ValidateElement(object element) /// /// Minimum value of the range allowed. /// Maximum value of the range allowed. - /// for invalid arguments + /// for invalid arguments. /// /// if maxRange has a different type than minRange /// if maxRange is smaller than minRange @@ -1334,7 +1334,7 @@ public sealed class ValidatePatternAttribute : ValidateEnumeratedArgumentsAttrib /// /// Validates that each parameter argument matches the RegexPattern /// - /// object to validate + /// object to validate. /// if is not a string /// that matches the pattern /// and for invalid arguments @@ -1364,8 +1364,8 @@ protected override void ValidateElement(object element) /// /// Initializes a new instance of the ValidatePatternAttribute class /// - /// Pattern string to match - /// for invalid arguments + /// Pattern string to match. + /// for invalid arguments. public ValidatePatternAttribute(string regexPattern) { if (String.IsNullOrEmpty(regexPattern)) @@ -1403,8 +1403,8 @@ public sealed class ValidateScriptAttribute : ValidateEnumeratedArgumentsAttribu /// /// Validates that each parameter argument matches the scriptblock /// - /// object to validate - /// if is invalid + /// object to validate. + /// if is invalid. protected override void ValidateElement(object element) { if (element == null) @@ -1435,8 +1435,8 @@ protected override void ValidateElement(object element) /// /// Initializes a new instance of the ValidateScriptBlockAttribute class /// - /// Scriptblock to match - /// for invalid arguments + /// Scriptblock to match. + /// for invalid arguments. public ValidateScriptAttribute(ScriptBlock scriptBlock) { if (scriptBlock == null) @@ -1467,7 +1467,7 @@ public sealed class ValidateCountAttribute : ValidateArgumentsAttribute /// /// Validates that the parameter argument count is in the specified range /// - /// Object to validate + /// Object to validate. /// /// The engine APIs for the context under which the validation is being /// evaluated. @@ -1538,9 +1538,9 @@ protected override void Validate(object arguments, EngineIntrinsics engineIntrin /// /// Initializes a new instance of the ValidateCountAttribute class /// - /// Minimum number of values required - /// Maximum number of values required - /// for invalid arguments + /// Minimum number of values required. + /// Maximum number of values required. + /// for invalid arguments. /// /// if minLength is greater than maxLength /// @@ -1685,7 +1685,7 @@ public IList ValidValues /// /// Validates that each parameter argument is present in the specified set /// - /// Object to validate + /// Object to validate. /// /// if element is not in the set /// for invalid argument @@ -1726,9 +1726,9 @@ private string SetAsString() /// /// Initializes a new instance of the ValidateSetAttribute class /// - /// list of valid values - /// for null arguments - /// for invalid arguments + /// list of valid values. + /// for null arguments. + /// for invalid arguments. public ValidateSetAttribute(params string[] validValues) { if (validValues == null) @@ -1748,8 +1748,8 @@ public ValidateSetAttribute(params string[] validValues) /// Initializes a new instance of the ValidateSetAttribute class. /// Valid values is returned dynamically from a custom class implementing 'IValidateSetValuesGenerator' interface. /// - /// class that implements the 'IValidateSetValuesGenerator' interface - /// for null arguments + /// class that implements the 'IValidateSetValuesGenerator' interface. + /// for null arguments. public ValidateSetAttribute(Type valuesGeneratorType) { // We check 'IsNotPublic' because we don't want allow 'Activator.CreateInstance' create an instance of non-public type. @@ -1785,7 +1785,7 @@ public sealed class ValidateTrustedDataAttribute : ValidateArgumentsAttribute /// /// Validates that the parameter argument is not untrusted /// - /// Object to validate + /// Object to validate. /// /// The engine APIs for the context under which the validation is being /// evaluated. @@ -1870,7 +1870,7 @@ public IList ValidRootDrives /// /// Initializes a new instance of the ValidateDrivePath class /// - /// List of approved root drives for path + /// List of approved root drives for path. public ValidateDriveAttribute(params string[] validRootDrives) { if (validRootDrives == null) @@ -1884,8 +1884,8 @@ public ValidateDriveAttribute(params string[] validRootDrives) /// /// Validates path argument /// - /// Object to validate - /// Engine intrinsics + /// Object to validate. + /// Engine intrinsics. protected override void Validate(object arguments, EngineIntrinsics engineIntrinsics) { if (arguments == null) @@ -2199,7 +2199,7 @@ protected ArgumentTransformationAttribute() /// The engine APIs for the context under which the transformation is being /// made. /// - /// parameter argument to mutate + /// parameter argument to mutate. /// Mutated object(s). /// /// Return the transformed value of . @@ -2208,8 +2208,8 @@ protected ArgumentTransformationAttribute() /// and throw /// for other recoverable errors. /// - /// should be thrown for invalid arguments - /// should be thrown for any problems during transformation + /// should be thrown for invalid arguments. + /// should be thrown for any problems during transformation. public abstract object Transform(EngineIntrinsics engineIntrinsics, object inputData); /// diff --git a/src/System.Management.Automation/engine/AutomationEngine.cs b/src/System.Management.Automation/engine/AutomationEngine.cs index e2a22372660..1d0c1402a9b 100644 --- a/src/System.Management.Automation/engine/AutomationEngine.cs +++ b/src/System.Management.Automation/engine/AutomationEngine.cs @@ -60,8 +60,8 @@ internal string Expand(string s) /// /// Compile a piece of text into a parse tree for later execution. /// - /// The text to parse - /// true iff the scriptblock will be added to history + /// The text to parse. + /// true iff the scriptblock will be added to history. /// The parse text as a parsetree node. internal ScriptBlock ParseScriptBlock(string script, bool addToHistory) { diff --git a/src/System.Management.Automation/engine/COM/ComAdapter.cs b/src/System.Management.Automation/engine/COM/ComAdapter.cs index edfc1526e6f..077fa10c974 100644 --- a/src/System.Management.Automation/engine/COM/ComAdapter.cs +++ b/src/System.Management.Automation/engine/COM/ComAdapter.cs @@ -19,7 +19,7 @@ internal class ComAdapter : Adapter /// /// Constructor for the ComAdapter /// - /// typeinfo for the com object we are adapting + /// typeinfo for the com object we are adapting. internal ComAdapter(ComTypeInfo typeinfo) { Diagnostics.Assert(typeinfo != null, "Caller to verify typeinfo is not null."); @@ -38,7 +38,7 @@ internal static string GetComTypeName(string clsid) /// /// Returns the TypeNameHierarchy out of an object /// - /// object to get the TypeNameHierarchy from + /// object to get the TypeNameHierarchy from. protected override IEnumerable GetTypeNameHierarchy(object obj) { yield return GetComTypeName(_comTypeInfo.Clsid); @@ -52,8 +52,8 @@ protected override IEnumerable GetTypeNameHierarchy(object obj) /// Returns null if memberName is not a member in the adapter or /// the corresponding PSMemberInfo /// - /// object to retrieve the PSMemberInfo from - /// name of the member to be retrieved + /// object to retrieve the PSMemberInfo from. + /// name of the member to be retrieved. /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { @@ -94,7 +94,7 @@ protected override T GetMember(object obj, string memberName) /// In the case of the DirectoryEntry adapter, this could be a cache of the objectClass /// to the properties available in it. /// - /// object to get all the member information from + /// object to get all the member information from. /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { @@ -140,7 +140,7 @@ protected override PSMemberInfoInternalCollection GetMembers(object obj) /// /// Returns an array with the property attributes /// - /// property we want the attributes from + /// property we want the attributes from. /// An array with the property attributes. protected override AttributeCollection PropertyAttributes(PSProperty property) { @@ -150,7 +150,7 @@ protected override AttributeCollection PropertyAttributes(PSProperty property) /// /// Returns the value from a property coming from a previous call to DoGetProperty /// - /// PSProperty coming from a previous call to DoGetProperty + /// PSProperty coming from a previous call to DoGetProperty. /// The value of the property. protected override object PropertyGet(PSProperty property) { @@ -161,8 +161,8 @@ protected override object PropertyGet(PSProperty property) /// /// Sets the value of a property coming from a previous call to DoGetProperty /// - /// PSProperty coming from a previous call to DoGetProperty - /// value to set the property with + /// PSProperty coming from a previous call to DoGetProperty. + /// value to set the property with. /// instructs the adapter to convert before setting, if the adapter supports conversion protected override void PropertySet(PSProperty property, object setValue, bool convertIfPossible) { @@ -173,7 +173,7 @@ protected override void PropertySet(PSProperty property, object setValue, bool c /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { @@ -184,7 +184,7 @@ protected override bool PropertyIsSettable(PSProperty property) /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { @@ -195,8 +195,8 @@ protected override bool PropertyIsGettable(PSProperty property) /// /// Returns the name of the type corresponding to the property /// - /// PSProperty obtained in a previous DoGetProperty - /// True if the result is for display purposes only + /// PSProperty obtained in a previous DoGetProperty. + /// True if the result is for display purposes only. /// The name of the type corresponding to the property. protected override string PropertyType(PSProperty property, bool forDisplay) { @@ -207,7 +207,7 @@ protected override string PropertyType(PSProperty property, bool forDisplay) /// /// get the property signature. /// - /// property object whose signature we want + /// property object whose signature we want. /// String representing the signature of the property. protected override string PropertyToString(PSProperty property) { @@ -221,8 +221,8 @@ protected override string PropertyToString(PSProperty property) /// Called after a non null return from GetMethodData to try to call /// the method with the arguments /// - /// the non empty return from GetMethods - /// the arguments to use + /// the non empty return from GetMethods. + /// the arguments to use. /// The return value for the method. protected override object MethodInvoke(PSMethod method, object[] arguments) { @@ -233,7 +233,7 @@ protected override object MethodInvoke(PSMethod method, object[] arguments) /// /// Called after a non null return from GetMethodData to return the overloads /// - /// the return of GetMethodData + /// the return of GetMethodData. /// protected override Collection MethodDefinitions(PSMethod method) { @@ -247,7 +247,7 @@ protected override Collection MethodDefinitions(PSMethod method) /// /// Returns the name of the type corresponding to the property's value /// - /// property obtained in a previous GetMember + /// property obtained in a previous GetMember. /// The name of the type corresponding to the member. protected override string ParameterizedPropertyType(PSParameterizedProperty property) { @@ -258,7 +258,7 @@ protected override string ParameterizedPropertyType(PSParameterizedProperty prop /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected override bool ParameterizedPropertyIsSettable(PSParameterizedProperty property) { @@ -269,7 +269,7 @@ protected override bool ParameterizedPropertyIsSettable(PSParameterizedProperty /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected override bool ParameterizedPropertyIsGettable(PSParameterizedProperty property) { @@ -280,8 +280,8 @@ protected override bool ParameterizedPropertyIsGettable(PSParameterizedProperty /// /// Called after a non null return from GetMember to get the property value /// - /// the non empty return from GetMember - /// the arguments to use + /// the non empty return from GetMember. + /// the arguments to use. /// The return value for the property. protected override object ParameterizedPropertyGet(PSParameterizedProperty property, object[] arguments) { @@ -292,9 +292,9 @@ protected override object ParameterizedPropertyGet(PSParameterizedProperty prope /// /// Called after a non null return from GetMember to set the property value /// - /// the non empty return from GetMember - /// the value to set property with - /// the arguments to use + /// the non empty return from GetMember. + /// the value to set property with. + /// the arguments to use. protected override void ParameterizedPropertySet(PSParameterizedProperty property, object setValue, object[] arguments) { ComProperty prop = (ComProperty)property.adapterData; @@ -304,7 +304,7 @@ protected override void ParameterizedPropertySet(PSParameterizedProperty propert /// /// Returns the string representation of the property in the object /// - /// property obtained in a previous GetMember + /// property obtained in a previous GetMember. /// The string representation of the property in the object. protected override string ParameterizedPropertyToString(PSParameterizedProperty property) { @@ -315,7 +315,7 @@ protected override string ParameterizedPropertyToString(PSParameterizedProperty /// /// Called after a non null return from GetMember to return the overloads /// - /// the return of GetMember + /// the return of GetMember. protected override Collection ParameterizedPropertyDefinitions(PSParameterizedProperty property) { ComProperty prop = (ComProperty)property.adapterData; diff --git a/src/System.Management.Automation/engine/COM/ComInvoker.cs b/src/System.Management.Automation/engine/COM/ComInvoker.cs index c8733713cea..72a2c4751c3 100644 --- a/src/System.Management.Automation/engine/COM/ComInvoker.cs +++ b/src/System.Management.Automation/engine/COM/ComInvoker.cs @@ -28,8 +28,8 @@ internal static class ComInvoker /// /// Make a by-Ref VARIANT value based on the passed-in VARIANT argument /// - /// The source Variant pointer - /// The destination Variant pointer + /// The source Variant pointer. + /// The destination Variant pointer. private static unsafe void MakeByRefVariant(IntPtr srcVariantPtr, IntPtr destVariantPtr) { var srcVariant = (Variant*)srcVariantPtr; @@ -73,7 +73,7 @@ private static unsafe void MakeByRefVariant(IntPtr srcVariantPtr, IntPtr destVar /// Alloc memory for a VARIANT array with the specified length. /// Also initialize the VARIANT elements to be the type 'VT_EMPTY'. /// - /// Array length + /// Array length. /// Pointer to the array. private static unsafe IntPtr NewVariantArray(int length) { @@ -92,9 +92,9 @@ private static unsafe IntPtr NewVariantArray(int length) /// /// Generate the ByRef array indicating whether the corresponding argument is by-reference. /// - /// Parameters retrieved from metadata - /// Count of arguments to pass in IDispatch.Invoke - /// Indicate if we are handling arguments for PropertyPut/PropertyPutRef + /// Parameters retrieved from metadata. + /// Count of arguments to pass in IDispatch.Invoke. + /// Indicate if we are handling arguments for PropertyPut/PropertyPutRef. /// internal static bool[] GetByRefArray(ParameterInformation[] parameters, int argumentCount, bool isPropertySet) { @@ -128,11 +128,11 @@ internal static bool[] GetByRefArray(ParameterInformation[] parameters, int argu /// /// Invoke the COM member /// - /// IDispatch object - /// Dispatch identifier that identifies the member - /// Arguments passed in - /// Boolean array that indicates by-Ref parameters - /// Invocation kind + /// IDispatch object. + /// Dispatch identifier that identifies the member. + /// Arguments passed in. + /// Boolean array that indicates by-Ref parameters. + /// Invocation kind. /// internal static object Invoke(IDispatch target, int dispId, object[] args, bool[] byRef, COM.INVOKEKIND invokeKind) { diff --git a/src/System.Management.Automation/engine/COM/ComMethod.cs b/src/System.Management.Automation/engine/COM/ComMethod.cs index d202304ffbe..b5e69a2813f 100644 --- a/src/System.Management.Automation/engine/COM/ComMethod.cs +++ b/src/System.Management.Automation/engine/COM/ComMethod.cs @@ -82,8 +82,8 @@ internal Collection MethodDefinitions() /// /// Invokes the method on object /// - /// represents the instance of the method we want to invoke - /// parameters to be passed to the method + /// represents the instance of the method we want to invoke. + /// parameters to be passed to the method. /// Returns the value of method call. internal object InvokeMethod(PSMethod method, object[] arguments) { diff --git a/src/System.Management.Automation/engine/COM/ComProperty.cs b/src/System.Management.Automation/engine/COM/ComProperty.cs index be7264daaec..284a085f2e8 100644 --- a/src/System.Management.Automation/engine/COM/ComProperty.cs +++ b/src/System.Management.Automation/engine/COM/ComProperty.cs @@ -26,7 +26,7 @@ internal class ComProperty /// /// Initializes a new instance of ComProperty. /// - /// reference to the ITypeInfo of the COM object + /// reference to the ITypeInfo of the COM object. /// name of the property being created. internal ComProperty(COM.ITypeInfo typeinfo, string name) { @@ -141,7 +141,7 @@ internal bool IsSettable /// /// Get value of this property /// - /// instance of the object from which to get the property value + /// instance of the object from which to get the property value. /// Value of the property. internal object GetValue(Object target) { @@ -171,8 +171,8 @@ internal object GetValue(Object target) /// /// Get value of this property /// - /// instance of the object from which to get the property value - /// parameters to get the property value + /// instance of the object from which to get the property value. + /// parameters to get the property value. /// Value of the property internal object GetValue(Object target, object[] arguments) { @@ -215,8 +215,8 @@ internal object GetValue(Object target, object[] arguments) /// /// Sets value of this property. /// - /// instance of the object to which to set the property value - /// value to set this property + /// instance of the object to which to set the property value. + /// value to set this property. internal void SetValue(Object target, object setValue) { object[] propValue = new object[1]; @@ -247,8 +247,8 @@ internal void SetValue(Object target, object setValue) /// /// Sets the value of the property. /// - /// instance of the object to which to set the property value - /// value to set this property + /// instance of the object to which to set the property value. + /// value to set this property. /// parameters to set this property. internal void SetValue(Object target, Object setValue, object[] arguments) { @@ -296,8 +296,8 @@ internal void SetValue(Object target, Object setValue, object[] arguments) /// /// Updates the COM property with setter and getter information. /// - /// functional descriptor for property getter or setter - /// index of function descriptor in type information + /// functional descriptor for property getter or setter. + /// index of function descriptor in type information. internal void UpdateFuncDesc(COM.FUNCDESC desc, int index) { _dispId = desc.memid; diff --git a/src/System.Management.Automation/engine/COM/ComTypeInfo.cs b/src/System.Management.Automation/engine/COM/ComTypeInfo.cs index 710727f4cb2..790c53ce9f2 100644 --- a/src/System.Management.Automation/engine/COM/ComTypeInfo.cs +++ b/src/System.Management.Automation/engine/COM/ComTypeInfo.cs @@ -37,7 +37,7 @@ internal class ComTypeInfo /// /// Constructor /// - /// ITypeInfo object being wrapped by this object + /// ITypeInfo object being wrapped by this object. internal ComTypeInfo(COM.ITypeInfo info) { _typeinfo = info; @@ -206,7 +206,7 @@ private void AddMethod(string strName, int index) /// /// Get TypeAttr for the given type information. /// - /// reference to ITypeInfo from which to get TypeAttr + /// reference to ITypeInfo from which to get TypeAttr. /// [ArchitectureSensitive] internal static COM.TYPEATTR GetTypeAttr(COM.ITypeInfo typeinfo) @@ -265,7 +265,7 @@ internal static COM.ITypeInfo GetDispatchTypeInfoFromCustomInterfaceTypeInfo(COM /// /// Get the IDispatch Typeinfo from CoClass typeinfo. /// - /// Reference to the type info to which the type descriptor belongs + /// Reference to the type info to which the type descriptor belongs. /// ITypeInfo reference to the Dispatch interface. internal static COM.ITypeInfo GetDispatchTypeInfoFromCoClassTypeInfo(COM.ITypeInfo typeinfo) { diff --git a/src/System.Management.Automation/engine/COM/ComUtil.cs b/src/System.Management.Automation/engine/COM/ComUtil.cs index 7b980e3b565..e99580727b0 100644 --- a/src/System.Management.Automation/engine/COM/ComUtil.cs +++ b/src/System.Management.Automation/engine/COM/ComUtil.cs @@ -28,9 +28,9 @@ internal class ComUtil /// /// Gets Method Signature from FuncDesc describing the method. /// - /// ITypeInfo interface of the object - /// FuncDesc which defines the method - /// True if this is a property put; these properties take their return type from their first parameter + /// ITypeInfo interface of the object. + /// FuncDesc which defines the method. + /// True if this is a property put; these properties take their return type from their first parameter. /// Signature of the method. internal static string GetMethodSignatureFromFuncDesc(COM.ITypeInfo typeinfo, COM.FUNCDESC funcdesc, bool isPropertyPut) { @@ -100,8 +100,8 @@ internal static string GetMethodSignatureFromFuncDesc(COM.ITypeInfo typeinfo, CO /// /// Gets the name of the method or property defined by funcdesc /// - /// ITypeInfo interface of the type - /// FuncDesc of property of method + /// ITypeInfo interface of the type. + /// FuncDesc of property of method. /// Name of the method or property. internal static string GetNameFromFuncDesc(COM.ITypeInfo typeinfo, COM.FUNCDESC funcdesc) { @@ -115,8 +115,8 @@ internal static string GetNameFromFuncDesc(COM.ITypeInfo typeinfo, COM.FUNCDESC /// /// Gets the name of the custom type defined in the type library /// - /// ITypeInfo interface of the type - /// reference to the custom type + /// ITypeInfo interface of the type. + /// reference to the custom type. /// Name of the custom type. private static string GetStringFromCustomType(COM.ITypeInfo typeinfo, IntPtr refptr) { @@ -143,8 +143,8 @@ private static string GetStringFromCustomType(COM.ITypeInfo typeinfo, IntPtr ref /// This function gets a string representation of the Type Descriptor /// This is used in generating signature for Properties and Methods. /// - /// Reference to the type info to which the type descriptor belongs - /// reference to type descriptor which is being converted to string from + /// Reference to the type info to which the type descriptor belongs. + /// reference to type descriptor which is being converted to string from. /// String representation of the type descriptor. private static string GetStringFromTypeDesc(COM.ITypeInfo typeinfo, COM.TYPEDESC typedesc) { @@ -246,7 +246,7 @@ private static string GetStringFromTypeDesc(COM.ITypeInfo typeinfo, COM.TYPEDESC /// /// Determine .net type for the given type descriptor /// - /// COM type descriptor to convert + /// COM type descriptor to convert. /// Type represented by the typedesc. internal static Type GetTypeFromTypeDesc(COM.TYPEDESC typedesc) { diff --git a/src/System.Management.Automation/engine/CmdletParameterBinderController.cs b/src/System.Management.Automation/engine/CmdletParameterBinderController.cs index ad4f89edaab..e7b563bf479 100644 --- a/src/System.Management.Automation/engine/CmdletParameterBinderController.cs +++ b/src/System.Management.Automation/engine/CmdletParameterBinderController.cs @@ -391,8 +391,8 @@ private void ApplyDefaultParameterBinding(string bindingStage, bool isDynamic) /// /// Bind the default parameter value pairs /// - /// validParameterSetFlag - /// default value pairs + /// validParameterSetFlag. + /// default value pairs. /// /// true if there is at least one default parameter bound successfully /// false if there is no default parameter bound successfully @@ -2496,9 +2496,9 @@ private Collection GetMissingMandatoryParameters /// /// Preserve potential parameter sets as much as possible /// - /// The mandatory set we choose to latch on - /// Other mandatory parameter sets to be ignored - /// Indicate if the chosen mandatory set contains any non-pipelineable mandatory parameters + /// The mandatory set we choose to latch on. + /// Other mandatory parameter sets to be ignored. + /// Indicate if the chosen mandatory set contains any non-pipelineable mandatory parameters. private void PreservePotentialParameterSets(uint chosenMandatorySet, uint otherMandatorySetsToBeIgnored, bool chosenSetContainsNonpipelineableMandatoryParameters) { // If the chosen set contains nonpipelineable mandatory parameters, then we set it as the only valid parameter set since we will prompt for those mandatory parameters @@ -2527,7 +2527,7 @@ private void PreservePotentialParameterSets(uint chosenMandatorySet, uint otherM /// This method is used only when we try to preserve parameter sets during the mandatory parameter checking. /// In cases where this method is used, there must be at least one parameter set declared. /// - /// the mandatory parameter sets to be ignored + /// the mandatory parameter sets to be ignored. private void IgnoreOtherMandatoryParameterSets(uint otherMandatorySetsToBeIgnored) { if (otherMandatorySetsToBeIgnored == 0) @@ -4403,7 +4403,7 @@ public DefaultParameterDictionary() /// /// Check for the keys' formats and make it versionable /// - /// a hashtable instance + /// a hashtable instance. public DefaultParameterDictionary(IDictionary dictionary) : this() { @@ -4494,8 +4494,8 @@ public override bool ContainsKey(object key) /// /// Override the Add to check for key's format and make it versionable /// - /// key - /// value + /// key. + /// value. public override void Add(object key, object value) { AddImpl(key, value, isSelfIndexing: false); @@ -4573,7 +4573,7 @@ public override object this[object key] /// /// Override the Remove to make it versionable /// - /// key + /// key. public override void Remove(object key) { if (key == null) @@ -4651,10 +4651,10 @@ internal static bool CheckKeyIsValid(string key, ref string cmdletName, ref stri /// /// Get the cmdlet name and the parameter name /// - /// point to a non-whitespace character - /// the key to iterate over + /// point to a non-whitespace character. + /// the key to iterate over. /// - /// Specify whether to get the cmdlet name or parameter name + /// Specify whether to get the cmdlet name or parameter name. /// /// For cmdletName: /// When the name is enclosed by quotes, the index returned should be the index of the character right after the second quote; @@ -4720,8 +4720,8 @@ private static int GetValueToken(int index, string key, ref string name, bool ge /// /// Skip whitespace characters /// - /// start index - /// the string to iterate over + /// start index. + /// the string to iterate over. /// /// Return -1 if we reach the end of the key, otherwise return the index of the first /// non-whitespace character we encounter. diff --git a/src/System.Management.Automation/engine/CodeMethods.cs b/src/System.Management.Automation/engine/CodeMethods.cs index bdbe2644267..abdda335a27 100644 --- a/src/System.Management.Automation/engine/CodeMethods.cs +++ b/src/System.Management.Automation/engine/CodeMethods.cs @@ -21,7 +21,7 @@ public static partial class ToStringCodeMethods /// /// ToString implementation for PropertyValueCollection /// - /// instance of PSObject wrapping a PropertyValueCollection + /// instance of PSObject wrapping a PropertyValueCollection. public static string PropertyValueCollection(PSObject instance) { if (instance == null) @@ -59,8 +59,8 @@ public static class AdapterCodeMethods /// /// Converts instance of LargeInteger to .net Int64. /// - /// Instance of PSObject wrapping DirectoryEntry object - /// Instance of PSObject wrapping LargeInteger instance + /// Instance of PSObject wrapping DirectoryEntry object. + /// Instance of PSObject wrapping LargeInteger instance. /// Converted Int64. [SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "integer")] public static Int64 ConvertLargeIntegerToInt64(PSObject deInstance, PSObject largeIntegerInstance) @@ -103,8 +103,8 @@ public static Int64 ConvertLargeIntegerToInt64(PSObject deInstance, PSObject lar /// /// Converts instance of DN-With-Binary to .net String /// - /// Instance of PSObject wrapping DirectoryEntry object - /// Instance of PSObject wrapping DN-With-Binary object + /// Instance of PSObject wrapping DirectoryEntry object. + /// Instance of PSObject wrapping DN-With-Binary object. /// Converted string. [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "dn", Justification = "DN represents valid prefix w.r.t Active Directory.")] public static string ConvertDNWithBinaryToString(PSObject deInstance, PSObject dnWithBinaryInstance) diff --git a/src/System.Management.Automation/engine/ComInterop/ComBinder.cs b/src/System.Management.Automation/engine/ComInterop/ComBinder.cs index 25ca95c4a69..b45bc2eeb6a 100644 --- a/src/System.Management.Automation/engine/ComInterop/ComBinder.cs +++ b/src/System.Management.Automation/engine/ComInterop/ComBinder.cs @@ -133,7 +133,7 @@ public static bool TryBindInvoke(InvokeBinder binder, DynamicMetaObject instance /// Tries to perform binding of the dynamic invoke member operation. /// /// An instance of the that represents the details of the dynamic operation. - /// True if this is for setting a property, false otherwise.. + /// True if this is for setting a property, false otherwise. /// The target of the dynamic operation. /// An array of instances - arguments to the invoke member operation. /// The new representing the result of the binding. diff --git a/src/System.Management.Automation/engine/ComInterop/ComTypeLibDesc.cs b/src/System.Management.Automation/engine/ComInterop/ComTypeLibDesc.cs index 9550c444834..ce11420ff69 100644 --- a/src/System.Management.Automation/engine/ComInterop/ComTypeLibDesc.cs +++ b/src/System.Management.Automation/engine/ComInterop/ComTypeLibDesc.cs @@ -62,7 +62,7 @@ DynamicMetaObject IDynamicMetaObjectProvider.GetMetaObject(Expression parameter) /// and creates a IDynamicMetaObjectProvider that allows to instantiate coclasses /// and get actual values for the enums. /// - /// Type Library Guid + /// Type Library Guid. /// ComTypeLibDesc object. [System.Runtime.Versioning.ResourceExposure(System.Runtime.Versioning.ResourceScope.Machine)] [System.Runtime.Versioning.ResourceConsumption(System.Runtime.Versioning.ResourceScope.Machine, System.Runtime.Versioning.ResourceScope.Machine)] @@ -81,7 +81,7 @@ public static ComTypeLibInfo CreateFromGuid(Guid typeLibGuid) /// and creates a IDynamicMetaObjectProvider that allows to instantiate coclasses /// and get actual values for the enums. /// - /// OLE automation compatible RCW + /// OLE automation compatible RCW. /// ComTypeLibDesc object. public static ComTypeLibInfo CreateFromObject(object rcw) { diff --git a/src/System.Management.Automation/engine/CommandCompletion/CommandCompletion.cs b/src/System.Management.Automation/engine/CommandCompletion/CommandCompletion.cs index 19c3b42b9b3..857f8080407 100644 --- a/src/System.Management.Automation/engine/CommandCompletion/CommandCompletion.cs +++ b/src/System.Management.Automation/engine/CommandCompletion/CommandCompletion.cs @@ -86,9 +86,9 @@ public static Tuple MapStringInputToParsedInput(s /// /// - /// The input to complete - /// The index of the cursor in the input - /// Optional options to configure how completion is performed + /// The input to complete. + /// The index of the cursor in the input. + /// Optional options to configure how completion is performed. /// public static CommandCompletion CompleteInput(string input, int cursorIndex, Hashtable options) { @@ -103,10 +103,10 @@ public static CommandCompletion CompleteInput(string input, int cursorIndex, Has /// /// - /// Ast for pre-parsed input - /// Tokens for pre-parsed input + /// Ast for pre-parsed input. + /// Tokens for pre-parsed input. /// - /// Optional options to configure how completion is performed + /// Optional options to configure how completion is performed. /// public static CommandCompletion CompleteInput(Ast ast, Token[] tokens, IScriptPosition positionOfCursor, Hashtable options) { @@ -132,10 +132,10 @@ public static CommandCompletion CompleteInput(Ast ast, Token[] tokens, IScriptPo /// Invokes the script function TabExpansion2. /// For legacy support, TabExpansion2 will indirectly call TabExpansion if it exists. /// - /// The input script to complete - /// The offset in where completion is requested + /// The input script to complete. + /// The offset in where completion is requested. /// Optional parameter that specifies configurable options for completion. - /// The powershell to use to invoke the script function TabExpansion2 + /// The powershell to use to invoke the script function TabExpansion2. /// A collection of completions with the replacement start and length. [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "powershell")] public static CommandCompletion CompleteInput(string input, int cursorIndex, Hashtable options, PowerShell powershell) @@ -205,11 +205,11 @@ public static CommandCompletion CompleteInput(string input, int cursorIndex, Has /// Invokes the script function TabExpansion2. /// For legacy support, TabExpansion2 will indirectly call TabExpansion if it exists. /// - /// The ast for pre-parsed input + /// The ast for pre-parsed input. /// /// - /// Optional options to configure how completion is performed - /// The powershell to use to invoke the script function TabExpansion2 + /// Optional options to configure how completion is performed. + /// The powershell to use to invoke the script function TabExpansion2. /// [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "powershell")] public static CommandCompletion CompleteInput(Ast ast, Token[] tokens, IScriptPosition cursorPosition, Hashtable options, PowerShell powershell) @@ -353,11 +353,11 @@ internal static CommandCompletion CompleteInputInDebugger(string input, int curs /// /// Command completion while in debug break mode. /// - /// The ast for pre-parsed input + /// The ast for pre-parsed input. /// /// - /// Optional options to configure how completion is performed - /// Current debugger + /// Optional options to configure how completion is performed. + /// Current debugger. /// Command completion. internal static CommandCompletion CompleteInputInDebugger(Ast ast, Token[] tokens, IScriptPosition cursorPosition, Hashtable options, Debugger debugger) { diff --git a/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs b/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs index 49e088ce580..12f0db21da0 100644 --- a/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs +++ b/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs @@ -783,7 +783,7 @@ where pattern.IsMatch(alias) /// /// Get completion results for operators that start with /// - /// The starting text of the operator to complete + /// The starting text of the operator to complete. /// A list of completion results. public static List CompleteOperator(string wordToComplete) { @@ -3969,8 +3969,8 @@ private static ArgumentLocation FindTargetArgumentLocation(Collection /// - /// the argument that is right before the 'tab' location - /// the number of positional arguments before the 'tab' location + /// the argument that is right before the 'tab' location. + /// the number of positional arguments before the 'tab' location. /// private static ArgumentLocation GenerateArgumentLocation(AstParameterArgumentPair prev, int position) { @@ -5795,8 +5795,8 @@ private static TypeCompletionMapping[][] InitializeTypeCache() /// /// Handle namespace when initializing the type cache /// - /// The TypeCompletionMapping dictionary - /// The namespace + /// The TypeCompletionMapping dictionary. + /// The namespace. private static void HandleNamespace(Dictionary entryCache, string @namespace) { if (string.IsNullOrEmpty(@namespace)) @@ -5832,10 +5832,10 @@ private static void HandleNamespace(Dictionary en /// /// Handle a type when initializing the type cache /// - /// The TypeCompletionMapping dictionary - /// The full type name - /// The short type name - /// The actual type object. It may be null if we are handling type information from the CoreCLR TypeCatalog + /// The TypeCompletionMapping dictionary. + /// The full type name. + /// The short type name. + /// The actual type object. It may be null if we are handling type information from the CoreCLR TypeCatalog. private static void HandleType(Dictionary entryCache, string fullTypeName, string shortTypeName, Type actualType) { if (string.IsNullOrEmpty(fullTypeName)) { return; } diff --git a/src/System.Management.Automation/engine/CommandCompletion/ExtensibleCompletion.cs b/src/System.Management.Automation/engine/CommandCompletion/ExtensibleCompletion.cs index 595045902fe..07c866b2685 100644 --- a/src/System.Management.Automation/engine/CommandCompletion/ExtensibleCompletion.cs +++ b/src/System.Management.Automation/engine/CommandCompletion/ExtensibleCompletion.cs @@ -169,9 +169,9 @@ public class ArgumentCompletionsAttribute : Attribute /// /// Initializes a new instance of the ArgumentCompletionsAttribute class /// - /// list of complete values - /// for null arguments - /// for invalid arguments + /// list of complete values. + /// for null arguments. + /// for invalid arguments. public ArgumentCompletionsAttribute(params string[] completions) { if (completions == null) diff --git a/src/System.Management.Automation/engine/CommandCompletion/PseudoParameterBinder.cs b/src/System.Management.Automation/engine/CommandCompletion/PseudoParameterBinder.cs index 35d7879d9ab..b8e77ffa505 100644 --- a/src/System.Management.Automation/engine/CommandCompletion/PseudoParameterBinder.cs +++ b/src/System.Management.Automation/engine/CommandCompletion/PseudoParameterBinder.cs @@ -771,8 +771,8 @@ public class StaticBindingError /// /// Creates a StaticBindingException /// - /// The element associated with the exception - /// The parameter binding exception that got raised + /// The element associated with the exception. + /// The parameter binding exception that got raised. internal StaticBindingError(CommandElementAst commandElement, ParameterBindingException exception) { this.CommandElement = commandElement; @@ -941,8 +941,8 @@ internal enum BindingType /// Get the parameter binding metadata /// /// - /// Indicate the type of the piped-in argument - /// The CommandParameterAst the cursor is pointing at + /// Indicate the type of the piped-in argument. + /// The CommandParameterAst the cursor is pointing at. /// Indicates whether pseudo binding is for argument binding, argument completion, or parameter completion. /// PseudoBindingInfo. internal PseudoBindingInfo DoPseudoParameterBinding(CommandAst command, Type pipeArgumentType, CommandParameterAst paramAstAtCursor, BindingType bindingType) @@ -1073,7 +1073,7 @@ internal PseudoBindingInfo DoPseudoParameterBinding(CommandAst command, Type pip /// /// Sets a temporary default host on the ExecutionContext /// - /// ExecutionContext + /// ExecutionContext. private void SetTemporaryDefaultHost(ExecutionContext executionContext) { if (executionContext.EngineHostInterface.IsHostRefSet) @@ -1095,7 +1095,7 @@ private void SetTemporaryDefaultHost(ExecutionContext executionContext) /// /// Restores original ExecutionContext host state. /// - /// ExecutionContext + /// ExecutionContext. private void RestoreHost(ExecutionContext executionContext) { // Remove temporary host and revert to original. diff --git a/src/System.Management.Automation/engine/CommandDiscovery.cs b/src/System.Management.Automation/engine/CommandDiscovery.cs index 5e459bb1365..0aeb0441fef 100644 --- a/src/System.Management.Automation/engine/CommandDiscovery.cs +++ b/src/System.Management.Automation/engine/CommandDiscovery.cs @@ -25,9 +25,9 @@ public class CommandLookupEventArgs : EventArgs /// /// Constructor for event args object /// - /// The name of the command we're searching for - /// The origin of the command internal or runspace (external) - /// The execution context for this command + /// The name of the command we're searching for. + /// The origin of the command internal or runspace (external). + /// The execution context for this command. internal CommandLookupEventArgs(string commandName, CommandOrigin commandOrigin, ExecutionContext context) { CommandName = commandName; @@ -516,8 +516,8 @@ internal static void VerifyNetFrameworkVersion(ExternalScriptInfo scriptInfo) /// 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 - /// version installed + /// versions in the requires statement. + /// version installed. /// /// true if requires and installed's major version match and requires' minor version /// is smaller than or equal to installed's diff --git a/src/System.Management.Automation/engine/CommandInfo.cs b/src/System.Management.Automation/engine/CommandInfo.cs index 375abc320bd..bb28681feec 100644 --- a/src/System.Management.Automation/engine/CommandInfo.cs +++ b/src/System.Management.Automation/engine/CommandInfo.cs @@ -762,7 +762,7 @@ public class PSTypeName /// /// This constructor is used when the type exists and is currently loaded. /// - /// The type + /// The type. public PSTypeName(Type type) { _type = type; @@ -775,7 +775,7 @@ public PSTypeName(Type type) /// /// This constructor is used when the type may not exist, or is not loaded. /// - /// The name of the type + /// The name of the type. public PSTypeName(string name) { Name = name; diff --git a/src/System.Management.Automation/engine/CommandMetadata.cs b/src/System.Management.Automation/engine/CommandMetadata.cs index b6cfdfc548d..2c5561dfcbb 100644 --- a/src/System.Management.Automation/engine/CommandMetadata.cs +++ b/src/System.Management.Automation/engine/CommandMetadata.cs @@ -156,7 +156,7 @@ public CommandMetadata(string path) /// A copy constructor that creates a deep copy of the CommandMetadata object. /// Instances of Attribute and Type classes are copied by reference. /// - /// object to copy + /// object to copy. public CommandMetadata(CommandMetadata other) { if (other == null) diff --git a/src/System.Management.Automation/engine/CommandParameter.cs b/src/System.Management.Automation/engine/CommandParameter.cs index 8f46b45549e..2a93440ff10 100644 --- a/src/System.Management.Automation/engine/CommandParameter.cs +++ b/src/System.Management.Automation/engine/CommandParameter.cs @@ -200,7 +200,7 @@ internal static CommandParameterInternal CreateArgument( /// The text of the parameter, as it did, or would, appear in script. /// The ast of the argument value in the script. /// The argument value. - /// Used in native commands to correctly handle -foo:bar vs. -foo: bar + /// Used in native commands to correctly handle -foo:bar vs. -foo: bar. internal static CommandParameterInternal CreateParameterWithArgument( Ast parameterAst, string parameterName, diff --git a/src/System.Management.Automation/engine/CommandProcessor.cs b/src/System.Management.Automation/engine/CommandProcessor.cs index f026749788d..19ec6cdd2b6 100644 --- a/src/System.Management.Automation/engine/CommandProcessor.cs +++ b/src/System.Management.Automation/engine/CommandProcessor.cs @@ -70,7 +70,7 @@ internal CommandProcessor(CmdletInfo cmdletInfo, ExecutionContext context) : bas /// /// /// - /// True when the script to be executed came from a file (as opposed to a function, or interactive input) + /// True when the script to be executed came from a file (as opposed to a function, or interactive input). internal CommandProcessor(IScriptCommandInfo scriptCommandInfo, ExecutionContext context, bool useLocalScope, bool fromScriptFile, SessionStateInternal sessionState) : base(scriptCommandInfo as CommandInfo) { @@ -820,8 +820,8 @@ private void InitCommon() /// Checks if user has requested help (for example passing "-?" parameter for a cmdlet) /// and if yes, then returns the help target to display. /// - /// help target to request - /// help category to request + /// help target to request. + /// help category to request. /// true if user requested help; false otherwise. internal override bool IsHelpRequested(out string helpTarget, out HelpCategory helpCategory) { diff --git a/src/System.Management.Automation/engine/CommandProcessorBase.cs b/src/System.Management.Automation/engine/CommandProcessorBase.cs index 5135fbe8118..ec42ba92535 100644 --- a/src/System.Management.Automation/engine/CommandProcessorBase.cs +++ b/src/System.Management.Automation/engine/CommandProcessorBase.cs @@ -180,9 +180,9 @@ internal bool UseLocalScope /// Ensures that the provided script block is compatible with the current language mode - to /// be used when a script block is being dotted. /// - /// The script block being dotted - /// The current language mode - /// The invocation info about the command + /// The script block being dotted. + /// The current language mode. + /// The invocation info about the command. protected static void ValidateCompatibleLanguageMode( ScriptBlock scriptBlock, PSLanguageMode languageMode, @@ -251,8 +251,8 @@ internal ExecutionContext Context /// Checks if user has requested help (for example passing "-?" parameter for a cmdlet) /// and if yes, then returns the help target to display. /// - /// help target to request - /// help category to request + /// help target to request. + /// help category to request. /// true if user requested help; false otherwise. internal virtual bool IsHelpRequested(out string helpTarget, out HelpCategory helpCategory) { @@ -266,9 +266,9 @@ internal virtual bool IsHelpRequested(out string helpTarget, out HelpCategory he /// /// Creates a command processor for "get-help [helpTarget]". /// - /// context for the command processor - /// help target - /// help category + /// context for the command processor. + /// help target. + /// help category. /// Command processor for "get-help [helpTarget]". internal static CommandProcessorBase CreateGetHelpCommandProcessor( ExecutionContext context, diff --git a/src/System.Management.Automation/engine/CommandSearcher.cs b/src/System.Management.Automation/engine/CommandSearcher.cs index 41a34d624dc..6d4589ae2e3 100644 --- a/src/System.Management.Automation/engine/CommandSearcher.cs +++ b/src/System.Management.Automation/engine/CommandSearcher.cs @@ -1160,7 +1160,7 @@ private string ResolvePSPath(string path) /// /// The name of the command to search for. /// - /// get names for command discovery + /// get names for command discovery. /// /// A collection of the patterns used to find the command. /// The patterns are as follows: diff --git a/src/System.Management.Automation/engine/ConfigurationInfo.cs b/src/System.Management.Automation/engine/ConfigurationInfo.cs index 85e2e7cc9d6..0168b7a3b2c 100644 --- a/src/System.Management.Automation/engine/ConfigurationInfo.cs +++ b/src/System.Management.Automation/engine/ConfigurationInfo.cs @@ -93,7 +93,7 @@ internal ConfigurationInfo(string name, ScriptBlock configuration, ScopedItemOpt /// /// The help file for the configuration. /// - /// The configuration is a meta configuration + /// The configuration is a meta configuration. /// /// If is null. /// diff --git a/src/System.Management.Automation/engine/CoreAdapter.cs b/src/System.Management.Automation/engine/CoreAdapter.cs index 60eb155d7aa..9f4c63d36f9 100644 --- a/src/System.Management.Automation/engine/CoreAdapter.cs +++ b/src/System.Management.Automation/engine/CoreAdapter.cs @@ -64,7 +64,7 @@ protected static IEnumerable GetDotNetTypeNameHierarchy(object obj) /// /// Returns the TypeNameHierarchy out of an object /// - /// object to get the TypeNameHierarchy from + /// object to get the TypeNameHierarchy from. protected virtual IEnumerable GetTypeNameHierarchy(object obj) { return GetDotNetTypeNameHierarchy(obj); @@ -74,7 +74,7 @@ protected virtual IEnumerable GetTypeNameHierarchy(object obj) /// Returns the cached typename, if it can be cached, otherwise constructs a new typename. /// By default, we don't return interned values, adapters can override if they choose. /// - /// object to get the TypeNameHierarchy from + /// object to get the TypeNameHierarchy from. protected virtual ConsolidatedString GetInternedTypeNameHierarchy(object obj) { return new ConsolidatedString(GetTypeNameHierarchy(obj)); @@ -84,8 +84,8 @@ protected virtual ConsolidatedString GetInternedTypeNameHierarchy(object obj) /// Returns null if memberName is not a member in the adapter or /// the corresponding PSMemberInfo /// - /// object to retrieve the PSMemberInfo from - /// name of the member to be retrieved + /// object to retrieve the PSMemberInfo from. + /// name of the member to be retrieved. /// The PSMemberInfo corresponding to memberName from obj. protected abstract T GetMember(object obj, string memberName) where T : PSMemberInfo; @@ -99,7 +99,7 @@ protected virtual ConsolidatedString GetInternedTypeNameHierarchy(object obj) /// In the case of the DirectoryEntry adapter, this could be a cache of the objectClass /// to the properties available in it. /// - /// object to get all the member information from + /// object to get all the member information from. /// All members in obj. protected abstract PSMemberInfoInternalCollection GetMembers(object obj) where T : PSMemberInfo; @@ -110,51 +110,51 @@ protected virtual ConsolidatedString GetInternedTypeNameHierarchy(object obj) /// /// Returns the value from a property coming from a previous call to GetMember /// - /// PSProperty coming from a previous call to GetMember + /// PSProperty coming from a previous call to GetMember. /// The value of the property. protected abstract object PropertyGet(PSProperty property); /// /// Sets the value of a property coming from a previous call to GetMember /// - /// PSProperty coming from a previous call to GetMember - /// value to set the property with - /// instructs the adapter to convert before setting, if the adapter supports conversion + /// PSProperty coming from a previous call to GetMember. + /// value to set the property with. + /// instructs the adapter to convert before setting, if the adapter supports conversion. protected abstract void PropertySet(PSProperty property, object setValue, bool convertIfPossible); /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected abstract bool PropertyIsSettable(PSProperty property); /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected abstract bool PropertyIsGettable(PSProperty property); /// /// Returns the name of the type corresponding to the property's value /// - /// PSProperty obtained in a previous GetMember - /// True if the result is for display purposes only + /// PSProperty obtained in a previous GetMember. + /// True if the result is for display purposes only. /// The name of the type corresponding to the member. protected abstract string PropertyType(PSProperty property, bool forDisplay); /// /// Returns the string representation of the property in the object /// - /// property obtained in a previous GetMember + /// property obtained in a previous GetMember. /// The string representation of the property in the object. protected abstract string PropertyToString(PSProperty property); /// /// Returns an array with the property attributes /// - /// property we want the attributes from + /// property we want the attributes from. /// An array with the property attributes. protected abstract AttributeCollection PropertyAttributes(PSProperty property); @@ -166,9 +166,9 @@ protected virtual ConsolidatedString GetInternedTypeNameHierarchy(object obj) /// Called after a non null return from GetMember to try to call /// the method with the arguments /// - /// the non empty return from GetMethods - /// invocation constraints - /// the arguments to use + /// the non empty return from GetMethods. + /// invocation constraints. + /// the arguments to use. /// The return value for the method. protected virtual object MethodInvoke(PSMethod method, PSMethodInvocationConstraints invocationConstraints, object[] arguments) { @@ -179,15 +179,15 @@ protected virtual object MethodInvoke(PSMethod method, PSMethodInvocationConstra /// Called after a non null return from GetMember to try to call /// the method with the arguments /// - /// the non empty return from GetMethods - /// the arguments to use + /// the non empty return from GetMethods. + /// the arguments to use. /// The return value for the method. protected abstract object MethodInvoke(PSMethod method, object[] arguments); /// /// Called after a non null return from GetMember to return the overloads /// - /// the return of GetMember + /// the return of GetMember. /// protected abstract Collection MethodDefinitions(PSMethod method); @@ -215,7 +215,7 @@ protected virtual string MethodToString(PSMethod method) /// /// Returns the name of the type corresponding to the property's value /// - /// property obtained in a previous GetMember + /// property obtained in a previous GetMember. /// The name of the type corresponding to the member. /// /// It is not necessary for derived methods to override this. @@ -230,7 +230,7 @@ protected virtual string ParameterizedPropertyType(PSParameterizedProperty prope /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. /// /// It is not necessary for derived methods to override this. @@ -245,7 +245,7 @@ protected virtual bool ParameterizedPropertyIsSettable(PSParameterizedProperty p /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. /// /// It is not necessary for derived methods to override this. @@ -260,7 +260,7 @@ protected virtual bool ParameterizedPropertyIsGettable(PSParameterizedProperty p /// /// Called after a non null return from GetMember to return the overloads /// - /// the return of GetMember + /// the return of GetMember. /// /// It is not necessary for derived methods to override this. /// This method is called only if ParameterizedProperties are present. @@ -274,8 +274,8 @@ protected virtual Collection ParameterizedPropertyDefinitions(PSParamete /// /// Called after a non null return from GetMember to get the property value /// - /// the non empty return from GetMember - /// the arguments to use + /// the non empty return from GetMember. + /// the arguments to use. /// The return value for the property. /// /// It is not necessary for derived methods to override this. @@ -290,9 +290,9 @@ protected virtual object ParameterizedPropertyGet(PSParameterizedProperty proper /// /// Called after a non null return from GetMember to set the property value /// - /// the non empty return from GetMember - /// the value to set property with - /// the arguments to use + /// the non empty return from GetMember. + /// the value to set property with. + /// the arguments to use. /// /// It is not necessary for derived methods to override this. /// This method is called only if ParameterizedProperties are present. @@ -306,7 +306,7 @@ protected virtual void ParameterizedPropertySet(PSParameterizedProperty property /// /// Returns the string representation of the property in the object /// - /// property obtained in a previous GetMember + /// property obtained in a previous GetMember. /// The string representation of the property in the object. /// /// It is not necessary for derived methods to override this. @@ -1207,14 +1207,14 @@ private static bool IsInvocationConstraintSatisfied(OverloadCandidate overloadCa /// Return the best method out of overloaded methods. /// The best has the smallest type distance between the method's parameters and the given arguments. /// - /// different overloads for a method - /// invocation constraints - /// true if we accept implicit/explicit casting conversion to a ByRef-like parameter type for method resolution - /// arguments to check against the overloads - /// if no best method, the error id to use in the error message - /// if no best method, the error message (format string) to use in the error message - /// true if the best method's last parameter is a params method - /// true if best method should be called as non-virtual + /// different overloads for a method. + /// invocation constraints. + /// true if we accept implicit/explicit casting conversion to a ByRef-like parameter type for method resolution. + /// arguments to check against the overloads. + /// if no best method, the error id to use in the error message. + /// if no best method, the error message (format string) to use in the error message. + /// true if the best method's last parameter is a params method. + /// true if best method should be called as non-virtual. internal static MethodInformation FindBestMethod( MethodInformation[] methods, PSMethodInvocationConstraints invocationConstraints, @@ -1705,11 +1705,11 @@ internal static object[] GetMethodArgumentsBase(string methodName, /// /// Auxiliary method in MethodInvoke to set newArguments[index] with the propper value /// - /// used for the MethodException that might be thrown - /// the complete array of arguments - /// the complete array of new arguments - /// the parameter to use - /// the index in newArguments to set + /// used for the MethodException that might be thrown. + /// the complete array of arguments. + /// the complete array of new arguments. + /// the parameter to use. + /// the index in newArguments to set. internal static void SetNewArgument(string methodName, object[] arguments, object[] newArguments, ParameterInformation parameter, int index) { @@ -2913,9 +2913,9 @@ private static void PopulateMethodReflectionTable(ConstructorInfo[] ctors, Cache /// Called from GetMethodReflectionTable within a lock to fill the /// method cache table /// - /// type to get methods from - /// table to be filled - /// bindingFlags to use + /// type to get methods from. + /// table to be filled. + /// bindingFlags to use. private static void PopulateMethodReflectionTable(Type type, CacheTable typeMethods, BindingFlags bindingFlags) { Type typeToGetMethod = type; @@ -3010,9 +3010,9 @@ private static void PopulateMethodReflectionTable(Type type, CacheTable typeMeth /// Called from GetEventReflectionTable within a lock to fill the /// event cache table /// - /// type to get events from - /// table to be filled - /// bindingFlags to use + /// type to get events from. + /// table to be filled. + /// bindingFlags to use. private static void PopulateEventReflectionTable(Type type, Dictionary typeEvents, BindingFlags bindingFlags) { // Assemblies in CoreCLR might not allow reflection execution on their internal types. In such case, we walk up @@ -3094,9 +3094,9 @@ private static bool PropertyAlreadyPresent(List previousProperties /// Called from GetPropertyReflectionTable within a lock to fill the /// property cache table /// - /// type to get properties from - /// table to be filled - /// bindingFlags to use + /// type to get properties from. + /// table to be filled. + /// bindingFlags to use. private static void PopulatePropertyReflectionTable(Type type, CacheTable typeProperties, BindingFlags bindingFlags) { var tempTable = new Dictionary>(StringComparer.OrdinalIgnoreCase); @@ -3267,7 +3267,7 @@ internal static Type GetFirstPublicParentType(Type type) /// typeTable with all public properties and fields /// of type. /// - /// type to load properties for + /// type to load properties for. private static CacheTable GetStaticPropertyReflectionTable(Type type) { lock (s_staticPropertyCacheTable) @@ -3288,7 +3288,7 @@ private static CacheTable GetStaticPropertyReflectionTable(Type type) /// /// Retrieves the table for static methods /// - /// type to load methods for + /// type to load methods for. private static CacheTable GetStaticMethodReflectionTable(Type type) { lock (s_staticMethodCacheTable) @@ -3309,7 +3309,7 @@ private static CacheTable GetStaticMethodReflectionTable(Type type) /// /// Retrieves the table for static events /// - /// type containing properties to load in typeTable + /// type containing properties to load in typeTable. private static Dictionary GetStaticEventReflectionTable(Type type) { lock (s_staticEventCacheTable) @@ -3332,7 +3332,7 @@ private static Dictionary GetStaticEventReflectionTable /// typeTable with all public properties and fields /// of type. /// - /// type with properties to load in typeTable + /// type with properties to load in typeTable. private static CacheTable GetInstancePropertyReflectionTable(Type type) { lock (s_instancePropertyCacheTable) @@ -3353,7 +3353,7 @@ private static CacheTable GetInstancePropertyReflectionTable(Type type) /// /// Retrieves the table for instance methods /// - /// type with methods to load in typeTable + /// type with methods to load in typeTable. private static CacheTable GetInstanceMethodReflectionTable(Type type) { lock (s_instanceMethodCacheTable) @@ -3399,7 +3399,7 @@ internal IEnumerable GetPropertiesAndMethods(Type type, bool @static) /// /// Retrieves the table for instance events /// - /// type containing methods to load in typeTable + /// type containing methods to load in typeTable. private static Dictionary GetInstanceEventReflectionTable(Type type) { lock (s_instanceEventCacheTable) @@ -3420,7 +3420,7 @@ private static Dictionary GetInstanceEventReflectionTab /// /// Returns true if a parameterized property should be in a PSMemberInfoCollection of type t /// - /// Type of a PSMemberInfoCollection like the type of T in PSMemberInfoCollection of T + /// Type of a PSMemberInfoCollection like the type of T in PSMemberInfoCollection of T. /// True if a parameterized property should be in a collection. /// /// Usually typeof(T).IsAssignableFrom(typeof(PSParameterizedProperty)) would work like it does @@ -3663,8 +3663,8 @@ protected override ConsolidatedString GetInternedTypeNameHierarchy(object obj) /// 1. Dynamic members cannot be invoked via reflection; /// 2. Access to dynamic members is handled by the DLR for free. /// - /// object to retrieve the PSMemberInfo from - /// name of the member to be retrieved + /// object to retrieve the PSMemberInfo from. + /// name of the member to be retrieved. /// /// The PSMemberInfo corresponding to memberName from obj, /// or null if the given member name is not a member in the adapter. @@ -3690,7 +3690,7 @@ protected override T GetMember(object obj, string memberName) /// Dynamic members of an object that implements IDynamicMetaObjectProvider are included because /// we want to view the dynamic members via 'Get-Member' and be able to auto-complete those members. /// - /// object to get all the member information from + /// object to get all the member information from. /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { @@ -3710,7 +3710,7 @@ protected override PSMemberInfoInternalCollection GetMembers(object obj) /// /// Returns an array with the property attributes /// - /// property we want the attributes from + /// property we want the attributes from. /// An array with the property attributes. protected override AttributeCollection PropertyAttributes(PSProperty property) { @@ -3721,7 +3721,7 @@ protected override AttributeCollection PropertyAttributes(PSProperty property) /// /// Returns the string representation of the property in the object /// - /// property obtained in a previous GetMember + /// property obtained in a previous GetMember. /// The string representation of the property in the object. protected override string PropertyToString(PSProperty property) { @@ -3752,7 +3752,7 @@ protected override string PropertyToString(PSProperty property) /// /// Returns the value from a property coming from a previous call to GetMember /// - /// PSProperty coming from a previous call to GetMember + /// PSProperty coming from a previous call to GetMember. /// The value of the property. protected override object PropertyGet(PSProperty property) { @@ -3804,9 +3804,9 @@ protected override object PropertyGet(PSProperty property) /// /// Sets the value of a property coming from a previous call to GetMember /// - /// PSProperty coming from a previous call to GetMember - /// value to set the property with - /// instructs the adapter to convert before setting, if the adapter supports conversion + /// PSProperty coming from a previous call to GetMember. + /// value to set the property with. + /// instructs the adapter to convert before setting, if the adapter supports conversion. protected override void PropertySet(PSProperty property, object setValue, bool convertIfPossible) { PropertyCacheEntry adapterData = (PropertyCacheEntry)property.adapterData; @@ -3869,7 +3869,7 @@ protected override void PropertySet(PSProperty property, object setValue, bool c /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { @@ -3879,7 +3879,7 @@ protected override bool PropertyIsSettable(PSProperty property) /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { @@ -3889,8 +3889,8 @@ protected override bool PropertyIsGettable(PSProperty property) /// /// Returns the name of the type corresponding to the property's value /// - /// PSProperty obtained in a previous GetMember - /// True if the result is for display purposes only + /// PSProperty obtained in a previous GetMember. + /// True if the result is for display purposes only. /// The name of the type corresponding to the member. protected override string PropertyType(PSProperty property, bool forDisplay) { @@ -3907,11 +3907,11 @@ protected override string PropertyType(PSProperty property, bool forDisplay) /// /// Calls constructor using the arguments and catching the appropriate exception /// - /// final arguments to the constructor + /// final arguments to the constructor. /// The return of the constructor. /// Information about the method to call. Used for setting references. /// Original arguments in the method call. Used for setting references. - /// if the constructor throws an exception + /// if the constructor throws an exception. internal static object AuxiliaryConstructorInvoke(MethodInformation methodInformation, object[] arguments, object[] originalArguments) { object returnValue; @@ -3946,12 +3946,12 @@ internal static object AuxiliaryConstructorInvoke(MethodInformation methodInform /// /// Calls method on target using the arguments and catching the appropriate exception /// - /// object we want to call the method on - /// final arguments to the method + /// object we want to call the method on. + /// final arguments to the method. /// Information about the method to call. Used for setting references. /// Original arguments in the method call. Used for setting references. /// The return of the method. - /// if the method throws an exception + /// if the method throws an exception. internal static object AuxiliaryMethodInvoke(object target, object[] arguments, MethodInformation methodInformation, object[] originalArguments) { object result; @@ -4020,7 +4020,7 @@ internal static object AuxiliaryMethodInvoke(object target, object[] arguments, /// /// Converts a MethodBase[] into a MethodInformation[] /// - /// the methods to be converted + /// the methods to be converted. /// The MethodInformation[] corresponding to methods. internal static MethodInformation[] GetMethodInformationArray(MethodBase[] methods) { @@ -4037,14 +4037,14 @@ internal static MethodInformation[] GetMethodInformationArray(MethodBase[] metho /// /// Calls the method best suited to the arguments on target. /// - /// used for error messages - /// object to call the method on - /// method information corresponding to methods - /// invocation constraints - /// arguments of the call + /// used for error messages. + /// object to call the method on. + /// method information corresponding to methods. + /// invocation constraints. + /// arguments of the call. /// The return of the method. - /// if the method throws an exception - /// if we could not find a method for the given arguments + /// if the method throws an exception. + /// if we could not find a method for the given arguments. internal static object MethodInvokeDotNet( string methodName, object target, @@ -4068,12 +4068,12 @@ internal static object MethodInvokeDotNet( /// /// Calls the method best suited to the arguments on target. /// - /// the type being constructed, used for diagnostics and caching - /// all overloads for the constructors - /// arguments of the call + /// the type being constructed, used for diagnostics and caching. + /// all overloads for the constructors. + /// arguments of the call. /// The return of the method. - /// if the method throws an exception - /// if we could not find a method for the given arguments + /// if the method throws an exception. + /// if we could not find a method for the given arguments. internal static object ConstructorInvokeDotNet(Type type, ConstructorInfo[] constructors, object[] arguments) { var newConstructors = GetMethodInformationArray(constructors); @@ -4234,8 +4234,8 @@ internal static string GetMethodInfoOverloadDefinition(string memberName, Method /// Called after a non null return from GetMember to try to call /// the method with the arguments /// - /// the non empty return from GetMethods - /// the arguments to use + /// the non empty return from GetMethods. + /// the arguments to use. /// The return value for the method. protected override object MethodInvoke(PSMethod method, object[] arguments) { @@ -4246,9 +4246,9 @@ protected override object MethodInvoke(PSMethod method, object[] arguments) /// Called after a non null return from GetMember to try to call /// the method with the arguments /// - /// the non empty return from GetMethods - /// invocation constraints - /// the arguments to use + /// the non empty return from GetMethods. + /// invocation constraints. + /// the arguments to use. /// The return value for the method. protected override object MethodInvoke(PSMethod method, PSMethodInvocationConstraints invocationConstraints, object[] arguments) { @@ -4264,7 +4264,7 @@ protected override object MethodInvoke(PSMethod method, PSMethodInvocationConstr /// /// Called after a non null return from GetMember to return the overloads /// - /// the return of GetMember + /// the return of GetMember. /// protected override Collection MethodDefinitions(PSMethod method) { @@ -4284,7 +4284,7 @@ protected override Collection MethodDefinitions(PSMethod method) /// /// Returns the name of the type corresponding to the property's value /// - /// property obtained in a previous GetMember + /// property obtained in a previous GetMember. /// The name of the type corresponding to the member. protected override string ParameterizedPropertyType(PSParameterizedProperty property) { @@ -4295,7 +4295,7 @@ protected override string ParameterizedPropertyType(PSParameterizedProperty prop /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected override bool ParameterizedPropertyIsSettable(PSParameterizedProperty property) { @@ -4305,7 +4305,7 @@ protected override bool ParameterizedPropertyIsSettable(PSParameterizedProperty /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected override bool ParameterizedPropertyIsGettable(PSParameterizedProperty property) { @@ -4315,8 +4315,8 @@ protected override bool ParameterizedPropertyIsGettable(PSParameterizedProperty /// /// Called after a non null return from GetMember to get the property value /// - /// the non empty return from GetMember - /// the arguments to use + /// the non empty return from GetMember. + /// the arguments to use. /// The return value for the property. protected override object ParameterizedPropertyGet(PSParameterizedProperty property, object[] arguments) { @@ -4328,9 +4328,9 @@ protected override object ParameterizedPropertyGet(PSParameterizedProperty prope /// /// Called after a non null return from GetMember to set the property value /// - /// the non empty return from GetMember - /// the value to set property with - /// the arguments to use + /// the non empty return from GetMember. + /// the value to set property with. + /// the arguments to use. protected override void ParameterizedPropertySet(PSParameterizedProperty property, object setValue, object[] arguments) { var adapterData = (ParameterizedPropertyCacheEntry)property.adapterData; @@ -4356,7 +4356,7 @@ protected override Collection ParameterizedPropertyDefinitions(PSParamet /// /// Returns the string representation of the property in the object /// - /// property obtained in a previous GetMember + /// property obtained in a previous GetMember. /// The string representation of the property in the object. protected override string ParameterizedPropertyToString(PSParameterizedProperty property) { @@ -4493,7 +4493,7 @@ internal abstract class MemberRedirectionAdapter : Adapter /// /// Returns an array with the property attributes /// - /// property we want the attributes from + /// property we want the attributes from. /// An array with the property attributes. protected override AttributeCollection PropertyAttributes(PSProperty property) { @@ -4503,7 +4503,7 @@ protected override AttributeCollection PropertyAttributes(PSProperty property) /// /// Returns the value from a property coming from a previous call to GetMember /// - /// PSProperty coming from a previous call to GetMember + /// PSProperty coming from a previous call to GetMember. /// The value of the property. protected override object PropertyGet(PSProperty property) { @@ -4514,9 +4514,9 @@ protected override object PropertyGet(PSProperty property) /// /// Sets the value of a property coming from a previous call to GetMember /// - /// PSProperty coming from a previous call to GetMember - /// value to set the property with - /// instructs the adapter to convert before setting, if the adapter supports conversion + /// PSProperty coming from a previous call to GetMember. + /// value to set the property with. + /// instructs the adapter to convert before setting, if the adapter supports conversion. protected override void PropertySet(PSProperty property, object setValue, bool convertIfPossible) { Diagnostics.Assert(false, "redirection adapter is not called for properties"); @@ -4526,7 +4526,7 @@ protected override void PropertySet(PSProperty property, object setValue, bool c /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { @@ -4537,7 +4537,7 @@ protected override bool PropertyIsSettable(PSProperty property) /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { @@ -4548,8 +4548,8 @@ protected override bool PropertyIsGettable(PSProperty property) /// /// Returns the name of the type corresponding to the property's value /// - /// PSProperty obtained in a previous GetMember - /// True if the result is for display purposes only + /// PSProperty obtained in a previous GetMember. + /// True if the result is for display purposes only. /// The name of the type corresponding to the member. protected override string PropertyType(PSProperty property, bool forDisplay) { @@ -4560,7 +4560,7 @@ protected override string PropertyType(PSProperty property, bool forDisplay) /// /// Returns the string representation of the property in the object /// - /// property obtained in a previous GetMember + /// property obtained in a previous GetMember. /// The string representation of the property in the object. protected override string PropertyToString(PSProperty property) { @@ -4576,8 +4576,8 @@ protected override string PropertyToString(PSProperty property) /// Called after a non null return from GetMember to try to call /// the method with the arguments /// - /// the non empty return from GetMethods - /// the arguments to use + /// the non empty return from GetMethods. + /// the arguments to use. /// The return value for the method. protected override object MethodInvoke(PSMethod method, object[] arguments) { @@ -4588,7 +4588,7 @@ protected override object MethodInvoke(PSMethod method, object[] arguments) /// /// Called after a non null return from GetMember to return the overloads /// - /// the return of GetMember + /// the return of GetMember. /// protected override Collection MethodDefinitions(PSMethod method) { @@ -4610,7 +4610,7 @@ internal class PSObjectAdapter : MemberRedirectionAdapter /// /// Returns the TypeNameHierarchy out of an object /// - /// object to get the TypeNameHierarchy from + /// object to get the TypeNameHierarchy from. protected override IEnumerable GetTypeNameHierarchy(object obj) { return ((PSObject)obj).InternalTypeNames; @@ -4620,8 +4620,8 @@ protected override IEnumerable GetTypeNameHierarchy(object obj) /// Returns null if memberName is not a member in the adapter or /// the corresponding PSMemberInfo /// - /// object to retrieve the PSMemberInfo from - /// name of the member to be retrieved + /// object to retrieve the PSMemberInfo from. + /// name of the member to be retrieved. /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { @@ -4638,7 +4638,7 @@ protected override T GetMember(object obj, string memberName) /// In the case of the DirectoryEntry adapter, this could be a cache of the objectClass /// to the properties available in it. /// - /// object to get all the member information from + /// object to get all the member information from. /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { @@ -4679,8 +4679,8 @@ protected override IEnumerable GetTypeNameHierarchy(object obj) /// Returns null if memberName is not a member in the adapter or /// the corresponding PSMemberInfo /// - /// object to retrieve the PSMemberInfo from - /// name of the member to be retrieved + /// object to retrieve the PSMemberInfo from. + /// name of the member to be retrieved. /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { @@ -4697,7 +4697,7 @@ protected override T GetMember(object obj, string memberName) /// In the case of the DirectoryEntry adapter, this could be a cache of the objectClass /// to the properties available in it. /// - /// object to get all the member information from + /// object to get all the member information from. /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { @@ -4751,24 +4751,24 @@ protected override ConsolidatedString GetInternedTypeNameHierarchy(object obj) /// the corresponding PSProperty with its adapterData set to information /// to be used when retrieving the property. /// - /// object to retrieve the PSProperty from - /// name of the property to be retrieved + /// object to retrieve the PSProperty from. + /// name of the property to be retrieved. /// The PSProperty corresponding to propertyName from obj. protected abstract PSProperty DoGetProperty(object obj, string propertyName); /// /// Retrieves all the properties available in the object. /// - /// object to get all the property information from - /// collection where the properties will be added + /// object to get all the property information from. + /// collection where the properties will be added. protected abstract void DoAddAllProperties(object obj, PSMemberInfoInternalCollection members) where T : PSMemberInfo; /// /// Returns null if memberName is not a member in the adapter or /// the corresponding PSMemberInfo /// - /// object to retrieve the PSMemberInfo from - /// name of the member to be retrieved + /// object to retrieve the PSMemberInfo from. + /// name of the member to be retrieved. /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { @@ -4814,7 +4814,7 @@ protected override T GetMember(object obj, string memberName) /// In the case of the DirectoryEntry adapter, this could be a cache of the objectClass /// to the properties available in it. /// - /// object to get all the member information from + /// object to get all the member information from. /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { @@ -4855,7 +4855,7 @@ internal class XmlNodeAdapter : PropertyOnlyAdapter /// /// Returns the TypeNameHierarchy out of an object /// - /// object to get the TypeNameHierarchy from + /// object to get the TypeNameHierarchy from. protected override IEnumerable GetTypeNameHierarchy(object obj) { XmlNode node = (XmlNode)obj; @@ -4891,8 +4891,8 @@ protected override IEnumerable GetTypeNameHierarchy(object obj) /// /// Retrieves all the properties available in the object. /// - /// object to get all the property information from - /// collection where the members will be added + /// object to get all the property information from. + /// collection where the members will be added. protected override void DoAddAllProperties(object obj, PSMemberInfoInternalCollection members) { XmlNode node = (XmlNode)obj; @@ -4945,8 +4945,8 @@ protected override void DoAddAllProperties(object obj, PSMemberInfoInternalCo /// the corresponding PSProperty with its adapterData set to information /// to be used when retrieving the property. /// - /// object to retrieve the PSProperty from - /// name of the property to be retrieved + /// object to retrieve the PSProperty from. + /// name of the property to be retrieved. /// The PSProperty corresponding to propertyName from obj. protected override PSProperty DoGetProperty(object obj, string propertyName) { @@ -4962,7 +4962,7 @@ protected override PSProperty DoGetProperty(object obj, string propertyName) /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { @@ -5007,7 +5007,7 @@ protected override bool PropertyIsSettable(PSProperty property) /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { @@ -5055,7 +5055,7 @@ private static object GetNodeObject(XmlNode node) /// /// Returns the value from a property coming from a previous call to DoGetProperty /// - /// PSProperty coming from a previous call to DoGetProperty + /// PSProperty coming from a previous call to DoGetProperty. /// The value of the property. protected override object PropertyGet(PSProperty property) { @@ -5077,9 +5077,9 @@ protected override object PropertyGet(PSProperty property) /// /// Sets the value of a property coming from a previous call to DoGetProperty /// - /// PSProperty coming from a previous call to DoGetProperty - /// value to set the property with - /// instructs the adapter to convert before setting, if the adapter supports conversion + /// PSProperty coming from a previous call to DoGetProperty. + /// value to set the property with. + /// instructs the adapter to convert before setting, if the adapter supports conversion. protected override void PropertySet(PSProperty property, object setValue, bool convertIfPossible) { // XML is always a string so implicitly convert to string @@ -5141,8 +5141,8 @@ protected override void PropertySet(PSProperty property, object setValue, bool c /// /// Returns the name of the type corresponding to the property /// - /// PSProperty obtained in a previous DoGetProperty - /// True if the result is for display purposes only + /// PSProperty obtained in a previous DoGetProperty. + /// True if the result is for display purposes only. /// The name of the type corresponding to the property. protected override string PropertyType(PSProperty property, bool forDisplay) { @@ -5164,9 +5164,9 @@ protected override string PropertyType(PSProperty property, bool forDisplay) /// Auxiliary in GetProperty to perform case sensitive and case insensitive searches /// in the child nodes /// - /// XmlNode to extract property from - /// property to look for - /// type pf comparison to perform + /// XmlNode to extract property from. + /// property to look for. + /// type pf comparison to perform. /// The corresponding XmlNode or null if not present. private static XmlNode[] FindNodes(object obj, string propertyName, StringComparison comparisonType) { @@ -5211,8 +5211,8 @@ internal class DataRowAdapter : PropertyOnlyAdapter /// /// Retrieves all the properties available in the object. /// - /// object to get all the property information from - /// collection where the members will be added + /// object to get all the property information from. + /// collection where the members will be added. protected override void DoAddAllProperties(object obj, PSMemberInfoInternalCollection members) { DataRow dataRow = (DataRow)obj; @@ -5233,8 +5233,8 @@ protected override void DoAddAllProperties(object obj, PSMemberInfoInternalCo /// the corresponding PSProperty with its adapterData set to information /// to be used when retrieving the property. /// - /// object to retrieve the PSProperty from - /// name of the property to be retrieved + /// object to retrieve the PSProperty from. + /// name of the property to be retrieved. /// The PSProperty corresponding to propertyName from obj. protected override PSProperty DoGetProperty(object obj, string propertyName) { @@ -5252,8 +5252,8 @@ protected override PSProperty DoGetProperty(object obj, string propertyName) /// /// Returns the name of the type corresponding to the property /// - /// PSProperty obtained in a previous DoGetProperty - /// True if the result is for display purposes only + /// PSProperty obtained in a previous DoGetProperty. + /// True if the result is for display purposes only. /// The name of the type corresponding to the property. protected override string PropertyType(PSProperty property, bool forDisplay) { @@ -5266,7 +5266,7 @@ protected override string PropertyType(PSProperty property, bool forDisplay) /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { @@ -5278,7 +5278,7 @@ protected override bool PropertyIsSettable(PSProperty property) /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { @@ -5288,7 +5288,7 @@ protected override bool PropertyIsGettable(PSProperty property) /// /// Returns the value from a property coming from a previous call to DoGetProperty /// - /// PSProperty coming from a previous call to DoGetProperty + /// PSProperty coming from a previous call to DoGetProperty. /// The value of the property. protected override object PropertyGet(PSProperty property) { @@ -5298,9 +5298,9 @@ protected override object PropertyGet(PSProperty property) /// /// Sets the value of a property coming from a previous call to DoGetProperty /// - /// PSProperty coming from a previous call to DoGetProperty - /// value to set the property with - /// instructs the adapter to convert before setting, if the adapter supports conversion + /// PSProperty coming from a previous call to DoGetProperty. + /// value to set the property with. + /// instructs the adapter to convert before setting, if the adapter supports conversion. protected override void PropertySet(PSProperty property, object setValue, bool convertIfPossible) { DataRow dataRow = (DataRow)property.baseObject; @@ -5318,8 +5318,8 @@ internal class DataRowViewAdapter : PropertyOnlyAdapter /// /// Retrieves all the properties available in the object. /// - /// object to get all the property information from - /// collection where the members will be added + /// object to get all the property information from. + /// collection where the members will be added. protected override void DoAddAllProperties(object obj, PSMemberInfoInternalCollection members) { DataRowView dataRowView = (DataRowView)obj; @@ -5340,8 +5340,8 @@ protected override void DoAddAllProperties(object obj, PSMemberInfoInternalCo /// the corresponding PSProperty with its adapterData set to information /// to be used when retrieving the property. /// - /// object to retrieve the PSProperty from - /// name of the property to be retrieved + /// object to retrieve the PSProperty from. + /// name of the property to be retrieved. /// The PSProperty corresponding to propertyName from obj. protected override PSProperty DoGetProperty(object obj, string propertyName) { @@ -5359,8 +5359,8 @@ protected override PSProperty DoGetProperty(object obj, string propertyName) /// /// Returns the name of the type corresponding to the property /// - /// PSProperty obtained in a previous DoGetProperty - /// True if the result is for display purposes only + /// PSProperty obtained in a previous DoGetProperty. + /// True if the result is for display purposes only. /// The name of the type corresponding to the property. protected override string PropertyType(PSProperty property, bool forDisplay) { @@ -5373,7 +5373,7 @@ protected override string PropertyType(PSProperty property, bool forDisplay) /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { @@ -5385,7 +5385,7 @@ protected override bool PropertyIsSettable(PSProperty property) /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { @@ -5395,7 +5395,7 @@ protected override bool PropertyIsGettable(PSProperty property) /// /// Returns the value from a property coming from a previous call to DoGetProperty /// - /// PSProperty coming from a previous call to DoGetProperty + /// PSProperty coming from a previous call to DoGetProperty. /// The value of the property. protected override object PropertyGet(PSProperty property) { @@ -5405,9 +5405,9 @@ protected override object PropertyGet(PSProperty property) /// /// Sets the value of a property coming from a previous call to DoGetProperty /// - /// PSProperty coming from a previous call to DoGetProperty - /// value to set the property with - /// instructs the adapter to convert before setting, if the adapter supports conversion + /// PSProperty coming from a previous call to DoGetProperty. + /// value to set the property with. + /// instructs the adapter to convert before setting, if the adapter supports conversion. protected override void PropertySet(PSProperty property, object setValue, bool convertIfPossible) { DataRowView dataRowView = (DataRowView)property.baseObject; diff --git a/src/System.Management.Automation/engine/DefaultCommandRuntime.cs b/src/System.Management.Automation/engine/DefaultCommandRuntime.cs index 09e7fd21bd4..f3b35b9dc8b 100644 --- a/src/System.Management.Automation/engine/DefaultCommandRuntime.cs +++ b/src/System.Management.Automation/engine/DefaultCommandRuntime.cs @@ -35,7 +35,7 @@ public DefaultCommandRuntime(List outputList) /// /// Implementation of WriteDebug - just discards the input. /// - /// Text to write + /// Text to write. public void WriteDebug(string text) {; } /// @@ -43,7 +43,7 @@ public DefaultCommandRuntime(List outputList) /// an exception then that exception will be thrown. If not, then an /// InvalidOperationException will be constructed and thrown. /// - /// Error record instance to process + /// Error record instance to process. public void WriteError(ErrorRecord errorRecord) { if (errorRecord.Exception != null) @@ -56,7 +56,7 @@ public void WriteError(ErrorRecord errorRecord) /// Default implementation of WriteObject - adds the object to the list /// passed to the objects constructor. /// - /// Object to write + /// Object to write. public void WriteObject(object sendToPipeline) { _output.Add(sendToPipeline); @@ -66,7 +66,7 @@ public void WriteObject(object sendToPipeline) /// Default implementation of the enumerated WriteObject. Either way, the /// objects are added to the list passed to this object in the constuctor. /// - /// Object to write + /// Object to write. /// If true, the collection is enumerated, otherwise /// it's written as a scalar. /// @@ -102,7 +102,7 @@ public void WriteObject(object sendToPipeline, bool enumerateCollection) /// /// Default implementation - just discards it's arguments /// - /// Source ID to write for + /// Source ID to write for. /// record to write. public void WriteProgress(Int64 sourceId, ProgressRecord progressRecord) {; } @@ -136,63 +136,63 @@ public void WriteObject(object sendToPipeline, bool enumerateCollection) /// /// Default implementation - always returns true. /// - /// ignored + /// ignored. /// True. public bool ShouldProcess(string target) { return true; } /// /// Default implementation - always returns true. /// - /// ignored - /// ignored + /// ignored. + /// ignored. /// True. public bool ShouldProcess(string target, string action) { return true; } /// /// Default implementation - always returns true. /// - /// ignored - /// ignored - /// ignored + /// ignored. + /// ignored. + /// ignored. /// True. public bool ShouldProcess(string verboseDescription, string verboseWarning, string caption) { return true; } /// /// Default implementation - always returns true. /// - /// ignored - /// ignored - /// ignored - /// ignored + /// ignored. + /// ignored. + /// ignored. + /// ignored. /// True. public bool ShouldProcess(string verboseDescription, string verboseWarning, string caption, out ShouldProcessReason shouldProcessReason) { shouldProcessReason = ShouldProcessReason.None; return true; } /// /// Default implementation - always returns true. /// - /// ignored - /// ignored + /// ignored. + /// ignored. /// True. public bool ShouldContinue(string query, string caption) { return true; } /// /// Default implementation - always returns true. /// - /// ignored - /// ignored - /// ignored - /// ignored + /// ignored. + /// ignored. + /// ignored. + /// ignored. /// True. public bool ShouldContinue(string query, string caption, ref bool yesToAll, ref bool noToAll) { return true; } /// /// Default implementation - always returns true. /// - /// ignored - /// ignored - /// ignored - /// ignored - /// ignored + /// ignored. + /// ignored. + /// ignored. + /// ignored. + /// ignored. /// True. public bool ShouldContinue(string query, string caption, bool hasSecurityImpact, ref bool yesToAll, ref bool noToAll) { return true; } @@ -228,7 +228,7 @@ public PSTransactionContext CurrentPSTransaction /// does what the base implementation does anyway - rethrow the exception /// if it exists, otherwise throw an invalid operation exception. /// - /// The error record to throw + /// The error record to throw. public void ThrowTerminatingError(ErrorRecord errorRecord) { if (errorRecord.Exception != null) diff --git a/src/System.Management.Automation/engine/DscResourceInfo.cs b/src/System.Management.Automation/engine/DscResourceInfo.cs index 22847667147..7f4efc7a698 100644 --- a/src/System.Management.Automation/engine/DscResourceInfo.cs +++ b/src/System.Management.Automation/engine/DscResourceInfo.cs @@ -101,7 +101,7 @@ internal DscResourceInfo(string name, string friendlyName, string path, string p /// /// Updates properties of the resource /// - /// Updated properties + /// Updated properties. public void UpdateProperties(IList properties) { if (properties != null) @@ -160,4 +160,4 @@ internal void UpdateValues(IList values) this.Values = new ReadOnlyCollection(values); } } -} \ No newline at end of file +} diff --git a/src/System.Management.Automation/engine/ErrorPackage.cs b/src/System.Management.Automation/engine/ErrorPackage.cs index c6c6cd7da75..daa5a258177 100644 --- a/src/System.Management.Automation/engine/ErrorPackage.cs +++ b/src/System.Management.Automation/engine/ErrorPackage.cs @@ -383,7 +383,7 @@ public string GetMessage() /// concise text description based on /// /// - /// Culture in which to display message + /// Culture in which to display message. /// Concise text description. /// /// GetMessage returns a concise string which categorizes the error, @@ -474,8 +474,8 @@ public override string ToString() /// strings longer than 40 characters and ellipsize them to /// the first and last 19 characters plus "..." in the middle. /// - /// culture to retrieve template if needed - /// original string + /// culture to retrieve template if needed. + /// original string. /// Ellipsized version of string. /// /// "Please do not make this public as ellipsize is not a word." @@ -540,7 +540,7 @@ public ErrorDetails(string message) /// Creates an instance of ErrorDetails specifying a Message. /// This variant is used by cmdlets. /// - /// cmdlet containing the template string + /// cmdlet containing the template string. /// by default, the /// /// name @@ -691,8 +691,8 @@ internal ErrorDetails(ErrorDetails errorDetails) /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected ErrorDetails(SerializationInfo info, StreamingContext context) @@ -705,8 +705,8 @@ protected ErrorDetails(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public virtual void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -1025,8 +1025,8 @@ public ErrorRecord( /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. /// /// ErrorRecord instances which are serialized using @@ -1043,8 +1043,8 @@ protected ErrorRecord(SerializationInfo info, /// /// Deserializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public virtual void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -1369,7 +1369,7 @@ private void ConstructFromPSObjectForRemoting(PSObject serializedErrorRecord) /// exception which already has an ErrorRecord /// ErrorCategoryInfo and ErrorDetails are deep-copied, other fields are not. /// - /// wrapped ErrorRecord + /// wrapped ErrorRecord. /// /// If the wrapped exception contains a ParentContainsErrorRecordException, the new /// ErrorRecord should have this exception as its Exception instead. @@ -1841,8 +1841,8 @@ public interface IResourceSupplier /// to generate the final error message in /// . /// - /// the base resource name - /// the resource id + /// the base resource name. + /// the resource id. /// The error message template string corresponding to baseName and resourceId. string GetResourceString(string baseName, string resourceId); } diff --git a/src/System.Management.Automation/engine/EventManager.cs b/src/System.Management.Automation/engine/EventManager.cs index 8b77ca5ba94..759b4d24754 100644 --- a/src/System.Management.Automation/engine/EventManager.cs +++ b/src/System.Management.Automation/engine/EventManager.cs @@ -1576,8 +1576,8 @@ internal class PSRemoteEventManager : PSEventManager /// /// Creates an event manager for the given runspace /// - /// Computer on which the event was generated - /// Runspace on which the event was generated + /// Computer on which the event was generated. + /// Runspace on which the event was generated. internal PSRemoteEventManager(string computerName, Guid runspaceId) { _computerName = computerName; @@ -2179,7 +2179,7 @@ internal class PSEventArgs : EventArgs /// /// Class constructor /// - /// event arguments + /// event arguments. public PSEventArgs(T args) { Args = args; diff --git a/src/System.Management.Automation/engine/ExecutionContext.cs b/src/System.Management.Automation/engine/ExecutionContext.cs index eb0f0d9a170..5ad60ba553a 100644 --- a/src/System.Management.Automation/engine/ExecutionContext.cs +++ b/src/System.Management.Automation/engine/ExecutionContext.cs @@ -677,7 +677,7 @@ internal HelpSystem HelpSystem /// /// Routine to create a command(processor) instance using the factory. /// - /// The name of the command to lookup + /// The name of the command to lookup. /// /// The command processor object. internal CommandProcessorBase CreateCommand(string command, bool dotSource) @@ -1422,8 +1422,8 @@ internal static Assembly LoadAssembly(string name, string filename, out Exceptio /// /// Report an initialization-time error. /// - /// resource string - /// arguments + /// resource string. + /// arguments. internal void ReportEngineStartupError(string resourceString, params object[] arguments) { try @@ -1453,7 +1453,7 @@ internal void ReportEngineStartupError(string resourceString, params object[] ar /// /// Report an initialization-time error /// - /// error to report + /// error to report. internal void ReportEngineStartupError(string error) { try @@ -1640,8 +1640,8 @@ private void InitializeCommon(AutomationEngine engine, PSHost hostInterface) /// with LoadFrom, which are in a different loaded context than Load, can still be used to /// resolve types. /// - /// The event sender - /// The event args + /// The event sender. + /// The event args. /// The resolve assembly or null if not found. private static Assembly PowerShellAssemblyResolveHandler(object sender, ResolveEventArgs args) { diff --git a/src/System.Management.Automation/engine/ExtendedTypeSystemException.cs b/src/System.Management.Automation/engine/ExtendedTypeSystemException.cs index ed7ab526d98..dbdbd5d5c12 100644 --- a/src/System.Management.Automation/engine/ExtendedTypeSystemException.cs +++ b/src/System.Management.Automation/engine/ExtendedTypeSystemException.cs @@ -25,7 +25,7 @@ public ExtendedTypeSystemException() : base(typeof(ExtendedTypeSystemException). /// /// Initializes a new instance of ExtendedTypeSystemException setting the message /// - /// the exception's message + /// the exception's message. public ExtendedTypeSystemException(string message) : base(message) { } @@ -33,8 +33,8 @@ public ExtendedTypeSystemException(string message) : base(message) /// /// Initializes a new instance of ExtendedTypeSystemException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public ExtendedTypeSystemException(string message, Exception innerException) : base(message, innerException) { } @@ -42,10 +42,10 @@ public ExtendedTypeSystemException(string message, Exception innerException) : b /// /// Recommended constructor for the class /// - /// String that uniquely identifies each thrown Exception - /// The inner exception, null for none - /// Resource string - /// Arguments to the resource string + /// String that uniquely identifies each thrown Exception. + /// The inner exception, null for none. + /// Resource string. + /// Arguments to the resource string. internal ExtendedTypeSystemException(string errorId, Exception innerException, string resourceString, params object[] arguments) : base(StringUtil.Format(resourceString, arguments), innerException) @@ -57,8 +57,8 @@ internal ExtendedTypeSystemException(string errorId, Exception innerException, s /// /// Initializes a new instance of ExtendedTypeSystemException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected ExtendedTypeSystemException(SerializationInfo info, StreamingContext context) : base(info, context) { @@ -93,7 +93,7 @@ public MethodException() : base(typeof(MethodException).FullName) /// /// Initializes a new instance of MethodException setting the message /// - /// the exception's message + /// the exception's message. public MethodException(string message) : base(message) { } @@ -101,8 +101,8 @@ public MethodException(string message) : base(message) /// /// Initializes a new instance of MethodException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public MethodException(string message, Exception innerException) : base(message, innerException) { } @@ -110,10 +110,10 @@ public MethodException(string message, Exception innerException) : base(message, /// /// Recommended constructor for the class /// - /// String that uniquely identifies each thrown Exception - /// The inner exception - /// Resource String - /// Arguments to the resource string + /// String that uniquely identifies each thrown Exception. + /// The inner exception. + /// Resource String. + /// Arguments to the resource string. internal MethodException(string errorId, Exception innerException, string resourceString, params object[] arguments) : base(errorId, innerException, resourceString, arguments) @@ -124,8 +124,8 @@ internal MethodException(string errorId, Exception innerException, /// /// Initializes a new instance of MethodException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected MethodException(SerializationInfo info, StreamingContext context) : base(info, context) { @@ -158,7 +158,7 @@ public MethodInvocationException() : base(typeof(MethodInvocationException).Full /// /// Initializes a new instance of MethodInvocationException setting the message /// - /// the exception's message + /// the exception's message. public MethodInvocationException(string message) : base(message) { } @@ -166,8 +166,8 @@ public MethodInvocationException(string message) : base(message) /// /// Initializes a new instance of MethodInvocationException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public MethodInvocationException(string message, Exception innerException) : base(message, innerException) { } @@ -175,10 +175,10 @@ public MethodInvocationException(string message, Exception innerException) : bas /// /// Recommended constructor for the class /// - /// String that uniquely identifies each thrown Exception - /// The inner exception - /// Resource String - /// Arguments to the resource string + /// String that uniquely identifies each thrown Exception. + /// The inner exception. + /// Resource String. + /// Arguments to the resource string. internal MethodInvocationException(string errorId, Exception innerException, string resourceString, params object[] arguments) : base(errorId, innerException, resourceString, arguments) @@ -189,8 +189,8 @@ internal MethodInvocationException(string errorId, Exception innerException, /// /// Initializes a new instance of MethodInvocationException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected MethodInvocationException(SerializationInfo info, StreamingContext context) : base(info, context) { @@ -221,7 +221,7 @@ public GetValueException() : base(typeof(GetValueException).FullName) /// /// Initializes a new instance of GetValueException setting the message /// - /// the exception's message + /// the exception's message. public GetValueException(string message) : base(message) { } @@ -229,8 +229,8 @@ public GetValueException(string message) : base(message) /// /// Initializes a new instance of GetValueException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public GetValueException(string message, Exception innerException) : base(message, innerException) { } @@ -238,10 +238,10 @@ public GetValueException(string message, Exception innerException) : base(messag /// /// Recommended constructor for the class /// - /// String that uniquely identifies each thrown Exception - /// The inner exception - /// Resource String - /// Arguments to the resource string + /// String that uniquely identifies each thrown Exception. + /// The inner exception. + /// Resource String. + /// Arguments to the resource string. internal GetValueException(string errorId, Exception innerException, string resourceString, params object[] arguments) : base(errorId, innerException, resourceString, arguments) @@ -252,8 +252,8 @@ internal GetValueException(string errorId, Exception innerException, /// /// Initializes a new instance of GetValueException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected GetValueException(SerializationInfo info, StreamingContext context) : base(info, context) { @@ -283,7 +283,7 @@ public PropertyNotFoundException() /// /// Initializes a new instance of GetValueException setting the message /// - /// the exception's message + /// the exception's message. public PropertyNotFoundException(string message) : base(message) { @@ -292,8 +292,8 @@ public PropertyNotFoundException(string message) /// /// Initializes a new instance of GetValueException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public PropertyNotFoundException(string message, Exception innerException) : base(message, innerException) { @@ -302,10 +302,10 @@ public PropertyNotFoundException(string message, Exception innerException) /// /// Recommended constructor for the class /// - /// String that uniquely identifies each thrown Exception - /// The inner exception - /// Resource String - /// Arguments to the resource string + /// String that uniquely identifies each thrown Exception. + /// The inner exception. + /// Resource String. + /// Arguments to the resource string. internal PropertyNotFoundException(string errorId, Exception innerException, string resourceString, params object[] arguments) : base(errorId, innerException, resourceString, arguments) @@ -316,8 +316,8 @@ internal PropertyNotFoundException(string errorId, Exception innerException, /// /// Initializes a new instance of GetValueException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected PropertyNotFoundException(SerializationInfo info, StreamingContext context) : base(info, context) { @@ -348,7 +348,7 @@ public GetValueInvocationException() : base(typeof(GetValueInvocationException). /// /// Initializes a new instance of GetValueInvocationException setting the message /// - /// the exception's message + /// the exception's message. public GetValueInvocationException(string message) : base(message) { } @@ -356,8 +356,8 @@ public GetValueInvocationException(string message) : base(message) /// /// Initializes a new instance of GetValueInvocationException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public GetValueInvocationException(string message, Exception innerException) : base(message, innerException) { } @@ -365,10 +365,10 @@ public GetValueInvocationException(string message, Exception innerException) : b /// /// Recommended constructor for the class /// - /// String that uniquely identifies each thrown Exception - /// The inner exception - /// Resource String - /// Arguments to the resource string + /// String that uniquely identifies each thrown Exception. + /// The inner exception. + /// Resource String. + /// Arguments to the resource string. internal GetValueInvocationException(string errorId, Exception innerException, string resourceString, params object[] arguments) : base(errorId, innerException, resourceString, arguments) @@ -379,8 +379,8 @@ internal GetValueInvocationException(string errorId, Exception innerException, /// /// Initializes a new instance of GetValueInvocationException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected GetValueInvocationException(SerializationInfo info, StreamingContext context) : base(info, context) { @@ -409,7 +409,7 @@ public SetValueException() : base(typeof(SetValueException).FullName) /// /// Initializes a new instance of SetValueException setting the message /// - /// the exception's message + /// the exception's message. public SetValueException(string message) : base(message) { } @@ -417,8 +417,8 @@ public SetValueException(string message) : base(message) /// /// Initializes a new instance of SetValueException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public SetValueException(string message, Exception innerException) : base(message, innerException) { } @@ -426,10 +426,10 @@ public SetValueException(string message, Exception innerException) : base(messag /// /// Recommended constructor for the class /// - /// String that uniquely identifies each thrown Exception - /// The inner exception - /// Resource String - /// Arguments to the resource string + /// String that uniquely identifies each thrown Exception. + /// The inner exception. + /// Resource String. + /// Arguments to the resource string. internal SetValueException(string errorId, Exception innerException, string resourceString, params object[] arguments) : base(errorId, innerException, resourceString, arguments) @@ -440,8 +440,8 @@ internal SetValueException(string errorId, Exception innerException, /// /// Initializes a new instance of SetValueException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected SetValueException(SerializationInfo info, StreamingContext context) : base(info, context) { @@ -470,7 +470,7 @@ public SetValueInvocationException() : base(typeof(SetValueInvocationException). /// /// Initializes a new instance of SetValueInvocationException setting the message /// - /// the exception's message + /// the exception's message. public SetValueInvocationException(string message) : base(message) { } @@ -478,8 +478,8 @@ public SetValueInvocationException(string message) : base(message) /// /// Initializes a new instance of SetValueInvocationException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public SetValueInvocationException(string message, Exception innerException) : base(message, innerException) { } @@ -487,10 +487,10 @@ public SetValueInvocationException(string message, Exception innerException) : b /// /// Recommended constructor for the class /// - /// String that uniquely identifies each thrown Exception - /// The inner exception - /// Resource String - /// Arguments to the resource string + /// String that uniquely identifies each thrown Exception. + /// The inner exception. + /// Resource String. + /// Arguments to the resource string. internal SetValueInvocationException(string errorId, Exception innerException, string resourceString, params object[] arguments) : base(errorId, innerException, resourceString, arguments) @@ -501,8 +501,8 @@ internal SetValueInvocationException(string errorId, Exception innerException, /// /// Initializes a new instance of SetValueInvocationException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected SetValueInvocationException(SerializationInfo info, StreamingContext context) : base(info, context) { @@ -541,8 +541,8 @@ public override void GetObjectData(SerializationInfo info, StreamingContext cont /// /// Initializes a new instance of PSInvalidCastException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected PSInvalidCastException(SerializationInfo info, StreamingContext context) : base(info, context) { _errorId = info.GetString("ErrorId"); @@ -560,15 +560,15 @@ public PSInvalidCastException() : base(typeof(PSInvalidCastException).FullName) /// /// Initializes a new instance of PSInvalidCastException setting the message /// - /// the exception's message + /// the exception's message. public PSInvalidCastException(string message) : base(message) { } /// /// Initializes a new instance of PSInvalidCastException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public PSInvalidCastException(string message, Exception innerException) : base(message, innerException) { } diff --git a/src/System.Management.Automation/engine/ExtraAdapter.cs b/src/System.Management.Automation/engine/ExtraAdapter.cs index 3209d33157e..301bd17be40 100644 --- a/src/System.Management.Automation/engine/ExtraAdapter.cs +++ b/src/System.Management.Automation/engine/ExtraAdapter.cs @@ -39,8 +39,8 @@ internal override bool CanSiteBinderOptimize(MemberTypes typeToOperateOn) /// Returns null if memberName is not a member in the adapter or /// the corresponding PSMemberInfo /// - /// object to retrieve the PSMemberInfo from - /// name of the member to be retrieved + /// object to retrieve the PSMemberInfo from. + /// name of the member to be retrieved. /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { @@ -132,7 +132,7 @@ protected override T GetMember(object obj, string memberName) /// In the case of the DirectoryEntry adapter, this could be a cache of the objectClass /// to the properties available in it. /// - /// object to get all the member information from + /// object to get all the member information from. /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { @@ -175,7 +175,7 @@ protected override PSMemberInfoInternalCollection GetMembers(object obj) /// /// Returns the value from a property coming from a previous call to GetMember /// - /// PSProperty coming from a previous call to GetMember + /// PSProperty coming from a previous call to GetMember. /// The value of the property. protected override object PropertyGet(PSProperty property) { @@ -185,9 +185,9 @@ protected override object PropertyGet(PSProperty property) /// /// Sets the value of a property coming from a previous call to GetMember /// - /// PSProperty coming from a previous call to GetMember - /// value to set the property with - /// instructs the adapter to convert before setting, if the adapter supports conversion + /// PSProperty coming from a previous call to GetMember. + /// value to set the property with. + /// instructs the adapter to convert before setting, if the adapter supports conversion. protected override void PropertySet(PSProperty property, object setValue, bool convertIfPossible) { PropertyValueCollection values = property.adapterData as PropertyValueCollection; @@ -253,7 +253,7 @@ protected override void PropertySet(PSProperty property, object setValue, bool c /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { @@ -263,7 +263,7 @@ protected override bool PropertyIsSettable(PSProperty property) /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { @@ -273,8 +273,8 @@ protected override bool PropertyIsGettable(PSProperty property) /// /// Returns the name of the type corresponding to the property's value /// - /// PSProperty obtained in a previous GetMember - /// True if the result is for display purposes only + /// PSProperty obtained in a previous GetMember. + /// True if the result is for display purposes only. /// The name of the type corresponding to the member. protected override string PropertyType(PSProperty property, bool forDisplay) { @@ -304,8 +304,8 @@ protected override object MethodInvoke(PSMethod method, PSMethodInvocationConstr /// Called after a non null return from GetMember to try to call /// the method with the arguments /// - /// the non empty return from GetMethods - /// the arguments to use + /// the non empty return from GetMethods. + /// the arguments to use. /// The return value for the method. protected override object MethodInvoke(PSMethod method, object[] arguments) { diff --git a/src/System.Management.Automation/engine/ICommandRuntime.cs b/src/System.Management.Automation/engine/ICommandRuntime.cs index cbec4995892..537c0ff0863 100644 --- a/src/System.Management.Automation/engine/ICommandRuntime.cs +++ b/src/System.Management.Automation/engine/ICommandRuntime.cs @@ -31,7 +31,7 @@ public interface ICommandRuntime /// /// Display debug information /// - /// debug output + /// debug output. /// /// This API is called by the cmdlet to display debug information on the inner workings /// of the Cmdlet. An implementation of this interface should display this information in @@ -51,7 +51,7 @@ public interface ICommandRuntime /// a /// rather than the real exception. /// - /// error + /// error. void WriteError(ErrorRecord errorRecord); /// @@ -88,7 +88,7 @@ public interface ICommandRuntime /// /// Called by the cmdlet to display progress information /// - /// progress information + /// progress information. /// /// Use WriteProgress to display progress information about /// the activity of your Task, when the operation of your Task @@ -126,7 +126,7 @@ public interface ICommandRuntime /// /// Called when the cmdlet want to display verbose information /// - /// verbose output + /// verbose output. /// /// Cmdlets use WriteVerbose to display more detailed information about /// the activity of the Cmdlet. By default, verbose output will @@ -146,7 +146,7 @@ public interface ICommandRuntime /// /// Called by the cmdlet to display warning information /// - /// warning output + /// warning output. /// /// Use WriteWarning to display warnings about /// the activity of your Cmdlet. By default, warning output will @@ -166,7 +166,7 @@ public interface ICommandRuntime /// /// Write text into pipeline execution log. /// - /// text to be written to log + /// text to be written to log. /// /// Use WriteCommandDetail to write important information about cmdlet execution to /// pipeline execution log. diff --git a/src/System.Management.Automation/engine/InformationRecord.cs b/src/System.Management.Automation/engine/InformationRecord.cs index 4c41e29fba6..621c26e9330 100644 --- a/src/System.Management.Automation/engine/InformationRecord.cs +++ b/src/System.Management.Automation/engine/InformationRecord.cs @@ -22,7 +22,7 @@ public class InformationRecord /// Initializes a new instance of the InformationRecord class. /// /// The object to be transmitted to the host. - /// The source of the message (i.e.: script path, function name, etc.) + /// The source of the message (i.e.: script path, function name, etc.). public InformationRecord(Object messageData, string source) { this.MessageData = messageData; diff --git a/src/System.Management.Automation/engine/InitialSessionState.cs b/src/System.Management.Automation/engine/InitialSessionState.cs index b2304d1690d..cd74a44fc42 100644 --- a/src/System.Management.Automation/engine/InitialSessionState.cs +++ b/src/System.Management.Automation/engine/InitialSessionState.cs @@ -387,8 +387,8 @@ public sealed class SessionStateAssemblyEntry : InitialSessionStateEntry /// Create a named entry for the assembly to load with both the /// name and the path to the assembly as a backup. /// - /// The name of the assembly to load - /// The path to the assembly to use as an alternative + /// The name of the assembly to load. + /// The path to the assembly to use as an alternative. public SessionStateAssemblyEntry(string name, string fileName) : base(name) { @@ -399,7 +399,7 @@ public SessionStateAssemblyEntry(string name, string fileName) /// Create a named entry for the assembly to load, specifying /// just the name. /// - /// The name of the assembly to load + /// The name of the assembly to load. public SessionStateAssemblyEntry(string name) : base(name) { @@ -527,7 +527,7 @@ public sealed class SessionStateScriptEntry : SessionStateCommandEntry /// /// Create a session state command entry instance. /// - /// The path to the script + /// The path to the script. public SessionStateScriptEntry(string path) : base(path, SessionStateEntryVisibility.Public) { @@ -538,7 +538,7 @@ public SessionStateScriptEntry(string path) /// /// Create a session state command entry instance with the specified visibility. /// - /// The path to the script + /// The path to the script. /// Visibility of the script. internal SessionStateScriptEntry(string path, SessionStateEntryVisibility visibility) : base(path, visibility) @@ -673,7 +673,7 @@ public SessionStateApplicationEntry(string path) /// Used to define a permitted script in this session state. If the path is /// "*", then any path is permitted. /// - /// The full path to the application + /// The full path to the application. /// Sets the external visibility of the path. internal SessionStateApplicationEntry(string path, SessionStateEntryVisibility visibility) : base(path, visibility) @@ -706,10 +706,10 @@ public sealed class SessionStateFunctionEntry : SessionStateCommandEntry /// /// Represents a function definition in an Initial session state object. /// - /// The name of the function - /// The definition of the function - /// Options controlling scope-related elements of this object - /// The name of the help file associated with the function + /// The name of the function. + /// The definition of the function. + /// Options controlling scope-related elements of this object. + /// The name of the help file associated with the function. public SessionStateFunctionEntry(string name, string definition, ScopedItemOptions options, string helpFile) : base(name, SessionStateEntryVisibility.Public) { @@ -827,8 +827,8 @@ public sealed class SessionStateVariableEntry : ConstrainedSessionStateEntry /// then the clone will contain a reference to the original object /// not a clone of it. /// - /// The name of the variable - /// The value to set the variable to + /// The name of the variable. + /// The value to set the variable to. /// A descriptive string to attach to the variable. public SessionStateVariableEntry(string name, object value, string description) : base(name, SessionStateEntryVisibility.Public) @@ -843,8 +843,8 @@ public SessionStateVariableEntry(string name, object value, string description) /// then the clone will contain a reference to the original object /// not a clone of it. /// - /// The name of the variable - /// The value to set the variable to + /// The name of the variable. + /// The value to set the variable to. /// A descriptive string to attach to the variable. /// Options like readonly, constant, allscope, etc. public SessionStateVariableEntry(string name, object value, string description, ScopedItemOptions options) @@ -861,8 +861,8 @@ public SessionStateVariableEntry(string name, object value, string description, /// then the clone will contain a reference to the original object /// not a clone of it. /// - /// The name of the variable - /// The value to set the variable to + /// The name of the variable. + /// The value to set the variable to. /// A descriptive string to attach to the variable. /// Options like readonly, constant, allscope, etc. /// A list of attributes to attach to the variable. @@ -882,8 +882,8 @@ public SessionStateVariableEntry(string name, object value, string description, /// then the clone will contain a reference to the original object /// not a clone of it. /// - /// The name of the variable - /// The value to set the variable to + /// The name of the variable. + /// The value to set the variable to. /// A descriptive string to attach to the variable. /// Options like readonly, constant, allscope, etc. /// A single attribute to attach to the variable. @@ -904,8 +904,8 @@ public SessionStateVariableEntry(string name, object value, string description, /// then the clone will contain a reference to the original object /// not a clone of it. /// - /// The name of the variable - /// The value to set the variable to + /// The name of the variable. + /// The value to set the variable to. /// A descriptive string to attach to the variable. /// Options like readonly, constant, allscope, etc. /// A single attribute to attach to the variable. @@ -1145,7 +1145,7 @@ public void Clear() /// and the type hasn't been specified. /// BUGBUG - brucepay - the throw thing is not implemented yet... /// - /// The name of the element to remove + /// The name of the element to remove. /// The type of object to remove, can be null to remove any type. public void Remove(string name, object type) { @@ -1850,7 +1850,7 @@ public Microsoft.PowerShell.ExecutionPolicy ExecutionPolicy /// /// Add a list of modules to import when the runspace is created. /// - /// The modules to add + /// The modules to add. /// public void ImportPSModule(params string[] name) { @@ -2638,9 +2638,9 @@ private void ProcessCommandModifications(Runspace initializedRunspace) /// /// Process a command modification for a specific parameter. /// - /// The hashtable of command modifications for this command - /// The metadata for the command being processed - /// The parameter being modified + /// The hashtable of command modifications for this command. + /// The metadata for the command being processed. + /// The parameter being modified. private static void ProcessCommandModification(Hashtable commandModification, CommandMetadata metadata, string parameterName) { // If the metadata doesn't actually contain the parameter, then we need to create one. diff --git a/src/System.Management.Automation/engine/InternalCommands.cs b/src/System.Management.Automation/engine/InternalCommands.cs index 3b920a83e0b..1728611adef 100644 --- a/src/System.Management.Automation/engine/InternalCommands.cs +++ b/src/System.Management.Automation/engine/InternalCommands.cs @@ -202,9 +202,9 @@ public object[] ArgumentList /// /// Execute the begin scriptblock at the start of processing /// - /// could not parse script - /// see Pipeline.Invoke - /// see Pipeline.Invoke + /// could not parse script. + /// see Pipeline.Invoke. + /// see Pipeline.Invoke. protected override void BeginProcessing() { Dbg.Assert(ParameterSetName == "ScriptBlockSet" || ParameterSetName == "PropertyAndMethodSet", "ParameterSetName is neither 'ScriptBlockSet' nor 'PropertyAndMethodSet'"); @@ -283,9 +283,9 @@ protected override void BeginProcessing() /// Execute the processing script blocks on the current pipeline object /// which is passed as it's only parameter. /// - /// could not parse script - /// see Pipeline.Invoke - /// see Pipeline.Invoke + /// could not parse script. + /// see Pipeline.Invoke. + /// see Pipeline.Invoke. protected override void ProcessRecord() { Dbg.Assert(ParameterSetName == "ScriptBlockSet" || ParameterSetName == "PropertyAndMethodSet", "ParameterSetName is neither 'ScriptBlockSet' nor 'PropertyAndMethodSet'"); @@ -838,9 +838,9 @@ internal static ErrorRecord GenerateNameParameterError(string paraName, string r /// /// Execute the end scriptblock when the pipeline is complete /// - /// could not parse script - /// see Pipeline.Invoke - /// see Pipeline.Invoke + /// could not parse script. + /// see Pipeline.Invoke. + /// see Pipeline.Invoke. protected override void EndProcessing() { if (ParameterSetName != "ScriptBlockSet") return; @@ -1617,9 +1617,9 @@ protected override void BeginProcessing() /// Execute the script block passing in the current pipeline object as /// it's only parameter. /// - /// could not parse script - /// see Pipeline.Invoke - /// see Pipeline.Invoke + /// could not parse script. + /// see Pipeline.Invoke. + /// see Pipeline.Invoke. protected override void ProcessRecord() { if (_inputObject == AutomationNull.Value) diff --git a/src/System.Management.Automation/engine/LanguagePrimitives.cs b/src/System.Management.Automation/engine/LanguagePrimitives.cs index 683bfcaded1..9ceacbe0577 100644 --- a/src/System.Management.Automation/engine/LanguagePrimitives.cs +++ b/src/System.Management.Automation/engine/LanguagePrimitives.cs @@ -72,16 +72,16 @@ private static object GetSourceValueAsObject(PSObject sourceValue) /// /// Determines if the converter can convert the parameter to the parameter. /// - /// value supposedly *not* of the types supported by this converted to be converted to the parameter - /// one of the types supported by this converter to which the parameter should be converted + /// value supposedly *not* of the types supported by this converted to be converted to the parameter. + /// one of the types supported by this converter to which the parameter should be converted. /// True if the converter can convert the parameter to the parameter, otherwise false. public abstract bool CanConvertFrom(object sourceValue, Type destinationType); /// /// Determines if the converter can convert the parameter to the parameter. /// - /// value supposedly *not* of the types supported by this converted to be converted to the parameter - /// one of the types supported by this converter to which the parameter should be converted + /// value supposedly *not* of the types supported by this converted to be converted to the parameter. + /// one of the types supported by this converter to which the parameter should be converted. /// True if the converter can convert the parameter to the parameter, otherwise false. public virtual bool CanConvertFrom(PSObject sourceValue, Type destinationType) { @@ -91,23 +91,23 @@ public virtual bool CanConvertFrom(PSObject sourceValue, Type destinationType) /// /// Converts the parameter to the parameter using formatProvider and ignoreCase /// - /// value supposedly *not* of the types supported by this converted to be converted to the parameter - /// one of the types supported by this converter to which the parameter should be converted to - /// The format provider to use like in IFormattable's ToString - /// true if case should be ignored + /// value supposedly *not* of the types supported by this converted to be converted to the parameter. + /// one of the types supported by this converter to which the parameter should be converted to. + /// The format provider to use like in IFormattable's ToString. + /// true if case should be ignored. /// The parameter converted to the parameter using formatProvider and ignoreCase. - /// if no conversion was possible + /// if no conversion was possible. public abstract object ConvertFrom(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase); /// /// Converts the parameter to the parameter using formatProvider and ignoreCase /// - /// value supposedly *not* of the types supported by this converted to be converted to the parameter - /// one of the types supported by this converter to which the parameter should be converted to - /// The format provider to use like in IFormattable's ToString - /// true if case should be ignored + /// value supposedly *not* of the types supported by this converted to be converted to the parameter. + /// one of the types supported by this converter to which the parameter should be converted to. + /// The format provider to use like in IFormattable's ToString. + /// true if case should be ignored. /// The parameter converted to the parameter using formatProvider and ignoreCase. - /// if no conversion was possible + /// if no conversion was possible. public virtual object ConvertFrom(PSObject sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { return this.ConvertFrom(GetSourceValueAsObject(sourceValue), destinationType, formatProvider, ignoreCase); @@ -116,16 +116,16 @@ public virtual object ConvertFrom(PSObject sourceValue, Type destinationType, IF /// /// Returns true if the converter can convert the parameter to the parameter /// - /// value supposedly from one of the types supported by this converter to be converted to the parameter - /// type to convert the parameter, supposedly not one of the types supported by the converter + /// value supposedly from one of the types supported by this converter to be converted to the parameter. + /// type to convert the parameter, supposedly not one of the types supported by the converter. /// True if the converter can convert the parameter to the parameter, otherwise false. public abstract bool CanConvertTo(object sourceValue, Type destinationType); /// /// Returns true if the converter can convert the parameter to the parameter /// - /// value supposedly from one of the types supported by this converter to be converted to the parameter - /// type to convert the parameter, supposedly not one of the types supported by the converter + /// value supposedly from one of the types supported by this converter to be converted to the parameter. + /// type to convert the parameter, supposedly not one of the types supported by the converter. /// True if the converter can convert the parameter to the parameter, otherwise false. public virtual bool CanConvertTo(PSObject sourceValue, Type destinationType) { @@ -135,23 +135,23 @@ public virtual bool CanConvertTo(PSObject sourceValue, Type destinationType) /// /// Converts the parameter to the parameter using formatProvider and ignoreCase /// - /// value supposedly from one of the types supported by this converter to be converted to the parameter - /// type to convert the parameter, supposedly not one of the types supported by the converter - /// The format provider to use like in IFormattable's ToString - /// true if case should be ignored + /// value supposedly from one of the types supported by this converter to be converted to the parameter. + /// type to convert the parameter, supposedly not one of the types supported by the converter. + /// The format provider to use like in IFormattable's ToString. + /// true if case should be ignored. /// SourceValue converted to the parameter using formatProvider and ignoreCase. - /// if no conversion was possible + /// if no conversion was possible. public abstract object ConvertTo(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase); /// /// Converts the parameter to the parameter using formatProvider and ignoreCase /// - /// value supposedly from one of the types supported by this converter to be converted to the parameter - /// type to convert the parameter, supposedly not one of the types supported by the converter - /// The format provider to use like in IFormattable's ToString - /// true if case should be ignored + /// value supposedly from one of the types supported by this converter to be converted to the parameter. + /// type to convert the parameter, supposedly not one of the types supported by the converter. + /// The format provider to use like in IFormattable's ToString. + /// true if case should be ignored. /// SourceValue converted to the parameter using formatProvider and ignoreCase. - /// if no conversion was possible + /// if no conversion was possible. public virtual object ConvertTo(PSObject sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { return this.ConvertTo(GetSourceValueAsObject(sourceValue), destinationType, formatProvider, ignoreCase); @@ -171,8 +171,8 @@ public class ConvertThroughString : PSTypeConverter /// /// This will return false only if sourceValue is string /// - /// value to convert from - /// ignored + /// value to convert from. + /// ignored. /// False only if sourceValue is string. public override bool CanConvertFrom(object sourceValue, Type destinationType) { @@ -189,12 +189,12 @@ public override bool CanConvertFrom(object sourceValue, Type destinationType) /// Converts to destinationType by first converting sourceValue to string /// and then converting the result to destinationType. /// - /// The value to convert from - /// The type this converter is associated with - /// The IFormatProvider to use - /// true if case should be ignored + /// The value to convert from. + /// The type this converter is associated with. + /// The IFormatProvider to use. + /// true if case should be ignored. /// SourceValue converted to destinationType. - /// When no conversion was possible + /// When no conversion was possible. public override object ConvertFrom(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { string sourceAsString = (string)LanguagePrimitives.ConvertTo(sourceValue, typeof(string), formatProvider); @@ -205,8 +205,8 @@ public override object ConvertFrom(object sourceValue, Type destinationType, IFo /// Returns false, since this converter is not designed to be used to /// convert from the type associated with the converted to other types. /// - /// The value to convert from - /// The value to convert from + /// The value to convert from. + /// The value to convert from. /// False. public override bool CanConvertTo(object sourceValue, Type destinationType) { @@ -217,12 +217,12 @@ public override bool CanConvertTo(object sourceValue, Type destinationType) /// Throws NotSupportedException, since this converter is not designed to be used to /// convert from the type associated with the converted to other types. /// - /// The value to convert from - /// The value to convert from - /// The IFormatProvider to use - /// true if case should be ignored + /// The value to convert from. + /// The value to convert from. + /// The IFormatProvider to use. + /// true if case should be ignored. /// This method does not return a value. - /// NotSupportedException is always thrown + /// NotSupportedException is always thrown. public override object ConvertTo(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { throw PSTraceSource.NewNotSupportedException(); @@ -544,7 +544,7 @@ private static GetEnumerableDelegate CalculateGetEnumerable(Type objectType) /// /// IEnumerable or IEnumerable-like object /// - /// When the act of getting the enumerator throws an exception + /// When the act of getting the enumerator throws an exception. [SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "obj", Justification = "Since V1 code is already shipped, excluding this message for backward compatibility reasons.")] public static IEnumerator GetEnumerator(object obj) { @@ -586,8 +586,8 @@ public static PSDataCollection GetPSDataCollection(object inputValue) /// /// Used to compare two objects for equality converting the second to the type of the first, if required. /// - /// first object - /// object to compare first to + /// first object. + /// object to compare first to. /// True if first is equal to the second. public static new bool Equals(object first, object second) { @@ -597,8 +597,8 @@ public static PSDataCollection GetPSDataCollection(object inputValue) /// /// Used to compare two objects for equality converting the second to the type of the first, if required. /// - /// first object - /// object to compare first to + /// first object. + /// object to compare first to. /// used only if first and second are strings /// to specify the type of string comparison /// True if first is equal to the second. @@ -610,8 +610,8 @@ public static bool Equals(object first, object second, bool ignoreCase) /// /// Used to compare two objects for equality converting the second to the type of the first, if required. /// - /// first object - /// object to compare first to + /// first object. + /// object to compare first to. /// used only if first and second are strings /// to specify the type of string comparison /// the format/culture to be used. If this parameter is null, @@ -704,7 +704,7 @@ public static bool Equals(object first, object second, bool ignoreCase, IFormatP /// /// Helper method for [Try]Compare to determine object ordering with null. /// - /// the numeric value to compare to null + /// the numeric value to compare to null. /// True if the number to compare is on the right hand side if the comparison. private static int CompareObjectToNull(object value, bool numberIsRightHandSide) { @@ -729,8 +729,8 @@ private static int CompareObjectToNull(object value, bool numberIsRightHandSide) /// Compare first and second, converting second to the /// type of the first, if necessary. /// - /// first comparison value - /// second comparison value + /// first comparison value. + /// second comparison value. /// Less than zero if first is smaller than second, more than /// zero if it is greater or zero if they are the same. /// @@ -746,9 +746,9 @@ public static int Compare(object first, object second) /// Compare first and second, converting second to the /// type of the first, if necessary. /// - /// first comparison value - /// second comparison value - /// Used if both values are strings + /// first comparison value. + /// second comparison value. + /// Used if both values are strings. /// Less than zero if first is smaller than second, more than /// zero if it is greater or zero if they are the same. /// @@ -764,10 +764,10 @@ public static int Compare(object first, object second, bool ignoreCase) /// Compare first and second, converting second to the /// type of the first, if necessary. /// - /// first comparison value - /// second comparison value - /// Used if both values are strings - /// Used in type conversions and if both values are strings + /// first comparison value. + /// second comparison value. + /// Used if both values are strings. + /// Used in type conversions and if both values are strings. /// Less than zero if first is smaller than second, more than /// zero if it is greater or zero if they are the same. /// @@ -979,7 +979,7 @@ public static bool TryCompare(object first, object second, bool ignoreCase, IFor /// /// Returns true if the language considers obj to be true /// - /// obj to verify if it is true + /// obj to verify if it is true. /// True if obj is true. [SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "obj", Justification = "Since V1 code is already shipped, excluding this message for backward compatibility reasons")] public static bool IsTrue(object obj) @@ -1061,7 +1061,7 @@ internal static bool IsTrue(IList objectArray) /// /// Internal routine that determines if an object meets any of our criteria for null. /// - /// The object to test + /// The object to test. /// True if the object is null. internal static bool IsNull(object obj) { @@ -1188,7 +1188,7 @@ internal static TypeCode GetTypeCode(Type type) /// the PSObject if required. /// /// The type for which to convert - /// The object from which to convert + /// The object from which to convert. /// An object of the specified type, if the conversion was successful. Returns null otherwise. internal static T FromObjectAs(Object castObject) { @@ -1263,7 +1263,7 @@ private enum TypeCodeTraits /// /// Verifies if type is a signed integer /// - /// type code to check + /// type code to check. /// True if type is a signed integer, false otherwise. internal static bool IsSignedInteger(TypeCode typeCode) { @@ -1273,7 +1273,7 @@ internal static bool IsSignedInteger(TypeCode typeCode) /// /// Verifies if type is an unsigned integer /// - /// type code to check + /// type code to check. /// True if type is an unsigned integer, false otherwise. internal static bool IsUnsignedInteger(TypeCode typeCode) { @@ -1283,7 +1283,7 @@ internal static bool IsUnsignedInteger(TypeCode typeCode) /// /// Verifies if type is integer /// - /// type code to check + /// type code to check. /// True if type is integer, false otherwise. internal static bool IsInteger(TypeCode typeCode) { @@ -1293,7 +1293,7 @@ internal static bool IsInteger(TypeCode typeCode) /// /// Verifies if type is a floating point number /// - /// type code to check + /// type code to check. /// True if type is floating point, false otherwise. internal static bool IsFloating(TypeCode typeCode) { @@ -1303,7 +1303,7 @@ internal static bool IsFloating(TypeCode typeCode) /// /// Verifies if type is an integer or floating point number /// - /// type code to check + /// type code to check. /// True if type is integer or floating point, false otherwise. internal static bool IsNumeric(TypeCode typeCode) { @@ -1313,7 +1313,7 @@ internal static bool IsNumeric(TypeCode typeCode) /// /// Verifies if type is a CIM intrinsic type /// - /// type code to check + /// type code to check. /// True if type is CIM intrinsic type, false otherwise. internal static bool IsCimIntrinsicScalarType(TypeCode typeCode) { @@ -1345,7 +1345,7 @@ internal static bool IsCimIntrinsicScalarType(Type type) /// /// Verifies if type is one of the boolean types /// - /// type to check + /// type to check. /// True if type is one of boolean types, false otherwise. internal static bool IsBooleanType(Type type) { @@ -1359,7 +1359,7 @@ internal static bool IsBooleanType(Type type) /// /// Verifies if type is one of switch parameter types /// - /// type to check + /// type to check. /// True if type is one of switch parameter types, false otherwise. internal static bool IsSwitchParameterType(Type type) { @@ -1372,7 +1372,7 @@ internal static bool IsSwitchParameterType(Type type) /// /// Verifies if type is one of boolean or switch parameter types /// - /// type to check + /// type to check. /// True if type if one of boolean or switch parameter types, /// false otherwise. internal static bool IsBoolOrSwitchParameterType(Type type) @@ -1393,8 +1393,8 @@ internal static bool IsBoolOrSwitchParameterType(Type type) /// need of conversion. /// /// The dictionary that potentially implement - /// The object representing the key - /// The value to assign + /// The object representing the key. + /// The value to assign. internal static void DoConversionsForSetInGenericDictionary(IDictionary dictionary, ref object key, ref object value) { foreach (Type i in dictionary.GetType().GetInterfaces()) @@ -1678,11 +1678,11 @@ public static string ConvertTypeNameToPSTypeName(string typeName) /// If any operation above throws an exception, this exception will be wrapped into a /// PSInvalidCastException and thrown resulting in no further conversion attempt. /// - /// value to be converted and returned - /// type to convert valueToConvert + /// value to be converted and returned. + /// type to convert valueToConvert. /// Converted value. - /// if resultType is null - /// if the conversion failed + /// if resultType is null. + /// if the conversion failed. public static object ConvertTo(object valueToConvert, Type resultType) { return ConvertTo(valueToConvert, resultType, true, CultureInfo.InvariantCulture, null); @@ -1733,12 +1733,12 @@ public static object ConvertTo(object valueToConvert, Type resultType) /// If any operation above throws an exception, this exception will be wrapped into a /// PSInvalidCastException and thrown resulting in no further conversion attempt. /// - /// value to be converted and returned - /// type to convert valueToConvert - /// To be used in custom type conversions, to call parse and to call Convert.ChangeType + /// value to be converted and returned. + /// type to convert valueToConvert. + /// To be used in custom type conversions, to call parse and to call Convert.ChangeType. /// Converted value. - /// if resultType is null - /// if the conversion failed + /// if resultType is null. + /// if the conversion failed. public static object ConvertTo(object valueToConvert, Type resultType, IFormatProvider formatProvider) { return ConvertTo(valueToConvert, resultType, true, formatProvider, null); @@ -1750,7 +1750,7 @@ public static object ConvertTo(object valueToConvert, Type resultType, IFormatPr /// value to be converted and returned. /// type to convert psobject. /// Indicates if inner properties have to be recursively converted. - /// To be used in custom type conversions, to call parse and to call Convert.ChangeType + /// To be used in custom type conversions, to call parse and to call Convert.ChangeType. /// Indicates if Unknown members in the psobject have to be ignored if the corresponding members in resultType do not exist. /// Converted value. public static object ConvertPSObjectToType(PSObject valueToConvert, Type resultType, bool recursion, IFormatProvider formatProvider, bool ignoreUnknownMembers) @@ -1787,7 +1787,7 @@ public static T ConvertTo(object valueToConvert) /// /// This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. /// - /// value to be converted and returned + /// value to be converted and returned. /// result of the conversion. This is valid only if the return is true. /// False for conversion failure, true for success. public static bool TryConvertTo(object valueToConvert, out T result) @@ -1807,8 +1807,8 @@ public static bool TryConvertTo(object valueToConvert, out T result) /// /// This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. /// - /// value to be converted and returned - /// governing conversion of types + /// value to be converted and returned. + /// governing conversion of types. /// result of the conversion. This is valid only if the return is true. /// False for conversion failure, true for success. public static bool TryConvertTo(object valueToConvert, IFormatProvider formatProvider, out T result) @@ -1830,8 +1830,8 @@ public static bool TryConvertTo(object valueToConvert, IFormatProvider format /// /// This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. /// - /// value to be converted and returned - /// type to convert valueToConvert + /// value to be converted and returned. + /// type to convert valueToConvert. /// result of the conversion. This is valid only if the return is true. /// False for conversion failure, true for success. public static bool TryConvertTo(object valueToConvert, Type resultType, out object result) @@ -1984,8 +1984,8 @@ public override bool CanConvertFrom(object sourceValue, Type destinationType) /// /// Checks if the enumValue is defined or not in enumType. /// - /// some enumeration - /// supposed to be an integer + /// some enumeration. + /// supposed to be an integer. /// /// private static bool IsDefinedEnum(object enumValue, Type enumType) @@ -2052,9 +2052,9 @@ private static bool IsDefinedEnum(object enumValue, Type enumType) /// Throws if the enumType enumeration has no negative values, but the enumValue is not /// defined in enumType. /// - /// some enumeration - /// supposed to be an integer - /// the error id to be used when throwing an exception + /// some enumeration. + /// supposed to be an integer. + /// the error id to be used when throwing an exception. internal static void ThrowForUndefinedEnum(string errorId, object enumValue, Type enumType) { ThrowForUndefinedEnum(errorId, enumValue, enumValue, enumType); @@ -2064,9 +2064,9 @@ internal static void ThrowForUndefinedEnum(string errorId, object enumValue, Typ /// Throws if the enumType enumeration has no negative values, but the enumValue is not /// defined in enumType. /// - /// The error id to be used when throwing an exception - /// value to validate - /// value to use while throwing an exception + /// The error id to be used when throwing an exception. + /// value to validate. + /// value to use while throwing an exception. /// the enum type to validate the enumValue with. /// /// is used by those callers who want the exception @@ -2251,10 +2251,10 @@ public override object ConvertTo(object sourceValue, Type destinationType, IForm /// different return type. Because of that we cannot call GetMethod since it would cause a /// AmbiguousMatchException. This auxiliary method calls GetMember to find the right method /// - /// Either op_Explicit or op_Implicit, at the moment - /// the type to look for an operator - /// Type of the only parameter the operator method should have - /// Return type of the operator method + /// Either op_Explicit or op_Implicit, at the moment. + /// the type to look for an operator. + /// Type of the only parameter the operator method should have. + /// Return type of the operator method. /// A cast operator method, or null if not found. private static MethodInfo FindCastOperator(string methodName, Type targetType, Type originalType, Type resultType) { @@ -4710,18 +4710,18 @@ internal static IConversionData FigureConversion(object valueToConvert, Type res /// /// - /// the same as in the public version - /// the same as in the public version - /// true if we should perform any recursive calls to ConvertTo - /// governing conversion of types + /// the same as in the public version. + /// the same as in the public version. + /// true if we should perform any recursive calls to ConvertTo. + /// governing conversion of types. /// /// Used by Remoting Rehydration Logic. While Deserializing a remote object, /// LocalPipeline.ExecutionContextFromTLS() might return null..In which case this /// TypeTable will be used to do the conversion. /// /// The value converted. - /// if resultType is null - /// if the conversion failed + /// if resultType is null. + /// if the conversion failed. internal static object ConvertTo(object valueToConvert, Type resultType, bool recursion, diff --git a/src/System.Management.Automation/engine/ManagementObjectAdapter.cs b/src/System.Management.Automation/engine/ManagementObjectAdapter.cs index ecaf177aae6..c73fd34b398 100644 --- a/src/System.Management.Automation/engine/ManagementObjectAdapter.cs +++ b/src/System.Management.Automation/engine/ManagementObjectAdapter.cs @@ -127,7 +127,7 @@ private IEnumerable GetTypeNameHierarchyFromDerivation(ManagementBaseObj /// /// Returns the TypeNameHierarchy out of an ManagementBaseObject /// - /// object to get the TypeNameHierarchy from + /// object to get the TypeNameHierarchy from. /// /// TypeName is of the format ObjectType#__Namespace\\__Class /// @@ -163,8 +163,8 @@ protected override IEnumerable GetTypeNameHierarchy(object obj) /// Returns null if memberName is not a member in the adapter or /// the corresponding PSMemberInfo /// - /// object to retrieve the PSMemberInfo from - /// name of the member to be retrieved + /// object to retrieve the PSMemberInfo from. + /// name of the member to be retrieved. /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { @@ -208,7 +208,7 @@ protected override T GetMember(object obj, string memberName) /// In the case of the DirectoryEntry adapter, this could be a cache of the objectClass /// to the properties available in it. /// - /// object to get all the member information from + /// object to get all the member information from. /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { @@ -226,8 +226,8 @@ protected override PSMemberInfoInternalCollection GetMembers(object obj) /// Called after a non null return from GetMember to try to call /// the method with the arguments /// - /// the non empty return from GetMethods - /// the arguments to use + /// the non empty return from GetMethods. + /// the arguments to use. /// The return value for the method. protected override object MethodInvoke(PSMethod method, object[] arguments) { @@ -243,7 +243,7 @@ protected override object MethodInvoke(PSMethod method, object[] arguments) /// /// Called after a non null return from GetMember to return the overloads /// - /// the return of GetMember + /// the return of GetMember. /// protected override Collection MethodDefinitions(PSMethod method) { @@ -257,7 +257,7 @@ protected override Collection MethodDefinitions(PSMethod method) /// /// Returns true if the property is settable /// - /// property to check + /// property to check. /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { @@ -293,7 +293,7 @@ protected override bool PropertyIsSettable(PSProperty property) /// /// Returns true if the property is gettable /// - /// property to check + /// property to check. /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { @@ -303,8 +303,8 @@ protected override bool PropertyIsGettable(PSProperty property) /// /// Returns the name of the type corresponding to the property /// - /// PSProperty obtained in a previous DoGetProperty - /// True if the result is for display purposes only + /// PSProperty obtained in a previous DoGetProperty. + /// True if the result is for display purposes only. /// The name of the type corresponding to the property. protected override string PropertyType(PSProperty property, bool forDisplay) { @@ -336,7 +336,7 @@ protected override string PropertyType(PSProperty property, bool forDisplay) /// /// Returns the value from a property coming from a previous call to DoGetProperty /// - /// PSProperty coming from a previous call to DoGetProperty + /// PSProperty coming from a previous call to DoGetProperty. /// The value of the property. protected override object PropertyGet(PSProperty property) { @@ -348,9 +348,9 @@ protected override object PropertyGet(PSProperty property) /// This method will only set the property on a particular instance. If you want /// to update the WMI store, call Put(). /// - /// PSProperty coming from a previous call to DoGetProperty - /// value to set the property with - /// instructs the adapter to convert before setting, if the adapter supports conversion + /// PSProperty coming from a previous call to DoGetProperty. + /// value to set the property with. + /// instructs the adapter to convert before setting, if the adapter supports conversion. protected override void PropertySet(PSProperty property, object setValue, bool convertIfPossible) { ManagementBaseObject mObj = property.baseObject as ManagementBaseObject; @@ -388,7 +388,7 @@ protected override void PropertySet(PSProperty property, object setValue, bool c /// /// Returns the string representation of the property in the object /// - /// property obtained in a previous GetMember + /// property obtained in a previous GetMember. /// The string representation of the property in the object. protected override string PropertyToString(PSProperty property) { @@ -419,7 +419,7 @@ protected override string PropertyToString(PSProperty property) /// /// Returns an array with the property attributes /// - /// property we want the attributes from + /// property we want the attributes from. /// An array with the property attributes. protected override AttributeCollection PropertyAttributes(PSProperty property) { @@ -546,7 +546,7 @@ private static ManagementClass CreateClassFrmObject(ManagementBaseObject mgmtBas /// /// Gets the object type associated with a CimType:object /// - /// PropertyData representing a parameter + /// PropertyData representing a parameter. /// /// typeof(object)#EmbeddedObjectTypeName if one found /// typeof(object) otherwise @@ -875,8 +875,8 @@ internal static string GetMethodDefinition(MethodData mData) /// /// Retrieves all the properties available in the object. /// - /// object to get all the property information from - /// collection where the members will be added + /// object to get all the property information from. + /// collection where the members will be added. protected abstract void AddAllProperties(ManagementBaseObject wmiObject, PSMemberInfoInternalCollection members) where T : PSMemberInfo; @@ -899,7 +899,7 @@ protected abstract object InvokeManagementMethod(ManagementObject wmiObject, /// /// PSMemberInfo /// Object for which the method is required. - /// Name of the method + /// Name of the method. /// /// PsMemberInfo if method exists. /// Null otherwise. @@ -912,8 +912,8 @@ protected abstract T GetManagementObjectMethod(ManagementBaseObject wmiObject /// the corresponding PSProperty with its adapterData set to information /// to be used when retrieving the property. /// - /// object to retrieve the PSProperty from - /// name of the property to be retrieved + /// object to retrieve the PSProperty from. + /// name of the property to be retrieved. /// The PSProperty corresponding to propertyName from obj. protected abstract PSProperty DoGetProperty(ManagementBaseObject wmiObject, string propertyName); diff --git a/src/System.Management.Automation/engine/MinishellParameterBinderController.cs b/src/System.Management.Automation/engine/MinishellParameterBinderController.cs index e2984a1377b..0d4ab38f55c 100644 --- a/src/System.Management.Automation/engine/MinishellParameterBinderController.cs +++ b/src/System.Management.Automation/engine/MinishellParameterBinderController.cs @@ -295,8 +295,8 @@ private void HandleSeenParameter(ref MinishellParameters seen, MinishellParamete /// /// This function processes the value for -inputFormat and -outputFormat parameter of minishell. /// - /// Name of the parameter for error messages. Value should be -inputFormat or -outputFormat - /// value to process + /// Name of the parameter for error messages. Value should be -inputFormat or -outputFormat. + /// value to process. /// Processed value. private string ProcessFormatParameterValue(string parameterName, object value) diff --git a/src/System.Management.Automation/engine/Modules/AnalysisCache.cs b/src/System.Management.Automation/engine/Modules/AnalysisCache.cs index fe4a4e2ff0a..f042c592926 100644 --- a/src/System.Management.Automation/engine/Modules/AnalysisCache.cs +++ b/src/System.Management.Automation/engine/Modules/AnalysisCache.cs @@ -445,7 +445,7 @@ private static ConcurrentDictionary AnalyzeTheOldWay(strin /// Also re-cache the module if the cached item is stale. /// /// Path to the module to get exported types from. - /// Current Context + /// Current Context. /// internal static ConcurrentDictionary GetExportedClasses(string modulePath, ExecutionContext context) { diff --git a/src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs b/src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs index 9920d5a166b..965cf6058ef 100644 --- a/src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs +++ b/src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs @@ -361,10 +361,10 @@ internal bool LoadUsingModulePath(PSModuleInfo parentModule, bool found, IEnumer /// /// Loads the latest valid version if moduleBase is a multi-versioned module directory /// - /// module directory path - /// The flag that indicate manifest processing option - /// The set of options that are used while importing a module - /// True if a module was found + /// module directory path. + /// The flag that indicate manifest processing option. + /// The set of options that are used while importing a module. + /// True if a module was found. /// internal PSModuleInfo LoadUsingMultiVersionModuleBase(string moduleBase, ManifestProcessingFlags manifestProcessingFlags, ImportModuleOptions importModuleOptions, out bool found) { @@ -1144,8 +1144,8 @@ internal static Version GetMaximumVersion(string stringVersion) /// /// Helper function for building a module info for Get-Module -List /// - /// The module file - /// True if we should update any cached module info for this module + /// The module file. + /// True if we should update any cached module info for this module. /// private PSModuleInfo CreateModuleInfoForGetModule(string file, bool refresh) { @@ -1299,12 +1299,12 @@ private PSModuleInfo CreateModuleInfoForGetModule(string file, bool refresh) /// /// Routine to process the module manifest data language script. /// - /// The script info for the manifest script - /// processing flags (whether to write errors / load elements) - /// The minimum version to check the manifest against - /// The maximum version to check the manifest against - /// The version to check the manifest against - /// The module guid to check the manifest against + /// The script info for the manifest script. + /// processing flags (whether to write errors / load elements). + /// The minimum version to check the manifest against. + /// The maximum version to check the manifest against. + /// The version to check the manifest against. + /// The module guid to check the manifest against. /// internal PSModuleInfo LoadModuleManifest( ExternalScriptInfo scriptInfo, @@ -1321,13 +1321,13 @@ internal PSModuleInfo LoadModuleManifest( /// /// Routine to process the module manifest data language script. /// - /// The script info for the manifest script - /// processing flags (whether to write errors / load elements) - /// The minimum version to check the manifest against - /// The maximum version to check the manifest against - /// The version to check the manifest against - /// The module guid to check the manifest against - /// The set of options that are used while importing a module + /// The script info for the manifest script. + /// processing flags (whether to write errors / load elements). + /// The minimum version to check the manifest against. + /// The maximum version to check the manifest against. + /// The version to check the manifest against. + /// The module guid to check the manifest against. + /// The set of options that are used while importing a module. /// internal PSModuleInfo LoadModuleManifest( ExternalScriptInfo scriptInfo, @@ -1378,7 +1378,7 @@ internal bool LoadModuleManifestData(ExternalScriptInfo scriptInfo, ManifestProc /// /// Helper function to generate fake PSModuleInfo objects from ModuleSpecification objects. /// - /// Collection of ModuleSpecification objects + /// Collection of ModuleSpecification objects. /// Collection of fake PSModuleInfo objects. private IEnumerable CreateFakeModuleObject(IEnumerable moduleSpecs) { @@ -1434,17 +1434,17 @@ private ErrorRecord GetErrorRecordIfUnsupportedRootCdxmlAndNestedModuleScenario( /// /// Routine to process the module manifest data language script. /// - /// The path to the manifest file - /// The script info for the manifest script - /// Contents of the module manifest - /// Contents of the localized module manifest - /// processing flags (whether to write errors / load elements) - /// The minimum version to check the manifest against - /// The maximum version to check the manifest against - /// The version to check the manifest against - /// The module guid to check the manifest against - /// The set of options that are used while importing a module - /// Tracks if there were errors in the file + /// The path to the manifest file. + /// The script info for the manifest script. + /// Contents of the module manifest. + /// Contents of the localized module manifest. + /// processing flags (whether to write errors / load elements). + /// The minimum version to check the manifest against. + /// The maximum version to check the manifest against. + /// The version to check the manifest against. + /// The module guid to check the manifest against. + /// The set of options that are used while importing a module. + /// Tracks if there were errors in the file. /// internal PSModuleInfo LoadModuleManifest( string moduleManifestPath, @@ -3788,7 +3788,7 @@ internal static object IsModuleLoaded(ExecutionContext context, ModuleSpecificat /// The current module being loaded. /// Either a string or a hash of ModuleName, optional Guid, and ModuleVersion. /// Used for error messages. - /// Specifies how to treat errors and whether to load elements + /// Specifies how to treat errors and whether to load elements. /// Set if any errors are found. /// Contains error record information. /// Null if the module is not loaded or loadElements is false, the loaded module otherwise. @@ -3813,7 +3813,7 @@ internal PSModuleInfo LoadRequiredModule(PSModuleInfo currentModule, ModuleSpeci /// The current module being loaded. /// Either a string or a hash of ModuleName, optional Guid, and ModuleVersion. /// Used for error messages. - /// Specifies how to treat errors and whether to load elements + /// Specifies how to treat errors and whether to load elements. /// Contains error record information. /// Null if the module is not loaded or loadElements is false, the loaded module otherwise. internal static PSModuleInfo LoadRequiredModule(ExecutionContext context, @@ -4317,11 +4317,11 @@ private ExternalScriptInfo FindLocalizedModuleManifest(string path) /// If it does and it's valid, it returns true otherwise it returns false. /// If the key wasn't there or wasn't valid, then is set to null /// - /// The hashtable to look for the key in - /// The manifest that generated the hashtable - /// the table key to use - /// Specifies how to treat errors and whether to load elements - /// Returns the extracted version + /// The hashtable to look for the key in. + /// The manifest that generated the hashtable. + /// the table key to use. + /// Specifies how to treat errors and whether to load elements. + /// Returns the extracted version. /// internal bool GetListOfStringsFromData( Hashtable data, @@ -4356,11 +4356,11 @@ internal bool GetListOfStringsFromData( /// If it does and it's valid, it returns true otherwise it returns false. /// If the key wasn't there or wasn't valid, then is set to null. /// - /// The hashtable to look for the key in - /// The manifest that generated the hashtable - /// the table key to use - /// Specifies how to treat errors and whether to load elements - /// Returns the extracted version + /// The hashtable to look for the key in. + /// The manifest that generated the hashtable. + /// the table key to use. + /// Specifies how to treat errors and whether to load elements. + /// Returns the extracted version. /// private bool GetListOfWildcardsFromData( Hashtable data, @@ -4409,14 +4409,14 @@ private bool GetListOfWildcardsFromData( /// If it does and it's valid, it returns true otherwise it returns false. /// If the key wasn't there or wasn't valid, then is set to null /// - /// The hashtable to look for the key in - /// The manifest that generated the hashtable - /// the table key to use - /// Specifies how to treat errors and whether to load elements - /// base directory of a module - /// expected file extension (added to strings that didn't have an extension) - /// if true then we want to error out if the specified files don't exist - /// Returns the extracted version + /// The hashtable to look for the key in. + /// The manifest that generated the hashtable. + /// the table key to use. + /// Specifies how to treat errors and whether to load elements. + /// base directory of a module. + /// expected file extension (added to strings that didn't have an extension). + /// if true then we want to error out if the specified files don't exist. + /// Returns the extracted version. /// private bool GetListOfFilesFromData( Hashtable data, @@ -5264,9 +5264,9 @@ internal PSModuleInfo IsModuleImportUnnecessaryBecauseModuleIsAlreadyLoaded(stri /// The session state instance to use for this module - may be null /// in which case a session state will be allocated if necessary /// - /// The set of options that are used while importing a module - /// The processing flags to use when processing the module - /// True if a module was found + /// The set of options that are used while importing a module. + /// The processing flags to use when processing the module. + /// True if a module was found. /// internal PSModuleInfo LoadUsingExtensions(PSModuleInfo parentModule, string moduleName, string fileBaseName, string extension, string moduleBase, @@ -5503,16 +5503,16 @@ internal PSModuleInfo LoadModule(string fileName, string moduleBase, string pref /// /// Load a module from a file... /// - /// The parent module, if any - /// The resolved path to load the module from - /// The module base path to use for this module - /// Command name prefix - /// The session state instance to use for this module - may be null in which case a session state will be allocated if necessary - /// Private Data for the module - /// The set of options that are used while importing a module - /// The manifest processing flags to use when processing the module - /// True if a module was found - /// True if a module file was found + /// The parent module, if any. + /// The resolved path to load the module from. + /// The module base path to use for this module. + /// Command name prefix. + /// The session state instance to use for this module - may be null in which case a session state will be allocated if necessary. + /// Private Data for the module. + /// The set of options that are used while importing a module. + /// The manifest processing flags to use when processing the module. + /// True if a module was found. + /// True if a module file was found. /// True if the module was successfully loaded. internal PSModuleInfo LoadModule(PSModuleInfo parentModule, string fileName, string moduleBase, string prefix, SessionState ss, object privateData, ref ImportModuleOptions options, @@ -6474,7 +6474,7 @@ private PSModuleInfo AnalyzeScriptFile(string filename, bool force, ExecutionCon /// /// If true, then then the registered snapins will also be searched when loading. /// The name of the snapin or assembly to load. - /// The path to the assembly to load + /// The path to the assembly to load. /// The assembly to load so no lookup need be done. /// The module base to use for this module. /// @@ -6482,11 +6482,11 @@ private PSModuleInfo AnalyzeScriptFile(string filename, bool force, ExecutionCon /// instance, however when loaded through a module manifest with nested modules, it will have a session /// state instance to store the imported functions, aliases and variables. /// - /// The set of options that are used while importing a module - /// The manifest processing flags to use when processing the module - /// load the types files mentioned in the snapin registration - /// Load the formst files mentioned in the snapin registration - /// Command name prefix + /// The set of options that are used while importing a module. + /// The manifest processing flags to use when processing the module. + /// load the types files mentioned in the snapin registration. + /// Load the formst files mentioned in the snapin registration. + /// Command name prefix. /// Sets this to true if an assembly was found. /// THe module info object that was created... internal PSModuleInfo LoadBinaryModule(bool trySnapInName, string moduleName, string fileName, @@ -6501,10 +6501,10 @@ internal PSModuleInfo LoadBinaryModule(bool trySnapInName, string moduleName, st /// /// Load a binary module. A binary module is an assembly that should contain cmdlets. /// - /// The parent module for which this module is a nested module + /// The parent module for which this module is a nested module. /// If true, then then the registered snapins will also be searched when loading. /// The name of the snapin or assembly to load. - /// The path to the assembly to load + /// The path to the assembly to load. /// The assembly to load so no lookup need be done. /// The module base to use for this module. /// @@ -6512,11 +6512,11 @@ internal PSModuleInfo LoadBinaryModule(bool trySnapInName, string moduleName, st /// instance, however when loaded through a module manifest with nested modules, it will have a session /// state instance to store the imported functions, aliases and variables. /// - /// The set of options that are used while importing a module - /// The manifest processing flags to use when processing the module - /// Command name prefix - /// load the types files mentioned in the snapin registration - /// Load the formst files mentioned in the snapin registration + /// The set of options that are used while importing a module. + /// The manifest processing flags to use when processing the module. + /// Command name prefix. + /// load the types files mentioned in the snapin registration. + /// Load the formst files mentioned in the snapin registration. /// Sets this to true if an assembly was found. /// Short name for module. /// @@ -7081,8 +7081,8 @@ internal static void AddModuleToModuleTables(ExecutionContext context, SessionSt /// Import the script-level functions from one session state to another, calling /// WriteVerbose for each imported member... /// - /// The session state instance to use as the source of the functions - /// Command name prefix + /// The session state instance to use as the source of the functions. + /// Command name prefix. protected internal void ImportModuleMembers(PSModuleInfo sourceModule, string prefix) { ImportModuleOptions importModuleOptions = new ImportModuleOptions(); @@ -7102,9 +7102,9 @@ protected internal void ImportModuleMembers(PSModuleInfo sourceModule, string pr /// Import the script-level functions from one session state to another, calling /// WriteVerbose for each imported member... /// - /// The session state instance to use as the source of the functions - /// Command name prefix - /// The set of options that are used while importing a module + /// The session state instance to use as the source of the functions. + /// Command name prefix. + /// The set of options that are used while importing a module. protected internal void ImportModuleMembers(PSModuleInfo sourceModule, string prefix, ImportModuleOptions options) { ImportModuleMembers( @@ -7572,9 +7572,9 @@ internal static PSSnapInInfo GetEngineSnapIn(ExecutionContext context, string na /// $mParent = import-module ParentModule # This internally imports SubModule /// $mParent.DoSomething # This works because SubModule functions are exported and accessible /// - /// Key - /// PSModuleInfo - /// True if module item is to be removed + /// Key. + /// PSModuleInfo. + /// True if module item is to be removed. /// True if module found in table and is safe to use. internal bool TryGetFromModuleTable(string key, out PSModuleInfo moduleInfo, bool toRemove = false) { diff --git a/src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs b/src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs index bedfc04bcf8..1a7136a5cff 100644 --- a/src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs +++ b/src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs @@ -83,16 +83,16 @@ internal void DecrementModuleNestingCount() /// /// Create a new module object from a scriptblock specifying the path to set for the module /// - /// The name of the module - /// The path where the module is rooted + /// The name of the module. + /// The path where the module is rooted. /// /// ScriptBlock that is executed to initialize the module... /// /// /// The arguments to pass to the scriptblock used to initialize the module /// - /// The session state instance to use for this module - may be null - /// The results produced from evaluating the scriptblock + /// The session state instance to use for this module - may be null. + /// The results produced from evaluating the scriptblock. /// The newly created module info object. internal PSModuleInfo CreateModule(string name, string path, ScriptBlock scriptBlock, SessionState ss, out List results, params object[] arguments) { @@ -102,12 +102,12 @@ internal PSModuleInfo CreateModule(string name, string path, ScriptBlock scriptB /// /// Create a new module object from a ScriptInfo object /// - /// The path where the module is rooted - /// The script info to use to create the module - /// The position for the command that loaded this module - /// Optional arguments to pass to the script while executing - /// The session state instance to use for this module - may be null - /// The private data to use for this module - may be null + /// The path where the module is rooted. + /// The script info to use to create the module. + /// The position for the command that loaded this module. + /// Optional arguments to pass to the script while executing. + /// The session state instance to use for this module - may be null. + /// The private data to use for this module - may be null. /// The constructed module object. internal PSModuleInfo CreateModule(string path, ExternalScriptInfo scriptInfo, IScriptExtent scriptPosition, SessionState ss, object privateData, params object[] arguments) { @@ -118,8 +118,8 @@ internal PSModuleInfo CreateModule(string path, ExternalScriptInfo scriptInfo, I /// /// Create a new module object from code specifying the path to set for the module /// - /// The name of the module - /// The path to use for the module root + /// The name of the module. + /// The path to use for the module root. /// /// The code to use to create the module. This can be one of ScriptBlock, string /// or ExternalScriptInfo @@ -134,8 +134,8 @@ internal PSModuleInfo CreateModule(string path, ExternalScriptInfo scriptInfo, I /// The position of the caller of this function so you can tell where the call /// to Import-Module (or whatever) occurred. This can be null. /// - /// The session state instance to use for this module - may be null - /// The private data to use for this module - may be null + /// The session state instance to use for this module - may be null. + /// The private data to use for this module - may be null. /// The created module. private PSModuleInfo CreateModuleImplementation(string name, string path, object moduleCode, IScriptExtent scriptPosition, SessionState ss, object privateData, out List result, params object[] arguments) { @@ -260,8 +260,8 @@ private PSModuleInfo CreateModuleImplementation(string name, string path, object /// bound to the module instance. /// /// Context to use to create bounded script. - /// The scriptblock to bind - /// Whether it should be linked to the global session state or not + /// The scriptblock to bind. + /// Whether it should be linked to the global session state or not. /// A new scriptblock. internal ScriptBlock CreateBoundScriptBlock(ExecutionContext context, ScriptBlock sb, bool linkToGlobal) { @@ -613,7 +613,7 @@ internal static bool AreModuleFieldsMatchingConstraints( /// Check that a given module version matches the required or minimum/maximum version constraints. /// Null constraints are not checked. /// - /// The module version to check. Must not be null + /// The module version to check. Must not be null. /// The version that the given version must be, if not null. /// The minimum version that the given version must be greater than or equal to, if not null. /// The maximum version that the given version must be less then or equal to, if not null. @@ -634,7 +634,7 @@ internal static bool IsVersionMatchingConstraints( /// Null constraints are not checked. /// /// The reason why the match failed. - /// The module version to check. Must not be null + /// The module version to check. Must not be null. /// The version that the given version must be, if not null. /// The minimum version that the given version must be greater than or equal to, if not null. /// The maximum version that the given version must be less then or equal to, if not null. @@ -904,7 +904,7 @@ internal static ExperimentalFeature[] GetExperimentalFeature(string manifestPath /// /// Returns true if the extension is one of the module extensions... /// - /// The extension to check + /// The extension to check. /// True if it was a module extension... internal static bool IsPowerShellModuleExtension(string extension) { @@ -920,7 +920,7 @@ internal static bool IsPowerShellModuleExtension(string extension) /// /// Gets the module name from module path. /// - /// The path to the module + /// The path to the module. /// The module name. internal static string GetModuleName(string path) { @@ -1469,7 +1469,7 @@ private static string ProcessOneModulePath(ExecutionContext context, string envP /// /// Removes all functions not belonging to the parent module. /// - /// Parent module + /// Parent module. internal static void RemoveNestedModuleFunctions(PSModuleInfo module) { var input = module.SessionState?.Internal?.ExportedFunctions; @@ -1524,12 +1524,12 @@ private static void SortAndRemoveDuplicates(List input, Func ke /// /// Mark stuff to be exported from the current environment using the various patterns /// - /// The cmdlet calling this method - /// The session state instance to do the exports on - /// Patterns describing the functions to export - /// Patterns describing the cmdlets to export - /// Patterns describing the aliases to export - /// Patterns describing the variables to export + /// The cmdlet calling this method. + /// The session state instance to do the exports on. + /// Patterns describing the functions to export. + /// Patterns describing the cmdlets to export. + /// Patterns describing the aliases to export. + /// Patterns describing the variables to export. /// List of Cmdlets that will not be exported, even if they match in cmdletPatterns. internal static void ExportModuleMembers( PSCmdlet cmdlet, @@ -1696,7 +1696,7 @@ internal static void ExportModuleMembers( /// /// Checks pattern list for wildcard characters. /// - /// Pattern list + /// Pattern list. /// True if pattern contains '*'. internal static bool PatternContainsWildcard(List list) { diff --git a/src/System.Management.Automation/engine/Modules/ModuleSpecification.cs b/src/System.Management.Automation/engine/Modules/ModuleSpecification.cs index 7b1aafaa56c..c2abfa6e8f1 100644 --- a/src/System.Management.Automation/engine/Modules/ModuleSpecification.cs +++ b/src/System.Management.Automation/engine/Modules/ModuleSpecification.cs @@ -82,7 +82,7 @@ public ModuleSpecification(Hashtable moduleSpecification) /// Initialize moduleSpecification from hashtable. Return exception object, if hashtable cannot be converted. /// Return null, in the success case. /// - /// object to initialize + /// object to initialize. /// contains info about object to initialize. /// internal static Exception ModuleSpecificationInitHelper(ModuleSpecification moduleSpecification, Hashtable hashtable) @@ -228,8 +228,8 @@ public override string ToString() /// /// Parse the specified string into a ModuleSpecification object /// - /// The module specification string - /// the ModuleSpecification object + /// The module specification string. + /// the ModuleSpecification object. /// public static bool TryParse(string input, out ModuleSpecification result) { @@ -265,7 +265,7 @@ internal ModuleSpecification WithNormalizedName(ExecutionContext context, string { return this; } - + return new ModuleSpecification() { Guid = Guid, diff --git a/src/System.Management.Automation/engine/Modules/ModuleUtils.cs b/src/System.Management.Automation/engine/Modules/ModuleUtils.cs index 098c9f53480..58165dbd97f 100644 --- a/src/System.Management.Automation/engine/Modules/ModuleUtils.cs +++ b/src/System.Management.Automation/engine/Modules/ModuleUtils.cs @@ -323,7 +323,7 @@ internal static IEnumerable GetDefaultAvailableModuleFiles(string topDir /// /// Gets the list of versions under the specified module base path in descending sorted order /// - /// module base path + /// module base path. /// Sorted list of versions. internal static List GetModuleVersionSubfolders(string moduleBase) { @@ -384,7 +384,7 @@ internal static bool IsOnSystem32ModulePath(string path) /// /// Gets a list of matching commands /// - /// command pattern + /// command pattern. /// /// /// diff --git a/src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs b/src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs index 1331a0161ed..b589ef29edc 100644 --- a/src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs +++ b/src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs @@ -541,7 +541,7 @@ public string DefaultCommandPrefix /// /// Return a single-quoted string. Any embedded single quotes will be doubled. /// - /// The string to quote + /// The string to quote. /// The quoted string. private string QuoteName(string name) { @@ -553,7 +553,7 @@ private string QuoteName(string name) /// /// Return a single-quoted string using the AbsoluteUri member to ensure it is escaped correctly /// - /// The Uri to quote + /// The Uri to quote. /// The quoted AbsoluteUri. private string QuoteName(Uri name) { @@ -565,7 +565,7 @@ private string QuoteName(Uri name) /// /// Return a single-quoted string from a Version object /// - /// The Version object to quote + /// The Version object to quote. /// The quoted Version string. private string QuoteName(Version name) { @@ -578,8 +578,8 @@ private string QuoteName(Version name) /// Takes a collection of strings and returns the collection /// quoted. /// - /// The list to quote - /// Streamwriter to get end of line character from + /// The list to quote. + /// Streamwriter to get end of line character from. /// The quoted list. private string QuoteNames(IEnumerable names, StreamWriter streamWriter) { @@ -653,8 +653,8 @@ private IEnumerable PreProcessModuleSpec(IEnumerable moduleSpecs) /// Takes a collection of "module specifications" (string or hashtable) /// and returns the collection as a string that can be inserted into a module manifest /// - /// The list to quote - /// Streamwriter to get end of line character from + /// The list to quote. + /// Streamwriter to get end of line character from. /// The quoted list. private string QuoteModules(IEnumerable moduleSpecs, StreamWriter streamWriter) { @@ -739,8 +739,8 @@ private string QuoteModules(IEnumerable moduleSpecs, StreamWriter streamWriter) /// Takes a collection of file names and returns the collection /// quoted. /// - /// The list to quote - /// Streamwriter to get end of line character from + /// The list to quote. + /// Streamwriter to get end of line character from. /// The quoted list. private string QuoteFiles(IEnumerable names, StreamWriter streamWriter) { @@ -889,10 +889,10 @@ private List TryResolveFilePath(string filePath) /// for a particular key. It returns a formatted string that includes /// a comment describing the key as well as the key and its value. /// - /// The manifest key to use - /// resourceString that holds the message - /// The formatted manifest fragment - /// Streamwriter to get end of line character from + /// The manifest key to use. + /// resourceString that holds the message. + /// The formatted manifest fragment. + /// Streamwriter to get end of line character from. /// private string ManifestFragment(string key, string resourceString, string value, StreamWriter streamWriter) { diff --git a/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs b/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs index 531198de8eb..c169d8da04c 100644 --- a/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs +++ b/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs @@ -43,8 +43,8 @@ internal static void SetDefaultDynamicNameAndPath(PSModuleInfo module) /// /// This object describes a PowerShell module... /// - /// The absolute path to the module - /// The execution context for this engine instance + /// The absolute path to the module. + /// The execution context for this engine instance. /// The module's sessionstate object - this may be null if the module is a dll. internal PSModuleInfo(string path, ExecutionContext context, SessionState sessionState) : this(null, path, context, sessionState) @@ -54,11 +54,11 @@ internal PSModuleInfo(string path, ExecutionContext context, SessionState sessio /// /// This object describes a PowerShell module... /// - /// The name to use for the module. If null, get it from the path name - /// The absolute path to the module - /// The execution context for this engine instance + /// The name to use for the module. If null, get it from the path name. + /// The absolute path to the module. + /// The execution context for this engine instance. /// The module's sessionstate object - this may be null if the module is a dll. - /// Language mode for script based modules + /// Language mode for script based modules. internal PSModuleInfo(string name, string path, ExecutionContext context, SessionState sessionState, PSLanguageMode? languageMode) : this(name, path, context, sessionState) { @@ -68,9 +68,9 @@ internal PSModuleInfo(string name, string path, ExecutionContext context, Sessio /// /// This object describes a PowerShell module... /// - /// The name to use for the module. If null, get it from the path name - /// The absolute path to the module - /// The execution context for this engine instance + /// The name to use for the module. If null, get it from the path name. + /// The absolute path to the module. + /// The execution context for this engine instance. /// The module's sessionstate object - this may be null if the module is a dll. internal PSModuleInfo(string name, string path, ExecutionContext context, SessionState sessionState) { @@ -223,7 +223,7 @@ public override string ToString() /// /// Sets the name property of the PSModuleInfo object /// - /// The name to set it to + /// The name to set it to. internal void SetName(string name) { Name = name; @@ -679,7 +679,7 @@ public string Prefix /// /// Add function to the fixed exports list /// - /// the function to add + /// the function to add. internal void AddDetectedFunctionExport(string name) { Dbg.Assert(name != null, "AddDetectedFunctionExport should not be called with a null value"); @@ -928,7 +928,7 @@ public ReadOnlyCollection NestedModules /// /// Add a module to the list of child modules. /// - /// The module to add + /// The module to add. internal void AddNestedModule(PSModuleInfo nestedModule) { AddModuleToList(nestedModule, _nestedModules); @@ -1020,7 +1020,7 @@ public ReadOnlyCollection RequiredModules /// /// Add a module to the list of required modules. /// - /// The module to add + /// The module to add. internal void AddRequiredModule(PSModuleInfo requiredModule) { AddModuleToList(requiredModule, _requiredModules); @@ -1046,7 +1046,7 @@ internal ReadOnlyCollection RequiredModulesSpecification /// /// Add a module to the list of required modules specification /// - /// The module to add + /// The module to add. internal void AddRequiredModuleSpecification(ModuleSpecification requiredModuleSpecification) { _requiredModulesSpecification.Add(requiredModuleSpecification); @@ -1194,8 +1194,8 @@ public Dictionary ExportedAliases /// /// Add alias to the detected alias list /// - /// the alias to add - /// the command it resolves to + /// the alias to add. + /// the command it resolves to. internal void AddDetectedAliasExport(string name, string value) { Dbg.Assert(name != null, "AddDetectedAliasExport should not be called with a null value"); @@ -1236,7 +1236,7 @@ public ReadOnlyCollection ExportedDscResources /// /// Returns a new scriptblock bound to this module instance. /// - /// The original scriptblock + /// The original scriptblock. /// The new bound scriptblock. public ScriptBlock NewBoundScriptBlock(ScriptBlock scriptBlockToBind) { @@ -1276,8 +1276,8 @@ internal ScriptBlock NewBoundScriptBlock(ScriptBlock scriptBlockToBind, Executio /// /// Invoke a scriptblock in the context of this module... /// - /// The scriptblock to invoke - /// Arguments to the scriptblock + /// The scriptblock to invoke. + /// Arguments to the scriptblock. /// The result of the invocation. public object Invoke(ScriptBlock sb, params object[] args) { @@ -1546,7 +1546,7 @@ internal static void AddToAppDomainLevelModuleCache(string moduleName, string pa /// /// If there is an entry for the named module in the appdomain level module path cache, remove it. /// - /// The name of the module to remove from the cache + /// The name of the module to remove from the cache. /// True if the module was remove. internal static bool RemoveFromAppDomainLevelCache(string moduleName) { diff --git a/src/System.Management.Automation/engine/MshCmdlet.cs b/src/System.Management.Automation/engine/MshCmdlet.cs index 0b4313a6678..def82681588 100644 --- a/src/System.Management.Automation/engine/MshCmdlet.cs +++ b/src/System.Management.Automation/engine/MshCmdlet.cs @@ -81,7 +81,7 @@ public bool IsPresent /// /// Implicit cast operator for casting SwitchParameter to bool. /// - /// The SwitchParameter object to convert to bool + /// The SwitchParameter object to convert to bool. /// The corresponding boolean value. public static implicit operator bool (SwitchParameter switchParameter) { @@ -91,7 +91,7 @@ public static implicit operator bool (SwitchParameter switchParameter) /// /// Implicit cast operator for casting bool to SwitchParameter. /// - /// The bool to convert to SwitchParameter + /// The bool to convert to SwitchParameter. /// The corresponding boolean value. public static implicit operator SwitchParameter(bool value) { @@ -130,7 +130,7 @@ public static SwitchParameter Present /// /// Compare this switch parameter to another object. /// - /// An object to compare against + /// An object to compare against. /// True if the objects are the same value. public override bool Equals(object obj) { @@ -159,8 +159,8 @@ public override int GetHashCode() /// /// Implement the == operator for switch parameters objects. /// - /// first object to compare - /// second object to compare + /// first object to compare. + /// second object to compare. /// True if they are the same. public static bool operator ==(SwitchParameter first, SwitchParameter second) { @@ -169,8 +169,8 @@ public override int GetHashCode() /// /// Implement the != operator for switch parameters /// - /// first object to compare - /// second object to compare + /// first object to compare. + /// second object to compare. /// True if they are different. public static bool operator !=(SwitchParameter first, SwitchParameter second) { @@ -179,8 +179,8 @@ public override int GetHashCode() /// /// Implement the == operator for switch parameters and booleans. /// - /// first object to compare - /// second object to compare + /// first object to compare. + /// second object to compare. /// True if they are the same. public static bool operator ==(SwitchParameter first, bool second) { @@ -189,8 +189,8 @@ public override int GetHashCode() /// /// Implement the != operator for switch parameters and booleans. /// - /// first object to compare - /// second object to compare + /// first object to compare. + /// second object to compare. /// True if they are different. public static bool operator !=(SwitchParameter first, bool second) { @@ -199,8 +199,8 @@ public override int GetHashCode() /// /// Implement the == operator for bool and switch parameters /// - /// first object to compare - /// second object to compare + /// first object to compare. + /// second object to compare. /// True if they are the same. public static bool operator ==(bool first, SwitchParameter second) { @@ -209,8 +209,8 @@ public override int GetHashCode() /// /// Implement the != operator for bool and switch parameters /// - /// first object to compare - /// second object to compare + /// first object to compare. + /// second object to compare. /// True if they are different. public static bool operator !=(bool first, SwitchParameter second) { @@ -297,9 +297,9 @@ public CommandInfo GetCommand(string commandName, CommandTypes type) /// Returns a command info for a given command name and type, using the specified arguments /// to resolve dynamic parameters. /// - /// The command name to search for - /// The command type to search for - /// The command arguments used to resolve dynamic parameters + /// The command name to search for. + /// The command type to search for. + /// The command arguments used to resolve dynamic parameters. /// A CommandInfo result that represents the resolved command. public CommandInfo GetCommand(string commandName, CommandTypes type, object[] arguments) { @@ -365,7 +365,7 @@ public CommandInfo GetCommand(string commandName, CommandTypes type, object[] ar /// /// Returns the CmdletInfo object that corresponds to the name argument /// - /// The name of the cmdlet to look for + /// The name of the cmdlet to look for. /// The cmdletInfo object if found, null otherwise. public CmdletInfo GetCmdlet(string commandName) { @@ -375,8 +375,8 @@ public CmdletInfo GetCmdlet(string commandName) /// /// Returns the CmdletInfo object that corresponds to the name argument /// - /// The name of the cmdlet to look for - /// The execution context instance to use for lookup + /// The name of the cmdlet to look for. + /// The execution context instance to use for lookup. /// The cmdletInfo object if found, null otherwise. internal static CmdletInfo GetCmdlet(string commandName, ExecutionContext context) { @@ -428,7 +428,7 @@ internal static CmdletInfo GetCmdlet(string commandName, ExecutionContext contex /// session state and retrieves the command directly. Note that the help file and snapin/module /// info will both be null on returned object. /// - /// the type name of the class implementing this cmdlet + /// the type name of the class implementing this cmdlet. /// CmdletInfo for the cmdlet if found, null otherwise. public CmdletInfo GetCmdletByTypeName(string cmdletTypeName) { @@ -539,9 +539,9 @@ public List GetCmdlets(string pattern) /// and optionally return the full path to applications and scripts rather than /// the simple command name. /// - /// The name of the command to use - /// If true treat the name as a pattern to search for - /// If true, return the full path to scripts and applications + /// The name of the command to use. + /// If true treat the name as a pattern to search for. + /// If true, return the full path to scripts and applications. /// A list of command names... public List GetCommandName(string name, bool nameIsPattern, bool returnFullName) { @@ -599,9 +599,9 @@ public List GetCommandName(string name, bool nameIsPattern, bool returnF /// /// Searches for PowerShell commands, optionally using wildcard patterns /// - /// The name of the command to use - /// Type of commands to support - /// If true treat the name as a pattern to search for + /// The name of the command to use. + /// Type of commands to support. + /// If true treat the name as a pattern to search for. /// Collection of command names... public IEnumerable GetCommands(string name, CommandTypes commandTypes, bool nameIsPattern) { @@ -671,10 +671,10 @@ internal IEnumerable GetCommands(string name, CommandTypes commandT /// /// Executes a piece of text as a script synchronously. /// - /// The script text to evaluate + /// The script text to evaluate. /// A collection of MshCobjects generated by the script. /// Thrown if there was a parsing error in the script. - /// Represents a script-level exception + /// Represents a script-level exception. /// public Collection InvokeScript(string script) { @@ -684,11 +684,11 @@ public Collection InvokeScript(string script) /// /// Executes a piece of text as a script synchronously. /// - /// The script text to evaluate - /// The arguments to the script + /// The script text to evaluate. + /// The arguments to the script. /// A collection of MshCobjects generated by the script. /// Thrown if there was a parsing error in the script. - /// Represents a script-level exception + /// Represents a script-level exception. /// public Collection InvokeScript(string script, params object[] args) { @@ -734,10 +734,10 @@ public Collection InvokeScript( /// /// Invoke a scriptblock in the current runspace, controlling if it gets a new scope. /// - /// If true, a new scope will be created - /// The scriptblock to execute - /// Optionall input to the command - /// Arguments to pass to the scriptblock + /// If true, a new scope will be created. + /// The scriptblock to execute. + /// Optionall input to the command. + /// Arguments to pass to the scriptblock. /// The result of the evaluation. public Collection InvokeScript( bool useLocalScope, ScriptBlock scriptBlock, IList input, params object[] args) @@ -776,8 +776,8 @@ public Collection InvokeScript( /// A collection of MshCobjects generated by the script. This will be /// empty if output was redirected. /// Thrown if there was a parsing error in the script. - /// Represents a script-level exception - /// Thrown if any redirect other than output is attempted + /// Represents a script-level exception. + /// Thrown if any redirect other than output is attempted. /// public Collection InvokeScript(string script, bool useNewScope, PipelineResultTypes writeToPipeline, IList input, params object[] args) @@ -881,7 +881,7 @@ private Collection InvokeScript(ScriptBlock sb, bool useNewScope, /// /// Compile a string into a script block. /// - /// The source text to compile + /// The source text to compile. /// The compiled script block. /// public ScriptBlock NewScriptBlock(string scriptText) diff --git a/src/System.Management.Automation/engine/MshCommandRuntime.cs b/src/System.Management.Automation/engine/MshCommandRuntime.cs index 9157e4715a6..e2c7ed36dc1 100644 --- a/src/System.Management.Automation/engine/MshCommandRuntime.cs +++ b/src/System.Management.Automation/engine/MshCommandRuntime.cs @@ -295,7 +295,7 @@ private void DoWriteObjects(object sendToPipeline) /// /// Display progress information /// - /// progress information + /// progress information. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. @@ -426,7 +426,7 @@ internal void WriteProgress( /// /// Display debug information /// - /// debug output + /// debug output. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. @@ -523,7 +523,7 @@ internal void WriteDebug(DebugRecord record, bool overrideInquire = false) /// /// Display verbose information /// - /// verbose output + /// verbose output. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. @@ -614,7 +614,7 @@ internal void WriteVerbose(VerboseRecord record, bool overrideInquire = false) /// /// Display warning information /// - /// warning output + /// warning output. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. @@ -846,7 +846,7 @@ internal void WriteInformation(InformationRecord record, bool overrideInquire = /// /// Write text into pipeline execution log. /// - /// text to be written to log + /// text to be written to log. /// /// Use WriteCommandDetail to write important information about cmdlet execution to /// pipeline execution log. @@ -2332,7 +2332,7 @@ public void Dispose() /// The general pattern is to call /// throw ManageException(e); /// - /// the exception + /// the exception. /// PipelineStoppedException. public Exception ManageException(Exception e) { @@ -2407,7 +2407,7 @@ private void EnsureVariableParameterAllowed() /// /// Append an error to the ErrorVariable if specified, and also to $ERROR /// - /// Exception or ErrorRecord + /// Exception or ErrorRecord. /// /// (An error occurred working with the error variable or $ERROR. /// @@ -2467,7 +2467,7 @@ internal void SetupWarningVariable() /// /// Append a warning to WarningVariable if specified. /// - /// The warning message + /// The warning message. internal void AppendWarningVarList(object obj) { this.OutputPipe.AppendVariableList(VariableStreamKind.Warning, obj); @@ -2552,7 +2552,7 @@ internal void SetupVariable(VariableStreamKind streamKind, string variableName, /// /// Append a Information to InformationVariable if specified. /// - /// The Information message + /// The Information message. internal void AppendInformationVarList(object obj) { this.OutputPipe.AppendVariableList(VariableStreamKind.Information, obj); @@ -2631,7 +2631,7 @@ internal void _WriteObjectsSkipAllowCheck(object sendToPipeline) /// a /// rather than the real exception. /// - /// error + /// error. /// /// Not permitted at this time or from this thread /// @@ -3463,8 +3463,8 @@ internal ContinueStatus WriteHelper( /// /// Helper for continue prompt, handles Inquire /// - /// may be null - /// may be null + /// may be null. + /// may be null. /// /// /// diff --git a/src/System.Management.Automation/engine/MshMemberInfo.cs b/src/System.Management.Automation/engine/MshMemberInfo.cs index c452576020d..77b60461f89 100644 --- a/src/System.Management.Automation/engine/MshMemberInfo.cs +++ b/src/System.Management.Automation/engine/MshMemberInfo.cs @@ -265,13 +265,13 @@ protected void SetMemberName(string name) /// When setting the value of a property throws an exception. /// This exception is also thrown if the property is an and there /// is no Runspace to run the script. - /// When some problem other then getting/setting the value happened + /// When some problem other then getting/setting the value happened. public abstract object Value { get; set; } /// /// Gets the type of the value for this member /// - /// When there was a problem getting the property + /// When there was a problem getting the property. public abstract string TypeNameOfValue { get; } /// @@ -368,9 +368,9 @@ public override string ToString() /// Initializes a new instance of PSAliasProperty setting the name of the alias /// and the name of the member this alias refers to. /// - /// name of the alias - /// name of the member this alias refers to - /// for invalid arguments + /// name of the alias. + /// name of the member this alias refers to. + /// for invalid arguments. public PSAliasProperty(string name, string referencedMemberName) { if (string.IsNullOrEmpty(name)) @@ -392,10 +392,10 @@ public PSAliasProperty(string name, string referencedMemberName) /// the name of the member this alias refers to and the type to convert the referenced /// member's value. /// - /// name of the alias - /// name of the member this alias refers to - /// the type to convert the referenced member's value - /// for invalid arguments + /// name of the alias. + /// name of the member this alias refers to. + /// the type to convert the referenced member's value. + /// for invalid arguments. public PSAliasProperty(string name, string referencedMemberName, Type conversionType) { if (string.IsNullOrEmpty(name)) @@ -577,8 +577,8 @@ private void LookupMember(string name, HashSet visitedAliases, out PSMem /// the alias has a cycle or /// an aliased member is not present /// - /// When getting the value of a property throws an exception - /// When setting the value of a property throws an exception + /// When getting the value of a property throws an exception. + /// When setting the value of a property throws an exception. public override object Value { get @@ -781,9 +781,9 @@ internal PSCodeProperty(string name) /// /// Initializes a new instance of the PSCodeProperty class as a read only property. /// - /// name of the property + /// name of the property. /// This should be a public static non void method taking one PSObject parameter. - /// if name is null or empty or getterCodeReference is null + /// if name is null or empty or getterCodeReference is null. /// if getterCodeReference doesn't have the right format. public PSCodeProperty(string name, MethodInfo getterCodeReference) { @@ -804,10 +804,10 @@ public PSCodeProperty(string name, MethodInfo getterCodeReference) /// /// Initializes a new instance of the PSCodeProperty class. Setter or getter can be null, but both cannot be null. /// - /// name of the property + /// name of the property. /// This should be a public static non void method taking one PSObject parameter. /// This should be a public static void method taking 2 parameters, where the first is an PSObject. - /// when methodForGet and methodForSet are null + /// when methodForGet and methodForSet are null. /// /// if: /// - getterCodeReference doesn't have the right format, @@ -872,8 +872,8 @@ public override PSMemberInfo Copy() /// /// Gets and Sets the value of this member /// - /// When getting and there is no getter or when the getter throws an exception - /// When setting and there is no setter or when the setter throws an exception + /// When getting and there is no getter or when the getter throws an exception. + /// When setting and there is no setter or when the setter throws an exception. public override object Value { get @@ -962,7 +962,7 @@ public override object Value /// /// Gets the type of the value for this member. /// - /// If there is no property getter + /// If there is no property getter. public override string TypeNameOfValue { get @@ -1054,8 +1054,8 @@ public override string ToString() /// /// Constructs a property from a serialized value /// - /// name of the property - /// value of the property + /// name of the property. + /// value of the property. internal PSProperty(string name, object serializedValue) { this.isDeserialized = true; @@ -1066,11 +1066,11 @@ internal PSProperty(string name, object serializedValue) /// /// Constructs this property /// - /// name of the property - /// adapter used in DoGetProperty - /// object passed to DoGetProperty - /// adapter specific data - /// for invalid arguments + /// name of the property. + /// adapter used in DoGetProperty. + /// object passed to DoGetProperty. + /// adapter specific data. + /// for invalid arguments. internal PSProperty(string name, Adapter adapter, object baseObject, object adapterData) { if (string.IsNullOrEmpty(name)) @@ -1133,8 +1133,8 @@ internal void SetAdaptedValue(object setValue, bool shouldConvert) /// /// Gets or sets the value of this property /// - /// When getting the value of a property throws an exception - /// When setting the value of a property throws an exception + /// When getting the value of a property throws an exception. + /// When setting the value of a property throws an exception. public override object Value { get => GetAdaptedValue(); @@ -1219,9 +1219,9 @@ public class PSAdaptedProperty : PSProperty /// /// Creates a property for the given base object /// - /// name of the property - /// an adapter can use this object to keep any arbitrary data it needs - /// for invalid arguments + /// name of the property. + /// an adapter can use this object to keep any arbitrary data it needs. + /// for invalid arguments. public PSAdaptedProperty(string name, object tag) : base(name, null, null, tag) { @@ -1285,9 +1285,9 @@ public override string ToString() /// /// Initializes a new instance of the PSNoteProperty class. /// - /// name of the property - /// value of the property - /// for an empty or null name + /// name of the property. + /// value of the property. + /// for an empty or null name. public PSNoteProperty(string name, object value) { if (string.IsNullOrEmpty(name)) @@ -1433,8 +1433,8 @@ public override string ToString() /// Initializes a new instance of the PSVariableProperty class. This is /// a subclass of the NoteProperty that wraps a variable instead of a simple value. /// - /// The variable to wrap - /// for an empty or null name + /// The variable to wrap. + /// for an empty or null name. public PSVariableProperty(PSVariable variable) : base(variable?.Name, null) { @@ -1658,9 +1658,9 @@ public ScriptBlock SetterScript /// /// Initializes an instance of the PSScriptProperty class as a read only property. /// - /// name of the property + /// name of the property. /// script to be used for the property getter. $this will be this PSObject. - /// for invalid arguments + /// for invalid arguments. public PSScriptProperty(string name, ScriptBlock getterScript) { if (string.IsNullOrEmpty(name)) @@ -1677,10 +1677,10 @@ public PSScriptProperty(string name, ScriptBlock getterScript) /// Initializes an instance of the PSScriptProperty class as a read only /// property. getterScript or setterScript can be null, but not both. /// - /// Name of this property + /// Name of this property. /// script to be used for the property getter. $this will be this PSObject. /// script to be used for the property setter. $this will be this PSObject and $args(1) will be the value to set. - /// for invalid arguments + /// for invalid arguments. public PSScriptProperty(string name, ScriptBlock getterScript, ScriptBlock setterScript) { if (string.IsNullOrEmpty(name)) @@ -1713,11 +1713,11 @@ public PSScriptProperty(string name, ScriptBlock getterScript, ScriptBlock sette /// Initializes an instance of the PSScriptProperty class as a read only /// property, using the text of the properties to support lazy initialization. /// - /// Name of this property + /// Name of this property. /// script to be used for the property getter. $this will be this PSObject. /// script to be used for the property setter. $this will be this PSObject and $args(1) will be the value to set. /// Language mode to be used during script block evaluation. - /// for invalid arguments + /// for invalid arguments. internal PSScriptProperty(string name, string getterScript, string setterScript, PSLanguageMode? languageMode) { if (string.IsNullOrEmpty(name)) @@ -2050,10 +2050,10 @@ protected PSMethodInfo() /// /// Invokes the appropriate method overload for the given arguments and returns its result. /// - /// arguments to the method + /// arguments to the method. /// Return value from the method. - /// if arguments is null - /// For problems finding an appropriate method for the arguments + /// if arguments is null. + /// For problems finding an appropriate method for the arguments. /// For exceptions invoking the method. /// This exception is also thrown for an when there is no Runspace to run the script. public abstract object Invoke(params object[] arguments); @@ -2068,7 +2068,7 @@ protected PSMethodInfo() /// /// Gets the value of this member. The getter returns the PSMethodInfo itself. /// - /// When setting the member + /// When setting the member. /// /// This is not the returned value of the method even for Methods with no arguments. /// The getter returns this (the PSMethodInfo itself). The setter is not supported. @@ -2165,10 +2165,10 @@ internal PSCodeMethod(string name) /// /// Initializes a new instance of the PSCodeMethod class. /// - /// name of the property + /// name of the property. /// this should be a public static method where the first parameter is an PSObject. - /// for invalid arguments - /// if the codeReference does not have the right format + /// for invalid arguments. + /// if the codeReference does not have the right format. public PSCodeMethod(string name, MethodInfo codeReference) { if (string.IsNullOrEmpty(name)) @@ -2216,15 +2216,15 @@ public override PSMemberInfo Copy() /// /// Invokes CodeReference method and returns its results. /// - /// arguments to the method + /// arguments to the method. /// Return value from the method. - /// if arguments is null + /// if arguments is null. /// /// When /// could CodeReference cannot match the given argument count or /// could not convert an argument to the type required /// - /// For exceptions invoking the CodeReference + /// For exceptions invoking the CodeReference. public override object Invoke(params object[] arguments) { if (arguments == null) @@ -2319,9 +2319,9 @@ public ScriptBlock Script /// /// Initializes a new instance of PSScriptMethod /// - /// name of the method + /// name of the method. /// script to be used when calling the method. - /// for invalid arguments + /// for invalid arguments. public PSScriptMethod(string name, ScriptBlock script) { if (string.IsNullOrEmpty(name)) @@ -2356,9 +2356,9 @@ internal PSScriptMethod(string name, ScriptBlock script, bool shouldCloneOnAcces /// /// Invokes Script method and returns its results. /// - /// arguments to the method + /// arguments to the method. /// Return value from the method. - /// if arguments is null + /// if arguments is null. /// For exceptions invoking the Script or if there is no Runspace to run the script. public override object Invoke(params object[] arguments) { @@ -2480,11 +2480,11 @@ public override string ToString() /// /// Constructs this method /// - /// name - /// adapter to be used invoking - /// baseObject for the methods - /// adapterData from adapter.GetMethodData - /// for invalid arguments + /// name. + /// adapter to be used invoking. + /// baseObject for the methods. + /// adapterData from adapter.GetMethodData. + /// for invalid arguments. internal PSMethod(string name, Adapter adapter, object baseObject, object adapterData) { if (string.IsNullOrEmpty(name)) @@ -2501,13 +2501,13 @@ internal PSMethod(string name, Adapter adapter, object baseObject, object adapte /// /// Constructs a PSMethod /// - /// name - /// adapter to be used invoking - /// baseObject for the methods - /// adapterData from adapter.GetMethodData + /// name. + /// adapter to be used invoking. + /// baseObject for the methods. + /// adapterData from adapter.GetMethodData. /// true if this member is a special member, false otherwise. /// true if this member is hidden, false otherwise. - /// for invalid arguments + /// for invalid arguments. internal PSMethod(string name, Adapter adapter, object baseObject, object adapterData, bool isSpecial, bool isHidden) : this(name, adapter, baseObject, adapterData) { @@ -2536,11 +2536,11 @@ public override PSMemberInfo Copy() /// /// Invokes the appropriate method overload for the given arguments and returns its result. /// - /// arguments to the method + /// arguments to the method. /// Return value from the method. - /// if arguments is null - /// For problems finding an appropriate method for the arguments - /// For exceptions invoking the method + /// if arguments is null. + /// For problems finding an appropriate method for the arguments. + /// For exceptions invoking the method. public override object Invoke(params object[] arguments) { return this.Invoke(null, arguments); @@ -2549,12 +2549,12 @@ public override object Invoke(params object[] arguments) /// /// Invokes the appropriate method overload for the given arguments and returns its result. /// - /// constraints - /// arguments to the method + /// constraints. + /// arguments to the method. /// Return value from the method. - /// if arguments is null - /// For problems finding an appropriate method for the arguments - /// For exceptions invoking the method + /// if arguments is null. + /// For problems finding an appropriate method for the arguments. + /// For exceptions invoking the method. internal object Invoke(PSMethodInvocationConstraints invocationConstraints, params object[] arguments) { if (arguments == null) @@ -2899,11 +2899,11 @@ public override string ToString() /// /// Constructs this parameterized property /// - /// name of the property - /// adapter used in DoGetMethod - /// object passed to DoGetMethod - /// adapter specific data - /// for invalid arguments + /// name of the property. + /// adapter used in DoGetMethod. + /// object passed to DoGetMethod. + /// adapter specific data. + /// for invalid arguments. internal PSParameterizedProperty(string name, Adapter adapter, object baseObject, object adapterData) { if (string.IsNullOrEmpty(name)) @@ -2942,10 +2942,10 @@ internal PSParameterizedProperty(string name) /// /// Invokes the getter method and returns its result /// - /// arguments to the method + /// arguments to the method. /// Return value from the method. - /// if arguments is null - /// When getting the value of a property throws an exception + /// if arguments is null. + /// When getting the value of a property throws an exception. public override object Invoke(params object[] arguments) { if (arguments == null) @@ -2959,10 +2959,10 @@ public override object Invoke(params object[] arguments) /// /// Invokes the setter method /// - /// value to set this property with - /// arguments to the method - /// if arguments is null - /// When setting the value of a property throws an exception + /// value to set this property with. + /// arguments to the method. + /// if arguments is null. + /// When setting the value of a property throws an exception. public void InvokeSet(object valueToSet, params object[] arguments) { if (arguments == null) @@ -3054,8 +3054,8 @@ public override string ToString() /// /// Initializes a new instance of PSMemberSet with no initial members /// - /// name for the member set - /// for invalid arguments + /// name for the member set. + /// for invalid arguments. public PSMemberSet(string name) { if (string.IsNullOrEmpty(name)) @@ -3073,9 +3073,9 @@ public PSMemberSet(string name) /// /// Initializes a new instance of PSMemberSet with all the initial members in /// - /// name for the member set - /// members in the member set - /// for invalid arguments + /// name for the member set. + /// members in the member set. + /// for invalid arguments. public PSMemberSet(string name, IEnumerable members) { if (string.IsNullOrEmpty(name)) @@ -3142,9 +3142,9 @@ private static Collection> GetTypePropertyCollec /// /// Used to create the Extended MemberSet /// - /// name of the memberSet - /// object associated with this memberset - /// for invalid arguments + /// name of the memberSet. + /// object associated with this memberset. + /// for invalid arguments. internal PSMemberSet(string name, PSObject mshObject) { if (string.IsNullOrEmpty(name)) @@ -3226,7 +3226,7 @@ public override PSMemberInfo Copy() /// /// Gets the value of this member. The getter returns the PSMemberSet itself. /// - /// When trying to set the property + /// When trying to set the property. public override object Value { get => this; @@ -3424,9 +3424,9 @@ public override string ToString() /// /// Initializes a new instance of PSPropertySet with a name and list of property names /// - /// name of the set - /// name of the properties in the set - /// for invalid arguments + /// name of the set. + /// name of the properties in the set. + /// for invalid arguments. public PSPropertySet(string name, IEnumerable referencedPropertyNames) { if (string.IsNullOrEmpty(name)) @@ -3478,7 +3478,7 @@ public override PSMemberInfo Copy() /// /// Gets the PSPropertySet itself. /// - /// When setting the member + /// When setting the member. public override object Value { get => this; @@ -3535,8 +3535,8 @@ public override string ToString() /// /// Constructs this event /// - /// The actual event - /// for invalid arguments + /// The actual event. + /// for invalid arguments. internal PSEvent(EventInfo baseEvent) { this.baseEvent = baseEvent; @@ -3565,7 +3565,7 @@ public override PSMemberInfo Copy() /// Gets the value of this member. The getter returns the /// actual .NET event that this type wraps. /// - /// When setting the member + /// When setting the member. public sealed override object Value { get => baseEvent; @@ -3640,11 +3640,11 @@ internal static WildcardPattern GetNamePattern(string name) /// Returns all members in memberList matching name and memberTypes /// /// Members to look for member with the correct types and name. - /// Name of the members to look for. The name might contain globbing characters - /// WildcardPattern out of name - /// type of members we want to retrieve + /// Name of the members to look for. The name might contain globbing characters. + /// WildcardPattern out of name. + /// type of members we want to retrieve. /// A collection of members of the right types and name extracted from memberList. - /// for invalid arguments + /// for invalid arguments. internal static PSMemberInfoInternalCollection Match(PSMemberInfoInternalCollection memberList, string name, WildcardPattern nameMatch, PSMemberTypes memberTypes) where T : PSMemberInfo { @@ -3703,7 +3703,7 @@ protected PSMemberInfoCollection() /// /// Adds a member to this collection /// - /// member to be added + /// member to be added. /// /// When: /// adding a member to an PSMemberSet from the type configuration file or @@ -3711,13 +3711,13 @@ protected PSMemberInfoCollection() /// trying to add a member with a type not compatible with this collection or /// a member by this name is already present /// - /// for invalid arguments + /// for invalid arguments. public abstract void Add(T member); /// /// Adds a member to this collection /// - /// member to be added + /// member to be added. /// flag to indicate that validation has already been done /// on this new member. Use only when you can guarantee that the input will not /// cause any of the errors normally caught by this method. @@ -3728,28 +3728,28 @@ protected PSMemberInfoCollection() /// trying to add a member with a type not compatible with this collection or /// a member by this name is already present /// - /// for invalid arguments + /// for invalid arguments. public abstract void Add(T member, bool preValidated); /// /// Removes a member from this collection /// - /// name of the member to be removed + /// name of the member to be removed. /// /// When: /// removing a member from an PSMemberSet from the type configuration file /// removing a member with a reserved member name or /// trying to remove a member with a type not compatible with this collection /// - /// for invalid arguments + /// for invalid arguments. public abstract void Remove(string name); /// /// Gets the member in this collection matching name. If the member does not exist, null is returned. /// - /// name of the member to look for + /// name of the member to look for. /// The member matching name. - /// for invalid arguments + /// for invalid arguments. public abstract T this[string name] { get; } #endregion abstract @@ -3761,7 +3761,7 @@ protected PSMemberInfoCollection() /// /// name of the members to be return. May contain wildcard characters. /// All members in the collection matching name. - /// for invalid arguments + /// for invalid arguments. public abstract ReadOnlyPSMemberInfoCollection Match(string name); /// @@ -3770,7 +3770,7 @@ protected PSMemberInfoCollection() /// name of the members to be return. May contain wildcard characters. /// type of the members to be searched. /// All members in the collection matching name and types. - /// for invalid arguments + /// for invalid arguments. public abstract ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes); /// @@ -3778,9 +3778,9 @@ protected PSMemberInfoCollection() /// /// name of the members to be return. May contain wildcard characters. /// type of the members to be searched. - /// match options + /// match options. /// All members in the collection matching name and types. - /// for invalid arguments + /// for invalid arguments. internal abstract ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes, MshMemberMatchOptions matchOptions); #endregion Match @@ -3829,7 +3829,7 @@ public class ReadOnlyPSMemberInfoCollection : IEnumerable where T : PSMemb /// Initializes a new instance of ReadOnlyPSMemberInfoCollection with the given members /// /// - /// for invalid arguments + /// for invalid arguments. internal ReadOnlyPSMemberInfoCollection(PSMemberInfoInternalCollection members) { if (members == null) @@ -3843,9 +3843,9 @@ internal ReadOnlyPSMemberInfoCollection(PSMemberInfoInternalCollection member /// /// Return the member in this collection matching name. If the member does not exist, null is returned. /// - /// name of the member to look for + /// name of the member to look for. /// The member matching name. - /// for invalid arguments + /// for invalid arguments. public T this[string name] { get @@ -3864,7 +3864,7 @@ public T this[string name] /// /// name of the members to be return. May contain wildcard characters. /// All members in the collection matching name. - /// for invalid arguments + /// for invalid arguments. public ReadOnlyPSMemberInfoCollection Match(string name) { if (string.IsNullOrEmpty(name)) @@ -3881,7 +3881,7 @@ public ReadOnlyPSMemberInfoCollection Match(string name) /// name of the members to be return. May contain wildcard characters. /// type of the members to be searched. /// All members in the collection matching name and types. - /// for invalid arguments + /// for invalid arguments. public ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes) { if (string.IsNullOrEmpty(name)) @@ -3918,8 +3918,8 @@ public virtual IEnumerator GetEnumerator() /// /// Returns the 0 based member identified by index /// - /// index of the member to retrieve - /// for invalid arguments + /// index of the member to retrieve. + /// for invalid arguments. public T this[int index] => _members[index]; } @@ -3998,9 +3998,9 @@ internal void Replace(T newMember) /// /// Adds a member to this collection /// - /// member to be added - /// when a member by this name is already present - /// for invalid arguments + /// member to be added. + /// when a member by this name is already present. + /// for invalid arguments. public override void Add(T member) { Add(member, false); @@ -4009,12 +4009,12 @@ public override void Add(T member) /// /// Adds a member to this collection /// - /// member to be added + /// member to be added. /// flag to indicate that validation has already been done /// on this new member. Use only when you can guarantee that the input will not /// cause any of the errors normally caught by this method. - /// when a member by this name is already present - /// for invalid arguments + /// when a member by this name is already present. + /// for invalid arguments. public override void Add(T member, bool preValidated) { if (member == null) @@ -4044,9 +4044,9 @@ public override void Add(T member, bool preValidated) /// /// Removes a member from this collection /// - /// name of the member to be removed - /// When removing a member with a reserved member name - /// for invalid arguments + /// name of the member to be removed. + /// When removing a member with a reserved member name. + /// for invalid arguments. public override void Remove(string name) { if (string.IsNullOrEmpty(name)) @@ -4084,9 +4084,9 @@ public override void Remove(string name) /// /// Returns the member in this collection matching name /// - /// name of the member to look for + /// name of the member to look for. /// The member matching name. - /// for invalid arguments + /// for invalid arguments. public override T this[string name] { get @@ -4113,7 +4113,7 @@ public override T this[string name] /// /// name of the members to be return. May contain wildcard characters. /// All members in the collection matching name. - /// for invalid arguments + /// for invalid arguments. public override ReadOnlyPSMemberInfoCollection Match(string name) { if (string.IsNullOrEmpty(name)) @@ -4130,7 +4130,7 @@ public override ReadOnlyPSMemberInfoCollection Match(string name) /// name of the members to be return. May contain wildcard characters. /// type of the members to be searched. /// All members in the collection matching name and types. - /// for invalid arguments + /// for invalid arguments. public override ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes) { if (string.IsNullOrEmpty(name)) @@ -4146,9 +4146,9 @@ public override ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTyp /// /// name of the members to be return. May contain wildcard characters. /// type of the members to be searched. - /// match options + /// match options. /// All members in the collection matching name and types. - /// for invalid arguments + /// for invalid arguments. internal override ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes, MshMemberMatchOptions matchOptions) { if (string.IsNullOrEmpty(name)) @@ -4224,8 +4224,8 @@ internal int VisibleCount /// /// Returns the 0 based member identified by index /// - /// index of the member to retrieve - /// for invalid arguments + /// index of the member to retrieve. + /// for invalid arguments. internal T this[int index] { get @@ -4431,7 +4431,7 @@ internal PSMemberInfoIntegratingCollection(object owner, Collection /// Adds member to the collection /// - /// member to be added + /// member to be added. /// /// When /// member is an PSProperty or PSMethod @@ -4441,7 +4441,7 @@ internal PSMemberInfoIntegratingCollection(object owner, Collection - /// for invalid arguments + /// for invalid arguments. public override void Add(T member) { Add(member, false); @@ -4450,7 +4450,7 @@ public override void Add(T member) /// /// Adds member to the collection /// - /// member to be added + /// member to be added. /// flag to indicate that validation has already been done /// on this new member. Use only when you can guarantee that the input will not /// cause any of the errors normally caught by this method. @@ -4463,7 +4463,7 @@ public override void Add(T member) /// a member with this name already exists /// trying to add a member to a static memberset /// - /// for invalid arguments + /// for invalid arguments. public override void Add(T member, bool preValidated) { if (member == null) @@ -4517,7 +4517,7 @@ internal void AddToReservedMemberSet(T member, bool preValidated) /// /// Adds member to the collection /// - /// member to be added + /// member to be added. /// flag to indicate that validation has already been done /// on this new member. Use only when you can guarantee that the input will not /// cause any of the errors normally caught by this method. @@ -4528,7 +4528,7 @@ internal void AddToReservedMemberSet(T member, bool preValidated) /// a member with this name already exists /// trying to add a member to a static memberset /// - /// for invalid arguments + /// for invalid arguments. internal void AddToTypesXmlCache(T member, bool preValidated) { if (member == null) @@ -4587,13 +4587,13 @@ internal void AddToTypesXmlCache(T member, bool preValidated) /// /// Removes the member named name from the collection /// - /// Name of the member to be removed + /// Name of the member to be removed. /// /// When trying to remove a member with a type not compatible with this collection /// When trying to remove a member from a static memberset /// When trying to remove a member from a MemberSet with a reserved name /// - /// for invalid arguments + /// for invalid arguments. public override void Remove(string name) { if (string.IsNullOrEmpty(name)) @@ -4670,8 +4670,8 @@ private void EnsureReservedMemberIsLoaded(string name) /// /// Returns the name corresponding to name or null if it is not present /// - /// name of the member to return - /// for invalid arguments + /// name of the member to return. + /// for invalid arguments. public override T this[string name] { get @@ -4833,7 +4833,7 @@ private PSMemberInfoInternalCollection GetIntegratedMembers(MshMemberMatchOpt /// /// name of the members to be return. May contain wildcard characters. /// All members in the collection matching name. - /// for invalid arguments + /// for invalid arguments. public override ReadOnlyPSMemberInfoCollection Match(string name) { if (string.IsNullOrEmpty(name)) @@ -4850,7 +4850,7 @@ public override ReadOnlyPSMemberInfoCollection Match(string name) /// name of the members to be return. May contain wildcard characters. /// type of the members to be searched. /// All members in the collection matching name and types. - /// for invalid arguments + /// for invalid arguments. public override ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes) { if (string.IsNullOrEmpty(name)) @@ -4866,9 +4866,9 @@ public override ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTyp /// /// name of the members to be return. May contain wildcard characters. /// type of the members to be searched. - /// search options + /// search options. /// All members in the collection matching name and types. - /// for invalid arguments + /// for invalid arguments. internal override ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes, MshMemberMatchOptions matchOptions) { using (PSObject.memberResolution.TraceScope("Matching \"{0}\"", name)) @@ -4916,7 +4916,7 @@ internal struct Enumerator : IEnumerator where S : PSMemberInfo /// /// Constructs this instance to enumerate over members /// - /// members we are enumerating + /// members we are enumerating. internal Enumerator(PSMemberInfoIntegratingCollection integratingCollection) { using (PSObject.memberResolution.TraceScope("Enumeration Start")) @@ -4974,7 +4974,7 @@ public bool MoveNext() /// /// Current PSMemberInfo in the enumeration /// - /// for invalid arguments + /// for invalid arguments. S IEnumerator.Current { get diff --git a/src/System.Management.Automation/engine/MshObject.cs b/src/System.Management.Automation/engine/MshObject.cs index 18ff909cf07..ef1b3f7e3fa 100644 --- a/src/System.Management.Automation/engine/MshObject.cs +++ b/src/System.Management.Automation/engine/MshObject.cs @@ -535,8 +535,8 @@ public PSObject(int instanceMemberCapacity) : this() /// /// Initializes a new instance of PSObject wrapping obj (accessible through BaseObject). /// - /// object we are wrapping - /// if is null + /// object we are wrapping. + /// if is null. [SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "obj", Justification = "This is shipped as part of V1. Retaining this for backward compatibility.")] public PSObject(object obj) { @@ -551,8 +551,8 @@ public PSObject(object obj) /// /// Creates a PSObject from an ISerializable context /// - /// Serialization information for this instance - /// The streaming context for this instance + /// Serialization information for this instance. + /// The streaming context for this instance. protected PSObject(SerializationInfo info, StreamingContext context) { if (info == null) @@ -1011,11 +1011,11 @@ internal static PSMemberInfo GetStaticCLRMember(object obj, string methodName) /// If obj is an PSObject it will be returned as is, otherwise /// a new PSObject will be created based on obj. /// - /// object to be wrapped + /// object to be wrapped. /// /// obj or a new PSObject whose BaseObject is obj /// - /// if is null + /// if is null. [SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "obj", Justification = "This is shipped as part of V1. Retaining this for backward compatibility.")] public static PSObject AsPSObject(object obj) { @@ -1240,9 +1240,9 @@ internal static string ToStringParser(ExecutionContext context, object obj, IFor /// If it is not present, and the BaseObject is null we try listing the properties. /// If the BaseObject is not null we try enumerating. If that fails we try the BaseObject's ToString. /// - /// The separator between elements, if this is an enumeration - /// the format to be passed to ToString - /// the formatProvider to be passed to ToString + /// The separator between elements, if this is an enumeration. + /// the format to be passed to ToString. + /// the formatProvider to be passed to ToString. /// true if we should enumerate values or properties which would cause recursive /// calls to this method. Such recursive calls will have recurse set to false, limiting the depth. /// If recurse is false, this parameter is not considered. If it is true @@ -1490,7 +1490,7 @@ internal static string ToString(ExecutionContext context, object obj, string sep /// concatenated using $ofs. /// /// The string representation for baseObject. - /// if an exception was thrown by the BaseObject's ToString + /// if an exception was thrown by the BaseObject's ToString. public override string ToString() { //If ToString value from deserialization is available, @@ -1508,10 +1508,10 @@ public override string ToString() /// CodeMethod or ScriptMethod will be used, if available. Enumerations items are /// concatenated using $ofs. /// - /// repassed to baseObject's IFormattable if present - /// repassed to baseObject's IFormattable if present + /// repassed to baseObject's IFormattable if present. + /// repassed to baseObject's IFormattable if present. /// The string representation for baseObject. - /// if an exception was thrown by the BaseObject's ToString + /// if an exception was thrown by the BaseObject's ToString. public string ToString(string format, IFormatProvider formatProvider) { //If ToString value from deserialization is available, @@ -1777,8 +1777,8 @@ internal void AddOrSetProperty(PSNoteProperty property) /// /// Implements the ISerializable contract for serializing a PSObject /// - /// Serialization information for this instance - /// The streaming context for this instance + /// Serialization information for this instance. + /// The streaming context for this instance. public virtual void GetObjectData(SerializationInfo info, StreamingContext context) { if (info == null) @@ -2028,8 +2028,8 @@ internal static void CopyDeserializerFields(PSObject source, PSObject target) /// /// Set base object /// - /// object which is set as core - /// If true, overwrite the type information + /// object which is set as core. + /// If true, overwrite the type information. ///This method is to be used only by Serialization code internal void SetCoreOnDeserialization(object value, bool overrideTypeInfo) { @@ -2458,7 +2458,7 @@ internal static string Type(Type type, bool dropNamespaces = false, string key = /// /// ToString implementation for Type /// - /// instance of PSObject wrapping a Type + /// instance of PSObject wrapping a Type. public static string Type(PSObject instance) { if (instance == null) @@ -2472,7 +2472,7 @@ public static string Type(PSObject instance) /// /// ToString implementation for XmlNode /// - /// instance of PSObject wrapping an XmlNode + /// instance of PSObject wrapping an XmlNode. public static string XmlNode(PSObject instance) { XmlNode node = (XmlNode)instance?.BaseObject; @@ -2487,7 +2487,7 @@ public static string XmlNode(PSObject instance) /// /// ToString implementation for XmlNodeList /// - /// instance of PSObject wrapping an XmlNodeList + /// instance of PSObject wrapping an XmlNodeList. public static string XmlNodeList(PSObject instance) { XmlNodeList nodes = (XmlNodeList)instance?.BaseObject; diff --git a/src/System.Management.Automation/engine/MshObjectTypeDescriptor.cs b/src/System.Management.Automation/engine/MshObjectTypeDescriptor.cs index 5788ada3cc3..20eae17c416 100644 --- a/src/System.Management.Automation/engine/MshObjectTypeDescriptor.cs +++ b/src/System.Management.Automation/engine/MshObjectTypeDescriptor.cs @@ -33,7 +33,7 @@ public class SettingValueExceptionEventArgs : EventArgs /// /// Initializes a new instance of setting the value of of the exception that triggered the associated event. /// - /// Exception that triggered the associated event + /// Exception that triggered the associated event. internal SettingValueExceptionEventArgs(Exception exception) { Exception = exception; @@ -66,7 +66,7 @@ public class GettingValueExceptionEventArgs : EventArgs /// /// Initializes a new instance of setting the value of of the exception that triggered the associated event. /// - /// Exception that triggered the associated event + /// Exception that triggered the associated event. internal GettingValueExceptionEventArgs(Exception exception) { Exception = exception; diff --git a/src/System.Management.Automation/engine/MshSecurityException.cs b/src/System.Management.Automation/engine/MshSecurityException.cs index fc5773c3699..56341a23732 100644 --- a/src/System.Management.Automation/engine/MshSecurityException.cs +++ b/src/System.Management.Automation/engine/MshSecurityException.cs @@ -31,8 +31,8 @@ public PSSecurityException() /// /// Serialization constructor for class PSSecurityException /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PSSecurityException(SerializationInfo info, StreamingContext context) diff --git a/src/System.Management.Automation/engine/NativeCommandParameterBinder.cs b/src/System.Management.Automation/engine/NativeCommandParameterBinder.cs index 63c476c270a..e9c03bf6de0 100644 --- a/src/System.Management.Automation/engine/NativeCommandParameterBinder.cs +++ b/src/System.Management.Automation/engine/NativeCommandParameterBinder.cs @@ -152,11 +152,11 @@ internal string Arguments /// and trailing spaces as appropriate. An array gets added as multiple arguments /// each of which will be stringized. /// - /// Execution context instance - /// The object to append - /// If the argument was an array literal, the Ast, otherwise null - /// true if the argument occurs after --% - /// True if the argument was a quoted string (single or double) + /// Execution context instance. + /// The object to append. + /// If the argument was an array literal, the Ast, otherwise null. + /// true if the argument occurs after --%. + /// True if the argument was a quoted string (single or double). private void appendOneNativeArgument(ExecutionContext context, object obj, ArrayLiteralAst argArrayAst, bool sawVerbatimArgumentMarker, bool usedQuotes) { IEnumerator list = LanguagePrimitives.GetEnumerator(obj); @@ -240,8 +240,8 @@ private void appendOneNativeArgument(ExecutionContext context, object obj, Array /// On Windows, just append . /// On Unix, do globbing as appropriate, otherwise just append . /// - /// The argument that possibly needs expansion - /// True if the argument was a quoted string (single or double) + /// The argument that possibly needs expansion. + /// True if the argument was a quoted string (single or double). private void PossiblyGlobArg(string arg, bool usedQuotes) { var argExpanded = false; @@ -332,7 +332,7 @@ private void PossiblyGlobArg(string arg, bool usedQuotes) /// /// Check to see if the string contains spaces and therefore must be quoted. /// - /// The string to check for spaces + /// The string to check for spaces. internal static bool NeedQuotes(string stringToCheck) { bool needQuotes = false, followingBackslash = false; diff --git a/src/System.Management.Automation/engine/NativeCommandProcessor.cs b/src/System.Management.Automation/engine/NativeCommandProcessor.cs index 9a16b15964f..8603d6837aa 100644 --- a/src/System.Management.Automation/engine/NativeCommandProcessor.cs +++ b/src/System.Management.Automation/engine/NativeCommandProcessor.cs @@ -122,8 +122,8 @@ internal class ProcessOutputObject /// /// Build an output object /// - /// The data to output - /// stream to which data belongs + /// The data to output. + /// stream to which data belongs. internal ProcessOutputObject(object data, MinishellStream stream) { Data = data; @@ -760,7 +760,7 @@ internal override void Complete() /// if the process handle is invalid (as seems to be the case with an ntvdm) /// then we try to get a fresh handle based on the original process id. /// - /// The process to kill + /// The process to kill. private static void KillProcess(Process processToKill) { if (NativeCommandProcessor.IsServerSide) @@ -1920,7 +1920,7 @@ internal static class ConsoleVisibility /// Code to control the display properties of the a window... /// /// The window to show... - /// The command to do + /// The command to do. /// True it it was successful. [DllImport("user32.dll")] internal static extern bool ShowWindow(IntPtr hWnd, int nCmdShow); diff --git a/src/System.Management.Automation/engine/PSClassInfo.cs b/src/System.Management.Automation/engine/PSClassInfo.cs index 03bab13b3c8..07e7befb47c 100644 --- a/src/System.Management.Automation/engine/PSClassInfo.cs +++ b/src/System.Management.Automation/engine/PSClassInfo.cs @@ -33,7 +33,7 @@ internal PSClassInfo(string name) /// /// Updates members of the class. /// - /// Updated members + /// Updated members. public void UpdateMembers(IList members) { if (members != null) diff --git a/src/System.Management.Automation/engine/PSConfiguration.cs b/src/System.Management.Automation/engine/PSConfiguration.cs index 2abdce0f034..24df539213d 100644 --- a/src/System.Management.Automation/engine/PSConfiguration.cs +++ b/src/System.Management.Automation/engine/PSConfiguration.cs @@ -126,7 +126,7 @@ internal string GetModulePath(ConfigScope scope) /// TODO: In a single config file, it might be better to nest this. It is unnecessary complexity until a need arises for more nested values. /// /// Whether this is a system-wide or per-user setting. - /// The shell associated with this policy. Typically, it is "Microsoft.PowerShell" + /// The shell associated with this policy. Typically, it is "Microsoft.PowerShell". /// The execution policy if found. Null otherwise. internal string GetExecutionPolicy(ConfigScope scope, string shellId) { @@ -446,7 +446,7 @@ private FileStream WaitForFile(string fullPath, FileMode mode, FileAccess access /// The ConfigScope of the configuration file to update. /// The string key of the value. /// The value to set. - /// Whether the key-value pair should be added to or removed from the file + /// Whether the key-value pair should be added to or removed from the file. private void UpdateValueInFile(ConfigScope scope, string key, T value, bool addValue) { string fileName = GetConfigFilePath(scope); diff --git a/src/System.Management.Automation/engine/PSVersionInfo.cs b/src/System.Management.Automation/engine/PSVersionInfo.cs index e1841db3355..41fc34e3d0b 100644 --- a/src/System.Management.Automation/engine/PSVersionInfo.cs +++ b/src/System.Management.Automation/engine/PSVersionInfo.cs @@ -414,7 +414,7 @@ public sealed class SemanticVersion : IComparable, IComparable, /// /// Construct a SemanticVersion from a string. /// - /// The version to parse + /// The version to parse. /// /// public SemanticVersion(string version) @@ -431,11 +431,11 @@ public SemanticVersion(string version) /// /// Construct a SemanticVersion. /// - /// The major version - /// The minor version - /// The patch version - /// The pre-release label for the version - /// The build metadata for the version + /// The major version. + /// The minor version. + /// The patch version. + /// The pre-release label for the version. + /// The build metadata for the version. /// /// If don't match 'LabelUnitRegEx'. /// If don't match 'LabelUnitRegEx'. @@ -461,10 +461,10 @@ public SemanticVersion(int major, int minor, int patch, string preReleaseLabel, /// /// Construct a SemanticVersion. /// - /// The major version - /// The minor version - /// The minor version - /// The label for the version + /// The major version. + /// The minor version. + /// The minor version. + /// The label for the version. /// /// /// If don't match 'LabelRegEx'. @@ -488,9 +488,9 @@ public SemanticVersion(int major, int minor, int patch, string label) /// /// Construct a SemanticVersion. /// - /// The major version - /// The minor version - /// The minor version + /// The major version. + /// The minor version. + /// The minor version. /// /// If , , or is less than 0. /// @@ -511,8 +511,8 @@ public SemanticVersion(int major, int minor, int patch) /// /// Construct a SemanticVersion. /// - /// The major version - /// The minor version + /// The major version. + /// The minor version. /// /// If or is less than 0. /// @@ -521,7 +521,7 @@ public SemanticVersion(int major, int minor) : this(major, minor, 0) {} /// /// Construct a SemanticVersion. /// - /// The major version + /// The major version. /// /// If is less than 0. /// @@ -621,7 +621,7 @@ public static implicit operator Version(SemanticVersion semver) /// /// Parse and return the result if it is a valid , otherwise throws an exception. /// - /// The string to parse + /// The string to parse. /// /// /// @@ -642,7 +642,7 @@ public static SemanticVersion Parse(string version) /// Parse and return true if it is a valid , otherwise return false. /// No exceptions are raised. /// - /// The string to parse + /// The string to parse. /// The return value when the string is a valid public static bool TryParse(string version, out SemanticVersion result) { diff --git a/src/System.Management.Automation/engine/Pipe.cs b/src/System.Management.Automation/engine/Pipe.cs index 291674a6188..fe126c08b50 100644 --- a/src/System.Management.Automation/engine/Pipe.cs +++ b/src/System.Management.Automation/engine/Pipe.cs @@ -341,7 +341,7 @@ internal Pipe(List resultList) /// written onto an Collection[PSObject] which is more useful /// in many circumstances than arraylist /// - /// The collection to write into + /// The collection to write into. internal Pipe(System.Collections.ObjectModel.Collection resultCollection) { Diagnostics.Assert(resultCollection != null, "resultCollection cannot be null"); @@ -355,7 +355,7 @@ internal Pipe(System.Collections.ObjectModel.Collection resultCollecti /// This pipe writes into another pipeline processor allowing /// pipelines to be chained together... /// - /// The execution context object for this engine instance + /// The execution context object for this engine instance. /// The pipeline to write into... internal Pipe(ExecutionContext context, PipelineProcessor outputPipeline) { @@ -389,7 +389,7 @@ internal Pipe(IEnumerator enumeratorToProcess) /// Writes an object to the pipe. This could recursively call to the /// downstream cmdlet, or write the object to the external output. /// - /// The object to add to the pipe + /// The object to add to the pipe. /// /// AutomationNull.Value is ignored /// diff --git a/src/System.Management.Automation/engine/ProgressRecord.cs b/src/System.Management.Automation/engine/ProgressRecord.cs index c26254acf0b..d1de4d957f7 100644 --- a/src/System.Management.Automation/engine/ProgressRecord.cs +++ b/src/System.Management.Automation/engine/ProgressRecord.cs @@ -354,8 +354,8 @@ public override /// The percentage complete will slowly converge toward 100%. /// At the the percentage complete will be 90%. /// - /// When did the operation start - /// How long does the operation usually take + /// When did the operation start. + /// How long does the operation usually take. /// Estimated percentage complete of the operation (always between 0 and 99% - never returns 100%). /// /// Thrown when @@ -459,7 +459,7 @@ internal static int GetPercentageComplete(DateTime startTime, TimeSpan expectedD /// Creates a ProgressRecord object from a PSObject property bag. /// PSObject has to be in the format returned by ToPSObjectForRemoting method. /// - /// PSObject to rehydrate + /// PSObject to rehydrate. /// /// ProgressRecord rehydrated from a PSObject property bag /// diff --git a/src/System.Management.Automation/engine/ScriptCommandProcessor.cs b/src/System.Management.Automation/engine/ScriptCommandProcessor.cs index 3afb8f46b01..fbb258eb5f2 100644 --- a/src/System.Management.Automation/engine/ScriptCommandProcessor.cs +++ b/src/System.Management.Automation/engine/ScriptCommandProcessor.cs @@ -127,8 +127,8 @@ protected void CommonInitialization(ScriptBlock scriptBlock, ExecutionContext co /// Checks if user has requested help (for example passing "-?" parameter for a cmdlet) /// and if yes, then returns the help target to display. /// - /// help target to request - /// help category to request + /// help target to request. + /// help category to request. /// true if user requested help; false otherwise. internal override bool IsHelpRequested(out string helpTarget, out HelpCategory helpCategory) { diff --git a/src/System.Management.Automation/engine/SecurityManagerBase.cs b/src/System.Management.Automation/engine/SecurityManagerBase.cs index ceb39adf86d..9a248b1a61f 100644 --- a/src/System.Management.Automation/engine/SecurityManagerBase.cs +++ b/src/System.Management.Automation/engine/SecurityManagerBase.cs @@ -61,8 +61,8 @@ public AuthorizationManager(string shellId) /// /// determine if we should run the specified file /// - /// info on entity to be run - /// the dispatch origin of a command + /// info on entity to be run. + /// the dispatch origin of a command. /// allows access to the host. /// /// This method throws SecurityException in case running is not allowed. @@ -160,10 +160,10 @@ internal void ShouldRunInternal(CommandInfo commandInfo, /// Determines if the host should run the command a specified by the CommandInfo parameter. /// The default implementation gives permission to run every command. /// - /// Information about the command to be run - /// The origin of the command - /// The host running the command - /// The reason for preventing execution, if applicable + /// Information about the command to be run. + /// The origin of the command. + /// The host running the command. + /// The reason for preventing execution, if applicable. /// True if the host should run the command. False otherwise. protected internal virtual bool ShouldRun(CommandInfo commandInfo, CommandOrigin origin, diff --git a/src/System.Management.Automation/engine/SessionState.cs b/src/System.Management.Automation/engine/SessionState.cs index 1520dc0537e..a7c4688e4ef 100644 --- a/src/System.Management.Automation/engine/SessionState.cs +++ b/src/System.Management.Automation/engine/SessionState.cs @@ -225,7 +225,7 @@ internal bool UseFullLanguageModeInDebugger /// /// See if a script is allowed to be run. /// - /// Path to check + /// Path to check. /// True if script is allowed. internal SessionStateEntryVisibility CheckScriptVisibility(string scriptPath) { @@ -252,7 +252,7 @@ internal SessionStateEntryVisibility CheckScriptVisibility(string scriptPath) /// /// Add an new SessionState cmdlet entry to this session state object... /// - /// The entry to add + /// The entry to add. internal void AddSessionStateEntry(SessionStateCmdletEntry entry) { AddSessionStateEntry(entry, /*local*/false); @@ -261,8 +261,8 @@ internal void AddSessionStateEntry(SessionStateCmdletEntry entry) /// /// Add an new SessionState cmdlet entry to this session state object... /// - /// The entry to add - /// If local, add cmdlet to current scope. Else, add to module scope + /// The entry to add. + /// If local, add cmdlet to current scope. Else, add to module scope. internal void AddSessionStateEntry(SessionStateCmdletEntry entry, bool local) { ExecutionContext.CommandDiscovery.AddSessionStateCmdletEntryToCache(entry, local); @@ -271,7 +271,7 @@ internal void AddSessionStateEntry(SessionStateCmdletEntry entry, bool local) /// /// Add an new SessionState cmdlet entry to this session state object... /// - /// The entry to add + /// The entry to add. internal void AddSessionStateEntry(SessionStateApplicationEntry entry) { this.Applications.Add(entry.Path); @@ -280,7 +280,7 @@ internal void AddSessionStateEntry(SessionStateApplicationEntry entry) /// /// Add an new SessionState cmdlet entry to this session state object... /// - /// The entry to add + /// The entry to add. internal void AddSessionStateEntry(SessionStateScriptEntry entry) { this.Scripts.Add(entry.Path); @@ -382,7 +382,7 @@ internal void InitializeFixedVariables() /// /// Check to see if an application is allowed to be run. /// - /// The path to the application to check + /// The path to the application to check. /// True if application is permitted. internal SessionStateEntryVisibility CheckApplicationVisibility(string applicationPath) { diff --git a/src/System.Management.Automation/engine/SessionStateAliasAPIs.cs b/src/System.Management.Automation/engine/SessionStateAliasAPIs.cs index d4ee3537a77..c5d6e04d19e 100644 --- a/src/System.Management.Automation/engine/SessionStateAliasAPIs.cs +++ b/src/System.Management.Automation/engine/SessionStateAliasAPIs.cs @@ -17,7 +17,7 @@ internal sealed partial class SessionStateInternal /// /// Add a new alias entry to this session state object... /// - /// The entry to add + /// The entry to add. /// /// A scope identifier that is either one of the "special" scopes like /// "global", "script", "local", or "private, or a numeric ID of a relative scope diff --git a/src/System.Management.Automation/engine/SessionStateContainer.cs b/src/System.Management.Automation/engine/SessionStateContainer.cs index f2c7acf2d53..7c960055a9a 100644 --- a/src/System.Management.Automation/engine/SessionStateContainer.cs +++ b/src/System.Management.Automation/engine/SessionStateContainer.cs @@ -1672,8 +1672,8 @@ private bool IsPathContainer( /// /// The count of items that do not match any include/exclude criteria. /// - /// Indicates if this is a Enumerate/Remove operation - /// a hint used to skip IsItemContainer checks + /// Indicates if this is a Enumerate/Remove operation. + /// a hint used to skip IsItemContainer checks. /// /// If the refers to a provider that could not be found. /// @@ -1724,8 +1724,8 @@ private void ProcessPathItems( /// /// The count of items that do not match any include/exclude criteria. /// - /// Indicates if this is a Enumerate/Remove operation - /// a hint used to skip IsItemContainer checks + /// Indicates if this is a Enumerate/Remove operation. + /// a hint used to skip IsItemContainer checks. /// /// If the refers to a provider that could not be found. /// diff --git a/src/System.Management.Automation/engine/SessionStateDriveAPIs.cs b/src/System.Management.Automation/engine/SessionStateDriveAPIs.cs index 16d5224d39d..335732ff4a4 100644 --- a/src/System.Management.Automation/engine/SessionStateDriveAPIs.cs +++ b/src/System.Management.Automation/engine/SessionStateDriveAPIs.cs @@ -743,7 +743,7 @@ private PSDriveInfo AutomountFileSystemDrive(System.IO.DriveInfo systemDriveInfo /// /// Auto-mounts a built-in drive. /// - /// The name of the drive to load + /// The name of the drive to load. /// internal PSDriveInfo AutomountBuiltInDrive(string name) { diff --git a/src/System.Management.Automation/engine/SessionStateFunctionAPIs.cs b/src/System.Management.Automation/engine/SessionStateFunctionAPIs.cs index 64536f3a243..f5b75466d6c 100644 --- a/src/System.Management.Automation/engine/SessionStateFunctionAPIs.cs +++ b/src/System.Management.Automation/engine/SessionStateFunctionAPIs.cs @@ -19,7 +19,7 @@ internal sealed partial class SessionStateInternal /// /// Add an new SessionState function entry to this session state object... /// - /// The entry to add + /// The entry to add. internal void AddSessionStateEntry(SessionStateFunctionEntry entry) { ScriptBlock sb = entry.ScriptBlock.Clone(); diff --git a/src/System.Management.Automation/engine/SessionStateNavigation.cs b/src/System.Management.Automation/engine/SessionStateNavigation.cs index cbc22b87329..367d35498d2 100644 --- a/src/System.Management.Automation/engine/SessionStateNavigation.cs +++ b/src/System.Management.Automation/engine/SessionStateNavigation.cs @@ -637,7 +637,7 @@ internal string NormalizeRelativePath( /// Tests the specified character for equality with one of the powershell path separators and /// returns true if it matches. /// - /// The character to test + /// The character to test. /// True if the character is a path separator. private bool IsPathSeparator(char c) { diff --git a/src/System.Management.Automation/engine/SessionStatePublic.cs b/src/System.Management.Automation/engine/SessionStatePublic.cs index 8b6446ca7ac..843875f32aa 100644 --- a/src/System.Management.Automation/engine/SessionStatePublic.cs +++ b/src/System.Management.Automation/engine/SessionStatePublic.cs @@ -180,7 +180,7 @@ public CommandInvocationIntrinsics InvokeCommand /// then the check will be made. If the check fails, then an exception will be thrown... /// /// The command origin value to check against... - /// The object to check + /// The object to check. public static void ThrowIfNotVisible(CommandOrigin origin, object valueToCheck) { SessionStateException exception; @@ -245,8 +245,8 @@ public static void ThrowIfNotVisible(CommandOrigin origin, object valueToCheck) /// /// Checks the visibility of an object based on the command origin argument. /// - /// The origin to check against - /// The object to check + /// The origin to check against. + /// The object to check. /// Returns true if the object is visible, false otherwise. public static bool IsVisible(CommandOrigin origin, object valueToCheck) { @@ -263,8 +263,8 @@ public static bool IsVisible(CommandOrigin origin, object valueToCheck) /// /// Checks the visibility of an object based on the command origin argument. /// - /// The origin to check against - /// The variable to check + /// The origin to check against. + /// The variable to check. /// Returns true if the object is visible, false otherwise. public static bool IsVisible(CommandOrigin origin, PSVariable variable) { @@ -280,8 +280,8 @@ public static bool IsVisible(CommandOrigin origin, PSVariable variable) /// /// Checks the visibility of an object based on the command origin argument. /// - /// The origin to check against - /// The command to check + /// The origin to check against. + /// The command to check. /// Returns true if the object is visible, false otherwise. public static bool IsVisible(CommandOrigin origin, CommandInfo commandInfo) { diff --git a/src/System.Management.Automation/engine/SessionStateScope.cs b/src/System.Management.Automation/engine/SessionStateScope.cs index d6ba0d6c719..84c00d4176a 100644 --- a/src/System.Management.Automation/engine/SessionStateScope.cs +++ b/src/System.Management.Automation/engine/SessionStateScope.cs @@ -313,8 +313,8 @@ internal PSVariable GetVariable(string name) /// /// The name of the variable. /// The command origin (where the scope was created), used to decide if the variable is visible. - /// true if looking up the variable as part of a new or set variable operation - /// The variable, if one is found in scope + /// true if looking up the variable as part of a new or set variable operation. + /// The variable, if one is found in scope. /// Thrown if the variable is not visible based on CommandOrigin. /// True if there is a variable in scope, false otherwise. internal bool TryGetVariable(string name, CommandOrigin origin, bool fromNewOrSet, out PSVariable variable) @@ -506,8 +506,8 @@ internal PSVariable SetVariable(string name, object value, bool asValue, bool fo /// Sets a variable to scope without any checks. /// This is intended to be used only for global scope. /// - /// PSVariable to set - /// SessionState for variable + /// PSVariable to set. + /// SessionState for variable. /// internal void SetVariableForce(PSVariable variableToSet, SessionStateInternal sessionState) { diff --git a/src/System.Management.Automation/engine/SessionStateVariableAPIs.cs b/src/System.Management.Automation/engine/SessionStateVariableAPIs.cs index 310c264e02b..ccd154621cd 100644 --- a/src/System.Management.Automation/engine/SessionStateVariableAPIs.cs +++ b/src/System.Management.Automation/engine/SessionStateVariableAPIs.cs @@ -24,7 +24,7 @@ internal sealed partial class SessionStateInternal /// /// Add an new SessionStateVariable entry to this session state object... /// - /// The entry to add + /// The entry to add. internal void AddSessionStateEntry(SessionStateVariableEntry entry) { PSVariable v = new PSVariable(entry.Name, entry.Value, diff --git a/src/System.Management.Automation/engine/ShellVariable.cs b/src/System.Management.Automation/engine/ShellVariable.cs index cc51d5adc63..21952a53ecb 100644 --- a/src/System.Management.Automation/engine/ShellVariable.cs +++ b/src/System.Management.Automation/engine/ShellVariable.cs @@ -518,7 +518,7 @@ internal static object TransformValue(IEnumerable attributes, object /// attributes, so repeating that process is slow and wrong. This function /// applies the attributes without repeating the checks. /// - /// The list of attributes to add + /// The list of attributes to add. internal void AddParameterAttributesNoChecks(Collection attributes) { foreach (Attribute attribute in attributes) diff --git a/src/System.Management.Automation/engine/TypeMetadata.cs b/src/System.Management.Automation/engine/TypeMetadata.cs index 4619d11096f..2fdd54ca26a 100644 --- a/src/System.Management.Automation/engine/TypeMetadata.cs +++ b/src/System.Management.Automation/engine/TypeMetadata.cs @@ -44,7 +44,7 @@ internal ParameterSetMetadata(ParameterSetSpecificMetadata psMD) /// /// A copy constructor that creates a deep copy of the ParameterSetMetadata object. /// - /// object to copy + /// object to copy. internal ParameterSetMetadata(ParameterSetMetadata other) { if (other == null) @@ -424,7 +424,7 @@ public ParameterMetadata(string name, Type parameterType) /// A copy constructor that creates a deep copy of the ParameterMetadata object. /// Instances of Attribute and Type classes are copied by reference. /// - /// object to copy + /// object to copy. public ParameterMetadata(ParameterMetadata other) { if (other == null) diff --git a/src/System.Management.Automation/engine/TypeTable.cs b/src/System.Management.Automation/engine/TypeTable.cs index 42ce5bd39c6..7c225d32f5e 100644 --- a/src/System.Management.Automation/engine/TypeTable.cs +++ b/src/System.Management.Automation/engine/TypeTable.cs @@ -1647,8 +1647,8 @@ protected TypeTableLoadException(SerializationInfo info, StreamingContext contex /// /// Serializes the exception data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -2544,8 +2544,8 @@ public class MemberSetData : TypeMemberData /// /// MemberSetData constructor /// - /// The name of the MemberSet - /// The members of the MemberSet + /// The name of the MemberSet. + /// The members of the MemberSet. public MemberSetData(string name, Collection members) : base(name) { @@ -3626,7 +3626,7 @@ internal Collection GetSpecificProperties(ConsolidatedString types) /// Gets the MemberInfoCollection for types. This method will cache its /// return value for future reference to the same types. /// - /// list of types to get the member from + /// list of types to get the member from. /// internal PSMemberInfoInternalCollection GetMembers(ConsolidatedString types) where T : PSMemberInfo { @@ -3702,7 +3702,7 @@ private PSMemberInfoInternalCollection MemberFactory(string k, Con /// /// Gets the type converter for the typeName /// - /// type name with the converter + /// type name with the converter. /// The type converter for the typeName or null, if there is no type converter. internal object GetTypeConverter(string typeName) { @@ -4144,7 +4144,7 @@ private static void StandardMembersUpdated() /// /// Host passed to . Can be null if no interactive questions should be asked. /// - /// Indicate if the file failed to be loaded + /// Indicate if the file failed to be loaded. internal void Initialize( string snapinName, string fileToLoad, @@ -4237,12 +4237,12 @@ private string GetModuleContents( /// /// Helper method to update with module file contents. /// - /// Module contents - /// Module name - /// Module file path - /// Whether the module contents are fully trusted - /// Whether the module contents are considered part of Windows (e.g. catalog signed) - /// Errors + /// Module contents. + /// Module name. + /// Module file path. + /// Whether the module contents are fully trusted. + /// Whether the module contents are considered part of Windows (e.g. catalog signed). + /// Errors. private void UpdateWithModuleContents( string fileContents, string moduleName, @@ -4284,9 +4284,9 @@ internal void Remove(string typeFile) /// /// Update the TypeTable by adding a TypeData instance. /// - /// throw when the argument is null - /// throw when there were failures during the update - /// a TypeData instance to update the TypeTable + /// throw when the argument is null. + /// throw when there were failures during the update. + /// a TypeData instance to update the TypeTable. public void AddType(TypeData typeData) { if (typeData == null) @@ -4309,9 +4309,9 @@ public void AddType(TypeData typeData) /// /// Remove all type information related to the type name. /// - /// throw when the argument is null or empty - /// throw if there were failures when remove the type - /// the name of the type to remove from TypeTable + /// throw when the argument is null or empty. + /// throw if there were failures when remove the type. + /// the name of the type to remove from TypeTable. public void RemoveType(string typeName) { if (String.IsNullOrEmpty(typeName)) @@ -4380,7 +4380,7 @@ PSHost host /// /// Entry created to make reflection-based test suites happy. DO NOT USE THIS ENTRY /// - /// The path to the file to load + /// The path to the file to load. /// A place to put the errors... /// If true, reset the table to empty... /// @@ -4389,7 +4389,7 @@ PSHost host /// /// Host passed to . Can be null if no interactive questions should be asked. /// - /// Indicate if the file cannot be loaded due to the security reason + /// Indicate if the file cannot be loaded due to the security reason. /// /// 1. The TypeTable cannot be updated because the TypeTable might have /// been created outside of the Runspace. @@ -4409,7 +4409,7 @@ internal void Update( /// Update type data from a specific file... /// /// The name of the module or snapin that this file is associated with. - /// The path to the file to load + /// The path to the file to load. /// A place to put the errors... /// /// Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) @@ -4417,7 +4417,7 @@ internal void Update( /// /// Host passed to . Can be null if no interactive questions should be asked. /// - /// Indicate if the file cannot be loaded due to security reason + /// Indicate if the file cannot be loaded due to security reason. /// /// 1. The TypeTable cannot be updated because the TypeTable might have /// been created outside of the Runspace. diff --git a/src/System.Management.Automation/engine/UserFeedbackParameters.cs b/src/System.Management.Automation/engine/UserFeedbackParameters.cs index a024e1e2bdd..1a88d6b322b 100644 --- a/src/System.Management.Automation/engine/UserFeedbackParameters.cs +++ b/src/System.Management.Automation/engine/UserFeedbackParameters.cs @@ -57,7 +57,7 @@ internal PagingParameters(MshCommandRuntime commandRuntime) /// of objects that the cmdlet would return without paging /// (this can be more than the size of the page specified in the cmdlet parameter). /// - /// a total count of objects that the cmdlet would return without paging + /// a total count of objects that the cmdlet would return without paging. /// /// accuracy of the parameter. /// 1.0 means 100% accurate; diff --git a/src/System.Management.Automation/engine/Utils.cs b/src/System.Management.Automation/engine/Utils.cs index 58ee8336e61..65b7867d3fb 100644 --- a/src/System.Management.Automation/engine/Utils.cs +++ b/src/System.Management.Automation/engine/Utils.cs @@ -361,7 +361,7 @@ internal static string GetCurrentMajorVersion() /// Version.TryParse will be used to convert the string to a Version /// object. /// - /// string representing version + /// string representing version. /// A Version Object. internal static Version StringToVersion(string versionString) { @@ -402,7 +402,7 @@ internal static Version StringToVersion(string versionString) /// Checks whether current monad session supports version specified /// by ver. /// - /// Version to check + /// Version to check. /// True if supported, false otherwise. internal static bool IsPSVersionSupported(string ver) { @@ -415,7 +415,7 @@ internal static bool IsPSVersionSupported(string ver) /// Checks whether current monad session supports version specified /// by checkVersion. /// - /// Version to check + /// Version to check. /// True if supported, false otherwise. internal static bool IsPSVersionSupported(Version checkVersion) { @@ -437,7 +437,7 @@ internal static bool IsPSVersionSupported(Version checkVersion) /// Checks whether current PowerShell session supports edition specified /// by checkEdition. /// - /// Edition to check + /// Edition to check. /// True if supported, false otherwise. internal static bool IsPSEditionSupported(string checkEdition) { @@ -466,7 +466,7 @@ internal static bool IsPSEditionSupported(IEnumerable editions) /// /// Checks whether the specified edition value is allowed. /// - /// Edition value to check + /// Edition value to check. /// True if allowed, false otherwise. internal static bool IsValidPSEditionValue(string editionValue) { @@ -895,7 +895,7 @@ private static bool TryGetWindowsCurrentIdentity(out WindowsIdentity currentIden /// /// Gets the current impersonating Windows identity, if any /// - /// Current impersonated Windows identity or null + /// Current impersonated Windows identity or null. /// True if current identity is impersonated. internal static bool TryGetWindowsImpersonatedIdentity(out WindowsIdentity impersonatedIdentity) { @@ -1092,7 +1092,7 @@ internal static string GetPowerShellAssemblyStrongName(string assemblyName) /// /// If a mutex is abandoned, in our case, it is ok to proceed /// - /// The mutex to wait on. If it is null, a new one will be created + /// The mutex to wait on. If it is null, a new one will be created. /// The initializer to use to recreate the mutex. /// A working mutex. If the mutex was abandoned, a new one is created to replace it. internal static Mutex SafeWaitMutex(Mutex mutex, MutexInitializer initializer) @@ -1355,7 +1355,7 @@ internal static bool IsComObject(object obj) /// ConstrainedLanguage -> ConstrainedLanguage /// NoLanguage -> NoLanguage /// - /// ExecutionContext + /// ExecutionContext. /// Previous language mode or null for no language mode change. internal static PSLanguageMode? EnforceSystemLockDownLanguageMode(ExecutionContext context) { @@ -1838,8 +1838,8 @@ public static void SetTestHook(string property, object value) /// remote session, i.e., has run the Import-PSSession cmdlet. This hook will return true if the provided commandPipeline /// is successfully batched and run in the remote session, and false if it is rejected for batching. /// - /// Command pipeline to test - /// Runspace with imported remote session + /// Command pipeline to test. + /// Runspace with imported remote session. /// True if commandPipeline is batched successfully. public static bool TestImplicitRemotingBatching(string commandPipeline, System.Management.Automation.Runspaces.Runspace runspace) { diff --git a/src/System.Management.Automation/engine/VariableAttributeCollection.cs b/src/System.Management.Automation/engine/VariableAttributeCollection.cs index 8bcc7d6985a..d4881c2b9d6 100644 --- a/src/System.Management.Automation/engine/VariableAttributeCollection.cs +++ b/src/System.Management.Automation/engine/VariableAttributeCollection.cs @@ -96,7 +96,7 @@ protected override void SetItem(int index, Attribute item) /// has already been done, this function will add the attribute without checking /// and possibly updating the value. /// - /// The attribute to add + /// The attribute to add. internal void AddAttributeNoCheck(Attribute item) { base.InsertItem(this.Count, item); diff --git a/src/System.Management.Automation/engine/WorkflowInfo.cs b/src/System.Management.Automation/engine/WorkflowInfo.cs index 555e82b54a9..3b94c6819d7 100644 --- a/src/System.Management.Automation/engine/WorkflowInfo.cs +++ b/src/System.Management.Automation/engine/WorkflowInfo.cs @@ -67,7 +67,7 @@ internal WorkflowInfo(string name, string definition, ScriptBlock workflow, stri /// /// The workflows referenced within . /// - /// module + /// module. /// /// If is null. /// diff --git a/src/System.Management.Automation/engine/cmdlet.cs b/src/System.Management.Automation/engine/cmdlet.cs index 0c1b7f26b60..38413337215 100644 --- a/src/System.Management.Automation/engine/cmdlet.cs +++ b/src/System.Management.Automation/engine/cmdlet.cs @@ -230,8 +230,8 @@ protected Cmdlet() /// baseName and resourceId from the current assembly. /// You should override this if you require a different behavior. /// - /// the base resource name - /// the resource id + /// the base resource name. + /// the resource id. /// The resource string corresponding to baseName and resourceId. /// /// Invalid or , or @@ -316,7 +316,7 @@ public ICommandRuntime CommandRuntime /// a /// rather than the real exception. /// - /// error + /// error. /// /// Not permitted at this time or from this thread /// @@ -419,7 +419,7 @@ public void WriteObject(object sendToPipeline, bool enumerateCollection) /// /// Display verbose information /// - /// verbose output + /// verbose output. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. @@ -456,7 +456,7 @@ public void WriteVerbose(string text) /// /// Display warning information /// - /// warning output + /// warning output. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. @@ -493,7 +493,7 @@ public void WriteWarning(string text) /// /// Write text into pipeline execution log. /// - /// text to be written to log + /// text to be written to log. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. @@ -530,7 +530,7 @@ public void WriteCommandDetail(string text) /// /// Display progress information /// - /// progress information + /// progress information. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. @@ -601,7 +601,7 @@ internal void WriteProgress( /// /// Display debug information /// - /// debug output + /// debug output. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. @@ -1627,7 +1627,7 @@ public IEnumerable Invoke() /// /// The type returned by the enumerator /// An instance of the appropriate enumerator. - /// Thrown when the object returned by the cmdlet cannot be converted to the target type + /// Thrown when the object returned by the cmdlet cannot be converted to the target type. public IEnumerable Invoke() { using (PSTransactionManager.GetEngineProtectionScope()) diff --git a/src/System.Management.Automation/engine/debugger/debugger.cs b/src/System.Management.Automation/engine/debugger/debugger.cs index 90d3b7092fe..00bce00ba18 100644 --- a/src/System.Management.Automation/engine/debugger/debugger.cs +++ b/src/System.Management.Automation/engine/debugger/debugger.cs @@ -204,9 +204,9 @@ public bool IsAsync /// /// Constructor /// - /// Started job - /// Debugger - /// Job started asynchronously + /// Started job. + /// Debugger. + /// Job started asynchronously. public PSJobStartEventArgs(Job job, Debugger debugger, bool isAsync) { this.Job = job; @@ -476,7 +476,7 @@ public virtual bool InBreakpoint /// /// RaiseDebuggerStopEvent /// - /// DebuggerStopEventArgs + /// DebuggerStopEventArgs. [SuppressMessage("Microsoft.Design", "CA1030:UseEventsWhereAppropriate")] protected void RaiseDebuggerStopEvent(DebuggerStopEventArgs args) { @@ -503,7 +503,7 @@ protected bool IsDebuggerStopEventSubscribed() /// /// RaiseBreakpointUpdatedEvent /// - /// BreakpointUpdatedEventArgs + /// BreakpointUpdatedEventArgs. [SuppressMessage("Microsoft.Design", "CA1030:UseEventsWhereAppropriate")] protected void RaiseBreakpointUpdatedEvent(BreakpointUpdatedEventArgs args) { @@ -559,15 +559,15 @@ protected void RaiseCancelRunspaceDebugProcessingEvent() /// Evaluates provided command either as a debugger specific command /// or a PowerShell command. /// - /// PowerShell command - /// Output + /// PowerShell command. + /// Output. /// DebuggerCommandResults. public abstract DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output); /// /// Sets the debugger resume action. /// - /// DebuggerResumeAction + /// DebuggerResumeAction. public abstract void SetDebuggerAction(DebuggerResumeAction resumeAction); /// @@ -585,11 +585,11 @@ protected void RaiseCancelRunspaceDebugProcessingEvent() /// /// Sets the parent debugger, breakpoints and other debugging context information. /// - /// Parent debugger - /// List of breakpoints - /// Debugger mode - /// host - /// Current path + /// Parent debugger. + /// List of breakpoints. + /// Debugger mode. + /// host. + /// Current path. public virtual void SetParent( Debugger parent, IEnumerable breakPoints, @@ -638,7 +638,7 @@ public virtual void ResetCommandProcessorSource() /// /// Sets debugger stepping mode. /// - /// True if stepping is to be enabled + /// True if stepping is to be enabled. public virtual void SetDebuggerStepMode(bool enabled) { throw new PSNotImplementedException(); @@ -652,8 +652,8 @@ public virtual void SetDebuggerStepMode(bool enabled) /// Passes the debugger command to the internal script debugger command processor. This /// is used internally to handle debugger commands such as list, help, etc. /// - /// Command string - /// Output collection + /// Command string. + /// Output collection. /// DebuggerCommand containing information on whether and how the command was processed. internal virtual DebuggerCommand InternalProcessCommand(string command, IList output) { @@ -665,8 +665,8 @@ internal virtual DebuggerCommand InternalProcessCommand(string command, IList - /// Current source line - /// Output collection + /// Current source line. + /// Output collection. /// True if source listed successfully. internal virtual bool InternalProcessListCommand(int lineNum, IList output) { @@ -689,7 +689,7 @@ internal virtual void DebugJob(Job job) /// Removes job from debugger job list and pops the its /// debugger from the active debugger stack. /// - /// Job + /// Job. internal virtual void StopDebugJob(Job job) { throw new PSNotImplementedException(); @@ -709,7 +709,7 @@ internal virtual CallStackFrame[] GetActiveDebuggerCallStack() /// for monitoring of debugger events. This is used to implement nested /// debugging of runspaces. /// - /// PSEntityCreatedRunspaceEventArgs + /// PSEntityCreatedRunspaceEventArgs. internal virtual void StartMonitoringRunspace(PSMonitorRunspaceInfo args) { throw new PSNotImplementedException(); @@ -718,7 +718,7 @@ internal virtual void StartMonitoringRunspace(PSMonitorRunspaceInfo args) /// /// Method to end the monitoring of a runspace for debugging events. /// - /// PSEntityCreatedRunspaceEventArgs + /// PSEntityCreatedRunspaceEventArgs. internal virtual void EndMonitoringRunspace(PSMonitorRunspaceInfo args) { throw new PSNotImplementedException(); @@ -736,7 +736,7 @@ internal virtual void ReleaseSavedDebugStop() /// /// Sets up debugger to debug provided Runspace in a nested debug session. /// - /// Runspace to debug + /// Runspace to debug. internal virtual void DebugRunspace(Runspace runspace) { throw new PSNotImplementedException(); @@ -745,7 +745,7 @@ internal virtual void DebugRunspace(Runspace runspace) /// /// Removes the provided Runspace from the nested "active" debugger state. /// - /// Runspace + /// Runspace. internal virtual void StopDebugRunspace(Runspace runspace) { throw new PSNotImplementedException(); @@ -779,7 +779,7 @@ internal void RaiseNestedDebuggingCancelEvent() /// The queue will then raise the StartRunspaceDebugProcessing events for each runspace to allow /// a host script debugger implementation to provide an active debugging session. /// - /// Runspace to debug + /// Runspace to debug. internal virtual void QueueRunspaceForDebug(Runspace runspace) { throw new PSNotImplementedException(); @@ -2029,7 +2029,7 @@ private enum InternalDebugMode /// Sets the internal Execution context debug mode given the /// current DebugMode setting. /// - /// Internal debug mode + /// Internal debug mode. private void SetInternalDebugMode(InternalDebugMode mode) { lock (_syncObject) @@ -2148,7 +2148,7 @@ private void RestoreInternalDebugMode() /// /// Set ScriptDebugger action. /// - /// DebuggerResumeAction + /// DebuggerResumeAction. public override void SetDebuggerAction(DebuggerResumeAction resumeAction) { throw new PSNotSupportedException( @@ -2173,8 +2173,8 @@ public override DebuggerStopEventArgs GetDebuggerStopArgs() /// /// ProcessCommand /// - /// PowerShell command - /// Output + /// PowerShell command. + /// Output. /// DebuggerCommandResults. public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output) { @@ -2401,7 +2401,7 @@ public override void ResetCommandProcessorSource() /// /// Sets debugger stepping mode. /// - /// True if stepping is to be enabled + /// True if stepping is to be enabled. public override void SetDebuggerStepMode(bool enabled) { if (enabled) @@ -2418,8 +2418,8 @@ public override void SetDebuggerStepMode(bool enabled) /// Passes the debugger command to the internal script debugger command processor. This /// is used internally to handle debugger commands such as list, help, etc. /// - /// Command string - /// output + /// Command string. + /// output. /// DebuggerCommand containing information on whether and how the command was processed. internal override DebuggerCommand InternalProcessCommand(string command, IList output) { @@ -2442,8 +2442,8 @@ internal override DebuggerCommand InternalProcessCommand(string command, IList

- /// Current source line - /// Output collection + /// Current source line. + /// Output collection. /// True if source listed successfully. internal override bool InternalProcessListCommand(int lineNum, IList output) { @@ -2620,7 +2620,7 @@ private bool TryAddDebugJob(Job job) /// Removes job from debugger job list and pops its /// debugger from the active debugger stack. /// - /// Job + /// Job. internal override void StopDebugJob(Job job) { // Parameter validation. @@ -2643,8 +2643,8 @@ internal override void StopDebugJob(Job job) ///

/// Helper method to set a IJobDebugger job CanDebug property. /// - /// IJobDebugger - /// Boolean + /// IJobDebugger. + /// Boolean. internal static void SetDebugJobAsync(IJobDebugger debuggableJob, bool isAsync) { if (debuggableJob != null) @@ -2660,7 +2660,7 @@ internal static void SetDebugJobAsync(IJobDebugger debuggableJob, bool isAsync) /// /// Sets up debugger to debug provided Runspace in a nested debug session. /// - /// Runspace to debug + /// Runspace to debug. internal override void DebugRunspace(Runspace runspace) { if (runspace == null) @@ -2705,7 +2705,7 @@ internal override void DebugRunspace(Runspace runspace) /// /// Removes the provided Runspace from the nested "active" debugger state. /// - /// Runspace + /// Runspace. internal override void StopDebugRunspace(Runspace runspace) { if (runspace == null) { throw new PSArgumentNullException("runspace"); } @@ -2726,7 +2726,7 @@ internal override void StopDebugRunspace(Runspace runspace) /// The queue will then raise the StartRunspaceDebugProcessing events for each runspace to allow /// a host script debugger implementation to provide an active debugging session. /// - /// Runspace to debug + /// Runspace to debug. internal override void QueueRunspaceForDebug(Runspace runspace) { runspace.StateChanged += RunspaceStateChangedHandler; @@ -3924,9 +3924,9 @@ public Guid ParentDebuggerId /// /// Creates an instance of NestedRunspaceDebugger. /// - /// Runspace - /// Runspace type - /// Debugger Id of parent + /// Runspace. + /// Runspace type. + /// Debugger Id of parent. public NestedRunspaceDebugger( Runspace runspace, PSMonitorRunspaceType runspaceType, @@ -3955,8 +3955,8 @@ public NestedRunspaceDebugger( /// /// Process debugger or PowerShell command/script. /// - /// PowerShell command - /// Output collection + /// PowerShell command. + /// Output collection. /// DebuggerCommandResults. public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output) { @@ -3991,7 +3991,7 @@ public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataC /// /// SetDebuggerAction /// - /// Debugger resume action + /// Debugger resume action. public override void SetDebuggerAction(DebuggerResumeAction resumeAction) { _wrappedDebugger.SetDebuggerAction(resumeAction); @@ -4018,7 +4018,7 @@ public override DebuggerStopEventArgs GetDebuggerStopArgs() /// /// Sets the debugger mode. /// - /// Debug mode + /// Debug mode. public override void SetDebugMode(DebugModes mode) { _wrappedDebugger.SetDebugMode(mode); @@ -4027,7 +4027,7 @@ public override void SetDebugMode(DebugModes mode) /// /// Sets debugger stepping mode. /// - /// True if stepping is to be enabled + /// True if stepping is to be enabled. public override void SetDebuggerStepMode(bool enabled) { _wrappedDebugger.SetDebuggerStepMode(enabled); @@ -4215,7 +4215,7 @@ internal sealed class StandaloneRunspaceDebugger : NestedRunspaceDebugger /// /// Constructor /// - /// Runspace + /// Runspace. public StandaloneRunspaceDebugger( Runspace runspace) : base(runspace, PSMonitorRunspaceType.Standalone, Guid.Empty) @@ -4325,11 +4325,11 @@ internal sealed class EmbeddedRunspaceDebugger : NestedRunspaceDebugger /// /// Constructor for runspaces executing from script. /// - /// Runspace to debug - /// PowerShell command - /// Root debugger - /// Runspace to monitor type - /// Parent debugger Id + /// Runspace to debug. + /// PowerShell command. + /// Root debugger. + /// Runspace to monitor type. + /// Parent debugger Id. public EmbeddedRunspaceDebugger( Runspace runspace, PowerShell command, @@ -4418,7 +4418,7 @@ protected override bool HandleListCommand(PSDataCollection output) /// cases where the debugged runspace is called inside a parent sccript, /// such as with Workflow InlineScripts and script Invoke-Command cases. /// - /// Invocation information from debugger stop + /// Invocation information from debugger stop. /// InvocationInfo. internal override InvocationInfo FixupInvocationInfo(InvocationInfo debugStopInvocationInfo) { @@ -4646,8 +4646,8 @@ private DebuggerCommandResults() /// /// Constructor /// - /// Resume action - /// True if evaluated by debugger + /// Resume action. + /// True if evaluated by debugger. public DebuggerCommandResults( DebuggerResumeAction? resumeAction, bool evaluatedByDebugger) @@ -4764,8 +4764,8 @@ public DebuggerCommand ProcessCommand(PSHost host, string command, InvocationInf /// /// Process list command with provided line number. /// - /// Current InvocationInfo - /// Output + /// Current InvocationInfo. + /// Output. public void ProcessListCommand(InvocationInfo invocationInfo, IList output) { DoProcessCommand(null, "list", invocationInfo, output); @@ -4775,7 +4775,7 @@ public void ProcessListCommand(InvocationInfo invocationInfo, IList ou /// Looks up string command and if it is a debugger command returns the /// corresponding DebuggerCommand object. /// - /// String command + /// String command. /// DebuggerCommand or null. public DebuggerCommand ProcessBasicCommand(string command) { @@ -5072,8 +5072,8 @@ public class PSDebugContext /// /// Constructor. /// - /// InvocationInfo - /// Breakpoints + /// InvocationInfo. + /// Breakpoints. public PSDebugContext(InvocationInfo invocationInfo, List breakpoints) { if (breakpoints == null) @@ -5109,7 +5109,7 @@ public sealed class CallStackFrame /// /// Constructor /// - /// Invocation Info + /// Invocation Info. public CallStackFrame(InvocationInfo invocationInfo) : this(null, invocationInfo) { @@ -5118,8 +5118,8 @@ public CallStackFrame(InvocationInfo invocationInfo) /// /// Constructor /// - /// Function context - /// Invocation Info + /// Function context. + /// Invocation Info. internal CallStackFrame(FunctionContext functionContext, InvocationInfo invocationInfo) { if (invocationInfo == null) @@ -5339,7 +5339,7 @@ public static class DebuggerUtils /// Helper method to determine if command should be added to debugger /// history. /// - /// Command string + /// Command string. /// True if command can be added to history. public static bool ShouldAddCommandToHistory(string command) { @@ -5372,8 +5372,8 @@ public static IEnumerable GetWorkflowDebuggerFunctions() /// /// Start monitoring a runspace on the target debugger. /// - /// Target debugger - /// PSMonitorRunspaceInfo + /// Target debugger. + /// PSMonitorRunspaceInfo. public static void StartMonitoringRunspace(Debugger debugger, PSMonitorRunspaceInfo runspaceInfo) { if (debugger == null) @@ -5392,8 +5392,8 @@ public static void StartMonitoringRunspace(Debugger debugger, PSMonitorRunspaceI /// /// End monitoring a runspace on the target degbugger. /// - /// Target debugger - /// PSMonitorRunspaceInfo + /// Target debugger. + /// PSMonitorRunspaceInfo. public static void EndMonitoringRunspace(Debugger debugger, PSMonitorRunspaceInfo runspaceInfo) { if (debugger == null) @@ -5466,8 +5466,8 @@ private PSMonitorRunspaceInfo() { } /// /// Constructor /// - /// Runspace - /// Runspace type + /// Runspace. + /// Runspace type. protected PSMonitorRunspaceInfo( Runspace runspace, PSMonitorRunspaceType runspaceType) @@ -5512,7 +5512,7 @@ public sealed class PSStandaloneMonitorRunspaceInfo : PSMonitorRunspaceInfo /// /// Creates instance of PSStandaloneMonitorRunspaceInfo /// - /// Runspace to monitor + /// Runspace to monitor. public PSStandaloneMonitorRunspaceInfo( Runspace runspace) : base(runspace, PSMonitorRunspaceType.Standalone) @@ -5534,7 +5534,7 @@ internal override PSMonitorRunspaceInfo Copy() /// /// Creates an instance of a NestedRunspaceDebugger. /// - /// Root debugger or null + /// Root debugger or null. /// NestedRunspaceDebugger wrapper. internal override NestedRunspaceDebugger CreateDebugger(Debugger rootDebugger) { @@ -5570,10 +5570,10 @@ public sealed class PSEmbeddedMonitorRunspaceInfo : PSMonitorRunspaceInfo /// /// Creates instance of PSEmbeddedMonitorRunspaceInfo /// - /// Runspace to monitor - /// Type of runspace - /// Running command - /// Unique parent debugger id or null + /// Runspace to monitor. + /// Type of runspace. + /// Running command. + /// Unique parent debugger id or null. public PSEmbeddedMonitorRunspaceInfo( Runspace runspace, PSMonitorRunspaceType runspaceType, @@ -5605,7 +5605,7 @@ internal override PSMonitorRunspaceInfo Copy() /// /// Creates an instance of a NestedRunspaceDebugger. /// - /// Root debugger or null + /// Root debugger or null. /// NestedRunspaceDebugger wrapper. internal override NestedRunspaceDebugger CreateDebugger(Debugger rootDebugger) { diff --git a/src/System.Management.Automation/engine/hostifaces/AsyncResult.cs b/src/System.Management.Automation/engine/hostifaces/AsyncResult.cs index 4b4664b0c9c..243d9009bc9 100644 --- a/src/System.Management.Automation/engine/hostifaces/AsyncResult.cs +++ b/src/System.Management.Automation/engine/hostifaces/AsyncResult.cs @@ -234,8 +234,8 @@ internal void EndInvoke() /// /// Use blocked thread to invoke callback delegate. /// - /// Callback delegate - /// Callback state + /// Callback delegate. + /// Callback state. internal bool InvokeCallbackOnThread(WaitCallback callback, object state) { if (callback == null) diff --git a/src/System.Management.Automation/engine/hostifaces/Command.cs b/src/System.Management.Automation/engine/hostifaces/Command.cs index e7a77b26000..c11ba595f3d 100644 --- a/src/System.Management.Automation/engine/hostifaces/Command.cs +++ b/src/System.Management.Automation/engine/hostifaces/Command.cs @@ -20,8 +20,8 @@ public sealed class Command /// /// Initializes a new instance of Command class using specified command parameter. /// - /// Name of the command or script contents - /// command is null + /// Name of the command or script contents. + /// command is null. public Command(string command) : this(command, false, null) { @@ -30,9 +30,9 @@ public Command(string command) /// /// Initializes a new instance of Command class using specified command parameter. /// - /// The command name or script contents + /// The command name or script contents. /// True if this command represents a script, otherwise; false. - /// command is null + /// command is null. public Command(string command, bool isScript) : this(command, isScript, null) { @@ -41,10 +41,10 @@ public Command(string command, bool isScript) /// /// Constructor /// - /// The command name or script contents + /// The command name or script contents. /// True if this command represents a script, otherwise; false. - /// if true local scope is used to run the script command - /// command is null + /// if true local scope is used to run the script command. + /// command is null. public Command(string command, bool isScript, bool useLocalScope) { IsEndOfStatement = false; @@ -567,7 +567,7 @@ CommandOrigin origin /// Creates a Command object from a PSObject property bag. /// PSObject has to be in the format returned by ToPSObjectForRemoting method. /// - /// PSObject to rehydrate + /// PSObject to rehydrate. /// /// Command rehydrated from a PSObject property bag /// @@ -634,7 +634,7 @@ internal static Command FromPSObjectForRemoting(PSObject commandAsPSObject) /// Returns this object as a PSObject property bag /// that can be used in a remoting protocol data object. /// - /// PowerShell remoting protocol version + /// PowerShell remoting protocol version. /// This object as a PSObject property bag. internal PSObject ToPSObjectForRemoting(Version psRPVersion) { @@ -853,7 +853,7 @@ internal void Add(string command, bool mergeUnclaimedPreviousCommandError) /// /// Adds a new script command /// - /// script contents + /// script contents. /// /// scriptContents is null. /// @@ -865,8 +865,8 @@ public void AddScript(string scriptContents) /// /// Adds a new scrip command for given script /// - /// script contents - /// if true local scope is used to run the script command + /// script contents. + /// if true local scope is used to run the script command. /// /// scriptContents is null. /// diff --git a/src/System.Management.Automation/engine/hostifaces/Connection.cs b/src/System.Management.Automation/engine/hostifaces/Connection.cs index fbad050777b..3e76af1036c 100644 --- a/src/System.Management.Automation/engine/hostifaces/Connection.cs +++ b/src/System.Management.Automation/engine/hostifaces/Connection.cs @@ -64,8 +64,8 @@ public InvalidRunspaceStateException(string message, Exception innerException) /// with a specified error message and current and expected state. /// /// The message that describes the error. - /// Current state of runspace - /// Expected states of runspace + /// Current state of runspace. + /// Expected states of runspace. internal InvalidRunspaceStateException ( string message, @@ -1409,7 +1409,7 @@ public static Runspace GetRunspace(RunspaceConnectionInfo connectionInfo, Guid s /// /// Creates a pipeline for specified command string /// - /// A valid command string + /// A valid command string. /// /// A pipeline pre-filled with a object for specified command parameter. /// @@ -1421,8 +1421,8 @@ public static Runspace GetRunspace(RunspaceConnectionInfo connectionInfo, Guid s /// /// Create a pipeline from a command string. /// - /// A valid command string - /// if true command is added to history + /// A valid command string. + /// if true command is added to history. /// /// A pipeline pre-filled with a object for specified command parameter. /// @@ -1444,8 +1444,8 @@ public static Runspace GetRunspace(RunspaceConnectionInfo connectionInfo, Guid s /// /// Creates a nested pipeline. /// - /// A valid command string - /// if true command is added to history + /// A valid command string. + /// if true command is added to history. /// /// A pipeline pre-filled with Command specified in commandString. /// @@ -1481,7 +1481,7 @@ public static Runspace GetRunspace(RunspaceConnectionInfo connectionInfo, Guid s /// /// Push a running PowerShell onto the stack. /// - /// PowerShell + /// PowerShell. internal void PushRunningPowerShell(PowerShell ps) { Dbg.Assert(ps != null, "Caller should not pass in null reference."); diff --git a/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs b/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs index d6ad04706bc..7bf5e4d7acb 100644 --- a/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs +++ b/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs @@ -29,7 +29,7 @@ internal abstract class RunspaceBase : Runspace /// Construct an instance of an Runspace using a custom /// implementation of PSHost. /// - /// The explicit PSHost implementation + /// The explicit PSHost implementation. /// /// Host is null. /// @@ -51,7 +51,7 @@ protected RunspaceBase(PSHost host) /// Construct an instance of an Runspace using a custom /// implementation of PSHost. /// - /// The explicit PSHost implementation + /// The explicit PSHost implementation. /// /// Host is null. /// @@ -530,7 +530,7 @@ public override Pipeline CreatePipeline() /// /// Create a pipeline from a command string /// - /// A valid command string + /// A valid command string. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -550,8 +550,8 @@ public override Pipeline CreatePipeline(string command) /// /// Create a pipeline from a command string. /// - /// A valid command string - /// if true command is added to history + /// A valid command string. + /// if true command is added to history. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -584,8 +584,8 @@ public override Pipeline CreateNestedPipeline() /// /// Creates a nested pipeline. /// - /// A valid command string - /// if true command is added to history + /// A valid command string. + /// if true command is added to history. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -606,8 +606,8 @@ public override Pipeline CreateNestedPipeline(string command, bool addToHistory) /// Create a pipeline from a command string /// /// A valid command string or String.Empty. - /// if true command is added to history - /// True for nested pipeline + /// if true command is added to history. + /// True for nested pipeline. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -696,7 +696,7 @@ public RunspaceEventQueueItem(RunspaceStateInfo runspaceStateInfo, RunspaceAvail /// /// Set the new runspace state. /// - /// the new state + /// the new state. /// An exception indicating the state change is the /// result of an error, otherwise; null. /// @@ -735,7 +735,7 @@ protected void SetRunspaceState(RunspaceState state, Exception reason) /// /// Set the current runspace state - no error /// - /// the new state + /// the new state. protected void SetRunspaceState(RunspaceState state) { this.SetRunspaceState(state, null); @@ -1515,8 +1515,8 @@ internal ProviderIntrinsics InvokeProvider /// Protected methods to be implemented by derived class. /// This does the actual work of setting variable. /// - /// Name of the variable to set - /// The value to set it to + /// Name of the variable to set. + /// The value to set it to. protected abstract void DoSetVariable(string name, object value); /// diff --git a/src/System.Management.Automation/engine/hostifaces/DefaultHost.cs b/src/System.Management.Automation/engine/hostifaces/DefaultHost.cs index 5ea86eeef5c..c6cf950db59 100644 --- a/src/System.Management.Automation/engine/hostifaces/DefaultHost.cs +++ b/src/System.Management.Automation/engine/hostifaces/DefaultHost.cs @@ -21,8 +21,8 @@ internal class DefaultHost : PSHost /// /// Creates an instance based on the current culture and current UI culture /// - /// Current culture for this host - /// Current UI culture for this host + /// Current culture for this host. + /// Current UI culture for this host. /// internal DefaultHost(CultureInfo currentCulture, CultureInfo currentUICulture) diff --git a/src/System.Management.Automation/engine/hostifaces/History.cs b/src/System.Management.Automation/engine/hostifaces/History.cs index c6913608846..1bc88f1f829 100644 --- a/src/System.Management.Automation/engine/hostifaces/History.cs +++ b/src/System.Management.Automation/engine/hostifaces/History.cs @@ -24,10 +24,10 @@ public class HistoryInfo /// /// Id of pipeline in which command associated /// with this history entry is executed - /// command string - /// status of pipeline execution - /// startTime of execution - /// endTime of execution + /// command string. + /// status of pipeline execution. + /// startTime of execution. + /// endTime of execution. internal HistoryInfo(long pipelineId, string cmdline, PipelineState status, DateTime startTime, DateTime endTime) { Dbg.Assert(cmdline != null, "caller should validate the parameter"); @@ -195,7 +195,7 @@ internal History(ExecutionContext context) /// /// /// - /// If true, the entry will not be added when the history is locked + /// If true, the entry will not be added when the history is locked. /// Id for the new created entry. Use this id to fetch the /// entry. Returns -1 if the entry is not added. /// This function is thread safe @@ -222,10 +222,10 @@ internal long AddEntry(long pipelineId, string cmdline, PipelineState status, Da /// /// Update the history entry corresponding to id. /// - /// id of history entry to be updated - /// status to be updated - /// endTime to be updated - /// If true, the entry will not be added when the history is locked + /// id of history entry to be updated. + /// status to be updated. + /// endTime to be updated. + /// If true, the entry will not be added when the history is locked. /// internal void UpdateEntry(long id, PipelineState status, DateTime endTime, bool skipIfLocked) { @@ -253,7 +253,7 @@ internal void UpdateEntry(long id, PipelineState status, DateTime endTime, bool /// Gets entry from buffer for given id. This id should be the /// id returned by Add method. /// - /// Id of the entry to be fetched + /// Id of the entry to be fetched. /// Entry corresponding to id if it is present else null /// internal HistoryInfo GetEntry(long id) @@ -551,7 +551,7 @@ internal HistoryInfo[] GetEntries(WildcardPattern wildcardpattern, long count, S /// /// Clears the history entry from buffer for a given id. /// - /// Id of the entry to be Cleared + /// Id of the entry to be Cleared. /// Nothing. internal void ClearEntry(long id) { @@ -630,7 +630,7 @@ private long Add(HistoryInfo entry) /// Gets entry from buffer for given id. This id should be the /// id returned by Add method. /// - /// Id of the entry to be fetched + /// Id of the entry to be fetched. /// Entry corresponding to id if it is present else null /// private HistoryInfo CoreGetEntry(long id) @@ -1893,10 +1893,10 @@ private void ClearHistoryByCmdLine() /// /// Clears the session history based on the input parameter - /// id of the entry to be cleared - /// count of entries to be cleared - /// cmdline string to be cleared - /// order of the entries + /// id of the entry to be cleared. + /// count of entries to be cleared. + /// cmdline string to be cleared. + /// order of the entries. /// Nothing. /// diff --git a/src/System.Management.Automation/engine/hostifaces/HostUtilities.cs b/src/System.Management.Automation/engine/hostifaces/HostUtilities.cs index 12514e5115d..f32fbf16d67 100644 --- a/src/System.Management.Automation/engine/hostifaces/HostUtilities.cs +++ b/src/System.Management.Automation/engine/hostifaces/HostUtilities.cs @@ -105,12 +105,12 @@ internal static PSCommand[] GetProfileCommands(string shellId) /// Gets the object that serves as a value to $profile and the paths on it /// /// The id identifying the host or shell used in profile file names. - /// used from test not to overwrite the profile file names from development boxes - /// path for all users and all hosts - /// path for current user and all hosts - /// path for all users current host - /// path for current user and current host - /// the object that serves as a value to $profile + /// used from test not to overwrite the profile file names from development boxes. + /// path for all users and all hosts. + /// path for current user and all hosts. + /// path for all users current host. + /// path for current user and current host. + /// the object that serves as a value to $profile. /// internal static void GetProfileObjectData(string shellId, bool useTestProfile, out string allUsersAllHosts, out string allUsersCurrentHost, out string currentUserAllHosts, out string currentUserCurrentHost, out PSObject dollarProfile) { @@ -125,7 +125,7 @@ internal static void GetProfileObjectData(string shellId, bool useTestProfile, o /// Gets an array of commands that can be run sequentially to set $profile and run the profile commands. /// /// The id identifying the host or shell used in profile file names. - /// used from test not to overwrite the profile file names from development boxes + /// used from test not to overwrite the profile file names from development boxes. /// internal static PSCommand[] GetProfileCommands(string shellId, bool useTestProfile) { @@ -160,7 +160,7 @@ internal static PSCommand[] GetProfileCommands(string shellId, bool useTestProfi /// /// Used to get all profile file names for the current or all hosts and for the current or all users. /// - /// null for all hosts, not null for the specified host + /// null for all hosts, not null for the specified host. /// false for all users, true for the current user. /// The profile file name matching the parameters. internal static string GetFullProfileFileName(string shellId, bool forCurrentUser) @@ -171,9 +171,9 @@ internal static string GetFullProfileFileName(string shellId, bool forCurrentUse /// /// Used to get all profile file names for the current or all hosts and for the current or all users. /// - /// null for all hosts, not null for the specified host + /// null for all hosts, not null for the specified host. /// false for all users, true for the current user. - /// used from test not to overwrite the profile file names from development boxes + /// used from test not to overwrite the profile file names from development boxes. /// The profile file name matching the parameters. internal static string GetFullProfileFileName(string shellId, bool forCurrentUser, bool useTestProfile) { @@ -227,8 +227,8 @@ private static string GetAllUsersFolderPath(string shellId) /// /// Gets the first lines of . /// - /// string we want to limit the number of lines - /// maximum number of lines to be returned + /// string we want to limit the number of lines. + /// maximum number of lines to be returned. /// The first lines of . internal static string GetMaxLines(string source, int maxLines) { @@ -880,8 +880,8 @@ internal static RemoteRunspace CreateConfiguredRunspace( /// provided runspace. It assumes the thread invoking this method is the same that runs all other /// commands on the provided runspace. /// - /// Runspace to invoke the command on - /// Command to invoke + /// Runspace to invoke the command on. + /// Command to invoke. /// Collection of command output result objects. public static Collection InvokeOnRunspace(PSCommand command, Runspace runspace) { diff --git a/src/System.Management.Automation/engine/hostifaces/InformationalRecord.cs b/src/System.Management.Automation/engine/hostifaces/InformationalRecord.cs index f56349eaea4..d55f225c8f2 100644 --- a/src/System.Management.Automation/engine/hostifaces/InformationalRecord.cs +++ b/src/System.Management.Automation/engine/hostifaces/InformationalRecord.cs @@ -186,8 +186,8 @@ public WarningRecord(PSObject record) /// /// Constructor for Fully qualified warning Id. /// - /// Fully qualified warning Id - /// Warning message + /// Fully qualified warning Id. + /// Warning message. public WarningRecord(string fullyQualifiedWarningId, string message) : base(message) { @@ -197,8 +197,8 @@ public WarningRecord(string fullyQualifiedWarningId, string message) /// /// Constructor for Fully qualified warning Id. /// - /// Fully qualified warning Id - /// Warning serialized object + /// Fully qualified warning Id. + /// Warning serialized object. public WarningRecord(string fullyQualifiedWarningId, PSObject record) : base(record) { @@ -260,4 +260,4 @@ public VerboseRecord(PSObject record) : base(record) { } } -} \ No newline at end of file +} diff --git a/src/System.Management.Automation/engine/hostifaces/InternalHostUserInterface.cs b/src/System.Management.Automation/engine/hostifaces/InternalHostUserInterface.cs index e81e5b38fe0..36116c20682 100644 --- a/src/System.Management.Automation/engine/hostifaces/InternalHostUserInterface.cs +++ b/src/System.Management.Automation/engine/hostifaces/InternalHostUserInterface.cs @@ -346,7 +346,7 @@ internal void WriteDebugRecord(DebugRecord record) /// /// Writes the DebugRecord to informational buffers. /// - /// DebugRecord + /// DebugRecord. internal void WriteDebugInfoBuffers(DebugRecord record) { if (_informationalBuffers != null) @@ -599,7 +599,7 @@ internal void WriteVerboseRecord(VerboseRecord record) /// /// Writes the VerboseRecord to informational buffers. /// - /// VerboseRecord + /// VerboseRecord. internal void WriteVerboseInfoBuffers(VerboseRecord record) { if (_informationalBuffers != null) @@ -643,7 +643,7 @@ internal void WriteWarningRecord(WarningRecord record) /// /// Writes the WarningRecord to informational buffers. /// - /// WarningRecord + /// WarningRecord. internal void WriteWarningInfoBuffers(WarningRecord record) { if (_informationalBuffers != null) @@ -669,7 +669,7 @@ internal void WriteInformationRecord(InformationRecord record) /// /// Writes the InformationRecord to informational buffers. /// - /// WarningRecord + /// WarningRecord. internal void WriteInformationInfoBuffers(InformationRecord record) { if (_informationalBuffers != null) diff --git a/src/System.Management.Automation/engine/hostifaces/ListModifier.cs b/src/System.Management.Automation/engine/hostifaces/ListModifier.cs index 1b5f5477f99..f09376c488a 100644 --- a/src/System.Management.Automation/engine/hostifaces/ListModifier.cs +++ b/src/System.Management.Automation/engine/hostifaces/ListModifier.cs @@ -35,8 +35,8 @@ public PSListModifier() /// /// Create a new PSListModifier with the specified add and remove lists. /// - /// The items to remove - /// The items to add + /// The items to remove. + /// The items to add. public PSListModifier(Collection removeItems, Collection addItems) { _itemsToAdd = addItems ?? new Collection(); @@ -47,7 +47,7 @@ public PSListModifier(Collection removeItems, Collection addItem /// /// Create a new PSListModifier to replace a given list with replaceItems. /// - /// The item(s) to replace an existing list with + /// The item(s) to replace an existing list with. public PSListModifier(object replacementItems) { _itemsToAdd = new Collection(); @@ -176,7 +176,7 @@ public Collection Replace /// /// Update the given collection with the items in Add and Remove. /// - /// The collection to update + /// The collection to update. public void ApplyTo(IList collectionToUpdate) { if (collectionToUpdate == null) @@ -209,7 +209,7 @@ public void ApplyTo(IList collectionToUpdate) /// /// Update the given collection with the items in Add and Remove. /// - /// The collection to update + /// The collection to update. public void ApplyTo(object collectionToUpdate) { if (collectionToUpdate == null) @@ -275,8 +275,8 @@ public PSListModifier() /// /// Create a new PSListModifier with the specified add and remove lists. /// - /// The items to remove - /// The items to add + /// The items to remove. + /// The items to add. public PSListModifier(Collection removeItems, Collection addItems) : base(removeItems, addItems) { @@ -285,7 +285,7 @@ public PSListModifier(Collection removeItems, Collection addItem /// /// Create a new PSListModifier to replace a given list with replaceItems. /// - /// The items to replace an existing list with + /// The items to replace an existing list with. public PSListModifier(object replacementItems) : base(replacementItems) { diff --git a/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs b/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs index 021b072587d..fc8c46f0101 100644 --- a/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs +++ b/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs @@ -214,9 +214,9 @@ public override void ResetRunspaceState() /// /// Create a pipeline from a command string /// - /// A valid command string. Can be null - /// if true command is added to history - /// True for nested pipeline + /// A valid command string. Can be null. + /// if true command is added to history. + /// True for nested pipeline. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -365,7 +365,7 @@ public class DebugPreference /// /// CreateDebugPerfStruct is a helper method to populate DebugPreference /// - /// App Domain Names + /// App Domain Names. /// DebugPreference. private static DebugPreference CreateDebugPreference(string[] AppDomainNames) { @@ -377,8 +377,8 @@ private static DebugPreference CreateDebugPreference(string[] AppDomainNames) /// /// SetDebugPreference is a helper method used to enable and disable debug preference. /// - /// Process Name - /// App Domain Name + /// Process Name. + /// App Domain Name. /// Indicates if the debug preference has to be enabled or disabled. internal static void SetDebugPreference(string processName, List appDomainName, bool enable) { @@ -525,7 +525,7 @@ internal static void SetDebugPreference(string processName, List appDoma /// GetDebugPreferenceCache is a helper method used to fetch /// the debug preference cache contents as a Hashtable. /// - /// Runspace + /// Runspace. /// If the Debug preference is persisted then a hashtable containing /// the debug preference is returned or else Null is returned. private static Hashtable GetDebugPreferenceCache(Runspace runspace) @@ -1337,7 +1337,7 @@ internal StopJobOperationHelper(Job job) /// /// Handles the Job state change event. /// - /// Originator of event, unused + /// Originator of event, unused. /// Event arguments containing Job state. private void HandleJobStateChanged(object sender, JobStateEventArgs eventArgs) { @@ -1414,8 +1414,8 @@ internal CloseOrDisconnectRunspaceOperationHelper(RemoteRunspace remoteRunspace) /// /// Handle the runspace state changed event /// - /// sender of this information, unused - /// runspace event args + /// sender of this information, unused. + /// runspace event args. private void HandleRunspaceStateChanged(object sender, RunspaceStateEventArgs eventArgs) { switch (eventArgs.RunspaceStateInfo.State) @@ -1518,7 +1518,7 @@ public RunspaceOpenModuleLoadException() /// /// Initializes a new instance of ScriptBlockToPowerShellNotSupportedException setting the message /// - /// the exception's message + /// the exception's message. public RunspaceOpenModuleLoadException(string message) : base(message) { @@ -1527,8 +1527,8 @@ public RunspaceOpenModuleLoadException(string message) /// /// Initializes a new instance of ScriptBlockToPowerShellNotSupportedException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public RunspaceOpenModuleLoadException(string message, Exception innerException) : base(message, innerException) { @@ -1537,8 +1537,8 @@ public RunspaceOpenModuleLoadException(string message, Exception innerException) /// /// Recommended constructor for the class /// - /// The name of the module that cause the error - /// The collection of errors that occurred during module processing + /// The name of the module that cause the error. + /// The collection of errors that occurred during module processing. internal RunspaceOpenModuleLoadException( string moduleName, PSDataCollection errors) @@ -1566,8 +1566,8 @@ public PSDataCollection ErrorRecords /// /// Initializes a new instance of RunspaceOpenModuleLoadException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected RunspaceOpenModuleLoadException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs b/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs index fa32c72bc92..d700acf1dfb 100644 --- a/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs +++ b/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs @@ -40,8 +40,8 @@ internal sealed class LocalPipeline : PipelineBase /// pipeline. /// /// The command string to parse. - /// if true, add pipeline to history - /// True for nested pipeline + /// if true, add pipeline to history. + /// True for nested pipeline. internal LocalPipeline(LocalRunspace runspace, string command, bool addToHistory, bool isNested) : base((Runspace)runspace, command, addToHistory, isNested) { @@ -95,7 +95,7 @@ internal LocalPipeline(LocalRunspace runspace, /// /// Copy constructor to support cloning /// - /// The source pipeline + /// The source pipeline. internal LocalPipeline(LocalPipeline pipeline) : base((PipelineBase)(pipeline)) { @@ -934,7 +934,7 @@ private PipelineProcessor CreatePipelineProcessor() /// /// Resolves command.CommandInfo to an appropriate CommandProcessorBase implementation /// - /// command to resolve + /// command to resolve. /// private CommandProcessorBase CreateCommandProcessBase(Command command) { @@ -1064,7 +1064,7 @@ void UpdateHistoryEntryAddedByAddHistoryCmdlet(bool skipIfLocked) /// /// sets the history string to the specified one /// - /// history string to set to + /// history string to set to. internal override void SetHistoryString(string historyString) { HistoryString = historyString; diff --git a/src/System.Management.Automation/engine/hostifaces/MshHostUserInterface.cs b/src/System.Management.Automation/engine/hostifaces/MshHostUserInterface.cs index c26f183633e..5b20c34cb1e 100644 --- a/src/System.Management.Automation/engine/hostifaces/MshHostUserInterface.cs +++ b/src/System.Management.Automation/engine/hostifaces/MshHostUserInterface.cs @@ -909,9 +909,9 @@ protected PSHostUserInterface() /// /// Helper to transcribe an error through formatting and output. /// - /// The Execution Context - /// The invocation info associated with the record - /// The error record + /// The Execution Context. + /// The invocation info associated with the record. + /// The error record. internal void TranscribeError(ExecutionContext context, InvocationInfo invocation, PSObject errorWrap) { context.InternalHost.UI.TranscribeCommandComplete(invocation); diff --git a/src/System.Management.Automation/engine/hostifaces/PSCommand.cs b/src/System.Management.Automation/engine/hostifaces/PSCommand.cs index 3681630b5ec..2749a5c5892 100644 --- a/src/System.Management.Automation/engine/hostifaces/PSCommand.cs +++ b/src/System.Management.Automation/engine/hostifaces/PSCommand.cs @@ -49,7 +49,7 @@ internal PSCommand(PSCommand commandToClone) /// /// Creates a PSCommand from the specified command /// - /// Command object to use + /// Command object to use. internal PSCommand(Command command) { _currentCommand = command; diff --git a/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs b/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs index b8c1ba8b3df..a6cb7cb81f5 100644 --- a/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs +++ b/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs @@ -197,7 +197,7 @@ public PSDataCollection(int capacity) : this(new List(capacity)) /// /// Wrap the argument in a PSDataCollection /// - /// The value to convert + /// The value to convert. /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] @@ -209,7 +209,7 @@ public static implicit operator PSDataCollection(bool valueToConvert) /// /// Wrap the argument in a PSDataCollection /// - /// The value to convert + /// The value to convert. /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] @@ -221,7 +221,7 @@ public static implicit operator PSDataCollection(string valueToConvert) /// /// Wrap the argument in a PSDataCollection /// - /// The value to convert + /// The value to convert. /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] @@ -233,7 +233,7 @@ public static implicit operator PSDataCollection(int valueToConvert) /// /// Wrap the argument in a PSDataCollection /// - /// The value to convert + /// The value to convert. /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] @@ -253,7 +253,7 @@ private static PSDataCollection CreateAndInitializeFromExplicitValue(object v /// /// Wrap the argument in a PSDataCollection /// - /// The value to convert + /// The value to convert. /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] @@ -268,7 +268,7 @@ public static implicit operator PSDataCollection(Hashtable valueToConvert) /// /// Wrap the argument in a PSDataCollection /// - /// The value to convert + /// The value to convert. /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] @@ -283,7 +283,7 @@ public static implicit operator PSDataCollection(T valueToConvert) /// /// Wrap the argument in a PSDataCollection /// - /// The value to convert + /// The value to convert. /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] @@ -326,8 +326,8 @@ internal PSDataCollection(IList listToUse) /// /// Creates a PSDataCollection from an ISerializable context /// - /// Serialization information for this instance - /// The streaming context for this instance + /// Serialization information for this instance. + /// The streaming context for this instance. protected PSDataCollection(SerializationInfo info, StreamingContext context) { if (info == null) @@ -1173,7 +1173,7 @@ public Collection ReadAll() /// /// A new collection with a copy of all the elements in the current collection. /// - /// maximum number of elements to read + /// maximum number of elements to read. internal Collection ReadAndRemove(int readCount) { Dbg.Assert(_data != null, "Collection cannot be null"); @@ -1292,8 +1292,8 @@ protected virtual void RemoveItem(int index) /// /// Implements the ISerializable contract for serializing a PSDataCollection /// - /// Serialization information for this instance - /// The streaming context for this instance + /// Serialization information for this instance. + /// The streaming context for this instance. public virtual void GetObjectData(SerializationInfo info, StreamingContext context) { if (info == null) @@ -1775,7 +1775,7 @@ public void Dispose() /// /// Release all the resources /// - /// if true, release all managed resources + /// if true, release all managed resources. protected void Dispose(bool disposing) { if (disposing) @@ -1934,7 +1934,7 @@ public bool MoveNext() /// true if the enumerator successfully advanced to the next element; /// otherwise, false. /// - /// true - to block when no elements are available + /// true - to block when no elements are available. public bool MoveNext(bool block) { lock (_collToEnumerate.SyncObject) diff --git a/src/System.Management.Automation/engine/hostifaces/Parameter.cs b/src/System.Management.Automation/engine/hostifaces/Parameter.cs index 7e236cb0537..9b309dc8123 100644 --- a/src/System.Management.Automation/engine/hostifaces/Parameter.cs +++ b/src/System.Management.Automation/engine/hostifaces/Parameter.cs @@ -20,7 +20,7 @@ public sealed class CommandParameter /// /// Create a named parameter with a null value /// - /// parameter name + /// parameter name. /// /// name is null. /// @@ -39,8 +39,8 @@ public CommandParameter(string name) /// /// Create a named parameter /// - /// parameter name - /// parameter value + /// parameter name. + /// parameter value. /// /// Name is non null and name length is zero after trimming whitespace. /// @@ -196,7 +196,7 @@ internal static CommandParameterInternal ToCommandParameterInternal(CommandParam /// Creates a CommandParameter object from a PSObject property bag. /// PSObject has to be in the format returned by ToPSObjectForRemoting method. /// - /// PSObject to rehydrate + /// PSObject to rehydrate. /// /// CommandParameter rehydrated from a PSObject property bag /// @@ -279,7 +279,7 @@ public CommandParameterCollection() /// /// Add a parameter with given name and default null value /// - /// name of the parameter + /// name of the parameter. /// /// name is null. /// @@ -294,8 +294,8 @@ public void Add(string name) /// /// Add a parameter with given name and value /// - /// name of the parameter - /// value of the parameter + /// name of the parameter. + /// value of the parameter. /// /// Both name and value are null. One of these must be non-null. /// diff --git a/src/System.Management.Automation/engine/hostifaces/Pipeline.cs b/src/System.Management.Automation/engine/hostifaces/Pipeline.cs index 5fa477c62f3..3e285316b53 100644 --- a/src/System.Management.Automation/engine/hostifaces/Pipeline.cs +++ b/src/System.Management.Automation/engine/hostifaces/Pipeline.cs @@ -59,8 +59,8 @@ public InvalidPipelineStateException(string message, Exception innerException) /// /// The error message that explains the reason for the exception. /// - /// Current state of pipeline - /// Expected state of pipeline + /// Current state of pipeline. + /// Expected state of pipeline. internal InvalidPipelineStateException(string message, PipelineState currentState, PipelineState expectedState) : base(message) { @@ -171,7 +171,7 @@ public sealed class PipelineStateInfo /// /// Constructor for state changes not resulting from an error. /// - /// Execution state + /// Execution state. internal PipelineStateInfo(PipelineState state) : this(state, null) { @@ -193,7 +193,7 @@ internal PipelineStateInfo(PipelineState state, Exception reason) /// /// Copy constructor to support cloning /// - /// source information + /// source information. /// /// ArgumentNullException when is null. /// @@ -666,7 +666,7 @@ public Collection Invoke() /// /// Sets the command collection. /// - /// command collection to set + /// command collection to set. /// called by ClientRemotePipeline internal void SetCommandCollection(CommandCollection commands) { @@ -676,7 +676,7 @@ internal void SetCommandCollection(CommandCollection commands) /// /// Sets the history string to the one that is specified /// - /// history string to set + /// history string to set. internal abstract void SetHistoryString(string historyString); /// diff --git a/src/System.Management.Automation/engine/hostifaces/PowerShell.cs b/src/System.Management.Automation/engine/hostifaces/PowerShell.cs index de52475fa54..667a2b2b09d 100644 --- a/src/System.Management.Automation/engine/hostifaces/PowerShell.cs +++ b/src/System.Management.Automation/engine/hostifaces/PowerShell.cs @@ -66,7 +66,7 @@ public InvalidPowerShellStateException(string message, Exception innerException) /// Initializes a new instance of the InvalidPowerShellStateException and defines value of /// CurrentState. /// - /// Current state of powershell + /// Current state of powershell. internal InvalidPowerShellStateException(PSInvocationState currentState) : base (StringUtil.Format(PowerShellStrings.InvalidPowerShellStateGeneral)) @@ -821,7 +821,7 @@ public static PowerShell Create() /// /// Constructs an empty PowerShell instance; a script or command must be added before invoking this instance /// - /// runspace mode + /// runspace mode. /// An instance of PowerShell. public static PowerShell Create(RunspaceMode runspace) { @@ -852,7 +852,7 @@ public static PowerShell Create(RunspaceMode runspace) /// /// Constructs an empty PowerShell instance; a script or command must be added before invoking this instance /// - /// InitialSessionState with which to create the runspace + /// InitialSessionState with which to create the runspace. /// An instance of PowerShell. public static PowerShell Create(InitialSessionState initialSessionState) { @@ -898,9 +898,9 @@ public PowerShell CreateNestedPowerShell() /// /// Method needed when deserializing PowerShell object coming from a RemoteDataObject /// - /// Indicates if PowerShell object is nested - /// Commands that the PowerShell pipeline is built of - /// Extra commands to run + /// Indicates if PowerShell object is nested. + /// Commands that the PowerShell pipeline is built of. + /// Extra commands to run. private static PowerShell Create(bool isNested, PSCommand psCommand, Collection extraCommands) { PowerShell powerShell = new PowerShell(psCommand, extraCommands, null); @@ -1110,7 +1110,7 @@ internal PowerShell AddCommand(Command command) /// /// CommandInfo object for the command to add. /// - /// The CommandInfo object for the command to add + /// The CommandInfo object for the command to add. /// /// A PSCommand instance with the command added. /// @@ -2121,9 +2121,9 @@ private void CheckRunspacePoolAndConnect() /// If the debugger evaluated a command then DebuggerCommand.ResumeAction /// value will be set appropriately. /// - /// Input - /// Output collection - /// PS invocation settings + /// Input. + /// Output collection. + /// PS invocation settings. /// True if PowerShell Invoke must run regardless /// of whether debugger handles the command. /// @@ -3666,8 +3666,8 @@ internal ExecutionContext GetContextFromTLS() /// /// Gets the steppable pipeline from the powershell object /// - /// engine execution context - /// command origin + /// engine execution context. + /// command origin. /// Steppable pipeline object. private SteppablePipeline GetSteppablePipeline(ExecutionContext context, CommandOrigin commandOrigin) { @@ -3920,7 +3920,7 @@ private void RaiseStateChangeEvent(PSInvocationStateInfo stateInfo) /// /// Sets the state of this powershell instance. /// - /// the state info to set + /// the state info to set. internal void SetStateChanged(PSInvocationStateInfo stateInfo) { PSInvocationStateInfo copyStateInfo = stateInfo; @@ -4233,9 +4233,9 @@ private void CoreInvoke(IEnumerable input, PSDataCollection ou /// /// input type /// output type - /// input objects - /// output object - /// invocation settings + /// input objects. + /// output object. + /// invocation settings. private void CoreInvokeHelper(PSDataCollection input, PSDataCollection output, PSInvocationSettings settings) { RunspacePool pool = _rsConnection as RunspacePool; @@ -4318,9 +4318,9 @@ private void CoreInvokeHelper(PSDataCollection input, P /// /// input type /// output type - /// input objects - /// output object - /// invocation settings + /// input objects. + /// output object. + /// invocation settings. private void CoreInvokeRemoteHelper(PSDataCollection input, PSDataCollection output, PSInvocationSettings settings) { RunspacePool pool = _rsConnection as RunspacePool; @@ -4352,9 +4352,9 @@ private void CoreInvokeRemoteHelper(PSDataCollection in /// /// input type /// output type - /// input objects - /// output object - /// invocation settings + /// input objects. + /// output object. + /// invocation settings. private void CoreInvoke(PSDataCollection input, PSDataCollection output, PSInvocationSettings settings) { bool isRemote = false; @@ -5453,7 +5453,7 @@ internal void GetSettings(out bool addToHistory, out bool noInput, out uint apar /// Creates a PowerShell object from a PSObject property bag. /// PSObject has to be in the format returned by ToPSObjectForRemoting method. /// - /// PSObject to rehydrate + /// PSObject to rehydrate. /// /// PowerShell rehydrated from a PSObject property bag /// diff --git a/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs b/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs index df618a25fac..344f6ca3798 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs @@ -61,7 +61,7 @@ public RunspaceInvoke(Runspace runspace) /// /// Invoke the specified script /// - /// msh script to invoke + /// msh script to invoke. /// Output of invocation. public Collection Invoke(string script) { @@ -71,8 +71,8 @@ public Collection Invoke(string script) /// /// Invoke the specified script and passes specified input to the script /// - /// msh script to invoke - /// input to script + /// msh script to invoke. + /// input to script. /// Output of invocation. public Collection Invoke(string script, IEnumerable input) { @@ -93,9 +93,9 @@ public Collection Invoke(string script, IEnumerable input) /// /// Invoke the specified script and passes specified input to the script. /// - /// msh script to invoke - /// input to script - /// this gets errors from script + /// msh script to invoke. + /// input to script. + /// this gets errors from script. /// Output of invocation. /// /// is the non-terminating error stream diff --git a/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs b/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs index b0ada3278c8..ffb1483ffa6 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs @@ -1211,7 +1211,7 @@ private void CloseThreadProc(object o) /// Raise state changed event based on the StateInfo /// object /// - /// state information object + /// state information object. protected void RaiseStateChangeEvent(RunspacePoolStateInfo stateInfo) { StateChanged.SafeInvoke(this, diff --git a/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs b/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs index 35464dbb2bb..f936ef4a709 100644 --- a/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs +++ b/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs @@ -24,10 +24,10 @@ internal abstract class PipelineBase : Pipeline /// /// Create a pipeline initialized with a command string /// - /// The associated Runspace/>. - /// command string - /// if true, add pipeline to history - /// True for nested pipeline + /// The associated Runspace/> + /// command string. + /// if true, add pipeline to history. + /// True for nested pipeline. /// /// Command is null and add to history is true /// @@ -115,7 +115,7 @@ protected PipelineBase(Runspace runspace, /// /// Copy constructor to support cloning /// - /// The source pipeline + /// The source pipeline. /// /// The copy constructor's intent is to support the scenario /// where a host needs to run the same set of commands multiple @@ -353,7 +353,7 @@ private void CoreStop(bool syncCall) /// /// Stop execution of pipeline /// - /// If false, call is asynchronous + /// If false, call is asynchronous. protected abstract void ImplementStop(bool syncCall); #endregion stop @@ -602,8 +602,8 @@ internal bool PerformNestedCheck /// /// True if method is called from Invoke, false /// if called from InvokeAsync - /// The sync object on which the lock is acquired - /// True if the method is invoked in a critical section + /// The sync object on which the lock is acquired. + /// True if the method is invoked in a critical section. /// /// 1) A pipeline is already executing. Pipeline cannot execute /// concurrently. @@ -783,7 +783,7 @@ public ExecutionEventQueueItem(PipelineStateInfo pipelineStateInfo, RunspaceAvai /// /// Sets the new execution state. /// - /// the new state + /// the new state. /// /// An exception indicating that state change is the result of an error, /// otherwise; null. @@ -823,7 +823,7 @@ protected void SetPipelineState(PipelineState state, Exception reason) /// /// Set the new execution state /// - /// the new state + /// the new state. protected void SetPipelineState(PipelineState state) { SetPipelineState(state, null); diff --git a/src/System.Management.Automation/engine/lang/interface/PSParser.cs b/src/System.Management.Automation/engine/lang/interface/PSParser.cs index 3ae02a7cb59..e626a87275c 100644 --- a/src/System.Management.Automation/engine/lang/interface/PSParser.cs +++ b/src/System.Management.Automation/engine/lang/interface/PSParser.cs @@ -133,8 +133,8 @@ private Collection Errors /// /// Parse a script into a collection of tokens. /// - /// script to parse - /// errors happened during parsing + /// script to parse. + /// errors happened during parsing. /// Collection of tokens generated during parsing. /// /// Although this API returns most parse-time exceptions in the errors @@ -160,8 +160,8 @@ public static Collection Tokenize(string script, out Collection /// Parse a script into a collection of tokens. /// - /// script to parse, as an array of lines - /// errors happened during parsing + /// script to parse, as an array of lines. + /// errors happened during parsing. /// Collection of tokens generated during parsing. /// /// Although this API returns most parse-time exceptions in the errors diff --git a/src/System.Management.Automation/engine/lang/interface/PSToken.cs b/src/System.Management.Automation/engine/lang/interface/PSToken.cs index 4de53f3bc07..927165b013e 100644 --- a/src/System.Management.Automation/engine/lang/interface/PSToken.cs +++ b/src/System.Management.Automation/engine/lang/interface/PSToken.cs @@ -75,7 +75,7 @@ public string Content /// /// Map a V3 token to a V2 PSTokenType /// - /// The V3 token + /// The V3 token. /// The V2 PSTokenType. public static PSTokenType GetPSTokenType(Token token) { diff --git a/src/System.Management.Automation/engine/lang/parserutils.cs b/src/System.Management.Automation/engine/lang/parserutils.cs index d5869f035cd..8b1aa9ee08f 100644 --- a/src/System.Management.Automation/engine/lang/parserutils.cs +++ b/src/System.Management.Automation/engine/lang/parserutils.cs @@ -75,7 +75,7 @@ public static bool IsCurlyBracket(char c) /// Canonicalize the quote character - map all of the aliases for " or ' /// into their ascii equivalent. /// - /// The character to map + /// The character to map. /// The mapped character. public static char AsQuote(char c) { @@ -364,7 +364,7 @@ internal static object BoolToObject(bool value) /// /// Convert an object into an int, avoiding boxing small integers... /// - /// The int to convert + /// The int to convert. /// The reference equivalent. internal static object IntToObject(int value) { @@ -390,7 +390,7 @@ internal static PSObject WrappedNumber(object data, string text) /// /// The position to use for error reporting. /// - /// The result could not be represented as an integer + /// The result could not be represented as an integer. internal static int FixNum(object obj, IScriptExtent errorPosition) { obj = PSObject.Base(obj); @@ -429,13 +429,13 @@ internal static T ConvertTo(object obj, IScriptExtent errorPosition) /// /// private method used to call the op_* operations for the math operators /// - /// left operand - /// right operand - /// name of the operation method to perform + /// left operand. + /// right operand. + /// name of the operation method to perform. /// The position to use for error reporting. - /// the string to use in error messages representing the op + /// the string to use in error messages representing the op. /// The result of the operation. - /// An error occurred performing the operation, see inner exception + /// An error occurred performing the operation, see inner exception. internal static object ImplicitOp(object lval, object rval, string op, IScriptExtent errorPosition, string errorOp) { // Get the base object. At somepoint, we may allow users to dynamically extend @@ -773,9 +773,9 @@ private static object SplitWithPattern(ExecutionContext context, IScriptExtent e /// /// Implementation of the PowerShell unary -join operator... /// - /// The execution context to use + /// The execution context to use. /// The position to use for error reporting. - /// left operand + /// left operand. /// The result of the operator. internal static object UnaryJoinOperator(ExecutionContext context, IScriptExtent errorPosition, object lval) { @@ -785,10 +785,10 @@ internal static object UnaryJoinOperator(ExecutionContext context, IScriptExtent /// /// Implementation of the PowerShell binary -join operator /// - /// The execution context to use + /// The execution context to use. /// The position to use for error reporting. - /// left operand - /// right operand + /// left operand. + /// right operand. /// The result of the operator. internal static object JoinOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval) { @@ -896,11 +896,11 @@ private static object AsChar(object obj) /// /// The implementation of the PowerShell -replace operator.... /// - /// The execution context in which to evaluate the expression + /// The execution context in which to evaluate the expression. /// The position to use for error reporting. - /// The object on which to replace the values + /// The object on which to replace the values. /// The replacement description. - /// True for -ireplace/-replace, false for -creplace + /// True for -ireplace/-replace, false for -creplace. /// The result of the operator. internal static object ReplaceOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, bool ignoreCase) { @@ -978,10 +978,10 @@ internal static object ReplaceOperator(ExecutionContext context, IScriptExtent e /// Abstracts away conversion of the optional substitute parameter to either a string or a MatchEvaluator delegate /// and finally returns the result of the final Regex.Replace operation. /// - /// The execution context in which to evaluate the expression - /// The input string + /// The execution context in which to evaluate the expression. + /// The input string. /// A Regex instance. - /// The substitute value + /// The substitute value. /// The result of the regex.Replace operation. private static object ReplaceOperatorImpl(ExecutionContext context, string input, Regex regex, object substitute) { @@ -1016,10 +1016,10 @@ private static object ReplaceOperatorImpl(ExecutionContext context, string input /// /// Implementation of the PowerShell type operators... /// - /// The execution context to use + /// The execution context to use. /// The position to use for error reporting. - /// left operand - /// right operand + /// left operand. + /// right operand. /// The result of the operator. internal static object IsOperator(ExecutionContext context, IScriptExtent errorPosition, object left, object right) { @@ -1057,10 +1057,10 @@ internal static object IsOperator(ExecutionContext context, IScriptExtent errorP /// /// Implementation of the PowerShell type operators... /// - /// The execution context to use + /// The execution context to use. /// The position to use for error reporting. - /// left operand - /// right operand + /// left operand. + /// right operand. /// The result of the operator. internal static object IsNotOperator(ExecutionContext context, IScriptExtent errorPosition, object left, object right) { @@ -1098,11 +1098,11 @@ internal static object IsNotOperator(ExecutionContext context, IScriptExtent err /// /// Implementation of the PowerShell -like operator /// - /// The execution context to use + /// The execution context to use. /// The position to use for error reporting. - /// left operand - /// right operand - /// the operator + /// left operand. + /// right operand. + /// the operator. /// The result of the operator. internal static object LikeOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, TokenKind @operator) { @@ -1143,12 +1143,12 @@ internal static object LikeOperator(ExecutionContext context, IScriptExtent erro /// /// Implementation of the PowerShell -match operator /// - /// The execution context to use + /// The execution context to use. /// The position to use for error reporting. - /// left operand - /// right operand + /// left operand. + /// right operand. /// ignore case? - /// true for -notmatch, false for -match + /// true for -notmatch, false for -match. /// The result of the operator. internal static object MatchOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, bool notMatch, bool ignoreCase) { @@ -1279,12 +1279,12 @@ internal static bool ContainsOperatorCompiled(ExecutionContext context, /// /// Implementation of the PowerShell -contains/-notcontains operators (and case sensitive variants) /// - /// The execution context to use + /// The execution context to use. /// The position to use for error reporting. - /// left operand - /// right operand + /// left operand. + /// right operand. /// ignore case? - /// true for -contains, false for -notcontains + /// true for -contains, false for -notcontains. /// The result of the operator. internal static object ContainsOperator(ExecutionContext context, IScriptExtent errorPosition, object left, object right, bool contains, bool ignoreCase) { @@ -1336,7 +1336,7 @@ internal static object CompareOperators(ExecutionContext context, IScriptExtent /// /// Cache regular expressions... /// - /// The string to find the pattern for + /// The string to find the pattern for. /// The options used to create the regex... /// A case-insensitive Regex... internal static Regex NewRegex(string patternString, RegexOptions options) @@ -1369,10 +1369,10 @@ internal static Regex NewRegex(string patternString, RegexOptions options) /// A routine used to advance an enumerator and catch errors that might occur /// performing the operation /// - /// The execution context used to see if the pipeline is stopping + /// The execution context used to see if the pipeline is stopping. /// The position to use for error reporting. /// THe enumerator to advance. - /// An error occurred moving to the next element in the enumeration + /// An error occurred moving to the next element in the enumeration. /// True if the move succeeded. internal static bool MoveNext(ExecutionContext context, IScriptExtent errorPosition, IEnumerator enumerator) { @@ -1407,7 +1407,7 @@ internal static bool MoveNext(ExecutionContext context, IScriptExtent errorPosit /// Wrapper caller for enumerator.MoveNext - handles and republishes errors... /// /// The position to use for error reporting. - /// The enumerator to read from + /// The enumerator to read from. /// internal static object Current(IScriptExtent errorPosition, IEnumerator enumerator) { @@ -1437,7 +1437,7 @@ internal static object Current(IScriptExtent errorPosition, IEnumerator enumerat /// /// Retrieves the obj's type full name /// - /// the object we want to retrieve the type's full name from + /// the object we want to retrieve the type's full name from. /// The obj's type full name. internal static string GetTypeFullName(object obj) { @@ -1465,14 +1465,14 @@ internal static string GetTypeFullName(object obj) /// methods and ScriptBlock notes. Native methods currently take precedence over notes... /// /// The position to use for error reporting. - /// The object to call the method on. It shouldn't be an msh object - /// The name of the method to call - /// Invocation constraints + /// The object to call the method on. It shouldn't be an msh object. + /// The name of the method to call. + /// Invocation constraints. /// The arguments to pass to the method. /// Set to true if you want to call a static method. - /// If not automation null, then this must be a settable property - /// Wraps the exception returned from the method call - /// Internal exception from a flow control statement + /// If not automation null, then this must be a settable property. + /// Wraps the exception returned from the method call. + /// Internal exception from a flow control statement. /// internal static object CallMethod( IScriptExtent errorPosition, @@ -1751,7 +1751,7 @@ internal static class InterpreterError /// Create a new instance of an interpreter exception /// /// The target object for this exception. - /// Type of exception to build + /// Type of exception to build. /// The position to use for error reporting. /// /// ResourceID to look up template message, and also ErrorID @@ -1759,7 +1759,7 @@ internal static class InterpreterError /// /// Resource string that holds the error message /// - /// Insertion parameters to message + /// Insertion parameters to message. /// A new instance of the specified exception type. internal static RuntimeException NewInterpreterException(object targetObject, Type exceptionType, IScriptExtent errorPosition, string resourceIdAndErrorId, string resourceString, params object[] args) @@ -1770,8 +1770,8 @@ internal static RuntimeException NewInterpreterException(object targetObject, /// /// Create a new instance of an interpreter exception /// - /// The object associated with the problem - /// Type of exception to build + /// The object associated with the problem. + /// Type of exception to build. /// The position to use for error reporting. /// /// ResourceID to look up template message, and also ErrorID @@ -1779,8 +1779,8 @@ internal static RuntimeException NewInterpreterException(object targetObject, /// /// Resource string which holds the error message /// - /// inner exception - /// Insertion parameters to message + /// inner exception. + /// Insertion parameters to message. /// New instance of an interpreter exception. internal static RuntimeException NewInterpreterExceptionWithInnerException(object targetObject, Type exceptionType, IScriptExtent errorPosition, string resourceIdAndErrorId, string resourceString, Exception innerException, params object[] args) @@ -1851,11 +1851,11 @@ internal static RuntimeException NewInterpreterExceptionWithInnerException(objec /// /// Create a new instance of an interpreter exception /// - /// Type of exception to build + /// Type of exception to build. /// The position to use for error reporting. - /// Message - /// ErrorID - /// inner exception + /// Message. + /// ErrorID. + /// inner exception. /// New instance of ParseException. internal static RuntimeException NewInterpreterExceptionByMessage( Type exceptionType, IScriptExtent errorPosition, string message, string errorId, Exception innerException) diff --git a/src/System.Management.Automation/engine/lang/scriptblock.cs b/src/System.Management.Automation/engine/lang/scriptblock.cs index 4324168f975..cff7f86a190 100644 --- a/src/System.Management.Automation/engine/lang/scriptblock.cs +++ b/src/System.Management.Automation/engine/lang/scriptblock.cs @@ -85,7 +85,7 @@ public partial class ScriptBlock /// /// Create a script block object based on a script string to be parsed immediately. /// - /// Engine context for this script block + /// Engine context for this script block. /// The string to compile. internal static ScriptBlock Create(ExecutionContext context, string script) { @@ -370,8 +370,8 @@ public SteppablePipeline GetSteppablePipeline(CommandOrigin commandOrigin, objec /// The arguments to this script. /// The object(s) generated during the execution of /// the script block returned as a collection of PSObjects. - /// Thrown if a script runtime exceptionexception occurred - /// An internal (non-public) exception from a flow control statement + /// Thrown if a script runtime exceptionexception occurred. + /// An internal (non-public) exception from a flow control statement. public Collection Invoke(params object[] args) { return DoInvoke(AutomationNull.Value, AutomationNull.Value, args); @@ -385,9 +385,9 @@ public Collection Invoke(params object[] args) /// This overload of the function takes a hashtable and converts it to the /// required dictionary which makes the API easier to use from within a PowerShell script. /// - /// A dictionary of functions to define - /// A list of variables to define - /// The arguments to the actual scriptblock + /// A dictionary of functions to define. + /// A list of variables to define. + /// The arguments to the actual scriptblock. /// public Collection InvokeWithContext( IDictionary functionsToDefine, @@ -427,9 +427,9 @@ public Collection InvokeWithContext( /// set of local functions and variables to be defined in the scriptblock's scope. The list of /// variables may include the special variables $input, $_ and $this. /// - /// A dictionary of functions to define - /// A list of variables to define - /// The arguments to the actual scriptblock + /// A dictionary of functions to define. + /// A list of variables to define. + /// The arguments to the actual scriptblock. /// public Collection InvokeWithContext( Dictionary functionsToDefine, @@ -491,8 +491,8 @@ public Collection InvokeWithContext( /// The arguments to pass to this scriptblock. /// The object(s) generated during the execution of the /// script block. They may or may not be wrapped in PSObject. It's up to the caller to check. - /// Thrown if a script runtime exceptionexception occurred - /// An internal (non-public) exception from a flow control statement + /// Thrown if a script runtime exceptionexception occurred. + /// An internal (non-public) exception from a flow control statement. public object InvokeReturnAsIs(params object[] args) { return DoInvokeReturnAsIs( @@ -799,7 +799,7 @@ internal object InvokeAsDelegateHelper(object dollarUnder, object dollarThis, ob /// /// Returns the current execution context from TLS, or raises an exception if it is null. /// - /// An attempt was made to use the scriptblock outside the engine + /// An attempt was made to use the scriptblock outside the engine. internal ExecutionContext GetContextFromTLS() { ExecutionContext context = LocalPipeline.GetExecutionContextFromTLS(); @@ -837,8 +837,8 @@ internal ExecutionContext GetContextFromTLS() /// The arguments to this script. /// The object(s) generated during the execution of /// the script block returned as a collection of PSObjects. - /// A script exception occurred - /// Internal exception from a flow control statement + /// A script exception occurred. + /// Internal exception from a flow control statement. internal Collection DoInvoke(object dollarUnder, object input, object[] args) { List result = new List(); @@ -894,8 +894,8 @@ private static Collection GetWrappedResult(List result) /// The arguments to this script. /// The object(s) generated during the execution of /// the script block returned as a collection of PSObjects. - /// A script exception occurred - /// Internal exception from a flow control statement + /// A script exception occurred. + /// Internal exception from a flow control statement. internal object DoInvokeReturnAsIs(bool useLocalScope, ErrorHandlingBehavior errorHandlingBehavior, object dollarUnder, @@ -1054,7 +1054,7 @@ internal SteppablePipeline(ExecutionContext context, PipelineProcessor pipeline) /// /// Begin execution of a steppable pipeline. This overload doesn't reroute output and error pipes. /// - /// true if you plan to write input into this pipe; false otherwise + /// true if you plan to write input into this pipe; false otherwise. public void Begin(bool expectInput) { Begin(expectInput, (ICommandRuntime)null); @@ -1064,7 +1064,7 @@ public void Begin(bool expectInput) /// Begin execution of a steppable pipeline, using the command running currently in the specified context to figure /// out how to route the output and errors. /// - /// true if you plan to write input into this pipe; false otherwise + /// true if you plan to write input into this pipe; false otherwise. /// context used to figure out how to route the output and errors. public void Begin(bool expectInput, EngineIntrinsics contextToRedirectTo) { @@ -1084,7 +1084,7 @@ public void Begin(bool expectInput, EngineIntrinsics contextToRedirectTo) /// out how to route the output and errors. This is the most effective /// way to start stepping. /// - /// The command you're calling this from (i.e. instance of PSCmdlet or value of $PSCmdlet variable) + /// The command you're calling this from (i.e. instance of PSCmdlet or value of $PSCmdlet variable). public void Begin(InternalCommand command) { if (command == null || command.MyInvocation == null) @@ -1130,7 +1130,7 @@ private void Begin(bool expectInput, ICommandRuntime commandRuntime) /// /// Process a single input object. /// - /// The object to process + /// The object to process. /// A collection of 0 or more result objects. public Array Process(object input) { @@ -1157,7 +1157,7 @@ public Array Process(object input) /// that the PowerShell runtime will PSBase an object before passing it to /// a .NET API call with argument type object. /// - /// The input object to process + /// The input object to process. /// public Array Process(PSObject input) { @@ -1278,7 +1278,7 @@ public ScriptBlockToPowerShellNotSupportedException() /// /// Initializes a new instance of ScriptBlockToPowerShellNotSupportedException setting the message /// - /// the exception's message + /// the exception's message. public ScriptBlockToPowerShellNotSupportedException(string message) : base(message) { @@ -1287,8 +1287,8 @@ public ScriptBlockToPowerShellNotSupportedException(string message) /// /// Initializes a new instance of ScriptBlockToPowerShellNotSupportedException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public ScriptBlockToPowerShellNotSupportedException(string message, Exception innerException) : base(message, innerException) { @@ -1297,10 +1297,10 @@ public ScriptBlockToPowerShellNotSupportedException(string message, Exception in /// /// Recommended constructor for the class /// - /// String that uniquely identifies each thrown Exception - /// The inner exception - /// The error message - /// Arguments to the resource string + /// String that uniquely identifies each thrown Exception. + /// The inner exception. + /// The error message. + /// Arguments to the resource string. internal ScriptBlockToPowerShellNotSupportedException( string errorId, Exception innerException, @@ -1315,8 +1315,8 @@ internal ScriptBlockToPowerShellNotSupportedException( /// /// Initializes a new instance of ScriptBlockToPowerShellNotSupportedException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected ScriptBlockToPowerShellNotSupportedException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/src/System.Management.Automation/engine/parser/Compiler.cs b/src/System.Management.Automation/engine/parser/Compiler.cs index 8254d1978e4..7e5b29c78c4 100644 --- a/src/System.Management.Automation/engine/parser/Compiler.cs +++ b/src/System.Management.Automation/engine/parser/Compiler.cs @@ -2395,7 +2395,7 @@ internal static void GenerateLoadUsings(IEnumerable usingStat /// This method should be called only for rootAsts (i.e. script file root ScriptBlockAst). /// /// - /// non-empty array of TypeDefinitionAst + /// non-empty array of TypeDefinitionAst. /// Assembly with defined types. internal static Assembly DefinePowerShellTypes(Ast rootForDefiningTypes, TypeDefinitionAst[] typeAsts) { diff --git a/src/System.Management.Automation/engine/parser/GlobalAssemblyCache.cs b/src/System.Management.Automation/engine/parser/GlobalAssemblyCache.cs index b4fe6eaba9e..fdb5982e7f3 100644 --- a/src/System.Management.Automation/engine/parser/GlobalAssemblyCache.cs +++ b/src/System.Management.Automation/engine/parser/GlobalAssemblyCache.cs @@ -150,10 +150,10 @@ private enum ASM_CACHE /// /// Looks up specified partial assembly name in the GAC and returns the best matching full assembly name/>. /// - /// The display name of an assembly - /// Full path name of the resolved assembly - /// The optional processor architecture - /// The optional preferred culture information + /// The display name of an assembly. + /// Full path name of the resolved assembly. + /// The optional processor architecture. + /// The optional preferred culture information. /// An assembly identity or null, if can't be resolved. /// is null. public static unsafe string ResolvePartialName( diff --git a/src/System.Management.Automation/engine/parser/PSType.cs b/src/System.Management.Automation/engine/parser/PSType.cs index 38d7a2ad8d9..18752762ae6 100644 --- a/src/System.Management.Automation/engine/parser/PSType.cs +++ b/src/System.Management.Automation/engine/parser/PSType.cs @@ -308,7 +308,7 @@ public DefineTypeHelper(Parser parser, ModuleBuilder module, TypeDefinitionAst t /// /// /// - /// return declared interfaces + /// return declared interfaces. /// private Type GetBaseTypes(Parser parser, TypeDefinitionAst typeDefinitionAst, out List interfaces) { diff --git a/src/System.Management.Automation/engine/parser/Parser.cs b/src/System.Management.Automation/engine/parser/Parser.cs index 71ac331da64..e1f4d457775 100644 --- a/src/System.Management.Automation/engine/parser/Parser.cs +++ b/src/System.Management.Automation/engine/parser/Parser.cs @@ -716,8 +716,8 @@ private static IEnumerable GetNestedErrorAsts(params object[] asts) /// /// Parses the specified constant hashtable string into a Hashtable object /// - /// The Hashtable string - /// the Hashtable object + /// The Hashtable string. + /// the Hashtable object. /// internal static bool TryParseAsConstantHashtable(string input, out Hashtable result) { @@ -3258,7 +3258,7 @@ private StatementAst ConfigurationStatementRule(IEnumerable custom /// Reads an argument expression for a keyword or keyword parameter. /// This can be either a bare word or an expression /// - /// the token of the associated keyword + /// the token of the associated keyword. private ExpressionAst GetWordOrExpression(Token keywordToken) { Token nameToken = NextToken(); @@ -3648,8 +3648,8 @@ private StatementAst WhileStatementRule(LabelToken labelToken, Token whileToken) /// This command has one of two signatures: /// keywordImplCommand /// - /// The name of the function to invoke - /// The data for this keyword definition + /// The name of the function to invoke. + /// The data for this keyword definition. /// private StatementAst DynamicKeywordStatementRule(Token functionName, DynamicKeyword keywordData) { @@ -7453,8 +7453,8 @@ private void SaveError(IScriptExtent extent, string errorId, string errorMsg, bo /// Debug assertion to ensure that all errors saved by the parser come /// from resource (.resx) files. /// - /// The error ID string (.resx key) - /// The error message, which may be a template string (.resx value) + /// The error ID string (.resx key). + /// The error message, which may be a template string (.resx value). [System.Diagnostics.Conditional("DEBUG")] [System.Diagnostics.Conditional("ASSERTIONS_TRACE")] private static void AssertErrorIdCorrespondsToMsgString(string errorId, string errorMsg) diff --git a/src/System.Management.Automation/engine/parser/SemanticChecks.cs b/src/System.Management.Automation/engine/parser/SemanticChecks.cs index 3c51b0552d6..53d45285cec 100644 --- a/src/System.Management.Automation/engine/parser/SemanticChecks.cs +++ b/src/System.Management.Automation/engine/parser/SemanticChecks.cs @@ -568,8 +568,8 @@ public override AstVisitAction VisitTryStatement(TryStatementAst tryStatementAst /// Check that label exists inside the method. /// Only call it, when label is present and can be calculated in compile time. /// - /// BreakStatementAst or ContinueStatementAst - /// label name. Can be null + /// BreakStatementAst or ContinueStatementAst. + /// label name. Can be null. private void CheckLabelExists(StatementAst ast, string label) { if (String.IsNullOrEmpty(label)) @@ -716,7 +716,7 @@ public override AstVisitAction VisitReturnStatement(ReturnStatementAst returnSta /// Check if the ast is a valid target for assignment. If not, the action reportError is called. /// /// The target of an assignment. - /// True if the operator '=' is used, false otherwise (e.g. false on '+=' or '++'.) + /// True if the operator '=' is used, false otherwise (e.g. false on '+=' or '++'.). /// The action called to report any errors. private void CheckAssignmentTarget(ExpressionAst ast, bool simpleAssignment, Action reportError) { @@ -1543,7 +1543,7 @@ internal static void CheckType(Parser parser, TypeDefinitionAst typeDefinitionAs /// Look up all the way up until find all the required members /// /// - /// The type definition ast of the DSC resource type + /// The type definition ast of the DSC resource type. /// flag to indicate if the class contains Set method. /// flag to indicate if the class contains Get method. /// flag to indicate if the class contains Test method. @@ -1600,7 +1600,7 @@ private static void LookupRequiredMembers(Parser parser, TypeDefinitionAst typeD /// Check if it is a Get method with correct return type and signature /// /// - /// The function member AST + /// The function member AST. /// True if it is a Get method with qualified return type and signature; otherwise, false. private static void CheckGet(Parser parser, FunctionMemberAst functionMemberAst, ref bool hasGet) { @@ -1644,7 +1644,7 @@ private static void CheckGet(Parser parser, FunctionMemberAst functionMemberAst, /// /// Check if it is a Test method with correct return type and signature /// - /// The function member AST + /// The function member AST. /// True if it is a Test method with qualified return type and signature; otherwise, false. private static void CheckTest(FunctionMemberAst functionMemberAst, ref bool hasTest) { @@ -1657,7 +1657,7 @@ private static void CheckTest(FunctionMemberAst functionMemberAst, ref bool hasT /// /// Check if it is a Set method with correct return type and signature /// - /// The function member AST + /// The function member AST. /// True if it is a Set method with qualified return type and signature; otherwise, false. private static void CheckSet(FunctionMemberAst functionMemberAst, ref bool hasSet) { @@ -1671,7 +1671,7 @@ private static void CheckSet(FunctionMemberAst functionMemberAst, ref bool hasSe /// True if it is a key property. /// /// - /// The property member AST + /// The property member AST. /// True if it is a key property; otherwise, false. private static void CheckKey(Parser parser, PropertyMemberAst propertyMemberAst, ref bool hasKey) { diff --git a/src/System.Management.Automation/engine/parser/SymbolResolver.cs b/src/System.Management.Automation/engine/parser/SymbolResolver.cs index 67b32efe2e5..b49561e3586 100644 --- a/src/System.Management.Automation/engine/parser/SymbolResolver.cs +++ b/src/System.Management.Automation/engine/parser/SymbolResolver.cs @@ -446,7 +446,7 @@ public override AstVisitAction VisitTypeConstraint(TypeConstraintAst typeConstra /// PSModuleInfo objects are returned in the right order: i.e. if multiply versions of the module /// is presented on the system and user didn't specify version, we will return all of them, but newer one would go first. /// - /// using statement + /// using statement. /// If exception happens, return exception object. /// /// True if in the module name uses wildcardCharacter. diff --git a/src/System.Management.Automation/engine/parser/TypeResolver.cs b/src/System.Management.Automation/engine/parser/TypeResolver.cs index c6b36ec52ca..0f87b0d1ae3 100644 --- a/src/System.Management.Automation/engine/parser/TypeResolver.cs +++ b/src/System.Management.Automation/engine/parser/TypeResolver.cs @@ -482,8 +482,8 @@ internal static Type ResolveITypeName(ITypeName iTypeName, out Exception excepti /// /// This routine converts a string into a Type object using the msh rules. /// - /// A string representing the name of the type to convert - /// The exception, if one happened, trying to find the type + /// A string representing the name of the type to convert. + /// The exception, if one happened, trying to find the type. /// A type if the conversion was successful, null otherwise. internal static Type ResolveType(string strTypeName, out Exception exception) { diff --git a/src/System.Management.Automation/engine/parser/ast.cs b/src/System.Management.Automation/engine/parser/ast.cs index 1d1267a7aea..142f42ce851 100644 --- a/src/System.Management.Automation/engine/parser/ast.cs +++ b/src/System.Management.Automation/engine/parser/ast.cs @@ -113,7 +113,7 @@ protected Ast(IScriptExtent extent) /// Visit the Ast using a visitor that can choose how the tree traversal is performed. This visit method is /// for advanced uses of the visitor pattern where an is insufficient. /// - /// The visitor + /// The visitor. /// Returns the value returned by the visitor. public object Visit(ICustomAstVisitor astVisitor) { @@ -128,7 +128,7 @@ public object Visit(ICustomAstVisitor astVisitor) /// /// Visit each node in the Ast, calling the methods in for each node in the ast. /// - /// The visitor + /// The visitor. public void Visit(AstVisitor astVisitor) { if (astVisitor == null) @@ -158,7 +158,7 @@ public IEnumerable FindAll(Func predicate, bool searchNestedScri /// /// Traverse the entire Ast, returning the first node in the tree for which returns true. /// - /// The predicate + /// The predicate. /// Search nested functions and script block expressions. /// The first matching node, or null if there is no match. public Ast Find(Func predicate, bool searchNestedScriptBlocks) @@ -214,7 +214,7 @@ public object SafeGetValue() /// Copy a collection of AST elements /// /// The actual AST type - /// Collection of ASTs + /// Collection of ASTs. /// internal static T[] CopyElements(ReadOnlyCollection elements) where T : Ast { @@ -233,7 +233,7 @@ internal static T[] CopyElements(ReadOnlyCollection elements) where T : As /// Copy a single AST element /// /// The actual AST type - /// An AST instance + /// An AST instance. /// internal static T CopyElement(T element) where T : Ast { @@ -933,7 +933,7 @@ public ScriptBlockAst(IScriptExtent extent, ParamBlockAst paramBlock, StatementB /// process block if is true. /// /// True if the script block is a filter, false if it is a function or workflow. - /// True if the script block is a configuration + /// True if the script block is a configuration. /// /// If or is null. /// @@ -954,7 +954,7 @@ public ScriptBlockAst(IScriptExtent extent, ParamBlockAst paramBlock, StatementB /// process block if is true. /// /// True if the script block is a filter, false if it is a function or workflow. - /// True if the script block is a configuration + /// True if the script block is a configuration. /// /// If or is null. /// @@ -975,7 +975,7 @@ public ScriptBlockAst(IScriptExtent extent, IEnumerable using /// process block if is true. /// /// True if the script block is a filter, false if it is a function or workflow. - /// True if the script block is a configuration + /// True if the script block is a configuration. /// /// If or is null. /// @@ -997,7 +997,7 @@ public ScriptBlockAst(IScriptExtent extent, IEnumerable attributes /// process block if is true. /// /// True if the script block is a filter, false if it is a function or workflow. - /// True if the script block is a configuration + /// True if the script block is a configuration. /// /// If or is null. /// @@ -2272,7 +2272,7 @@ internal string GetTooltip() /// This method is used when we call Invoke-Command targeting a PSv2 remote machine. In that case, we might need to call this method /// to process the script block text, since $using prefix cannot be recognized by PSv2. /// - /// A sorted enumerator of using variable asts, ascendingly sorted based on StartOffSet + /// A sorted enumerator of using variable asts, ascendingly sorted based on StartOffSet. /// /// The text of the ParameterAst with $using variable being replaced with a new variable name. /// @@ -2523,7 +2523,7 @@ public class TypeDefinitionAst : StatementAst /// Construct a type definition. /// /// The extent of the type definition, from any attributes to the closing curly brace. - /// The name of the type + /// The name of the type. /// The attributes, or null if no attributes were specified. /// The members, or null if no members were specified. /// The attributes (like class or interface) of the type. @@ -2777,7 +2777,7 @@ public UsingStatementAst(IScriptExtent extent, UsingStatementKind kind, StringCo /// Construct a simple (one that is not a form of an alias) using module statement with module specification as hashtable. /// /// The extent of the using statement including the using keyword. - /// HashtableAst that describes object + /// HashtableAst that describes object. public UsingStatementAst(IScriptExtent extent, HashtableAst moduleSpecification) : base(extent) { @@ -5384,7 +5384,7 @@ public class PipelineAst : PipelineBaseAst /// /// The extent of the pipeline. /// The collection of commands representing the pipeline. - /// Indicates that this pipeline should be run in the background + /// Indicates that this pipeline should be run in the background. /// /// If is null. /// @@ -5425,7 +5425,7 @@ public PipelineAst(IScriptExtent extent, IEnumerable pipelineEle /// /// The extent of the pipeline (which should be the extent of the command). /// The command for the pipeline. - /// Indicates that this pipeline should be run in the background + /// Indicates that this pipeline should be run in the background. /// /// If or is null. /// @@ -5690,7 +5690,7 @@ public class CommandAst : CommandBaseAst /// The extent of the command, starting with either the optional invocation operator '&' or '.' or the command name /// and ending with the last command element. /// - /// The elements of the command (command name, parameters and expressions.) + /// The elements of the command (command name, parameters and expressions.). /// The invocation operator that was used, if any. /// The redirections for the command, may be null. /// @@ -6225,9 +6225,9 @@ public class ConfigurationDefinitionAst : StatementAst /// /// The extent of the expression, starting with the attribute and ending after the expression being attributed. /// - /// of the configuration statement - /// The type of the configuration - /// The configuration name expression + /// of the configuration statement. + /// The type of the configuration. + /// The configuration name expression. /// /// If , , or is null. /// @@ -6494,7 +6494,7 @@ internal PipelineAst GenerateSetItemPipelineAst() /// /// /// - /// Item1 - ResourceName, Item2 - ModuleName, Item3 - ModuleVersion + /// Item1 - ResourceName, Item2 - ModuleName, Item3 - ModuleVersion. /// private static bool IsImportCommand(StatementAst stmt, List> resourceModulePairsToImport) { @@ -6710,7 +6710,7 @@ public class DynamicKeywordStatementAst : StatementAst /// /// The extent of the expression, starting with the attribute and ending after the expression being attributed. /// - /// A collection of used to invoke specific command + /// A collection of used to invoke specific command. /// /// If is null or empty. /// @@ -7226,7 +7226,7 @@ public class UnaryExpressionAst : ExpressionAst /// /// Construct a unary expression. /// - /// The extent of the expression, including the operator (which may be prefix or postfix.) + /// The extent of the expression, including the operator (which may be prefix or postfix.). /// The unary operator token kind for the operation. /// The expression that the unary operator is applied to. /// @@ -7386,8 +7386,8 @@ public class AttributedExpressionAst : ExpressionAst, ISupportsAssignment, IAssi /// /// The extent of the expression, starting with the attribute and ending after the expression being attributed. /// - /// The attribute being applied to . - /// The expression being attributed by . + /// The attribute being applied to + /// The expression being attributed by /// /// If , , or is null. /// @@ -8827,7 +8827,7 @@ public class VariableExpressionAst : ExpressionAst, ISupportsAssignment, IAssign /// The name of the variable. A leading '$' or '@' is not removed, those characters are assumed to be part of /// the variable name. /// - /// True if splatting, like @PSBoundParameters, false otherwise, like $false. + /// True if splatting, like @PSBoundParameters, false otherwise, like $false /// /// If or is null, or if /// is an empty string. diff --git a/src/System.Management.Automation/engine/parser/tokenizer.cs b/src/System.Management.Automation/engine/parser/tokenizer.cs index f9eb0a3d216..45787cb8f19 100644 --- a/src/System.Management.Automation/engine/parser/tokenizer.cs +++ b/src/System.Management.Automation/engine/parser/tokenizer.cs @@ -3665,11 +3665,11 @@ private Token ScanNumber(char firstChar) return NewNumberToken(value); } - /// the first character - /// indicate if it's a hex number - /// indicate if it's a real number - /// indicate the type suffix - /// indicate the specified multiplier + /// the first character. + /// indicate if it's a hex number. + /// indicate if it's a real number. + /// indicate the type suffix. + /// indicate the specified multiplier. /// /// return null if the token is not a number /// OR diff --git a/src/System.Management.Automation/engine/pipeline.cs b/src/System.Management.Automation/engine/pipeline.cs index 3c9cbd7882d..3410a36bede 100644 --- a/src/System.Management.Automation/engine/pipeline.cs +++ b/src/System.Management.Automation/engine/pipeline.cs @@ -296,8 +296,8 @@ internal void AddRedirectionPipe(PipelineProcessor pipelineProcessor) /// Add a command to the pipeline /// /// - /// reference number of command from which to read, 0 for none - /// read from error queue of command readFromCommand + /// reference number of command from which to read, 0 for none. + /// read from error queue of command readFromCommand. /// Reference number of this command for use in readFromCommand. /// /// @@ -747,7 +747,7 @@ internal Array DoComplete() /// to process as is the case for I/O redirection into a file. We /// still want the file opened, even if there was nothing to write to it. /// - /// True if you want to write to this pipeline + /// True if you want to write to this pipeline. internal void StartStepping(bool expectInput) { try @@ -1118,7 +1118,7 @@ private void SetupParameterVariables() /// /// Array of input objects for first stage /// - /// If true, unravel the input otherwise pass as one object + /// If true, unravel the input otherwise pass as one object. /// /// Exception if any cmdlet throws a [terminating] exception /// @@ -1239,7 +1239,7 @@ private Array RetrieveResults() /// to write into the parent pipeline. It does this by resetting the terminal /// pipeline object. /// - /// The pipeline to write success objects to + /// The pipeline to write success objects to. internal void LinkPipelineSuccessOutput(Pipe pipeToUse) { Dbg.Assert(pipeToUse != null, "Caller should verify pipeToUse != null"); @@ -1382,8 +1382,8 @@ private void DisposeCommands() /// Makes an internal note of the exception, but only if this is /// the first error. /// - /// error which terminated the pipeline - /// command against which to log SecondFailure + /// error which terminated the pipeline. + /// command against which to log SecondFailure. /// True iff the pipeline was not already stopped. internal bool RecordFailure(Exception e, InternalCommand command) { diff --git a/src/System.Management.Automation/engine/regex.cs b/src/System.Management.Automation/engine/regex.cs index c923d110ac5..8eca0f02042 100644 --- a/src/System.Management.Automation/engine/regex.cs +++ b/src/System.Management.Automation/engine/regex.cs @@ -85,7 +85,7 @@ internal string PatternConvertedToRegex /// Initializes and instance of the WildcardPattern class /// for the specified wildcard pattern. /// - /// The wildcard pattern to match + /// The wildcard pattern to match. /// The constructed WildcardPattern object. /// if wildCardType == None, the pattern does not have wild cards public WildcardPattern(string pattern) @@ -104,7 +104,7 @@ public WildcardPattern(string pattern) /// that modify the pattern. /// /// The wildcard pattern to match. - /// Wildcard options + /// Wildcard options. /// The constructed WildcardPattern object. /// if wildCardType == None, the pattern does not have wild cards public WildcardPattern(string pattern, @@ -124,7 +124,7 @@ public WildcardPattern(string pattern, /// /// Create a new WildcardPattern, or return an already created one. /// - /// The pattern + /// The pattern. /// /// public static WildcardPattern Get(string pattern, WildcardOptions options) @@ -174,7 +174,7 @@ public bool IsMatch(string input) /// Escape special chars, except for those specified in , in a string by replacing them with their escape codes. /// /// The input string containing the text to convert. - /// Array of characters that not to escape + /// Array of characters that not to escape. /// /// A string of characters with any metacharacters, except for those specified in , converted to their escaped form. /// @@ -427,7 +427,7 @@ public WildcardPatternException() /// Constructs an instance of the WildcardPatternException object taking /// a message parameter to use in constructing the exception. /// - /// The string to use as the exception message + /// The string to use as the exception message. public WildcardPatternException(string message) : base(message) { } @@ -436,7 +436,7 @@ public WildcardPatternException(string message) : base(message) /// Constructor for class WildcardPatternException that takes both a message to use /// and an inner exception to include in this object. /// - /// The exception message to use + /// The exception message to use. /// The innerException object to encapsulate. public WildcardPatternException(string message, Exception innerException) @@ -447,8 +447,8 @@ public WildcardPatternException(string message, /// /// Constructor for class WildcardPatternException for serialization. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected WildcardPatternException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -588,8 +588,8 @@ internal void AppendBracketExpression(string brackedExpressionContents, string b /// Parses , calling appropriate overloads /// in /// - /// Pattern to parse - /// Parser to call back + /// Pattern to parse. + /// Parser to call back. public static void Parse(WildcardPattern pattern, WildcardPatternParser parser) { parser.BeginWildcardPattern(pattern); @@ -859,7 +859,7 @@ protected override void EndBracketExpression() /// /// Parses a into a /// - /// Wildcard pattern to parse + /// Wildcard pattern to parse. /// Regular expression equivalent to public static Regex Parse(WildcardPattern wildcardPattern) { diff --git a/src/System.Management.Automation/engine/remoting/client/ClientRemotePowerShell.cs b/src/System.Management.Automation/engine/remoting/client/ClientRemotePowerShell.cs index 4b8eaeb8dfd..b72e529e57f 100644 --- a/src/System.Management.Automation/engine/remoting/client/ClientRemotePowerShell.cs +++ b/src/System.Management.Automation/engine/remoting/client/ClientRemotePowerShell.cs @@ -28,7 +28,7 @@ internal class ClientRemotePowerShell : IDisposable /// /// Constructor which creates a client remote powershell /// - /// powershell instance + /// powershell instance. /// The runspace pool associated with /// this shell internal ClientRemotePowerShell(PowerShell shell, RemoteRunspacePoolInternal runspacePool) @@ -73,7 +73,7 @@ internal PowerShell PowerShell /// /// Set the state information of the client powershell /// - /// state information to set + /// state information to set. internal void SetStateInfo(PSInvocationStateInfo stateInfo) { shell.SetStateChanged(stateInfo); @@ -217,7 +217,7 @@ internal void SendInput() /// /// Initialize the client remote powershell instance /// - /// input for execution + /// input for execution. /// error stream to which /// data needs to be written to /// informational buffers @@ -361,8 +361,8 @@ internal PSConnectionRetryStatus ConnectionRetryStatus /// server side. It is added to the error collection of the /// client powershell /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleErrorReceived(object sender, RemoteDataEventArgs eventArgs) { using (s_tracer.TraceEventHandlers()) @@ -377,8 +377,8 @@ private void HandleErrorReceived(object sender, RemoteDataEventArgs /// server side. It is added to the output collection of the /// client powershell /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleOutputReceived(object sender, RemoteDataEventArgs eventArgs) { using (s_tracer.TraceEventHandlers()) @@ -400,8 +400,8 @@ private void HandleOutputReceived(object sender, RemoteDataEventArgs eve /// The invocation state of the server powershell has changed. /// The state of the client powershell is reflected accordingly /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleInvocationStateInfoReceived(object sender, RemoteDataEventArgs eventArgs) { @@ -470,7 +470,7 @@ private void HandleInvocationStateInfoReceived(object sender, /// and close the remote runspace/pool if the stop call failed due /// to network outage problems. /// - /// Exception + /// Exception. private void CheckAndCloseRunspaceAfterStop(Exception ex) { PSRemotingTransportException transportException = ex as PSRemotingTransportException; @@ -513,8 +513,8 @@ private void CheckAndCloseRunspaceAfterStop(Exception ex) /// Handler for handling any informational message received /// from the server side. /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleInformationalMessageReceived(object sender, RemoteDataEventArgs eventArgs) { @@ -679,7 +679,7 @@ private bool IsFinished(PSInvocationState state) /// /// Execute the specified host call /// - /// host call to execute + /// host call to execute. private void ExecuteHostCall(RemoteHostCall hostcall) { if (hostcall.IsVoidMethod) @@ -731,7 +731,7 @@ private void HandleCloseNotificationFromRunspacePool(object sender, /// all the powershell objects associated with the /// runspace pool to Failed /// - /// sender of this information, unused + /// sender of this information, unused. /// arguments describing this event /// contains information on the reason associated with the /// runspace pool entering a Broken state @@ -954,7 +954,7 @@ public void Dispose() /// /// Release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. protected void Dispose(bool disposing) { if (disposing) diff --git a/src/System.Management.Automation/engine/remoting/client/Job.cs b/src/System.Management.Automation/engine/remoting/client/Job.cs index 22398565586..53fccf44b1c 100644 --- a/src/System.Management.Automation/engine/remoting/client/Job.cs +++ b/src/System.Management.Automation/engine/remoting/client/Job.cs @@ -159,7 +159,7 @@ public InvalidJobStateException(JobState currentState, string actionMessage) /// Initializes a new instance of the InvalidPSJobStateException and defines value of /// CurrentState. /// - /// Current state of powershell + /// Current state of powershell. internal InvalidJobStateException(JobState currentState) : base ( @@ -226,7 +226,7 @@ public sealed class JobStateInfo /// /// Constructor for state changes not resulting from an error. /// - /// Execution state + /// Execution state. public JobStateInfo(JobState state) : this(state, null) { @@ -248,7 +248,7 @@ public JobStateInfo(JobState state, Exception reason) /// /// Copy constructor to support cloning /// - /// source information + /// source information. /// /// ArgumentNullException when is null. /// @@ -416,7 +416,7 @@ protected Job() /// /// Creates an instance of this class /// - /// Command invoked by this job object + /// Command invoked by this job object. protected Job(string command) : this() { @@ -427,8 +427,8 @@ protected Job(string command) /// /// Creates an instance of this class /// - /// Command invoked by this job object - /// Friendly name for the job object + /// Command invoked by this job object. + /// Friendly name for the job object. protected Job(string command, string name) : this(command) { @@ -441,9 +441,9 @@ protected Job(string command, string name) /// /// Creates an instance of this class /// - /// Command invoked by this job object - /// Friendly name for the job object - /// Child jobs of this job object + /// Command invoked by this job object. + /// Friendly name for the job object. + /// Child jobs of this job object. protected Job(string command, string name, IList childJobs) : this(command, name) { @@ -453,9 +453,9 @@ protected Job(string command, string name, IList childJobs) /// /// Creates an instance of this class /// - /// Command invoked by this job object - /// Friendly name for the job object - /// Id and InstanceId pair to be used for this job object + /// Command invoked by this job object. + /// Friendly name for the job object. + /// Id and InstanceId pair to be used for this job object. /// The JobIdentifier is a token that must be issued by PowerShell to allow /// reuse of the Id. This is the only way to set either Id or instance Id. protected Job(string command, string name, JobIdentifier token) @@ -485,9 +485,9 @@ protected Job(string command, string name, JobIdentifier token) /// /// Creates an instance of this class /// - /// Command invoked by this job object - /// Friendly name for the job object - /// InstanceId to be used for this job object + /// Command invoked by this job object. + /// Friendly name for the job object. + /// InstanceId to be used for this job object. /// The InstanceId may need to be set to maintain job identity across /// instances of the process. protected Job(string command, string name, Guid instanceId) @@ -1596,7 +1596,7 @@ private static void TraceException(Exception e) /// /// Gets the job for the specified location /// - /// location to filter on + /// location to filter on. /// Collection of jobs. internal List GetJobsForLocation(string location) { @@ -1772,8 +1772,8 @@ internal PSRemotingJob(PSSession[] remoteRunspaceInfos, /// /// remote command corresponding to this /// result object - /// Throttle limit to use - /// a friendly name for the job object + /// Throttle limit to use. + /// a friendly name for the job object. internal PSRemotingJob(string[] computerNames, List computerNameHelpers, string remoteCommand, int throttleLimit, string name) @@ -1805,7 +1805,7 @@ internal PSRemotingJob(string[] computerNames, /// runspaces /// remote command corresponding to this /// result object - /// throttle limit to use + /// throttle limit to use. /// internal PSRemotingJob(PSSession[] remoteRunspaceInfos, List runspaceHelpers, string remoteCommand, @@ -2639,7 +2639,7 @@ internal override IEnumerable GetRunspaces() /// count of blocked child jobs. When count reaches 0, sets the /// state of the parent job to running /// - /// sender of this event, unused + /// sender of this event, unused. /// event arguments, should be empty in this /// case private void HandleJobUnblocked(object sender, EventArgs eventArgs) @@ -2757,7 +2757,7 @@ internal class PSRemotingChildJob : Job, IJobDebugger /// /// Creates an instance of PSRemotingChildJob /// - /// command invoked by this job object + /// command invoked by this job object. /// /// internal PSRemotingChildJob(string remoteCommand, ExecutionCmdletHelper helper, ThrottleManager throttleManager) @@ -3026,7 +3026,7 @@ public bool IsAsync /// /// the pipeline reader which raised /// this event - /// information describing the ready event + /// information describing the ready event. private void HandleOutputReady(object sender, EventArgs eventArgs) { PSDataCollectionPipelineReader reader = @@ -3077,7 +3077,7 @@ private void HandleOutputReady(object sender, EventArgs eventArgs) /// /// the pipeline reader which raised /// this event - /// information describing the ready event + /// information describing the ready event. private void HandleErrorReady(object sender, EventArgs eventArgs) { PSDataCollectionPipelineReader reader = @@ -3192,8 +3192,8 @@ protected virtual void HandlePipelineStateChanged(object sender, PipelineStateEv /// /// Handle a throttle complete event /// - /// sender of this event - /// not used in this method + /// sender of this event. + /// not used in this method. private void HandleThrottleComplete(object sender, EventArgs eventArgs) { //Question: Why do we register for HandleThrottleComplete when we have already @@ -3213,8 +3213,8 @@ private void HandleThrottleComplete(object sender, EventArgs eventArgs) /// /// Handle the operation complete event /// - /// sender of this event - /// operation complete event args + /// sender of this event. + /// operation complete event args. protected virtual void HandleOperationComplete(object sender, OperationStateEventArgs stateEventArgs) { //Question:Why are we registering for OperationComplete if we already @@ -3526,8 +3526,8 @@ protected void AggregateResultsFromHelper(ExecutionCmdletHelper helper) /// If it is null, then returns the PowerShell with the specified /// instance Id. /// - /// remote pipeline - /// instance as described in event args + /// remote pipeline. + /// instance as described in event args. /// PowerShell instance. private PowerShell GetPipelinePowerShell(RemotePipeline pipeline, Guid instanceId) { @@ -3543,8 +3543,8 @@ private PowerShell GetPipelinePowerShell(RemotePipeline pipeline, Guid instanceI /// When a debug message is raised in the underlying PowerShell /// add it to the jobs debug stream /// - /// unused - /// arguments describing this event + /// unused. + /// arguments describing this event. private void HandleDebugAdded(object sender, DataAddedEventArgs eventArgs) { int index = eventArgs.Index; @@ -3560,8 +3560,8 @@ private void HandleDebugAdded(object sender, DataAddedEventArgs eventArgs) /// When a verbose message is raised in the underlying PowerShell /// add it to the jobs verbose stream /// - /// unused - /// arguments describing this event + /// unused. + /// arguments describing this event. private void HandleVerboseAdded(object sender, DataAddedEventArgs eventArgs) { int index = eventArgs.Index; @@ -3577,8 +3577,8 @@ private void HandleVerboseAdded(object sender, DataAddedEventArgs eventArgs) /// When a warning message is raised in the underlying PowerShell /// add it to the jobs warning stream /// - /// unused - /// arguments describing this event + /// unused. + /// arguments describing this event. private void HandleWarningAdded(object sender, DataAddedEventArgs eventArgs) { int index = eventArgs.Index; @@ -3596,8 +3596,8 @@ private void HandleWarningAdded(object sender, DataAddedEventArgs eventArgs) /// When a progress message is raised in the underlying PowerShell /// add it to the jobs progress tream /// - /// unused - /// arguments describing this event + /// unused. + /// arguments describing this event. private void HandleProgressAdded(object sender, DataAddedEventArgs eventArgs) { int index = eventArgs.Index; @@ -3613,8 +3613,8 @@ private void HandleProgressAdded(object sender, DataAddedEventArgs eventArgs) /// When a Information message is raised in the underlying PowerShell /// add it to the jobs Information stream /// - /// unused - /// arguments describing this event + /// unused. + /// arguments describing this event. private void HandleInformationAdded(object sender, DataAddedEventArgs eventArgs) { int index = eventArgs.Index; @@ -3659,7 +3659,7 @@ protected void StopAggregateResultsFromHelper(ExecutionCmdletHelper helper) /// This is to support Invoke-Command auto-disconnect where a new PSRemoting /// job must be created to pass back to user for connection. /// - /// helper class + /// helper class. protected void RemoveAggreateCallbacksFromHelper(ExecutionCmdletHelper helper) { // Remove old data output callbacks from pipeline so new callbacks can be added. @@ -3763,7 +3763,7 @@ internal void UnblockJob() /// /// Returns the PowerShell for the specified instance id /// - /// instance id of powershell + /// instance id of powershell. /// Powershell instance. internal virtual PowerShell GetPowerShell(Guid instanceId) { @@ -3791,8 +3791,8 @@ internal PowerShell GetPowerShell() /// job state to Debug. Set back to Running when availability goes back to /// Busy (indicating the script/command is running again). /// - /// Runspace - /// RunspaceAvailabilityEventArgs + /// Runspace. + /// RunspaceAvailabilityEventArgs. private void HandleRunspaceAvailabilityChanged(object sender, RunspaceAvailabilityEventArgs e) { RunspaceAvailability prevAvailability = _prevRunspaceAvailability; @@ -3893,8 +3893,8 @@ public RemotingJobDebugger( /// Evaluates provided command either as a debugger specific command /// or a PowerShell command. /// - /// PowerShell command - /// Output + /// PowerShell command. + /// Output. /// DebuggerCommandResults. public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output) { @@ -3910,7 +3910,7 @@ public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataC /// /// Sets the debugger resume action. /// - /// DebuggerResumeAction + /// DebuggerResumeAction. public override void SetDebuggerAction(DebuggerResumeAction resumeAction) { _wrappedDebugger.SetDebuggerAction(resumeAction); @@ -3937,11 +3937,11 @@ public override DebuggerStopEventArgs GetDebuggerStopArgs() /// /// Sets the parent debugger, breakpoints, and other debugging context information. /// - /// Parent debugger - /// List of breakpoints - /// Debugger mode - /// PowerShell host - /// Current path + /// Parent debugger. + /// List of breakpoints. + /// Debugger mode. + /// PowerShell host. + /// Current path. public override void SetParent( Debugger parent, IEnumerable breakPoints, @@ -3975,7 +3975,7 @@ public override IEnumerable GetCallStack() /// /// Sets debugger stepping mode. /// - /// True if stepping is to be enabled + /// True if stepping is to be enabled. public override void SetDebuggerStepMode(bool enabled) { _wrappedDebugger.SetDebuggerStepMode(enabled); @@ -4094,7 +4094,7 @@ internal class PSInvokeExpressionSyncJob : PSRemotingChildJob /// /// Construct an invoke-expression sync job /// - /// list of operations to use + /// list of operations to use. /// throttle manager to use for /// this job internal PSInvokeExpressionSyncJob(List operations, ThrottleManager throttleManager) @@ -4177,7 +4177,7 @@ protected override void DoCleanupOnFinished() /// /// release all resources /// - /// true if called by Dispose() + /// true if called by Dispose(). protected override void Dispose(bool disposing) { base.Dispose(disposing); @@ -4187,8 +4187,8 @@ protected override void Dispose(bool disposing) /// Handles operation complete from the operations. Adds an error record /// to results whenever an error is encountered /// - /// sender of this event - /// arguments describing this event, unused + /// sender of this event. + /// arguments describing this event, unused. protected override void HandleOperationComplete(object sender, OperationStateEventArgs stateEventArgs) { ExecutionCmdletHelper helper = sender as ExecutionCmdletHelper; @@ -4312,7 +4312,7 @@ protected override void DoFinish() /// /// Returns the PowerShell instance for the specified id /// - /// instance id of PowerShell + /// instance id of PowerShell. /// PowerShell instance. internal override PowerShell GetPowerShell(Guid instanceId) { diff --git a/src/System.Management.Automation/engine/remoting/client/Job2.cs b/src/System.Management.Automation/engine/remoting/client/Job2.cs index 5de8b13d417..baf187f9607 100644 --- a/src/System.Management.Automation/engine/remoting/client/Job2.cs +++ b/src/System.Management.Automation/engine/remoting/client/Job2.cs @@ -141,8 +141,8 @@ protected Job2(string command) : base(command) { } /// /// Creates an instance of this class /// - /// Command invoked by this job object - /// Friendly name for the job object + /// Command invoked by this job object. + /// Friendly name for the job object. protected Job2(string command, string name) : base(command, name) { @@ -151,9 +151,9 @@ protected Job2(string command, string name) /// /// Creates an instance of this class /// - /// Command invoked by this job object - /// Friendly name for the job object - /// Child jobs of this job object + /// Command invoked by this job object. + /// Friendly name for the job object. + /// Child jobs of this job object. protected Job2(string command, string name, IList childJobs) : base(command, name, childJobs) { @@ -162,9 +162,9 @@ protected Job2(string command, string name, IList childJobs) /// /// Creates an instance of this class /// - /// Command invoked by this job object - /// Friendly name for the job object - /// JobIdentifier token used to assign Id and InstanceId + /// Command invoked by this job object. + /// Friendly name for the job object. + /// JobIdentifier token used to assign Id and InstanceId. protected Job2(string command, string name, JobIdentifier token) : base(command, name, token) { @@ -173,8 +173,8 @@ protected Job2(string command, string name, JobIdentifier token) /// /// Creates an instance of this class /// - /// Command string - /// Friendly name for the job + /// Command string. + /// Friendly name for the job. /// Instance ID to allow job identification across sessions. protected Job2(string command, string name, Guid instanceId) : base(command, name, instanceId) @@ -189,7 +189,7 @@ protected Job2(string command, string name, Guid instanceId) /// colliding with some implementation which may have /// added that method /// - /// state of the job + /// state of the job. /// exception associated with the /// job entering this state protected new void SetJobState(JobState state, Exception reason) @@ -597,8 +597,8 @@ private ManualResetEvent JobSuspendedOrAborted /// Create a container parent job with the /// specified command string and name /// - /// command string - /// friendly name for display + /// command string. + /// friendly name for display. public ContainerParentJob(string command, string name) : base(command, name) { @@ -609,7 +609,7 @@ public ContainerParentJob(string command, string name) /// Create a container parent job with the /// specified command string /// - /// Command string + /// Command string. public ContainerParentJob(string command) : base(command) { @@ -620,9 +620,9 @@ public ContainerParentJob(string command) /// Create a container parent job with the /// specified command string /// - /// Command string - /// Friendly name for the job - /// JobIdentifier token that allows reuse of an Id and Instance Id + /// Command string. + /// Friendly name for the job. + /// JobIdentifier token that allows reuse of an Id and Instance Id. public ContainerParentJob(string command, string name, JobIdentifier jobId) : base(command, name, jobId) { @@ -633,8 +633,8 @@ public ContainerParentJob(string command, string name, JobIdentifier jobId) /// Create a container parent job with the /// specified command string /// - /// Command string - /// Friendly name for the job + /// Command string. + /// Friendly name for the job. /// Instance ID to allow job identification across sessions. public ContainerParentJob(string command, string name, Guid instanceId) : base(command, name, instanceId) @@ -646,10 +646,10 @@ public ContainerParentJob(string command, string name, Guid instanceId) /// Create a container parent job with the /// specified command string /// - /// Command string - /// Friendly name for the job - /// JobIdentifier token that allows reuse of an Id and Instance Id - /// Job type name + /// Command string. + /// Friendly name for the job. + /// JobIdentifier token that allows reuse of an Id and Instance Id. + /// Job type name. public ContainerParentJob(string command, string name, JobIdentifier jobId, string jobType) : base(command, name, jobId) { @@ -661,10 +661,10 @@ public ContainerParentJob(string command, string name, JobIdentifier jobId, stri /// Create a container parent job with the /// specified command string /// - /// Command string - /// Friendly name for the job + /// Command string. + /// Friendly name for the job. /// Instance ID to allow job identification across sessions. - /// Job type name + /// Job type name. public ContainerParentJob(string command, string name, Guid instanceId, string jobType) : base(command, name, instanceId) { @@ -676,9 +676,9 @@ public ContainerParentJob(string command, string name, Guid instanceId, string j /// Create a container parent job with the specified command, name, /// job type strings. /// - /// Command string - /// Friendly name for the job - /// Job type name + /// Command string. + /// Friendly name for the job. + /// Job type name. public ContainerParentJob(string command, string name, string jobType) : base(command, name) { @@ -695,7 +695,7 @@ public ContainerParentJob(string command, string name, string jobType) /// /// Add a child job to the parent job /// - /// child job to add + /// child job to add. /// Thrown if the job is disposed. /// Thrown if child being added is null. public void AddChildJob(Job2 childJob) @@ -2119,7 +2119,7 @@ public JobFailedException() /// /// Creates a new JobFailedException /// - /// The message of the exception + /// The message of the exception. public JobFailedException(string message) : base(message) { @@ -2128,7 +2128,7 @@ public JobFailedException(string message) /// /// Creates a new JobFailedException /// - /// The message of the exception + /// The message of the exception. /// The actual exception that caused this error. public JobFailedException(string message, Exception innerException) : base(message, innerException) @@ -2149,8 +2149,8 @@ public JobFailedException(Exception innerException, ScriptExtent displayScriptPo /// /// Class constructor /// - /// serialization info - /// streaming context + /// serialization info. + /// streaming context. protected JobFailedException(SerializationInfo serializationInfo, StreamingContext streamingContext) : base(serializationInfo, streamingContext) { @@ -2175,8 +2175,8 @@ protected JobFailedException(SerializationInfo serializationInfo, StreamingConte /// /// Gets the information for serialization /// - /// The standard SerializationInfo - /// The standard StreaminContext + /// The standard SerializationInfo. + /// The standard StreaminContext. public override void GetObjectData(SerializationInfo info, StreamingContext context) { if (info == null) diff --git a/src/System.Management.Automation/engine/remoting/client/JobManager.cs b/src/System.Management.Automation/engine/remoting/client/JobManager.cs index 216819b148e..ed33c7a30f6 100644 --- a/src/System.Management.Automation/engine/remoting/client/JobManager.cs +++ b/src/System.Management.Automation/engine/remoting/client/JobManager.cs @@ -264,8 +264,8 @@ public Job2 NewJob(JobInvocationInfo specification) /// /// Saves the job to a persisted store. /// - /// Job2 type job to persist - /// Job definition containing source adapter information + /// Job2 type job to persist. + /// Job definition containing source adapter information. public void PersistJob(Job2 job, JobDefinition definition) { if (job == null) @@ -420,7 +420,7 @@ private JobSourceAdapter GetJobSourceAdapter(JobDefinition definition) /// Cmdlet requesting this, for error processing. /// /// - /// job source adapter type names + /// job source adapter type names. /// Collection of jobs. /// If cmdlet parameter is null, throws exception on error from /// JobSourceAdapter implementation. @@ -442,7 +442,7 @@ internal List GetJobs( /// /// /// - /// job source adapter type names + /// job source adapter type names. /// Collection of jobs that match the specified /// criteria. /// If cmdlet parameter is null, throws exception on error from @@ -466,7 +466,7 @@ internal List GetJobsByName( /// /// /// - /// job source adapter type names + /// job source adapter type names. /// Collection of jobs that match the specified /// criteria. /// If cmdlet parameter is null, throws exception on error from @@ -490,7 +490,7 @@ internal List GetJobsByCommand( /// /// /// - /// job source adapter type names + /// job source adapter type names. /// Collection of jobs with the specified /// state. /// If cmdlet parameter is null, throws exception on error from @@ -528,8 +528,8 @@ internal List GetJobsByFilter(Dictionary filter, Cmdlet cm /// /// Get a filtered list of jobs based on adapter name. /// - /// job id - /// adapter name + /// job id. + /// adapter name. /// internal bool IsJobFromAdapter(Guid id, string name) { @@ -557,7 +557,7 @@ internal bool IsJobFromAdapter(Guid id, string name) /// /// /// - /// job source adapter type names + /// job source adapter type names. /// Filtered list of jobs. /// If cmdlet parameter is null, throws exception on error from /// JobSourceAdapter implementation. @@ -878,7 +878,7 @@ private static void WriteErrorOrWarning(bool writeErrorOnException, Cmdlet cmdle /// /// Returns a List of adapter names currently loaded. /// - /// Adapter names to filter on + /// Adapter names to filter on. /// List of names. internal List GetLoadedAdapterNames(string[] adapterTypeNames) { diff --git a/src/System.Management.Automation/engine/remoting/client/JobSourceAdapter.cs b/src/System.Management.Automation/engine/remoting/client/JobSourceAdapter.cs index 6f58b27c535..56adcaa7c3e 100644 --- a/src/System.Management.Automation/engine/remoting/client/JobSourceAdapter.cs +++ b/src/System.Management.Automation/engine/remoting/client/JobSourceAdapter.cs @@ -95,7 +95,7 @@ public Guid InstanceId /// Save this definition to the specified /// file on disk /// - /// stream to save to + /// stream to save to. public virtual void Save(Stream stream) { throw new NotImplementedException(); @@ -249,7 +249,7 @@ public List Parameters /// /// Save this specification to a file /// - /// stream to save to + /// stream to save to. public virtual void Save(Stream stream) { throw new NotImplementedException(); @@ -258,7 +258,7 @@ public virtual void Save(Stream stream) /// /// Load this specification from a file /// - /// stream to load from + /// stream to load from. public virtual void Load(Stream stream) { throw new NotImplementedException(); @@ -273,8 +273,8 @@ protected JobInvocationInfo() /// /// Create a new job definition with a single set of parameters. /// - /// The job definition - /// The parameter collection to use + /// The job definition. + /// The parameter collection to use. public JobInvocationInfo(JobDefinition definition, Dictionary parameters) { _definition = definition; @@ -289,8 +289,8 @@ public JobInvocationInfo(JobDefinition definition, Dictionary pa /// Create a new job definition with a multiple sets of parameters. This allows /// different parameters for different machines. /// - /// The job definition - /// Collection of sets of parameters to use for the child jobs + /// The job definition. + /// Collection of sets of parameters to use for the child jobs. [SuppressMessage("Microsoft.Design", "CA1006:DoNotNestGenericTypesInMemberSignatures", Justification = "This is forced by the interaction of PowerShell and Workflow.")] public JobInvocationInfo(JobDefinition definition, IEnumerable> parameterCollectionList) @@ -353,7 +353,7 @@ public virtual void GetObjectData(SerializationInfo info, StreamingContext conte /// /// Utility function to turn a dictionary of name/value pairs into a parameter collection /// - /// The dictionary to convert + /// The dictionary to convert. /// The converted collection. private static CommandParameterCollection ConvertDictionaryToParameterCollection(IEnumerable> parameters) { @@ -387,7 +387,7 @@ public abstract class JobSourceAdapter /// creator of the original job. /// The original job must have been saved using "SaveJobIdForReconstruction" /// - /// Instance Id of the job to recreate + /// Instance Id of the job to recreate. /// JobIdentifier to be used in job construction. protected JobIdentifier RetrieveJobIdForReuse(Guid instanceId) { @@ -441,7 +441,7 @@ private void StoreJobIdForReuseHelper(Hashtable duplicateDetector, Job2 job, boo /// /// Create a new job with the specified definition /// - /// job definition to use + /// job definition to use. /// Job object. public Job2 NewJob(JobDefinition definition) { @@ -454,8 +454,8 @@ public Job2 NewJob(JobDefinition definition) /// then a default location will be used to find the job /// definition by name. /// - /// Job definition name - /// Job definition file path + /// Job definition name. + /// Job definition file path. /// Job2 object. public virtual Job2 NewJob(string definitionName, string definitionPath) { @@ -465,7 +465,7 @@ public virtual Job2 NewJob(string definitionName, string definitionPath) /// /// Create a new job with the specified JobSpecification /// - /// specification + /// specification. /// Job object. public abstract Job2 NewJob(JobInvocationInfo specification); @@ -489,7 +489,7 @@ public virtual Job2 NewJob(string definitionName, string definitionPath) /// /// Get list of jobs that run the specified command /// - /// command to match + /// command to match. /// /// Collection of jobs that match the specified /// criteria. @@ -498,7 +498,7 @@ public virtual Job2 NewJob(string definitionName, string definitionPath) /// /// Get list of jobs that has the specified id /// - /// Guid to match + /// Guid to match. /// /// Job with the specified guid. public abstract Job2 GetJobByInstanceId(Guid instanceId, bool recurse); @@ -506,7 +506,7 @@ public virtual Job2 NewJob(string definitionName, string definitionPath) /// /// Get job that has specific session id /// - /// Id to match + /// Id to match. /// /// Job with the specified id. public abstract Job2 GetJobBySessionId(int id, bool recurse); @@ -514,7 +514,7 @@ public virtual Job2 NewJob(string definitionName, string definitionPath) /// /// Get list of jobs that are in the specified state /// - /// state to match + /// state to match. /// /// Collection of jobs with the specified /// state. @@ -534,13 +534,13 @@ public virtual Job2 NewJob(string definitionName, string definitionPath) /// /// Remove a job from the store /// - /// job object to remove + /// job object to remove. public abstract void RemoveJob(Job2 job); /// /// Saves the job to a persisted store. /// - /// Job2 type job to persist + /// Job2 type job to persist. public virtual void PersistJob(Job2 job) { // Implemented only if job needs to be told when to persist. diff --git a/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs b/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs index 0f4652073d1..1510cc63fc7 100644 --- a/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs +++ b/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs @@ -35,7 +35,7 @@ public sealed class PSJobProxy : Job2 /// /// Internal constructor /// - /// the command to execute + /// the command to execute. internal PSJobProxy(string command) : base(command) { @@ -378,8 +378,8 @@ public void StartJob(PSDataCollection input) /// the job, delegates may be indicated to ensure that no events will be missed /// after the child job is created if data begins streaming back immediately. /// - /// delegate used to subscribe to data added events on the child jobs - /// delegate used to subscribe to state changed events on the child jobs + /// delegate used to subscribe to data added events on the child jobs. + /// delegate used to subscribe to state changed events on the child jobs. /// collection of input /// objects public void StartJob(EventHandler dataAdded, EventHandler stateChanged, PSDataCollection input) @@ -408,8 +408,8 @@ public void StartJob(EventHandler dataAdded, EventHandler /// the job, delegates may be indicated to ensure that no events will be missed /// after the child job is created if data begins streaming back immediately. /// - /// delegate used to subscribe to data added events on the child jobs - /// delegate used to subscribe to state changed events on the child jobs + /// delegate used to subscribe to data added events on the child jobs. + /// delegate used to subscribe to state changed events on the child jobs. /// collection of input /// objects public void StartJobAsync(EventHandler dataAdded, EventHandler stateChanged, PSDataCollection input) @@ -842,8 +842,8 @@ public void ReceiveJob() /// /// Will begin streaming data for a job object created by the "create" method that is in a not started state. /// - /// delegate used to subscribe to data added events on the child jobs - /// delegate used to subscribe to state changed events on the child jobs + /// delegate used to subscribe to data added events on the child jobs. + /// delegate used to subscribe to state changed events on the child jobs. public void ReceiveJob(EventHandler dataAdded, EventHandler stateChanged) { lock (SyncRoot) @@ -1164,7 +1164,7 @@ private void ProcessQueueWorker(object state) /// Checks if there is more data in the specified collection /// /// Type of the collection - /// collection to check + /// collection to check. /// True if the collection has more data. private static bool CollectionHasMoreData(PSDataCollection collection) { @@ -1311,7 +1311,7 @@ private void DoResumeAsync() /// /// Worker method to remove the remote job object /// - /// state information indicates the "force" parameter + /// state information indicates the "force" parameter. private void DoRemove(object state) { AssertNotDisposed(); @@ -1582,8 +1582,8 @@ private void HandleMyStateChange(object sender, JobStateEventArgs e) /// Event handler for InvocationStateChanged on the powershell /// object running receive-job /// - /// sender of this event - /// argument describing this event + /// sender of this event. + /// argument describing this event. private void ReceivePowerShellInvocationStateChanged(object sender, PSInvocationStateChangedEventArgs e) { _tracer.WriteMessage(ClassNameTrace, "ReceivePowerShellInvocationStateChanged", _remoteJobInstanceId, this, @@ -2351,7 +2351,7 @@ private static string RemoveIdentifierInformation(string message, out Guid jobIn /// /// Dispose all managed resources /// - /// true when being disposed + /// true when being disposed. protected override void Dispose(bool disposing) { if (!disposing) return; diff --git a/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs b/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs index e7ebd86d915..60f007e19a9 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs @@ -48,7 +48,7 @@ internal class RemoteRunspacePoolInternal : RunspacePoolInternal, IDisposable /// 1. TargetTypeForDeserialization /// 2. TypeConverter /// - /// Host associated with this runspacepool + /// Host associated with this runspacepool. /// /// Application arguments the server can see in /// @@ -492,8 +492,8 @@ internal override int GetAvailableRunspaces() /// The server sent application private data. Store the data so that user /// can get it later. /// - /// argument describing this event - /// sender of this event + /// argument describing this event. + /// sender of this event. internal void HandleApplicationPrivateDataReceived(object sender, RemoteDataEventArgs eventArgs) { @@ -533,8 +533,8 @@ internal void HandleInitInfoReceived(object sender, /// The state of the server RunspacePool has changed. Handle /// the same and reflect local states accordingly /// - /// argument describing this event - /// sender of this event + /// argument describing this event. + /// sender of this event. internal void HandleStateInfoReceived(object sender, RemoteDataEventArgs eventArgs) { @@ -604,8 +604,8 @@ internal void HandleStateInfoReceived(object sender, /// A host call has been proxied from the server which needs to /// be executed /// - /// sender of this event - /// arguments describing this event + /// sender of this event. + /// arguments describing this event. internal void HandleRemoteHostCalls(object sender, RemoteDataEventArgs eventArgs) { @@ -779,7 +779,7 @@ internal Version PSRemotingProtocolVersion /// /// Push a running PowerShell onto the stack. /// - /// PowerShell + /// PowerShell. internal void PushRunningPowerShell(PowerShell ps) { Dbg.Assert(ps != null, "Caller should not pass in null reference."); @@ -1560,7 +1560,7 @@ private void SetRunspacePoolState(RunspacePoolStateInfo newStateInfo) /// /// state information object /// describing the state change at the server RunspacePool - /// raise state changed events if true + /// raise state changed events if true. private void SetRunspacePoolState(RunspacePoolStateInfo newStateInfo, bool raiseEvents) { stateInfo = newStateInfo; @@ -1645,8 +1645,8 @@ private void SetReconnectAsCompleted() /// /// The session is closing set the state and reason accordingly /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleSessionClosing(object sender, RemoteDataEventArgs eventArgs) { // just capture the reason for closing here..handle the session closed event @@ -1657,8 +1657,8 @@ private void HandleSessionClosing(object sender, RemoteDataEventArgs /// /// The session closed, set the state and reason accordingly /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleSessionClosed(object sender, RemoteDataEventArgs eventArgs) { if (eventArgs.Data != null) @@ -1759,8 +1759,8 @@ private void SetCloseAsCompleted() /// from the server, this method sets the response and thereby unblocks /// corresponding call /// - /// sender of this message, unused - /// contains response and call id + /// sender of this message, unused. + /// contains response and call id. private void HandleResponseReceived(object sender, RemoteDataEventArgs eventArgs) { PSObject data = eventArgs.Data; @@ -1926,7 +1926,7 @@ public void Dispose() /// /// Release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. public override void Dispose(bool disposing) { // dispose the base class before disposing dataStructure handler. @@ -2101,7 +2101,7 @@ internal static Collection GetRemoteCommands(Guid shellId, WSManConnec /// Use the WSMan New-WSManSessionOption cmdlet to create a session options /// object used for Get-WSManInstance queries. /// - /// WSManConnectionInfo + /// WSManConnectionInfo. /// WSMan session options object. private static object GetSessionOptions(WSManConnectionInfo wsmanConnectionInfo) { diff --git a/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs b/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs index 9bce80c35d9..47a8a707de5 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs @@ -30,8 +30,8 @@ public OriginInfo OriginInfo /// /// constructor /// - /// the error record that is wrapped - /// origin information + /// the error record that is wrapped. + /// origin information. public RemotingErrorRecord(ErrorRecord errorRecord, OriginInfo originInfo) : this(errorRecord, originInfo, null) { } /// @@ -56,8 +56,8 @@ private RemotingErrorRecord(ErrorRecord errorRecord, OriginInfo originInfo, Exce /// /// Serializer method for class. /// - /// Serializer information - /// Streaming context + /// Serializer information. + /// Streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -74,8 +74,8 @@ public override void GetObjectData(SerializationInfo info, StreamingContext cont /// /// Deserializer constructor. /// - /// Serializer information - /// Streaming context + /// Serializer information. + /// Streaming context. protected RemotingErrorRecord(SerializationInfo info, StreamingContext context) : base(info, context) { @@ -122,8 +122,8 @@ public OriginInfo OriginInfo /// /// Constructor /// - /// the progress record that is wrapped - /// origin information + /// the progress record that is wrapped. + /// origin information. public RemotingProgressRecord(ProgressRecord progressRecord, OriginInfo originInfo) : base(Validate(progressRecord).ActivityId, Validate(progressRecord).Activity, Validate(progressRecord).StatusDescription) { @@ -168,8 +168,8 @@ public OriginInfo OriginInfo /// /// Constructor /// - /// The warning message that is wrapped - /// The origin information + /// The warning message that is wrapped. + /// The origin information. public RemotingWarningRecord(string message, OriginInfo originInfo) : base(message) { _originInfo = originInfo; @@ -178,8 +178,8 @@ public RemotingWarningRecord(string message, OriginInfo originInfo) : base(messa /// /// Constructor taking WarningRecord to wrap and OriginInfo. /// - /// WarningRecord to wrap - /// OriginInfo + /// WarningRecord to wrap. + /// OriginInfo. internal RemotingWarningRecord( WarningRecord warningRecord, OriginInfo originInfo) @@ -209,8 +209,8 @@ public OriginInfo OriginInfo /// /// Constructor /// - /// The debug message that is wrapped - /// The origin information + /// The debug message that is wrapped. + /// The origin information. public RemotingDebugRecord(string message, OriginInfo originInfo) : base(message) { _originInfo = originInfo; @@ -237,8 +237,8 @@ public OriginInfo OriginInfo /// /// Constructor /// - /// The verbose message that is wrapped - /// The origin information + /// The verbose message that is wrapped. + /// The origin information. public RemotingVerboseRecord(string message, OriginInfo originInfo) : base(message) { _originInfo = originInfo; @@ -265,8 +265,8 @@ public OriginInfo OriginInfo /// /// Constructor /// - /// The Information message that is wrapped - /// The origin information + /// The Information message that is wrapped. + /// The origin information. public RemotingInformationRecord(InformationRecord record, OriginInfo originInfo) : base(record) { @@ -343,8 +343,8 @@ public Guid InstanceID /// /// public constructor /// - /// machine name - /// instance id of runspace + /// machine name. + /// instance id of runspace. [SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "ID")] public OriginInfo(string computerName, Guid runspaceID) : this(computerName, runspaceID, Guid.Empty) @@ -353,9 +353,9 @@ public OriginInfo(string computerName, Guid runspaceID) /// /// public constructor /// - /// machine name - /// instance id of runspace - /// instance id for the origin object + /// machine name. + /// instance id of runspace. + /// instance id for the origin object. [SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "ID")] public OriginInfo(string computerName, Guid runspaceID, Guid instanceID) { diff --git a/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs b/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs index c5fe3cf9604..ed10f8ad0da 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs @@ -116,7 +116,7 @@ internal void ConnectPoolAsync() /// Process the data received from the runspace pool /// on the server /// - /// data received + /// data received. internal void ProcessReceivedData(RemoteDataObject receivedData) { // verify if this data structure handler is the intended recipient @@ -209,7 +209,7 @@ internal void ProcessReceivedData(RemoteDataObject receivedData) /// Creates a PowerShell data structure handler instance associated /// with this runspace pool data structure handler /// - /// associated powershell + /// associated powershell. /// PowerShell data structure handler object. internal ClientPowerShellDataStructureHandler CreatePowerShellDataStructureHandler( ClientRemotePowerShell shell) @@ -225,7 +225,7 @@ internal ClientPowerShellDataStructureHandler CreatePowerShellDataStructureHandl /// Creates a PowerShell instances on the server, associates it /// with this runspace pool and invokes /// - /// the client remote powershell + /// the client remote powershell. internal void CreatePowerShellOnServerAndInvoke(ClientRemotePowerShell shell) { // add to associated powershell list and send request to server @@ -290,7 +290,7 @@ internal void DispatchMessageToPowerShell(RemoteDataObject rcvdData) /// /// send the host response to the server /// - /// host response object to send + /// host response object to send. internal void SendHostResponseToServer(RemoteHostResponse hostResponse) { SendDataAsync(hostResponse.Encode(), DataPriorityType.PromptResponse); @@ -299,7 +299,7 @@ internal void SendHostResponseToServer(RemoteHostResponse hostResponse) /// /// Send a message to the server instructing it to reset its runspace state. /// - /// Caller Id + /// Caller Id. internal void SendResetRunspaceStateToServer(long callId) { RemoteDataObject message = @@ -311,7 +311,7 @@ internal void SendResetRunspaceStateToServer(long callId) /// /// sent a message to modify the max runspaces of the runspace pool /// - /// new maxrunspaces to set + /// new maxrunspaces to set. /// call id on which the calling method will /// be blocked on internal void SendSetMaxRunspacesToServer(int maxRunspaces, long callId) @@ -325,7 +325,7 @@ internal void SendSetMaxRunspacesToServer(int maxRunspaces, long callId) /// /// Send a message to modify the min runspaces of the runspace pool /// - /// new minrunspaces to set + /// new minrunspaces to set. /// call id on which the calling method will /// be blocked on internal void SendSetMinRunspacesToServer(int minRunspaces, long callId) @@ -425,7 +425,7 @@ internal void SendGetAvailableRunspacesToServer(long callId) /// Send the data specified as a RemoteDataObject asynchronously /// to the runspace pool on the remote session /// - /// data to send + /// data to send. /// This overload takes a RemoteDataObject and should be /// the one used within the code private void SendDataAsync(RemoteDataObject data) @@ -438,8 +438,8 @@ private void SendDataAsync(RemoteDataObject data) /// session with the specified priority /// /// - /// data to be sent to server - /// priority with which to send data + /// data to be sent to server. + /// priority with which to send data. internal void SendDataAsync(RemoteDataObject data, DataPriorityType priority) { _transportManager.DataToBeSentCollection.Add(data, priority); @@ -449,8 +449,8 @@ internal void SendDataAsync(RemoteDataObject data, DataPriorityType priori /// Send the data asynchronously to runspace pool driver on remote /// session with the specified priority /// - /// data object to send - /// priority with which to send data + /// data object to send. + /// priority with which to send data. internal void SendDataAsync(PSObject data, DataPriorityType priority) { RemoteDataObject dataToBeSent = RemoteDataObject.CreateFrom(RemotingDestination.Server, @@ -477,8 +477,8 @@ private ClientRemoteSessionImpl CreateClientRemoteSession( /// /// Handler for handling all session events /// - /// sender of this event - /// object describing this event + /// sender of this event. + /// object describing this event. private void HandleClientRemoteSessionStateChanged( object sender, RemoteSessionStateEventArgs e) { @@ -667,7 +667,7 @@ private void NotifyAssociatedPowerShells(RunspacePoolStateInfo stateInfo) /// /// Gets the ClientPowerShellDataStructureHandler instance for the specified id /// - /// id of the client remote powershell + /// id of the client remote powershell. /// ClientPowerShellDataStructureHandler object. private ClientPowerShellDataStructureHandler GetAssociatedPowerShellDataStructureHandler (Guid clientPowerShellId) @@ -690,8 +690,8 @@ private ClientPowerShellDataStructureHandler GetAssociatedPowerShellDataStructur /// /// Remove the association of the powershell from the runspace pool /// - /// sender of this event - /// unused + /// sender of this event. + /// unused. private void HandleRemoveAssociation(object sender, EventArgs e) { Dbg.Assert(sender is ClientPowerShellDataStructureHandler, @"sender of the event @@ -857,8 +857,8 @@ private void HandleRobustConnectionNotification( /// /// Forwards the session create completion event. /// - /// transport sender - /// CreateCompleteEventArgs + /// transport sender. + /// CreateCompleteEventArgs. private void HandleSessionCreateCompleted(object sender, CreateCompleteEventArgs eventArgs) { SessionCreateCompleted.SafeInvoke(this, eventArgs); @@ -963,7 +963,7 @@ public void Dispose() /// /// Release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. public void Dispose(bool disposing) { if (disposing) @@ -1148,7 +1148,7 @@ private void OnSignalCompleted(object sender, EventArgs e) /// /// Send the host response to the server /// - /// host response to send + /// host response to send. internal void SendHostResponseToServer(RemoteHostResponse hostResponse) { RemoteDataObject dataToBeSent = @@ -1202,7 +1202,7 @@ internal void SendInput(ObjectStreamBase inputstream) /// Process the data received from the runspace pool /// on the server /// - /// data received + /// data received. internal void ProcessReceivedData(RemoteDataObject receivedData) { // verify if this data structure handler is the intended recipient @@ -1529,7 +1529,7 @@ internal Guid PowerShellId /// Send the data specified as a RemoteDataObject asynchronously /// to the powershell on server /// - /// data to send + /// data to send. /// This overload takes a RemoteDataObject and should be /// the one used within the code private void SendDataAsync(RemoteDataObject data) @@ -1541,8 +1541,8 @@ private void SendDataAsync(RemoteDataObject data) /// /// Handle data added to input /// - /// sender of this event - /// information describing this event + /// sender of this event. + /// information describing this event. private void HandleInputDataReady(object sender, EventArgs e) { // make sure only one thread calls the WriteInput. @@ -1593,7 +1593,7 @@ private void WriteInput(ObjectStreamBase inputstream) /// Helper method to add transport manager callbacks and set transport /// manager disconnected state. /// - /// Boolean + /// Boolean. private void SetupTransportManager(bool inDisconnectMode) { TransportManager.WSManTransportErrorOccured += HandleTransportError; diff --git a/src/System.Management.Automation/engine/remoting/client/RunspaceRef.cs b/src/System.Management.Automation/engine/remoting/client/RunspaceRef.cs index 086c328c8f2..7f995f1f5de 100644 --- a/src/System.Management.Automation/engine/remoting/client/RunspaceRef.cs +++ b/src/System.Management.Automation/engine/remoting/client/RunspaceRef.cs @@ -275,9 +275,9 @@ internal void Override(RemoteRunspace remoteRunspace) /// /// Override inside a safe lock /// - /// runspace to override - /// object to use in synchronization - /// set is runspace pushed + /// runspace to override. + /// object to use in synchronization. + /// set is runspace pushed. internal void Override(RemoteRunspace remoteRunspace, object syncObject, out bool isRunspacePushed) { lock (_localSyncObject) diff --git a/src/System.Management.Automation/engine/remoting/client/ThrottlingJob.cs b/src/System.Management.Automation/engine/remoting/client/ThrottlingJob.cs index 1dec7181884..d8cf5e4db4c 100644 --- a/src/System.Management.Automation/engine/remoting/client/ThrottlingJob.cs +++ b/src/System.Management.Automation/engine/remoting/client/ThrottlingJob.cs @@ -258,8 +258,8 @@ private int CountOfRunningOrReadyToRunChildJobs /// /// Creates a new object. /// - /// Command invoked by this job object - /// Friendly name for the job object + /// Command invoked by this job object. + /// Friendly name for the job object. /// Name describing job type. /// /// The maximum number of child jobs that can be running at any given point in time. @@ -361,9 +361,9 @@ internal void DisableFlowControlForPendingCmdletActionsQueue() /// /// Adds and starts a child job. /// - /// Child job to add - /// Flags of the child job - /// action to run after enqueuing the job + /// Child job to add. + /// Flags of the child job. + /// action to run after enqueuing the job. /// /// Thrown when the child job is not in the state. /// (because this can lead to race conditions - the child job can finish before the parent job has a chance to register for child job events) diff --git a/src/System.Management.Automation/engine/remoting/client/clientremotesession.cs b/src/System.Management.Automation/engine/remoting/client/clientremotesession.cs index 061ca82d2da..7089b6d75ff 100644 --- a/src/System.Management.Automation/engine/remoting/client/clientremotesession.cs +++ b/src/System.Management.Automation/engine/remoting/client/clientremotesession.cs @@ -384,7 +384,7 @@ internal override void CompleteKeyExchange() /// /// Handles an encrypted session key received from the other side /// - /// sender of this event + /// sender of this event. /// arguments that contain the remote /// public key private void HandleEncryptedSessionKeyReceived(object sender, RemoteDataEventArgs eventArgs) @@ -416,8 +416,8 @@ private void HandleEncryptedSessionKeyReceived(object sender, RemoteDataEventArg /// /// Handles a request for public key from the server /// - /// send of this event, unused - /// arguments describing this event, unused + /// send of this event, unused. + /// arguments describing this event, unused. private void HandlePublicKeyRequestReceived(object sender, RemoteDataEventArgs eventArgs) { if (SessionDataStructureHandler.StateMachine.State == RemoteSessionState.Established) @@ -583,7 +583,7 @@ public void Dispose() /// /// Release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. public void Dispose(bool disposing) { if (disposing) diff --git a/src/System.Management.Automation/engine/remoting/client/clientremotesessionprotocolstatemachine.cs b/src/System.Management.Automation/engine/remoting/client/clientremotesessionprotocolstatemachine.cs index 6052a7e0df1..e2e59148e10 100644 --- a/src/System.Management.Automation/engine/remoting/client/clientremotesessionprotocolstatemachine.cs +++ b/src/System.Management.Automation/engine/remoting/client/clientremotesessionprotocolstatemachine.cs @@ -168,8 +168,8 @@ private void RaiseStateMachineEvents() /// if the specified event is valid for the current state of /// the state machine /// - /// sender of this event - /// event args + /// sender of this event. + /// event args. private void SetStateHandler(object sender, RemoteSessionStateMachineEventArgs eventArgs) { switch (eventArgs.StateEvent) @@ -331,7 +331,7 @@ private void SetStateHandler(object sender, RemoteSessionStateMachineEventArgs e /// /// Handles the timeout for key exchange /// - /// sender of this event + /// sender of this event. private void HandleKeyExchangeTimeout(object sender) { Dbg.Assert(_state == RemoteSessionState.EstablishedAndKeySent, "timeout should only happen when waiting for a key"); @@ -354,8 +354,8 @@ private void HandleKeyExchangeTimeout(object sender) /// asserts if the specified event is valid for /// the current state of the state machine /// - /// sender of this event - /// event args + /// sender of this event. + /// event args. private void SetStateToClosedHandler(object sender, RemoteSessionStateMachineEventArgs eventArgs) { Dbg.Assert(_state == RemoteSessionState.NegotiationReceived && @@ -759,8 +759,8 @@ private void DoClose(object sender, RemoteSessionStateMachineEventArgs arg) /// which contains the reason for the fatal error as an inner exception. /// This way the internal details are not surfaced to the user /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void DoFatal(object sender, RemoteSessionStateMachineEventArgs eventArgs) { PSRemotingDataStructureException fatalError = @@ -783,7 +783,7 @@ private void CleanAll() /// one thread can be manipulating the state at a time /// the state is not synchronized /// - /// new state of the state machine + /// new state of the state machine. /// reason why the state machine is set /// to the new state private void SetState(RemoteSessionState newState, Exception reason) diff --git a/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs b/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs index 6531b06d93a..d3ce6c7dbe2 100644 --- a/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs +++ b/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs @@ -64,9 +64,9 @@ public ExecutionEventQueueItem(PipelineStateInfo pipelineStateInfo, RunspaceAvai /// /// Private constructor that does most of the work constructing a remote pipeline object. /// - /// RemoteRunspace object - /// AddToHistory - /// IsNested + /// RemoteRunspace object. + /// AddToHistory. + /// IsNested. private RemotePipeline(RemoteRunspace runspace, bool addToHistory, bool isNested) : base(runspace) { @@ -107,10 +107,10 @@ private RemotePipeline(RemoteRunspace runspace, bool addToHistory, bool isNested /// Constructs a remote pipeline for the specified runspace and /// specified command /// - /// runspace in which to create the pipeline - /// command as a string, to be used in pipeline creation - /// whether to add the command to the runspaces history - /// whether this pipeline is nested + /// runspace in which to create the pipeline. + /// command as a string, to be used in pipeline creation. + /// whether to add the command to the runspaces history. + /// whether this pipeline is nested. internal RemotePipeline(RemoteRunspace runspace, string command, bool addToHistory, bool isNested) : this(runspace, addToHistory, isNested) { @@ -159,7 +159,7 @@ internal RemotePipeline(RemoteRunspace runspace) /// /// Creates a cloned pipeline from the specified one /// - /// pipeline to clone from + /// pipeline to clone from. /// This constructor is private because this will /// only be called from the copy method private RemotePipeline(RemotePipeline pipeline) : @@ -637,7 +637,7 @@ private bool CanStopPipeline(out bool isAlreadyStopping) /// /// Disposes the pipeline /// - /// true, when called on Dispose() + /// true, when called on Dispose(). protected override void Dispose(bool disposing) { try @@ -719,7 +719,7 @@ private void HandleInvocationStateChanged(object sender, PSInvocationStateChange /// /// Sets the new execution state. /// - /// the new state + /// the new state. /// /// An exception indicating that state change is the result of an error, /// otherwise; null. @@ -863,8 +863,8 @@ protected void RaisePipelineStateEvents() /// command will be immediately disconnected after it begins /// running. /// - /// true if called from a sync call - /// Invoke and Disconnect + /// true if called from a sync call. + /// Invoke and Disconnect. private void InitPowerShell(bool syncCall, bool invokeAndDisconnect = false) { if (_commands == null || _commands.Count == 0) @@ -938,8 +938,8 @@ private void InitPowerShellForConnect(bool syncCall) /// /// Handle host call received /// - /// sender of this event, unused - /// arguments describing the host call to invoke + /// sender of this event, unused. + /// arguments describing the host call to invoke. private void HandleHostCallReceived(object sender, RemoteDataEventArgs eventArgs) { ClientMethodExecutor.Dispatch( @@ -1129,7 +1129,7 @@ internal PowerShell PowerShell /// /// Sets the history string to the specified string /// - /// new history string to set to + /// new history string to set to. internal override void SetHistoryString(string historyString) { _powershell.HistoryString = historyString; diff --git a/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs b/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs index bbeed2c3067..466b80dead0 100644 --- a/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs +++ b/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs @@ -124,7 +124,7 @@ protected bool ByPassRunspaceStateCheck /// /// connection information which identifies /// the remote computer - /// host on the client + /// host on the client. /// /// Friendly name for remote runspace session. /// Id for remote runspace. @@ -614,7 +614,7 @@ public override void Close() /// /// Dispose this runspace /// - /// true if called from Dispose + /// true if called from Dispose. protected override void Dispose(bool disposing) { try @@ -767,11 +767,11 @@ internal static Runspace[] GetRemoteRunspaces(RunspaceConnectionInfo connectionI /// Creates a single disconnected remote Runspace object based on connection information and /// session / command identifiers. /// - /// Connection object for target machine - /// Session Id to connect to - /// Optional command Id to connect to - /// Optional PSHost - /// Optional TypeTable + /// Connection object for target machine. + /// Session Id to connect to. + /// Optional command Id to connect to. + /// Optional PSHost. + /// Optional TypeTable. /// Disconnect remote Runspace object. internal static Runspace GetRemoteRunspace(RunspaceConnectionInfo connectionInfo, Guid sessionId, Guid? commandId, PSHost host, TypeTable typeTable) { @@ -1032,7 +1032,7 @@ public override Pipeline CreatePipeline() /// /// Create a pipeline from a command string /// - /// A valid command string + /// A valid command string. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -1052,8 +1052,8 @@ public override Pipeline CreatePipeline(string command) /// /// Create a pipeline from a command string. /// - /// A valid command string - /// if true command is added to history + /// A valid command string. + /// if true command is added to history. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -1088,8 +1088,8 @@ public override Pipeline CreateNestedPipeline() /// /// Creates a nested pipeline. /// - /// A valid command string - /// if true command is added to history + /// A valid command string. + /// if true command is added to history. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -1184,7 +1184,7 @@ internal void RemoveFromRunningPipelineList(RemotePipeline pipeline) /// Check to see, if there is any other pipeline running in this /// runspace. If not, then add this to the list of pipelines /// - /// pipeline to check and add + /// pipeline to check and add. /// whether this is being called from /// a synchronous method call internal void DoConcurrentCheckAndAddToRunningPipelines(RemotePipeline pipeline, bool syncCall) @@ -1393,7 +1393,7 @@ private void AssertIfStateIsBeforeOpen() /// /// Set the new runspace state. /// - /// the new state + /// the new state. /// An exception indicating the state change is the /// result of an error, otherwise; null. /// @@ -1566,7 +1566,7 @@ internal override Pipeline GetCurrentlyRunningPipeline() /// /// Handles any host calls received from the server /// - /// sender of this information, unused + /// sender of this information, unused. /// arguments describing this event, contains /// a RemoteHostCall object private void HandleHostCallReceived(object sender, RemoteDataEventArgs eventArgs) @@ -1665,7 +1665,7 @@ private void UpdateDisconnectExpiresOn() /// /// current invoke-command /// instance - /// local pipeline id + /// local pipeline id. /// True, if another invoke-command is running /// before, false otherwise. internal bool IsAnotherInvokeCommandExecuting(InvokeCommandCommand invokeCommand, @@ -1714,7 +1714,7 @@ internal bool IsAnotherInvokeCommandExecuting(InvokeCommandCommand invokeCommand /// /// reference to invoke command /// which is currently being processed - /// the local pipeline id + /// the local pipeline id. internal void SetCurrentInvokeCommand(InvokeCommandCommand invokeCommand, long localPipelineId) { @@ -1849,7 +1849,7 @@ private RemoteDebugger() { } /// /// Constructor /// - /// Associated remote runspace + /// Associated remote runspace. public RemoteDebugger(RemoteRunspace runspace) { if (runspace == null) @@ -1873,8 +1873,8 @@ public RemoteDebugger(RemoteRunspace runspace) /// /// Process debugger command. /// - /// Debugger PSCommand - /// Output + /// Debugger PSCommand. + /// Output. /// DebuggerCommandResults. public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output) { @@ -2010,7 +2010,7 @@ public override void StopProcessCommand() /// /// SetDebuggerAction /// - /// DebuggerResumeAction + /// DebuggerResumeAction. public override void SetDebuggerAction(DebuggerResumeAction resumeAction) { CheckForValidateState(); @@ -2094,7 +2094,7 @@ public override void SetDebugMode(DebugModes mode) /// /// Sets debugger stepping mode. /// - /// True if stepping is to be enabled + /// True if stepping is to be enabled. public override void SetDebuggerStepMode(bool enabled) { CheckForValidateState(); @@ -2254,12 +2254,12 @@ internal bool IsRemoteDebug /// /// Sets client debug info state based on server info. /// - /// Debug mode - /// Currently in breakpoint - /// Breakpoint count - /// Break All setting - /// UnhandledBreakpointMode - /// Server PowerShell version + /// Debug mode. + /// Currently in breakpoint. + /// Breakpoint count. + /// Break All setting. + /// UnhandledBreakpointMode. + /// Server PowerShell version. internal void SetClientDebugInfo( DebugModes? debugMode, bool inBreakpoint, diff --git a/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs b/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs index d9f47e929bb..1f46947441c 100644 --- a/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs +++ b/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs @@ -221,7 +221,7 @@ public override string ToString() /// new runspace is a reconstructed runspace having the same Guid /// as the existing runspace. /// - /// Runspace to insert + /// Runspace to insert. /// Boolean indicating if runspace was inserted. internal bool InsertRunspace(RemoteRunspace remoteRunspace) { @@ -358,7 +358,7 @@ private string GetTransportName() /// /// Returns shell configuration name with shell prefix removed. /// - /// shell configuration name + /// shell configuration name. /// Display shell name. private string GetDisplayShellName(string shell) { @@ -375,7 +375,7 @@ private string GetDisplayShellName(string shell) /// /// Generates a unique runspace id. /// - /// Returned Id + /// Returned Id. /// Returned name. internal static string GenerateRunspaceName(out int rtnId) { diff --git a/src/System.Management.Automation/engine/remoting/client/remotingprotocolimplementation.cs b/src/System.Management.Automation/engine/remoting/client/remotingprotocolimplementation.cs index 064c3dee7f0..90543f3933d 100644 --- a/src/System.Management.Automation/engine/remoting/client/remotingprotocolimplementation.cs +++ b/src/System.Management.Automation/engine/remoting/client/remotingprotocolimplementation.cs @@ -749,7 +749,7 @@ public void Dispose() /// /// release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. protected void Dispose(bool disposing) { if (disposing) @@ -768,7 +768,7 @@ protected void Dispose(bool disposing) /// /// Send the specified local public key to the remote end /// - /// local public key as a string + /// local public key as a string. internal override void SendPublicKeyAsync(string localPublicKey) { _transportManager.DataToBeSentCollection.Add( @@ -779,7 +779,7 @@ internal override void SendPublicKeyAsync(string localPublicKey) /// /// Raise the public key received event /// - /// received data + /// received data. /// This method is a hook to be called /// from the transport manager internal override void RaiseKeyExchangeMessageReceived(RemoteDataObject receivedData) diff --git a/src/System.Management.Automation/engine/remoting/commands/ConnectPSSession.cs b/src/System.Management.Automation/engine/remoting/commands/ConnectPSSession.cs index d1783d7ba32..a3f7b74ed89 100644 --- a/src/System.Management.Automation/engine/remoting/commands/ConnectPSSession.cs +++ b/src/System.Management.Automation/engine/remoting/commands/ConnectPSSession.cs @@ -787,7 +787,7 @@ private Collection QueryForDisconnectedSessions() /// /// Creates a collection of PSSession objects based on cmdlet parameters. /// - /// OverrideParameter + /// OverrideParameter. /// Collection of PSSession objects in disconnected state. private Collection CollectDisconnectedSessions(OverrideParameter overrideParam = OverrideParameter.None) { @@ -909,8 +909,8 @@ private void ConnectSessions(Collection psSessions) /// /// Handles the connect throttling complete event from the ThrottleManager. /// - /// Sender - /// EventArgs + /// Sender. + /// EventArgs. private void HandleThrottleConnectComplete(object sender, EventArgs eventArgs) { _operationsComplete.Set(); diff --git a/src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs b/src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs index e90b7c622cc..c251dc72a36 100644 --- a/src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs +++ b/src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs @@ -1419,7 +1419,7 @@ internal static void ThrowIfNotAdministrator() /// /// Creates a Grouped Managed Service Account credential based on the passed in account name /// - /// Group Managed Service Account name + /// Group Managed Service Account name. /// PSCredential for GMS account. /// /// Invalid account name. Must be of form 'Domain\UserName'. diff --git a/src/System.Management.Automation/engine/remoting/commands/DisconnectPSSession.cs b/src/System.Management.Automation/engine/remoting/commands/DisconnectPSSession.cs index ff4771e5c4c..39db9fd0c11 100644 --- a/src/System.Management.Automation/engine/remoting/commands/DisconnectPSSession.cs +++ b/src/System.Management.Automation/engine/remoting/commands/DisconnectPSSession.cs @@ -333,8 +333,8 @@ protected override void StopProcessing() /// /// Handles the connect throttling complete event from the ThrottleManager. /// - /// Sender - /// EventArgs + /// Sender. + /// EventArgs. private void HandleThrottleDisconnectComplete(object sender, EventArgs eventArgs) { _stream.ObjectWriter.Close(); diff --git a/src/System.Management.Automation/engine/remoting/commands/EnterPSHostProcessCommand.cs b/src/System.Management.Automation/engine/remoting/commands/EnterPSHostProcessCommand.cs index a95a6e95897..2624baeac89 100644 --- a/src/System.Management.Automation/engine/remoting/commands/EnterPSHostProcessCommand.cs +++ b/src/System.Management.Automation/engine/remoting/commands/EnterPSHostProcessCommand.cs @@ -526,7 +526,7 @@ private int[] GetProcIdsFromNames(string[] names) /// PowerShell pipe name example: /// PSHost.130566795082911445.8224.DefaultAppDomain.powershell /// - /// Process Ids or null + /// Process Ids or null. /// Collection of process AppDomain info. internal static IReadOnlyCollection GetAppDomainNamesFromProcessId(int[] procIds) { @@ -692,9 +692,9 @@ private PSHostProcessInfo() { } /// /// Constructor /// - /// Name of process - /// Id of process - /// Name of process AppDomain + /// Name of process. + /// Id of process. + /// Name of process AppDomain. internal PSHostProcessInfo(string processName, int processId, string appDomainName) { if (string.IsNullOrEmpty(processName)) { throw new PSArgumentNullException("processName"); } diff --git a/src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs b/src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs index fd21505b8d0..04fe8d08763 100644 --- a/src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs +++ b/src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs @@ -1606,7 +1606,7 @@ private List GetDisconnectedSessions(PSInvokeExpressionSyncJob job) /// /// Writes an input value to the pipeline /// - /// input value to write + /// input value to write. private void WriteInput(object inputValue) { // when there are no input writers, there is no @@ -1647,7 +1647,7 @@ private void WriteInput(object inputValue) /// /// Writes the results in the job object /// - /// Write in a non-blocking manner + /// Write in a non-blocking manner. private void WriteJobResults(bool nonblocking) { if (_job == null) @@ -1869,7 +1869,7 @@ private void StopProgressBar( /// /// Writes the stream objects in the specified collection /// - /// collection to read from + /// collection to read from. private void WriteStreamObjectsFromCollection(IEnumerable results) { foreach (var result in results) @@ -1938,7 +1938,7 @@ private void DetermineThrowStatementBehavior() /// /// Process the stream object before writing it in the specified collection. /// - /// stream object to process + /// stream object to process. private void PreProcessStreamObject(PSStreamObject streamObject) { ErrorRecord errorRecord = streamObject.Value as ErrorRecord; @@ -2015,7 +2015,7 @@ public void Dispose() /// /// internal dispose method which does the actual disposing /// - /// whether called from dispose or finalize + /// whether called from dispose or finalize. private void Dispose(bool disposing) { if (disposing) diff --git a/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs b/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs index e0ad7d64d3d..3592b83e500 100644 --- a/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs +++ b/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs @@ -16,7 +16,7 @@ public abstract class Repository where T : class /// /// Add an item to the repository /// - /// object to add + /// object to add. public void Add(T item) { if (item == null) @@ -42,7 +42,7 @@ public void Add(T item) /// /// Remove the specified item from the repository /// - /// object to remove + /// object to remove. public void Remove(T item) { if (item == null) @@ -79,7 +79,7 @@ public List GetItems() /// /// Get a key for the specified item /// - /// item for which the key is required + /// item for which the key is required. /// Returns a key. protected abstract Guid GetKey(T item); @@ -178,7 +178,7 @@ internal JobRepository() : base("job") /// /// Returns the instance id of the job as key /// - /// job for which a key is required + /// job for which a key is required. /// Returns jobs guid. protected override Guid GetKey(Job item) { diff --git a/src/System.Management.Automation/engine/remoting/commands/NewPSSessionConfigurationFile.cs b/src/System.Management.Automation/engine/remoting/commands/NewPSSessionConfigurationFile.cs index 1530d932b93..cb135424ba3 100644 --- a/src/System.Management.Automation/engine/remoting/commands/NewPSSessionConfigurationFile.cs +++ b/src/System.Management.Automation/engine/remoting/commands/NewPSSessionConfigurationFile.cs @@ -1879,7 +1879,7 @@ internal static string ConfigFragment(string key, string resourceString, string /// /// Return a single-quoted string. Any embedded single quotes will be doubled. /// - /// The string to quote + /// The string to quote. /// The quoted string. internal static string QuoteName(object name) { @@ -1891,7 +1891,7 @@ internal static string QuoteName(object name) /// /// Return a script block string wrapped in curly braces. /// - /// The string to wrap + /// The string to wrap. /// The wrapped string. internal static string WrapScriptBlock(object sb) { @@ -2079,7 +2079,7 @@ internal static string CombineHashtableArray(IDictionary[] tables, StreamWriter /// /// Combines an array of strings into a single string block /// - /// string values + /// string values. /// String block. internal static string CombineStringArray(string[] values) { diff --git a/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs b/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs index 1c4826dd340..27c46dde0d2 100644 --- a/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs +++ b/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs @@ -58,8 +58,8 @@ internal void WriteStreamObject(Action action) /// Resolve all the machine names provided. Basically, if a machine /// name is '.' assume localhost /// - /// array of computer names to resolve - /// resolved array of machine names + /// array of computer names to resolve. + /// resolved array of machine names. protected void ResolveComputerNames(string[] computerNames, out string[] resolvedComputerNames) { if (computerNames == null) @@ -87,7 +87,7 @@ protected void ResolveComputerNames(string[] computerNames, out string[] resolve /// Resolves a computer name. If its null or empty /// its assumed to be localhost /// - /// computer name to resolve + /// computer name to resolve. /// Resolved computer name. protected string ResolveComputerName(string computerName) { @@ -246,7 +246,7 @@ protected string ResolveShell(string shell) /// 2. DEFAULTREMOTEAPPNAME variable set /// 3. WSMan /// - /// application name to resolve + /// application name to resolve. /// Resolved appname. protected string ResolveAppName(string appName) { @@ -850,10 +850,10 @@ internal static void ValidateSpecifiedAuthentication(PSCredential credential, st /// Parse a hostname used with SSH Transport to get embedded /// username and/or port. /// - /// host name to parse - /// resolved target host - /// resolved target user name - /// resolved target port + /// host name to parse. + /// resolved target host. + /// resolved target user name. + /// resolved target port. protected void ParseSshHostName(string hostname, out string host, out string userName, out int port) { host = hostname; @@ -1055,7 +1055,7 @@ protected void ValidateComputerName(string[] computerNames) /// /// Validates parameter value and returns as string /// - /// Parameter value to be validated + /// Parameter value to be validated. /// Parameter value as string. private static string GetSSHConnectionStringParameter(object param) { @@ -1070,7 +1070,7 @@ private static string GetSSHConnectionStringParameter(object param) /// /// Validates parameter value and returns as integer /// - /// Parameter value to be validated + /// Parameter value to be validated. /// Parameter value as integer. private static int GetSSHConnectionIntParameter(object param) { @@ -1825,7 +1825,7 @@ protected virtual void CreateHelpersForSpecifiedContainerSession() /// /// Creates a pipeline from the powershell /// - /// runspace on which to create the pipeline + /// runspace on which to create the pipeline. /// A pipeline. internal Pipeline CreatePipeline(RemoteRunspace remoteRunspace) { @@ -1935,7 +1935,7 @@ protected void CloseAllInputStreams() /// /// exception which is causing this error record /// to be written - /// Uri which caused this exception + /// Uri which caused this exception. private void WriteErrorCreateRemoteRunspaceFailed(Exception e, Uri uri) { Dbg.Assert(e is UriFormatException || e is InvalidOperationException || @@ -2927,10 +2927,10 @@ private Dictionary GetMatchingRunspacesBySessionId(bool writeob /// /// Gets the matching runspaces by vm name or container id with optional session name /// - /// if true write the object down the pipeline + /// if true write the object down the pipeline. /// Runspace state filter value. /// Runspace configuration name filter value. - /// if true the target is a container instead of virtual machine + /// if true the target is a container instead of virtual machine. /// List of matching runspaces. private Dictionary GetMatchingRunspacesByVMNameContainerId(bool writeobject, SessionFilterState filterState, @@ -2995,10 +2995,10 @@ private Dictionary GetMatchingRunspacesByVMNameContainerId(bool /// /// Gets the matching runspaces by vm name or container id with session instanceid /// - /// if true write the object down the pipeline + /// if true write the object down the pipeline. /// Runspace state filter value. /// Runspace configuration name filter value. - /// if true the target is a container instead of virtual machine + /// if true the target is a container instead of virtual machine. /// List of matching runspaces. private Dictionary GetMatchingRunspacesByVMNameContainerIdSessionInstanceId(bool writeobject, SessionFilterState filterState, @@ -3053,7 +3053,7 @@ private Dictionary GetMatchingRunspacesByVMNameContainerIdSessi /// /// Gets the matching runspaces by vm guid and optional session name /// - /// if true write the object down the pipeline + /// if true write the object down the pipeline. /// Runspace state filter value. /// Runspace configuration name filter value. /// List of matching runspaces. @@ -3098,7 +3098,7 @@ private Dictionary GetMatchingRunspacesByVMId(bool writeobject, /// /// Gets the matching runspaces by vm guid and session instanceid /// - /// if true write the object down the pipeline + /// if true write the object down the pipeline. /// Runspace state filter value. /// Runspace configuration name filter value. /// List of matching runspaces. @@ -3133,9 +3133,9 @@ private Dictionary GetMatchingRunspacesByVMIdSessionInstanceId( /// /// Write the matching runspace objects down the pipeline, or add to the list. /// - /// The matching runspaces - /// if true write the object down the pipeline. Otherwise, add to the list - /// The list we add the matching runspaces to + /// The matching runspaces. + /// if true write the object down the pipeline. Otherwise, add to the list. + /// The list we add the matching runspaces to. private void WriteOrAddMatches(List matchingRunspaceInfos, bool writeobject, ref Dictionary matches) @@ -3300,7 +3300,7 @@ internal class ExecutionCmdletHelperRunspace : ExecutionCmdletHelper /// /// Internal constructor /// - /// pipeline object associated with this operation + /// pipeline object associated with this operation. internal ExecutionCmdletHelperRunspace(Pipeline pipeline) { this.pipeline = pipeline; @@ -3373,7 +3373,7 @@ internal override void StopOperation() /// StartOperation and StopOperation. Here nothing more is done excepting raising /// the OperationComplete event appropriately which will be handled by the cmdlet /// - /// source of this event + /// source of this event. /// object describing state information about the /// pipeline private void HandlePipelineStateChanged(object sender, PipelineStateEventArgs stateEventArgs) @@ -3463,7 +3463,7 @@ internal class ExecutionCmdletHelperComputerName : ExecutionCmdletHelper /// /// RemoteRunspace that is associated /// with this operation - /// pipeline created from the remote runspace + /// pipeline created from the remote runspace. /// Indicates if pipeline should be disconnected after invoking command. internal ExecutionCmdletHelperComputerName(RemoteRunspace remoteRunspace, Pipeline pipeline, bool invokeAndDisconnect = false) { @@ -3536,8 +3536,8 @@ internal override void StopOperation() /// /// Handles the state changed event for runspace operations /// - /// sender of this information - /// object describing this event + /// sender of this information. + /// object describing this event. private void HandleRunspaceStateChanged(object sender, RunspaceStateEventArgs stateEventArgs) { @@ -3607,8 +3607,8 @@ private void HandleRunspaceStateChanged(object sender, /// /// Handles the state changed event for the pipeline. /// - /// sender of this information - /// object describing this event + /// sender of this information. + /// object describing this event. private void HandlePipelineStateChanged(object sender, PipelineStateEventArgs stateEventArgs) { @@ -3684,12 +3684,12 @@ internal static class PathResolver /// Resolves the specified path and verifies the path belongs to /// FileSystemProvider. /// - /// Path to resolve + /// Path to resolve. /// True if wildcard expansion should be suppressed for this path. /// reference to calling cmdlet. This will be used for /// for writing errors /// - /// resource string for error when path is not from filesystem provider + /// resource string for error when path is not from filesystem provider. /// A fully qualified string representing filename. internal static string ResolveProviderAndPath(string path, bool isLiteralPath, PSCmdlet cmdlet, bool allowNonexistingPaths, string resourceString) { @@ -4054,8 +4054,8 @@ private static bool UseExistingRunspace( /// Returns Exception message. If message is WSMan Xml then /// the WSMan message and error code is extracted and returned. /// - /// Exception - /// Returned WSMan error code + /// Exception. + /// Returned WSMan error code. /// WSMan message. internal static string ExtractMessage( Exception e, diff --git a/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs b/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs index 31f54a81869..17bb5739946 100644 --- a/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs +++ b/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs @@ -918,7 +918,7 @@ private void WriteReasonError(Job job) /// /// Returns all the results from supplied PSDataCollection. /// - /// data collection to read from + /// data collection to read from. /// Collection with copy of data. private Collection ReadAll(PSDataCollection psDataCollection) { @@ -942,8 +942,8 @@ private Collection ReadAll(PSDataCollection psDataCollection) /// Write the results from this Job object. It also writes the /// results from its child objects recursively. /// - /// Hashtable used for duplicate detection - /// Job whose results are written + /// Hashtable used for duplicate detection. + /// Job whose results are written. /// private void WriteJobResultsRecursivelyHelper(Hashtable duplicate, Job job, bool registerInsteadOfWrite) { @@ -985,7 +985,7 @@ private void WriteJobResultsRecursivelyHelper(Hashtable duplicate, Job job, bool /// /// Writes the job objects if required by the cmdlet /// - /// collection of jobs to write + /// collection of jobs to write. /// this method is intended to be called only from /// ProcessRecord. When any changes are made ensure that this /// contract is not broken @@ -1448,7 +1448,7 @@ private void AddRemoveErrorToResults(Job job, Exception ex) /// Write the results from this Job object. It also writes the /// results from its child objects recursively. /// - /// Job whose results are written + /// Job whose results are written. /// private void WriteJobResultsRecursively(Job job, bool registerInsteadOfWrite) { diff --git a/src/System.Management.Automation/engine/remoting/commands/ReceivePSSession.cs b/src/System.Management.Automation/engine/remoting/commands/ReceivePSSession.cs index f4685b3abf8..c712c5e8270 100644 --- a/src/System.Management.Automation/engine/remoting/commands/ReceivePSSession.cs +++ b/src/System.Management.Automation/engine/remoting/commands/ReceivePSSession.cs @@ -1024,8 +1024,8 @@ private void ConnectSessionToHost(PSSession session, PSRemotingJob job = null) /// Helper method to append computer name and session GUID /// note properties to the PSObject before it is written. /// - /// PSObject - /// PSSession + /// PSObject. + /// PSSession. private void WriteRemoteObject( PSObject psObject, PSSession session) @@ -1152,8 +1152,8 @@ private PSSession ConnectSession(PSSession session, out Exception ex) /// Helper method to attempt to retrieve a disconnected runspace object /// from the server, based on the provided session object. /// - /// PSSession - /// PSSession. + /// PSSession session object. + /// PSSession disconnected runspace object. private PSSession TryGetSessionFromServer(PSSession session) { RemoteRunspace remoteRunspace = session.Runspace as RemoteRunspace; diff --git a/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs b/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs index 6e9829ce9a0..e1a47871682 100644 --- a/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs +++ b/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs @@ -46,10 +46,10 @@ public class JobCmdletBase : PSRemotingCmdlet /// Find the jobs in repository which match matching the specified names /// /// if true, method writes the object instead of returning it - /// in list (an empty list is returned). - /// write error if no match is found - /// check if this job can be removed - /// recurse and check in child jobs + /// in list (an empty list is returned). + /// write error if no match is found. + /// check if this job can be removed. + /// recurse and check in child jobs. /// List of matching jobs. internal List FindJobsMatchingByName( bool recurse, @@ -179,10 +179,10 @@ private bool FindJobsMatchingByNameHelper(List matches, IList jobsToSe /// Find the jobs in repository which match the specified instanceid /// /// if true, method writes the object instead of returning it - /// in list (an empty list is returned). - /// write error if no match is found - /// check if this job can be removed - /// look in all child jobs + /// in list (an empty list is returned). + /// write error if no match is found. + /// check if this job can be removed. + /// look in all child jobs. /// List of matching jobs. internal List FindJobsMatchingByInstanceId(bool recurse, bool writeobject, bool writeErrorOnNoMatch, bool checkIfJobCanBeRemoved) { @@ -296,10 +296,10 @@ private bool FindJobsMatchingByInstanceIdHelper(List matches, IList jo /// Find the jobs in repository which match the specified session ids /// /// if true, method writes the object instead of returning it - /// in list (an empty list is returned). - /// write error if no match is found - /// check if this job can be removed - /// look in child jobs as well + /// in list (an empty list is returned). + /// write error if no match is found. + /// check if this job can be removed. + /// look in child jobs as well. /// List of matching jobs. internal List FindJobsMatchingBySessionId(bool recurse, bool writeobject, bool writeErrorOnNoMatch, bool checkIfJobCanBeRemoved) { @@ -400,7 +400,7 @@ private bool FindJobsMatchingBySessionIdHelper(List matches, IList job /// Find the jobs in repository which match the specified command /// /// if true, method writes the object instead of returning it - /// in list (an empty list is returned). + /// in list (an empty list is returned). /// List of matching jobs. internal List FindJobsMatchingByCommand( bool writeobject) @@ -453,7 +453,7 @@ internal List FindJobsMatchingByCommand( /// Find the jobs in repository which match the specified state /// /// if true, method writes the object instead of returning it - /// in list (an empty list is returned). + /// in list (an empty list is returned). /// List of matching jobs. internal List FindJobsMatchingByState( bool writeobject) @@ -551,8 +551,8 @@ private bool FindJobsMatchingByFilterHelper(List matches, List jobsToS /// /// /// if true, method writes the object instead of returning it - /// in list (an empty list is returned). - /// if true, only jobs which can be removed will be checked + /// in list (an empty list is returned). + /// if true, only jobs which can be removed will be checked. /// internal List CopyJobsToList(Job[] jobs, bool writeobject, bool checkIfJobCanBeRemoved) { @@ -580,11 +580,11 @@ internal List CopyJobsToList(Job[] jobs, bool writeobject, bool checkIfJobC /// /// Checks that this job object can be removed. If not, writes an error record. /// - /// Job object to be removed + /// Job object to be removed. /// Name of the parameter which is associated with this job object. /// - /// Resource String in case of error - /// Parameters for resource message + /// Resource String in case of error. + /// Parameters for resource message. /// True if object should be removed, else false. private bool CheckJobCanBeRemoved(Job job, string parameterName, string resourceString, params object[] list) { diff --git a/src/System.Management.Automation/engine/remoting/commands/StartJob.cs b/src/System.Management.Automation/engine/remoting/commands/StartJob.cs index 5d62484d5e0..92a5548e72b 100644 --- a/src/System.Management.Automation/engine/remoting/commands/StartJob.cs +++ b/src/System.Management.Automation/engine/remoting/commands/StartJob.cs @@ -733,7 +733,7 @@ public void Dispose() /// /// internal dispose method which does the actual disposing /// - /// whether called from dispose or finalize + /// whether called from dispose or finalize. private void Dispose(bool disposing) { if (disposing) diff --git a/src/System.Management.Automation/engine/remoting/commands/newrunspacecommand.cs b/src/System.Management.Automation/engine/remoting/commands/newrunspacecommand.cs index 018fcee6e80..659b5b9f3af 100644 --- a/src/System.Management.Automation/engine/remoting/commands/newrunspacecommand.cs +++ b/src/System.Management.Automation/engine/remoting/commands/newrunspacecommand.cs @@ -395,7 +395,7 @@ private void HandleURIDirectionReported(object sender, RemoteDataEventArgs /// /// Handles state changes for Runspace /// - /// Sender of this event + /// Sender of this event. /// Event information object which describes /// the event which triggered this method private void HandleRunspaceStateChanged(object sender, OperationStateEventArgs stateEventArgs) @@ -1199,7 +1199,7 @@ protected void Dispose(bool disposing) /// /// Handles the throttling complete event of the throttle manager /// - /// sender of this event + /// sender of this event. /// private void HandleThrottleComplete(object sender, EventArgs eventArgs) { @@ -1215,7 +1215,7 @@ private void HandleThrottleComplete(object sender, EventArgs eventArgs) /// /// exception which is causing this error record /// to be written - /// Uri which caused this exception + /// Uri which caused this exception. private void WriteErrorCreateRemoteRunspaceFailed(Exception e, Uri uri) { Dbg.Assert(e is UriFormatException || e is InvalidOperationException || @@ -1378,7 +1378,7 @@ internal override event EventHandler OperationComplete /// an exception since this prevents other event handlers in the chain from /// being called. /// - /// Source of this event + /// Source of this event. /// object describing state information of the /// runspace private void HandleRunspaceStateChanged(object source, RunspaceStateEventArgs stateEventArgs) diff --git a/src/System.Management.Automation/engine/remoting/common/RemoteSessionHyperVSocket.cs b/src/System.Management.Automation/engine/remoting/common/RemoteSessionHyperVSocket.cs index 1de23dd4056..7c030dfb860 100644 --- a/src/System.Management.Automation/engine/remoting/common/RemoteSessionHyperVSocket.cs +++ b/src/System.Management.Automation/engine/remoting/common/RemoteSessionHyperVSocket.cs @@ -486,9 +486,9 @@ public void Dispose() /// Connect to Hyper-V socket server. This is a blocking call until a /// connection occurs or the timeout time has elapsed. /// - /// The credential used for authentication - /// The configuration name of the PS session - /// Whether this is the first connection + /// The credential used for authentication. + /// The configuration name of the PS session. + /// Whether this is the first connection. public bool Connect( NetworkCredential networkCredential, string configurationName, diff --git a/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs b/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs index 41e53b4bbd0..b7a3176cc58 100644 --- a/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs +++ b/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs @@ -46,7 +46,7 @@ internal static class NamedPipeUtils /// Create a pipe name based on process information. /// E.g., "PSHost.ProcessStartTime.ProcessId.DefaultAppDomain.ProcessName" /// - /// Process Id + /// Process Id. /// Pipe name. internal static string CreateProcessPipeName( int procId) @@ -59,7 +59,7 @@ internal static string CreateProcessPipeName( /// Create a pipe name based on process information. /// E.g., "PSHost.ProcessStartTime.ProcessId.DefaultAppDomain.ProcessName" /// - /// Process object + /// Process object. /// Pipe name. internal static string CreateProcessPipeName( System.Diagnostics.Process proc) @@ -71,7 +71,7 @@ internal static string CreateProcessPipeName( /// Create a pipe name based on process Id and appdomain name information. /// E.g., "PSHost.ProcessStartTime.ProcessId.DefaultAppDomain.ProcessName" /// - /// Process Id + /// Process Id. /// Name of process app domain to connect to. /// Pipe name. internal static string CreateProcessPipeName( @@ -85,7 +85,7 @@ internal static string CreateProcessPipeName( /// Create a pipe name based on process and appdomain name information. /// E.g., "PSHost.ProcessStartTime.ProcessId.DefaultAppDomain.ProcessName" /// - /// Process object + /// Process object. /// Name of process app domain to connect to. /// Pipe name. internal static string CreateProcessPipeName( @@ -324,8 +324,8 @@ private ListenerEndedEventArgs() { } /// /// Constructor. /// - /// Listener end reason - /// Restart listener + /// Listener end reason. + /// Restart listener. public ListenerEndedEventArgs( Exception reason, bool restartListener) @@ -440,7 +440,7 @@ public static RemoteSessionNamedPipeServer CreateRemoteSessionNamedPipeServer() /// /// Constructor. Creates named pipe server with provided pipe name. /// - /// Named Pipe name + /// Named Pipe name. internal RemoteSessionNamedPipeServer( string pipeName) { @@ -683,7 +683,7 @@ private void WaitForConnection() /// /// Process listening thread. /// - /// client callback delegate + /// client callback delegate. [SuppressMessage("Microsoft.Reliability", "CA2001:AvoidCallingProblematicMethods", MessageId = "System.Runtime.InteropServices.SafeHandle.DangerousGetHandle")] private void ProcessListeningThread(object state) { @@ -828,7 +828,7 @@ private void ProcessListeningThread(object state) /// This method supports PowerShell running in "NamedPipeServerMode", which is used for /// PowerShell Direct Windows Server Container connection and management. /// - /// name of the configuration to use + /// name of the configuration to use. internal static void RunServerMode(string configurationName) { IPCNamedPipeServerEnabled = true; @@ -1017,7 +1017,7 @@ public void Dispose() /// Connect to named pipe server. This is a blocking call until a /// connection occurs or the timeout time has elapsed. /// - /// Connection attempt timeout in milliseconds + /// Connection attempt timeout in milliseconds. public void Connect( int timeout) { @@ -1077,7 +1077,7 @@ private RemoteSessionNamedPipeClient() /// Constructor. Creates Named Pipe based on process object. /// /// Target process object for pipe. - /// AppDomain name or null for default AppDomain + /// AppDomain name or null for default AppDomain. public RemoteSessionNamedPipeClient( System.Diagnostics.Process process, string appDomainName) : this(NamedPipeUtils.CreateProcessPipeName(process, appDomainName)) @@ -1087,7 +1087,7 @@ public RemoteSessionNamedPipeClient( /// Constructor. Creates Named Pipe based on process Id. /// /// Target process Id for pipe. - /// AppDomain name or null for default AppDomain + /// AppDomain name or null for default AppDomain. public RemoteSessionNamedPipeClient( int procId, string appDomainName) : this(NamedPipeUtils.CreateProcessPipeName(procId, appDomainName)) @@ -1096,7 +1096,7 @@ public RemoteSessionNamedPipeClient( /// /// Constructor. Creates Named Pipe based on name argument. /// - /// Named Pipe name + /// Named Pipe name. internal RemoteSessionNamedPipeClient( string pipeName) { @@ -1199,7 +1199,7 @@ internal sealed class ContainerSessionNamedPipeClient : NamedPipeClientBase /// Constructor. Creates Named Pipe based on process Id, app domain name and container object root path. /// /// Target process Id for pipe. - /// AppDomain name or null for default AppDomain + /// AppDomain name or null for default AppDomain. /// Container OB root. public ContainerSessionNamedPipeClient( int procId, diff --git a/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs b/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs index 2c3a1e39fca..8e377086bac 100644 --- a/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs +++ b/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs @@ -340,9 +340,9 @@ internal int TimeSpanToTimeOutMs(TimeSpan t) /// /// Creates the appropriate client session transportmanager. /// - /// Runspace/Pool instance Id - /// Session name - /// PSRemotingCryptoHelper + /// Runspace/Pool instance Id. + /// Session name. + /// PSRemotingCryptoHelper. internal virtual BaseClientSessionTransportManager CreateClientSessionTransportManager( Guid instanceId, string sessionName, @@ -363,7 +363,7 @@ internal virtual RunspaceConnectionInfo InternalCopy() /// /// Validates port number is in range /// - /// Port number to validate + /// Port number to validate. internal virtual void ValidatePortInRange(int port) { if ((port < MinPort || port > MaxPort)) @@ -804,10 +804,10 @@ public PSCredential ProxyCredential /// /// Constructor used to create a WSManConnectionInfo /// - /// computer to connect to - /// scheme to be used for connection - /// port to connect to - /// application end point to connect to + /// computer to connect to. + /// scheme to be used for connection. + /// port to connect to. + /// application end point to connect to. /// remote shell to launch /// on connection /// credential to be used @@ -831,10 +831,10 @@ public WSManConnectionInfo(string scheme, string computerName, int port, string /// /// Constructor used to create a WSManConnectionInfo /// - /// computer to connect to + /// computer to connect to. /// Scheme to be used for connection. - /// port to connect to - /// application end point to connect to + /// port to connect to. + /// application end point to connect to. /// remote shell to launch /// on connection /// credential to be used @@ -899,7 +899,7 @@ public WSManConnectionInfo() /// and explicit credentials - server life time is /// default and open timeout is default /// - /// uri of remote runspace + /// uri of remote runspace. /// /// credentials to use to /// connect to the remote runspace @@ -948,7 +948,7 @@ public WSManConnectionInfo(Uri uri, string shellUri, PSCredential credential) /// Constructor used to create a WSManConnectionInfo. This constructor supports a certificate thumbprint to /// be used while connecting to a remote machine instead of credential. /// - /// uri of remote runspace + /// uri of remote runspace. /// /// /// A thumb print of the certificate to use while connecting to the remote machine. @@ -966,7 +966,7 @@ public WSManConnectionInfo(Uri uri, string shellUri, string certificateThumbprin /// default server life time and default open /// timeout /// - /// uri of remote runspace + /// uri of remote runspace. /// When an /// uri representing an invalid path is specified public WSManConnectionInfo(Uri uri) @@ -1510,7 +1510,7 @@ internal void SetDisconnectedExpiresOnToNow() /// /// Constructor that constructs the configuration name from its type /// - /// type of configuration to construct + /// type of configuration to construct. public WSManConnectionInfo(PSSessionType configurationType) : this() { ComputerName = string.Empty; @@ -1746,7 +1746,7 @@ public NamedPipeConnectionInfo( /// /// Constructor /// - /// Process Id to connect to + /// Process Id to connect to. /// Application domain name to connect to, or default AppDomain if blank. public NamedPipeConnectionInfo( int processId, @@ -1757,9 +1757,9 @@ public NamedPipeConnectionInfo( /// /// Constructor /// - /// Process Id to connect to + /// Process Id to connect to. /// Name of application domain to connect to. Connection is to default application domain if blank. - /// Open time out in Milliseconds + /// Open time out in Milliseconds. public NamedPipeConnectionInfo( int processId, string appDomainName, @@ -1915,9 +1915,9 @@ private SSHConnectionInfo() /// /// Constructor /// - /// User Name - /// Computer Name - /// Key File Path + /// User Name. + /// Computer Name. + /// Key File Path. public SSHConnectionInfo( string userName, string computerName, @@ -1935,10 +1935,10 @@ public SSHConnectionInfo( /// /// Constructor /// - /// User Name - /// Computer Name - /// Key File Path - /// Port number for connection (default 22) + /// User Name. + /// Computer Name. + /// Key File Path. + /// Port number for connection (default 22). public SSHConnectionInfo( string userName, string computerName, @@ -1953,11 +1953,11 @@ public SSHConnectionInfo( /// /// Constructor /// - /// User Name - /// Computer Name - /// Key File Path - /// Port number for connection (default 22) - /// Subsystem to use (default 'powershell') + /// User Name. + /// Computer Name. + /// Key File Path. + /// Port number for connection (default 22). + /// Subsystem to use (default 'powershell'). public SSHConnectionInfo( string userName, string computerName, @@ -2271,7 +2271,7 @@ private static FileStream OpenStream(int fd, FileAccess access) } /// Copies environment variables from ProcessStartInfo - /// ProcessStartInfo + /// ProcessStartInfo. /// String array of environment key/value pairs. private static string[] CopyEnvVariables(ProcessStartInfo psi) { diff --git a/src/System.Management.Automation/engine/remoting/common/RunspacePoolStateInfo.cs b/src/System.Management.Automation/engine/remoting/common/RunspacePoolStateInfo.cs index 69314b706bf..20d99321165 100644 --- a/src/System.Management.Automation/engine/remoting/common/RunspacePoolStateInfo.cs +++ b/src/System.Management.Automation/engine/remoting/common/RunspacePoolStateInfo.cs @@ -29,7 +29,7 @@ public sealed class RunspacePoolStateInfo /// /// Constructor for creating the state info /// - /// state + /// state. /// exception that resulted in this /// state change. Can be null public RunspacePoolStateInfo(RunspacePoolState state, Exception reason) @@ -38,4 +38,4 @@ public RunspacePoolStateInfo(RunspacePoolState state, Exception reason) Reason = reason; } } -} \ No newline at end of file +} 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 8f6b9001429..f84cdd2ac26 100644 --- a/src/System.Management.Automation/engine/remoting/common/WireDataFormat/EncodeAndDecode.cs +++ b/src/System.Management.Automation/engine/remoting/common/WireDataFormat/EncodeAndDecode.cs @@ -637,12 +637,12 @@ private static PSNoteProperty CreateHostInfoProperty(HostInfo hostInfo) /// This method generates a Remoting data structure handler message for /// creating a RunspacePool on the server /// - /// id of the clientRunspacePool + /// id of the clientRunspacePool. /// minRunspaces for the RunspacePool /// to be created at the server /// maxRunspaces for the RunspacePool /// to be created at the server - /// local runspace pool + /// local runspace pool. /// host for the runspacepool at the client end /// from this host, information will be extracted and sent to /// server @@ -699,7 +699,7 @@ internal static RemoteDataObject GenerateCreateRunspacePool( /// This method generates a Remoting data structure handler message for /// creating a RunspacePool on the server /// - /// id of the clientRunspacePool + /// id of the clientRunspacePool. /// minRunspaces for the RunspacePool /// to be created at the server /// maxRunspaces for the RunspacePool @@ -756,7 +756,7 @@ internal static RemoteDataObject GenerateConnectRunspacePool( /// Generates a response message to ConnectRunspace that includes /// sufficient information to construction client RunspacePool state /// - /// id of the clientRunspacePool + /// id of the clientRunspacePool. /// minRunspaces for the RunspacePool /// to be created at the server /// maxRunspaces for the RunspacePool @@ -791,10 +791,10 @@ internal static RemoteDataObject GenerateRunspacePoolInitData( /// This method generates a Remoting data structure handler message for /// modifying the maxrunspaces of the specified runspace pool on the server /// - /// id of the clientRunspacePool + /// id of the clientRunspacePool. /// new value of maxRunspaces for the /// specified RunspacePool - /// call id of the call at client + /// call id of the call at client. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- @@ -822,10 +822,10 @@ internal static RemoteDataObject GenerateSetMaxRunspaces(Guid clientRunspacePool /// This method generates a Remoting data structure handler message for /// modifying the maxrunspaces of the specified runspace pool on the server /// - /// id of the clientRunspacePool + /// id of the clientRunspacePool. /// new value of minRunspaces for the /// specified RunspacePool - /// call id of the call at client + /// call id of the call at client. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- @@ -853,9 +853,9 @@ internal static RemoteDataObject GenerateSetMinRunspaces(Guid clientRunspacePool /// This method generates a Remoting data structure handler message for /// that contains a response to SetMaxRunspaces or SetMinRunspaces /// - /// id of the clientRunspacePool - /// call id of the call at client - /// response to the call + /// id of the clientRunspacePool. + /// call id of the call at client. + /// response to the call. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- @@ -885,7 +885,7 @@ internal static RemoteDataObject GenerateRunspacePoolOperationResponse(Guid clie /// /// guid of the runspace pool on which /// this needs to be queried - /// call id of the call at the client + /// call id of the call at the client. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------- @@ -911,8 +911,8 @@ internal static RemoteDataObject GenerateGetAvailableRunspaces(Guid clientRunspa /// This method generates a remoting data structure handler message for /// transferring a roles public key to the other side /// - /// runspace pool id - /// public key to send across + /// runspace pool id. + /// public key to send across. /// destination that this message is /// targeted to /// Data structure message. @@ -940,7 +940,7 @@ internal static RemoteDataObject GenerateMyPublicKey(Guid runspacePoolId, /// This method generates a remoting data structure handler message for /// requesting a public key from the client to the server /// - /// runspace pool id + /// runspace pool id. /// Data structure message. /// The message format is as under for this message /// -------------------------------------------------------------------------- @@ -962,8 +962,8 @@ internal static RemoteDataObject GeneratePublicKeyRequest(Guid runspacePoolId) /// This method generates a remoting data structure handler message for /// sending an encrypted session key to the client /// - /// runspace pool id - /// encrypted session key + /// runspace pool id. + /// encrypted session key. /// Data structure message. /// The message format is as under for this message /// -------------------------------------------------------------------------- @@ -1152,8 +1152,8 @@ internal static RemoteDataObject GenerateCreatePowerShell(ClientRemotePowerShell /// This method creates a remoting data structure handler message for transporting /// application private data from server to client /// - /// id of the client RunspacePool - /// application private data + /// id of the client RunspacePool. + /// application private data. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- @@ -1181,8 +1181,8 @@ internal static RemoteDataObject GenerateApplicationPrivateData( /// This method creates a remoting data structure handler message for transporting a state /// information from server to client /// - /// id of the client RunspacePool - /// State information object + /// id of the client RunspacePool. + /// State information object. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- @@ -1225,8 +1225,8 @@ internal static RemoteDataObject GenerateRunspacePoolStateInfo( /// This method creates a remoting data structure handler message for transporting a PowerShell /// event from server to client /// - /// id of the client RunspacePool - /// PowerShell event + /// id of the client RunspacePool. + /// PowerShell event. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- @@ -1260,7 +1260,7 @@ internal static RemoteDataObject GeneratePSEventArgs(Guid clientRunspacePoolId, /// the single runspace on the server. /// /// - /// Caller Id + /// Caller Id. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------------- @@ -1284,7 +1284,7 @@ internal static RemoteDataObject GenerateResetRunspaceState(Guid clientRunspaceP /// /// Returns the PS remoting protocol version associated with the provided /// - /// RunspacePool + /// RunspacePool. /// PS remoting protocol version. internal static Version GetPSRemotingProtocolVersion(RunspacePool rsPool) { @@ -1300,9 +1300,9 @@ internal static Version GetPSRemotingProtocolVersion(RunspacePool rsPool) /// This method creates a remoting data structure handler message for sending a powershell /// input data from the client to the server /// - /// input data to send - /// client runspace pool id - /// client powershell id + /// input data to send. + /// client runspace pool id. + /// client powershell id. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- @@ -1325,8 +1325,8 @@ internal static RemoteDataObject GeneratePowerShellInput(object data, Guid clien /// This method creates a remoting data structure handler message for signalling /// end of input data for powershell /// - /// client runspace pool id - /// client powershell id + /// client runspace pool id. + /// client powershell id. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- @@ -1349,7 +1349,7 @@ internal static RemoteDataObject GeneratePowerShellInputEnd(Guid clientRemoteRun /// This method creates a remoting data structure handler message for transporting a /// powershell output data from server to client /// - /// data to be sent + /// data to be sent. /// id of client powershell /// to which this information need to be delivered /// id of client runspacepool @@ -1377,7 +1377,7 @@ internal static RemoteDataObject GeneratePowerShellOutput(PSObject data, Guid cl /// powershell informational message (debug/verbose/warning/progress)from /// server to client /// - /// data to be sent + /// data to be sent. /// id of client powershell /// to which this information need to be delivered /// id of client runspacepool @@ -1407,7 +1407,7 @@ internal static RemoteDataObject GeneratePowerShellInformational(object data, /// powershell progress message from /// server to client /// - /// progress record to send + /// progress record to send. /// id of client powershell /// to which this information need to be delivered /// id of client runspacepool @@ -1440,7 +1440,7 @@ internal static RemoteDataObject GeneratePowerShellInformational(ProgressRecord /// powershell information stream message from /// server to client /// - /// information record to send + /// information record to send. /// id of client powershell /// to which this information need to be delivered /// id of client runspacepool @@ -1472,7 +1472,7 @@ internal static RemoteDataObject GeneratePowerShellInformational(InformationReco /// This method creates a remoting data structure handler message for transporting a /// powershell error record from server to client /// - /// error record to be sent + /// error record to be sent. /// id of client powershell /// to which this information need to be delivered /// id of client runspacepool @@ -1499,7 +1499,7 @@ internal static RemoteDataObject GeneratePowerShellError(object errorRecord, /// This method creates a remoting data structure handler message for transporting a /// powershell state information from server to client /// - /// state information object + /// state information object. /// id of client powershell /// to which this information need to be delivered /// id of client runspacepool @@ -1575,8 +1575,8 @@ internal static ErrorRecord GetErrorRecordFromException(Exception exception) /// Gets a Note Property for the exception. /// /// - /// ErrorId to use if exception is not of type IContainsErrorRecord - /// ErrorCategory to use if exception is not of type IContainsErrorRecord + /// ErrorId to use if exception is not of type IContainsErrorRecord. + /// ErrorCategory to use if exception is not of type IContainsErrorRecord. /// private static PSNoteProperty GetExceptionProperty(Exception exception, string errorId, ErrorCategory category) { @@ -1595,7 +1595,7 @@ private static PSNoteProperty GetExceptionProperty(Exception exception, string e /// This method creates a remoting data structure handler message for transporting a session /// capability message. Should be used by client. /// - /// RemoteSession capability object to encode + /// RemoteSession capability object to encode. /// /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message @@ -1841,7 +1841,7 @@ internal static IEnumerable> EnumerateHashtable /// decode and obtain the RunspacePool state info from the /// data object specified /// - /// data object to decode + /// data object to decode. /// RunspacePoolStateInfo. internal static RunspacePoolStateInfo GetRunspacePoolStateInfo(PSObject dataAsPSObject) { @@ -1860,7 +1860,7 @@ internal static RunspacePoolStateInfo GetRunspacePoolStateInfo(PSObject dataAsPS /// decode and obtain the application private data from the /// data object specified /// - /// data object to decode + /// data object to decode. /// Application private data. internal static PSPrimitiveDictionary GetApplicationPrivateData(PSObject dataAsPSObject) { @@ -1875,7 +1875,7 @@ internal static PSPrimitiveDictionary GetApplicationPrivateData(PSObject dataAsP /// /// Gets the public key from the encoded message /// - /// data object to decode + /// data object to decode. /// Public key as string. internal static string GetPublicKey(PSObject dataAsPSObject) { @@ -1890,7 +1890,7 @@ internal static string GetPublicKey(PSObject dataAsPSObject) /// /// Gets the encrypted session key from the encoded message /// - /// data object to decode + /// data object to decode. /// Encrypted session key as string. internal static string GetEncryptedSessionKey(PSObject dataAsPSObject) { @@ -1906,7 +1906,7 @@ internal static string GetEncryptedSessionKey(PSObject dataAsPSObject) /// decode and obtain the RunspacePool state info from the /// data object specified /// - /// data object to decode + /// data object to decode. /// RunspacePoolStateInfo. internal static PSEventArgs GetPSEventArgs(PSObject dataAsPSObject) { @@ -1946,7 +1946,7 @@ internal static PSEventArgs GetPSEventArgs(PSObject dataAsPSObject) /// decode and obtain the minimum runspaces to create in the /// runspace pool from the data object specified /// - /// data object to decode + /// data object to decode. /// Minimum runspaces. internal static int GetMinRunspaces(PSObject dataAsPSObject) { @@ -1962,7 +1962,7 @@ internal static int GetMinRunspaces(PSObject dataAsPSObject) /// decode and obtain the maximum runspaces to create in the /// runspace pool from the data object specified /// - /// data object to decode + /// data object to decode. /// Maximum runspaces. internal static int GetMaxRunspaces(PSObject dataAsPSObject) { @@ -1978,7 +1978,7 @@ internal static int GetMaxRunspaces(PSObject dataAsPSObject) /// decode and obtain the thread options for the runspaces in the /// runspace pool from the data object specified /// - /// data object to decode + /// data object to decode. /// Thread options. internal static PSPrimitiveDictionary GetApplicationArguments(PSObject dataAsPSObject) { @@ -1995,7 +1995,7 @@ internal static PSPrimitiveDictionary GetApplicationArguments(PSObject dataAsPSO /// /// Generates RunspacePoolInitInfo object from a received PSObject /// - /// data object to decode + /// data object to decode. /// RunspacePoolInitInfo generated. internal static RunspacePoolInitInfo GetRunspacePoolInitInfo(PSObject dataAsPSObject) { @@ -2014,7 +2014,7 @@ internal static RunspacePoolInitInfo GetRunspacePoolInitInfo(PSObject dataAsPSOb /// decode and obtain the thread options for the runspaces in the /// runspace pool from the data object specified /// - /// data object to decode + /// data object to decode. /// Thread options. internal static PSThreadOptions GetThreadOptions(PSObject dataAsPSObject) { @@ -2030,7 +2030,7 @@ internal static PSThreadOptions GetThreadOptions(PSObject dataAsPSObject) /// decode and obtain the host info for the host /// associated with the runspace pool /// - /// dataAsPSObject object to decode + /// dataAsPSObject object to decode. /// Host information. internal static HostInfo GetHostInfo(PSObject dataAsPSObject) { @@ -2082,7 +2082,7 @@ internal static Exception GetExceptionFromSerializedErrorRecord(object serialize /// /// Gets the output from the message /// - /// object to decode + /// object to decode. /// Output object. /// the current implementation does nothing, /// however this method is there in place as the @@ -2095,7 +2095,7 @@ internal static object GetPowerShellOutput(object data) /// /// Gets the PSInvocationStateInfo from the data /// - /// object to decode + /// object to decode. /// PSInvocationInfo. internal static PSInvocationStateInfo GetPowerShellStateInfo(object data) { @@ -2114,7 +2114,7 @@ internal static PSInvocationStateInfo GetPowerShellStateInfo(object data) /// /// Gets the ErrorRecord from the message /// - /// data to decode + /// data to decode. /// Error record. internal static ErrorRecord GetPowerShellError(object data) { @@ -2200,7 +2200,7 @@ internal static InformationRecord GetPowerShellInformation(object data) /// /// Gets the PowerShell object from the specified data /// - /// data to decode + /// data to decode. /// Deserialized PowerShell object. internal static PowerShell GetPowerShell(object data) { @@ -2217,7 +2217,7 @@ internal static PowerShell GetPowerShell(object data) /// /// Gets the PowerShell object from the specified data /// - /// data to decode + /// data to decode. /// Deserialized PowerShell object. internal static PowerShell GetCommandDiscoveryPipeline(object data) { @@ -2291,7 +2291,7 @@ internal static PowerShell GetCommandDiscoveryPipeline(object data) /// /// Gets the NoInput setting from the specified data /// - /// data to decode + /// data to decode. /// true if there is no pipeline input; false otherwise. internal static bool GetNoInput(object data) { @@ -2308,7 +2308,7 @@ internal static bool GetNoInput(object data) /// /// Gets the AddToHistory setting from the specified data /// - /// data to decode + /// data to decode. /// true if there is addToHistory data; false otherwise. internal static bool GetAddToHistory(object data) { @@ -2325,7 +2325,7 @@ internal static bool GetAddToHistory(object data) /// /// Gets the IsNested setting from the specified data /// - /// data to decode + /// data to decode. /// true if there is IsNested data; false otherwise. internal static bool GetIsNested(object data) { @@ -2365,7 +2365,7 @@ internal static RemoteStreamOptions GetRemoteStreamOptions(object data) /// /// Decodes a RemoteSessionCapability object /// - /// data to decode + /// data to decode. /// RemoteSessionCapability object. internal static RemoteSessionCapability GetSessionCapability(object data) { @@ -2410,7 +2410,7 @@ internal static RemoteSessionCapability GetSessionCapability(object data) /// /// Checks if the server supports batch invocation /// - /// runspace instance + /// runspace instance. /// True if batch invocation is supported, false if not. internal static bool ServerSupportsBatchInvocation(Runspace runspace) { diff --git a/src/System.Management.Automation/engine/remoting/common/WireDataFormat/RemoteHost.cs b/src/System.Management.Automation/engine/remoting/common/WireDataFormat/RemoteHost.cs index db8aed0f102..aace117dbdf 100644 --- a/src/System.Management.Automation/engine/remoting/common/WireDataFormat/RemoteHost.cs +++ b/src/System.Management.Automation/engine/remoting/common/WireDataFormat/RemoteHost.cs @@ -437,7 +437,7 @@ internal Collection PerformSecurityChecksOnHostMessage(string co /// Used in ensuring that remote prompt messages are /// tagged with "Windows PowerShell Credential Request" /// - /// caption to modify + /// caption to modify. /// New modified caption. private string ModifyCaption(string caption) { @@ -460,7 +460,7 @@ private string ModifyCaption(string caption) /// contain a warning that they originate from a /// different computer /// - /// original message to modify + /// original message to modify. /// computername to include in the /// message /// Message which contains a warning as well. @@ -481,7 +481,7 @@ private string ModifyMessage(string message, string computerName) /// /// computer name to include /// in warning - /// resource string to use + /// resource string to use. /// A constructed remote host call message /// which will display the warning. private RemoteHostCall ConstructWarningMessageForSecureString(string computerName, diff --git a/src/System.Management.Automation/engine/remoting/common/psstreamobject.cs b/src/System.Management.Automation/engine/remoting/common/psstreamobject.cs index f31a59e0e43..db10d626b2d 100644 --- a/src/System.Management.Automation/engine/remoting/common/psstreamobject.cs +++ b/src/System.Management.Automation/engine/remoting/common/psstreamobject.cs @@ -97,7 +97,7 @@ public PSStreamObject(PSStreamObjectType objectType, object value) : /// Handle the object obtained from an ObjectStream's reader /// based on its type /// - /// cmdlet to use for outputting the object + /// cmdlet to use for outputting the object. /// Used by Receive-Job to suppress inquire preference. public void WriteStreamObject(Cmdlet cmdlet, bool overrideInquire = false) { @@ -258,7 +258,7 @@ private static void GetIdentifierInfo(string message, out Guid jobInstanceId, ou /// Handle the object obtained from an ObjectStream's reader /// based on its type /// - /// cmdlet to use for outputting the object + /// cmdlet to use for outputting the object. /// /// Suppresses prompt on messages with Inquire preference. /// Needed for Receive-Job @@ -432,7 +432,7 @@ internal void WriteStreamObject(Cmdlet cmdlet, Guid instanceId, bool overrideInq /// Handle the object obtained from an ObjectStream's reader /// based on its type /// - /// cmdlet to use for outputting the object + /// cmdlet to use for outputting the object. /// /// Overrides the inquire preference, used in Receive-Job to suppress prompts. internal void WriteStreamObject(Cmdlet cmdlet, bool writeSourceIdentifier, bool overrideInquire) diff --git a/src/System.Management.Automation/engine/remoting/common/remotingexceptions.cs b/src/System.Management.Automation/engine/remoting/common/remotingexceptions.cs index 0e38667e3dd..42ae90eccfc 100644 --- a/src/System.Management.Automation/engine/remoting/common/remotingexceptions.cs +++ b/src/System.Management.Automation/engine/remoting/common/remotingexceptions.cs @@ -488,8 +488,8 @@ protected PSRemotingTransportException(SerializationInfo info, StreamingContext /// /// Serializes the exception data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -653,8 +653,8 @@ internal PSRemotingTransportRedirectException(string redirectLocation, PSRemotin /// /// Serializes the exception data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs b/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs index 88284e882c7..d5a67ee7aee 100644 --- a/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs +++ b/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs @@ -160,7 +160,7 @@ internal bool RunspaceDebugStepInEnabled /// /// RaiseRunspaceDebugStopEvent /// - /// Runspace + /// Runspace. internal void RaiseRunspaceDebugStopEvent(System.Management.Automation.Runspaces.Runspace runspace) { RunspaceDebugStop.SafeInvoke(this, new StartRunspaceDebugProcessingEventArgs(runspace)); @@ -227,7 +227,7 @@ internal int ThrottleLimit /// /// Submit a list of operations that need to be throttled /// - /// list of operations to be throttled + /// list of operations to be throttled. /// Once the operations are added to the queue, the method will /// start operations from the queue /// @@ -260,7 +260,7 @@ internal void SubmitOperations(List operations) /// /// Add a single operation to the queue /// - /// Operation to be added + /// Operation to be added. internal void AddOperation(IThrottleOperation operation) { // add item to the queue @@ -366,7 +366,7 @@ internal void StopAllOperations() /// /// Stop the specified operation /// - /// operation which needs to be stopped + /// operation which needs to be stopped. internal void StopOperation(IThrottleOperation operation) { // StopOperation is being called a second time @@ -454,7 +454,7 @@ public ThrottleManager() /// the /// interface /// - /// sender of the event + /// sender of the event. /// Event information object which describes the event /// which triggered this method private void OperationCompleteHandler(object source, OperationStateEventArgs stateEventArgs) diff --git a/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs b/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs index 94365ebe281..0c1f91ca6fe 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs @@ -577,7 +577,7 @@ internal void RaiseReadyForDisconnect() /// /// Queue the robust connection notification event. /// - /// Determines what kind of notification + /// Determines what kind of notification. internal void QueueRobustConnectionNotification(int flags) { ConnectionStatusEventArgs args = null; @@ -616,7 +616,7 @@ internal void QueueRobustConnectionNotification(int flags) /// /// Raise the Robust Connection notification event. /// - /// ConnectionStatusEventArgs + /// ConnectionStatusEventArgs. internal void RaiseRobustConnectionNotification(ConnectionStatusEventArgs args) { RobustConnectionNotification.SafeInvoke(this, args); @@ -755,7 +755,7 @@ internal void EnqueueAndStartProcessingThread(RemoteDataObject remoteO /// Helper method to check RemoteDataObject for a host call requiring user /// interaction. /// - /// Remote data object + /// Remote data object. /// True if remote data object requires a user response. private bool CheckForInteractiveHostCall(RemoteDataObject remoteObject) { diff --git a/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs b/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs index 10c2cbbba30..7b727f27a69 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs @@ -1403,9 +1403,9 @@ internal static class DISCUtils /// /// Create an ExternalScriptInfo object from a file path. /// - /// execution context - /// The path to the file - /// The base name of the script + /// execution context. + /// The path to the file. + /// The base name of the script. /// The ExternalScriptInfo object. internal static ExternalScriptInfo GetScriptInfoForFile(ExecutionContext context, string fileName, out string scriptName) { @@ -1433,8 +1433,8 @@ internal static ExternalScriptInfo GetScriptInfoForFile(ExecutionContext context /// /// Loads the configuration file into a hashtable /// - /// execution context - /// the ExternalScriptInfo object + /// execution context. + /// the ExternalScriptInfo object. /// Configuration hashtable. internal static Hashtable LoadConfigFile(ExecutionContext context, ExternalScriptInfo scriptInfo) { @@ -1462,7 +1462,7 @@ internal static Hashtable LoadConfigFile(ExecutionContext context, ExternalScrip /// /// Verifies the configuration hashtable /// - /// configuration hashtable + /// configuration hashtable. /// /// /// True if valid, false otherwise. @@ -1709,7 +1709,7 @@ internal Hashtable ConfigHash /// /// Creates a new instance of a Declarative Initial Session State Configuration /// - /// The path to the .pssc file representing the initial session state + /// The path to the .pssc file representing the initial session state. /// /// The verifier that PowerShell should call to determine if groups in the Role entry apply to the /// target session. If you have a WindowsPrincipal for a user, for example, create a Function that diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs index 8ebdbe76950..b62eaaa135e 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs @@ -2426,7 +2426,7 @@ internal static extern void WSManGetSessionOptionAsDword(IntPtr wsManSessionHand /// will be used as the language code to get the error message in. /// /// - /// session option to get + /// session option to get. /// internal static string WSManGetSessionOptionAsString(IntPtr wsManAPIHandle, WSManSessionOption option) @@ -2974,7 +2974,7 @@ internal static extern int WSManPluginReportContext( /// Registers the shutdown callback. /// /// Specifies the resource URI, options, locale, shutdown flag, and handle for the request. - /// Callback to be executed on shutdown + /// Callback to be executed on shutdown. /// /// [DllImport(WSManNativeApi.WSManProviderApiDll, SetLastError = false, CharSet = CharSet.Unicode)] diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs index 988d608924f..ccc70eae3a4 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs @@ -534,7 +534,7 @@ private void AddToActiveShellSessions( /// /// Retrieves a WSManPluginShellSession if matched. /// - /// Shell context (WSManPluginRequest.unmanagedHandle) + /// Shell context (WSManPluginRequest.unmanagedHandle). /// Null WSManPluginShellSession if not matched. The object if matched. private WSManPluginShellSession GetFromActiveShellSessions( IntPtr key) @@ -574,7 +574,7 @@ private void DeleteFromActiveShellSessions( /// /// Triggers a shell close from an event handler. /// - /// Shell context + /// Shell context. /// private void HandleShellSessionClosed( object source, @@ -1552,7 +1552,7 @@ internal static void UnhandledExceptionHandler( /// /// /// - /// Pre-formatted localized string + /// Pre-formatted localized string. /// internal static void ReportOperationComplete( WSManNativeApi.WSManPluginRequest requestDetails, diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs index 3ea56076921..57a0c434a18 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs @@ -26,12 +26,12 @@ namespace System.Management.Automation.Remoting /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PCWSTR - /// WSMAN_SHELL_STARTUP_INFO* - /// WSMAN_DATA* + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PCWSTR. + /// WSMAN_SHELL_STARTUP_INFO*. + /// WSMAN_DATA*. internal delegate void WSMPluginShellDelegate( // TODO: Rename to WSManPluginShellDelegate once I remove the MC++ module. IntPtr pluginContext, IntPtr requestDetails, @@ -42,20 +42,20 @@ internal delegate void WSMPluginShellDelegate( // TODO: Rename to WSManPluginShe /// /// - /// PVOID - /// PVOID + /// PVOID. + /// PVOID. internal delegate void WSMPluginReleaseShellContextDelegate( IntPtr pluginContext, IntPtr shellContext); /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PVOID - /// PVOID optional - /// WSMAN_DATA* optional + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PVOID. + /// PVOID optional. + /// WSMAN_DATA* optional. internal delegate void WSMPluginConnectDelegate( IntPtr pluginContext, IntPtr requestDetails, @@ -66,12 +66,12 @@ internal delegate void WSMPluginConnectDelegate( /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PVOID - /// PCWSTR - /// WSMAN_COMMAND_ARG_SET* + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PVOID. + /// PCWSTR. + /// WSMAN_COMMAND_ARG_SET*. internal delegate void WSMPluginCommandDelegate( IntPtr pluginContext, IntPtr requestDetails, @@ -83,15 +83,15 @@ internal delegate void WSMPluginCommandDelegate( /// /// Delegate that is passed to native layer for callback on operation shutdown notifications /// - /// IntPtr + /// IntPtr. internal delegate void WSMPluginOperationShutdownDelegate( IntPtr shutdownContext); /// /// - /// PVOID - /// PVOID - /// PVOID + /// PVOID. + /// PVOID. + /// PVOID. internal delegate void WSMPluginReleaseCommandContextDelegate( IntPtr pluginContext, IntPtr shellContext, @@ -99,13 +99,13 @@ internal delegate void WSMPluginReleaseCommandContextDelegate( /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PVOID - /// PVOID - /// PCWSTR - /// WSMAN_DATA* + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PVOID. + /// PVOID. + /// PCWSTR. + /// WSMAN_DATA*. internal delegate void WSMPluginSendDelegate( IntPtr pluginContext, IntPtr requestDetails, @@ -117,12 +117,12 @@ internal delegate void WSMPluginSendDelegate( /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PVOID - /// PVOID optional - /// WSMAN_STREAM_ID_SET* optional + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PVOID. + /// PVOID optional. + /// WSMAN_STREAM_ID_SET* optional. internal delegate void WSMPluginReceiveDelegate( IntPtr pluginContext, IntPtr requestDetails, @@ -133,12 +133,12 @@ internal delegate void WSMPluginReceiveDelegate( /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PVOID - /// PVOID optional - /// PCWSTR + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PVOID. + /// PVOID optional. + /// PCWSTR. internal delegate void WSMPluginSignalDelegate( IntPtr pluginContext, IntPtr requestDetails, @@ -158,7 +158,7 @@ internal delegate void WaitOrTimerCallbackDelegate( /// /// - /// PVOID + /// PVOID. internal delegate void WSMShutdownPluginDelegate( IntPtr pluginContext); @@ -426,7 +426,7 @@ private WSManPluginManagedEntryWrapper() { } /// Called only once after the assembly is loaded..This is used to perform /// various initializations. /// - /// IntPtr to WSManPluginEntryDelegates.WSManPluginEntryDelegatesInternal + /// IntPtr to WSManPluginEntryDelegates.WSManPluginEntryDelegatesInternal. /// 0 = Success, 1 = Failure. public static int InitPlugin( IntPtr wkrPtrs) @@ -463,7 +463,7 @@ public static int InitPlugin( /// /// Called only once during shutdown. This is used to perform various deinitializations. /// - /// PVOID + /// PVOID. public static void ShutdownPlugin( IntPtr pluginContext) { @@ -477,12 +477,12 @@ public static void ShutdownPlugin( /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PVOID - /// PVOID optional - /// WSMAN_DATA* optional + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PVOID. + /// PVOID optional. + /// WSMAN_DATA* optional. public static void WSManPluginConnect( IntPtr pluginContext, IntPtr requestDetails, @@ -509,12 +509,12 @@ public static void WSManPluginConnect( /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PCWSTR - /// WSMAN_SHELL_STARTUP_INFO* - /// WSMAN_DATA* + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PCWSTR. + /// WSMAN_SHELL_STARTUP_INFO*. + /// WSMAN_DATA*. public static void WSManPluginShell( IntPtr pluginContext, IntPtr requestDetails, @@ -553,8 +553,8 @@ public static void WSManPluginShell( /// /// - /// PVOID - /// PVOID + /// PVOID. + /// PVOID. public static void WSManPluginReleaseShellContext( IntPtr pluginContext, IntPtr shellContext) @@ -565,12 +565,12 @@ public static void WSManPluginReleaseShellContext( /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PVOID - /// PCWSTR - /// WSMAN_COMMAND_ARG_SET* optional + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PVOID. + /// PCWSTR. + /// WSMAN_COMMAND_ARG_SET* optional. public static void WSManPluginCommand( IntPtr pluginContext, IntPtr requestDetails, @@ -598,7 +598,7 @@ public static void WSManPluginCommand( /// /// Operation shutdown notification that was registered with the native layer for each of the shellCreate operations. /// - /// IntPtr + /// IntPtr. public static void WSManPSShutdown( IntPtr shutdownContext) { @@ -610,9 +610,9 @@ public static void WSManPSShutdown( /// /// - /// PVOID - /// PVOID - /// PVOID + /// PVOID. + /// PVOID. + /// PVOID. public static void WSManPluginReleaseCommandContext( IntPtr pluginContext, IntPtr shellContext, @@ -624,13 +624,13 @@ public static void WSManPluginReleaseCommandContext( /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PVOID - /// PVOID - /// PCWSTR - /// WSMAN_DATA* + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PVOID. + /// PVOID. + /// PCWSTR. + /// WSMAN_DATA*. public static void WSManPluginSend( IntPtr pluginContext, IntPtr requestDetails, @@ -658,12 +658,12 @@ public static void WSManPluginSend( /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PVOID - /// PVOID optional - /// WSMAN_STREAM_ID_SET* optional + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PVOID. + /// PVOID optional. + /// WSMAN_STREAM_ID_SET* optional. public static void WSManPluginReceive( IntPtr pluginContext, IntPtr requestDetails, @@ -690,12 +690,12 @@ public static void WSManPluginReceive( /// /// - /// PVOID - /// WSMAN_PLUGIN_REQUEST* - /// DWORD - /// PVOID - /// PVOID optional - /// PCWSTR + /// PVOID. + /// WSMAN_PLUGIN_REQUEST*. + /// DWORD. + /// PVOID. + /// PVOID optional. + /// PCWSTR. public static void WSManPluginSignal( IntPtr pluginContext, IntPtr requestDetails, @@ -725,8 +725,8 @@ public static void WSManPluginSignal( /// Conforms to: /// public delegate void WaitOrTimerCallback( Object state, bool timedOut ) /// - /// PVOID - /// BOOLEAN + /// PVOID. + /// BOOLEAN. /// public static void PSPluginOperationShutdownCallback( object operationContext, diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs index 1b8780afbcf..03e49585d2d 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs @@ -251,8 +251,8 @@ internal enum tmStartModes /// Helper method to convert a transport error code value /// to a fully qualified error Id string. /// - /// transport error code - /// Default FQEID + /// transport error code. + /// Default FQEID. /// Fully qualified error Id string. internal static string GetFQEIDFromTransportError( int transportErrorCode, @@ -548,8 +548,8 @@ static WSManClientSessionTransportManager() /// /// Connection info to use while connecting to the remote machine. /// - /// crypto helper - /// session friendly name + /// crypto helper. + /// session friendly name. /// /// 1. Create Session failed with a non-zero error code. /// @@ -1240,7 +1240,7 @@ internal override void CloseAsync() /// With default configuration remoting from V3 client to V2 server will break as V3 client can send upto 500KB in a single Send packet /// So if server version is known to be V2, we'll downgrade the max env size to 150KB (V2's default) if the current value is 500KB (V3 default) /// - /// server negotiated protocol version + /// server negotiated protocol version. internal void AdjustForProtocolVariations(Version serverProtocolVersion) { if (serverProtocolVersion <= RemotingConstants.ProtocolVersionWin7RTM) @@ -1705,7 +1705,7 @@ internal void ClearReceiveOrSendResources(int flags, bool shouldClearSend) /// /// Call back from worker thread / queue to raise Robust Connection notification event. /// - /// ConnectionStatusEventArgs + /// ConnectionStatusEventArgs. internal override void ProcessPrivateData(object privateData) { // Raise the Robust @@ -1763,7 +1763,7 @@ internal IntPtr SessionHandle /// session create/connect retry attempt may be beneficial then do the /// retry attempt. /// - /// Error code returned from Create response + /// Error code returned from Create response. /// True if a session create retry has been started. private bool RetrySessionCreation(int sessionCreateErrorCode) { diff --git a/src/System.Management.Automation/engine/remoting/server/ServerPowerShellDriver.cs b/src/System.Management.Automation/engine/remoting/server/ServerPowerShellDriver.cs index db9ebcc2c01..8ad45490722 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerPowerShellDriver.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerPowerShellDriver.cs @@ -50,17 +50,17 @@ internal class ServerPowerShellDriver /// /// Default constructor for creating ServerPowerShellDrivers /// - /// decoded powershell object - /// extra pipeline to be run after completes - /// whether there is input for this powershell - /// the client powershell id - /// the client runspacepool id + /// decoded powershell object. + /// extra pipeline to be run after completes. + /// whether there is input for this powershell. + /// the client powershell id. + /// the client runspacepool id. /// runspace pool driver /// which is creating this powershell driver - /// apartment state for this powershell + /// apartment state for this powershell. /// host info using which the host for /// this powershell will be constructed - /// serialization options for the streams in this powershell + /// serialization options for the streams in this powershell. /// /// true if the command is to be added to history list of the runspace. false, otherwise. /// @@ -80,16 +80,16 @@ internal ServerPowerShellDriver(PowerShell powershell, PowerShell extraPowerShel /// /// Default constructor for creating ServerPowerShellDrivers /// - /// decoded powershell object - /// extra pipeline to be run after completes - /// whether there is input for this powershell - /// the client powershell id - /// the client runspacepool id + /// decoded powershell object. + /// extra pipeline to be run after completes. + /// whether there is input for this powershell. + /// the client powershell id. + /// the client runspacepool id. /// runspace pool driver /// which is creating this powershell driver /// host info using which the host for /// this powershell will be constructed - /// serialization options for the streams in this powershell + /// serialization options for the streams in this powershell. /// /// true if the command is to be added to history list of the runspace. false, otherwise. /// @@ -111,16 +111,16 @@ internal ServerPowerShellDriver(PowerShell powershell, PowerShell extraPowerShel /// /// Default constructor for creating ServerPowerShellDrivers /// - /// decoded powershell object - /// extra pipeline to be run after completes - /// whether there is input for this powershell - /// the client powershell id - /// the client runspacepool id + /// decoded powershell object. + /// extra pipeline to be run after completes. + /// whether there is input for this powershell. + /// the client powershell id. + /// the client runspacepool id. /// runspace pool driver /// which is creating this powershell driver /// host info using which the host for /// this powershell will be constructed - /// serialization options for the streams in this powershell + /// serialization options for the streams in this powershell. /// /// true if the command is to be added to history list of the runspace. false, otherwise. /// @@ -139,17 +139,17 @@ internal ServerPowerShellDriver(PowerShell powershell, PowerShell extraPowerShel /// /// Default constructor for creating ServerPowerShellDrivers /// - /// decoded powershell object - /// extra pipeline to be run after completes - /// whether there is input for this powershell - /// the client powershell id - /// the client runspacepool id + /// decoded powershell object. + /// extra pipeline to be run after completes. + /// whether there is input for this powershell. + /// the client powershell id. + /// the client runspacepool id. /// runspace pool driver /// which is creating this powershell driver - /// apartment state for this powershell + /// apartment state for this powershell. /// host info using which the host for /// this powershell will be constructed - /// serialization options for the streams in this powershell + /// serialization options for the streams in this powershell. /// /// true if the command is to be added to history list of the runspace. false, otherwise. /// @@ -460,7 +460,7 @@ private void UnregisterPipelineOutputEventHandlers(PSDataCollection pi /// Handle state changed information from PowerShell /// and send it to the client /// - /// sender of this event + /// sender of this event. /// arguments describing state changed /// information for this powershell private void HandlePowerShellInvocationStateChanged(object sender, @@ -539,8 +539,8 @@ private void HandlePowerShellInvocationStateChanged(object sender, /// /// Handles DataAdded event from the Output of the powershell /// - /// sender of this information - /// arguments describing this event + /// sender of this information. + /// arguments describing this event. private void HandleOutputDataAdded(object sender, DataAddedEventArgs e) { int index = e.Index; @@ -564,8 +564,8 @@ private void HandleOutputDataAdded(object sender, DataAddedEventArgs e) /// /// Handles DataAdded event from Error of the PowerShell /// - /// sender of this event - /// arguments describing this event + /// sender of this event. + /// arguments describing this event. private void HandleErrorDataAdded(object sender, DataAddedEventArgs e) { int index = e.Index; @@ -589,8 +589,8 @@ private void HandleErrorDataAdded(object sender, DataAddedEventArgs e) /// /// Handles DataAdded event from Progress of PowerShell /// - /// sender of this information, unused - /// arguments describing this event + /// sender of this information, unused. + /// arguments describing this event. private void HandleProgressAdded(object sender, DataAddedEventArgs eventArgs) { int index = eventArgs.Index; @@ -614,8 +614,8 @@ private void HandleProgressAdded(object sender, DataAddedEventArgs eventArgs) /// /// Handles DataAdded event from Warning of PowerShell /// - /// sender of this information, unused - /// arguments describing this event + /// sender of this information, unused. + /// arguments describing this event. private void HandleWarningAdded(object sender, DataAddedEventArgs eventArgs) { int index = eventArgs.Index; @@ -639,8 +639,8 @@ private void HandleWarningAdded(object sender, DataAddedEventArgs eventArgs) /// /// Handles DataAdded from Verbose of PowerShell /// - /// sender of this information, unused - /// sender of this information + /// sender of this information, unused. + /// sender of this information. private void HandleVerboseAdded(object sender, DataAddedEventArgs eventArgs) { int index = eventArgs.Index; @@ -664,8 +664,8 @@ private void HandleVerboseAdded(object sender, DataAddedEventArgs eventArgs) /// /// Handles DataAdded from Debug of PowerShell /// - /// sender of this information, unused - /// sender of this information + /// sender of this information, unused. + /// sender of this information. private void HandleDebugAdded(object sender, DataAddedEventArgs eventArgs) { int index = eventArgs.Index; @@ -689,8 +689,8 @@ private void HandleDebugAdded(object sender, DataAddedEventArgs eventArgs) /// /// Handles DataAdded from Information of PowerShell /// - /// sender of this information, unused - /// sender of this information + /// sender of this information, unused. + /// sender of this information. private void HandleInformationAdded(object sender, DataAddedEventArgs eventArgs) { int index = eventArgs.Index; @@ -764,8 +764,8 @@ private void SendRemainingData() /// /// Stop the local powershell /// - /// sender of this event, unused - /// unused + /// sender of this event, unused. + /// unused. private void HandleStopReceived(object sender, EventArgs eventArgs) { do // false loop @@ -816,8 +816,8 @@ private void HandleStopReceived(object sender, EventArgs eventArgs) /// /// Add input to the local powershell's input collection /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleInputReceived(object sender, RemoteDataEventArgs eventArgs) { // This can be called in pushed runspace scenarios for error reporting (pipeline stopped). @@ -831,8 +831,8 @@ private void HandleInputReceived(object sender, RemoteDataEventArgs even /// /// Close the input collection of the local powershell /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleInputEndReceived(object sender, EventArgs eventArgs) { // This can be called in pushed runspace scenarios for error reporting (pipeline stopped). @@ -857,8 +857,8 @@ private void HandleSessionConnected(object sender, EventArgs eventArgs) /// /// Handle a host message response received /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleHostResponseReceived(object sender, RemoteDataEventArgs eventArgs) { _remoteHost.ServerMethodExecutor.HandleRemoteHostResponseFromClient(eventArgs.Data); diff --git a/src/System.Management.Automation/engine/remoting/server/ServerRemoteHost.cs b/src/System.Management.Automation/engine/remoting/server/ServerRemoteHost.cs index 78d58988be2..3d46bee4fcf 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerRemoteHost.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerRemoteHost.cs @@ -324,7 +324,7 @@ public override bool IsRunspacePushed /// /// Push runspace to use for remote command execution /// - /// RemoteRunspace + /// RemoteRunspace. public override void PushRunspace(Runspace runspace) { // Double session hop is currently allowed only for WSMan (non-OutOfProc) sessions, where diff --git a/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs b/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs index eca809d498f..27bada7093f 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs @@ -37,8 +37,8 @@ internal ServerRunspacePoolDataStructureHandler(ServerRunspacePoolDriver driver, /// /// Send a message with application private data to the client /// - /// applicationPrivateData to send - /// server capability negotiated during initial exchange of remoting messages / session capabilities of client and server + /// applicationPrivateData to send. + /// server capability negotiated during initial exchange of remoting messages / session capabilities of client and server. internal void SendApplicationPrivateDataToClient(PSPrimitiveDictionary applicationPrivateData, RemoteSessionCapability serverCapability) { // make server's PSVersionTable available to the client using ApplicationPrivateData @@ -62,7 +62,7 @@ internal void SendApplicationPrivateDataToClient(PSPrimitiveDictionary applicati /// /// Send a message with the RunspacePoolStateInfo to the client /// - /// state info to send + /// state info to send. internal void SendStateInfoToClient(RunspacePoolStateInfo stateInfo) { RemoteDataObject data = RemotingEncoder.GenerateRunspacePoolStateInfo( @@ -74,7 +74,7 @@ internal void SendStateInfoToClient(RunspacePoolStateInfo stateInfo) /// /// Send a message with the PSEventArgs to the client /// - /// event to send + /// event to send. internal void SendPSEventArgsToClient(PSEventArgs e) { RemoteDataObject data = RemotingEncoder.GeneratePSEventArgs(_clientRunspacePoolId, e); @@ -104,7 +104,7 @@ internal void ProcessConnect() /// Process the data received from the runspace pool on /// the server /// - /// data received + /// data received. internal void ProcessReceivedData(RemoteDataObject receivedData) { if (receivedData == null) @@ -198,10 +198,10 @@ internal void ProcessReceivedData(RemoteDataObject receivedData) /// /// Creates a powershell data structure handler from this runspace pool /// - /// powershell instance id - /// runspace pool id - /// remote stream options - /// local PowerShell object + /// powershell instance id. + /// runspace pool id. + /// remote stream options. + /// local PowerShell object. /// ServerPowerShellDataStructureHandler. internal ServerPowerShellDataStructureHandler CreatePowerShellDataStructureHandler( Guid instanceId, Guid runspacePoolId, RemoteStreamOptions remoteStreamOptions, PowerShell localPowerShell) @@ -257,7 +257,7 @@ internal ServerPowerShellDataStructureHandler GetPowerShellDataStructureHandler( /// /// dispatch the message to the associated powershell data structure handler /// - /// message to dispatch + /// message to dispatch. internal void DispatchMessageToPowerShell(RemoteDataObject rcvdData) { ServerPowerShellDataStructureHandler dsHandler = @@ -275,8 +275,8 @@ internal void DispatchMessageToPowerShell(RemoteDataObject rcvdData) /// Send the specified response to the client. The client call will /// be blocked on the same /// - /// call id on the client - /// response to send + /// call id on the client. + /// response to send. internal void SendResponseToClient(long callId, object response) { RemoteDataObject message = @@ -348,7 +348,7 @@ internal TypeTable TypeTable /// Send the data specified as a RemoteDataObject asynchronously /// to the runspace pool on the remote session /// - /// data to send + /// data to send. /// This overload takes a RemoteDataObject and should /// be the one thats used to send data from within this /// data structure handler class @@ -386,8 +386,8 @@ internal ServerPowerShellDataStructureHandler GetAssociatedPowerShellDataStructu /// /// Remove the association of the powershell from the runspace pool /// - /// sender of this event - /// unused + /// sender of this event. + /// unused. private void HandleRemoveAssociation(object sender, EventArgs e) { Dbg.Assert(sender is ServerPowerShellDataStructureHandler, @"sender of the event @@ -447,11 +447,11 @@ internal class ServerPowerShellDataStructureHandler /// Default constructor for creating ServerPowerShellDataStructureHandler /// instance /// - /// powershell instance id - /// runspace pool id - /// remote stream options - /// transport manager - /// local powershell object + /// powershell instance id. + /// runspace pool id. + /// remote stream options. + /// transport manager. + /// local powershell object. internal ServerPowerShellDataStructureHandler(Guid instanceId, Guid runspacePoolId, RemoteStreamOptions remoteStreamOptions, AbstractServerTransportManager transportManager, PowerShell localPowerShell) { @@ -521,7 +521,7 @@ internal void SendStateChangedInformationToClient(PSInvocationStateInfo /// /// Send the output data to the client /// - /// data to send + /// data to send. internal void SendOutputDataToClient(PSObject data) { SendDataAsync(RemotingEncoder.GeneratePowerShellOutput(data, @@ -531,7 +531,7 @@ internal void SendOutputDataToClient(PSObject data) /// /// Send the error record to client /// - /// error record to send + /// error record to send. internal void SendErrorRecordToClient(ErrorRecord errorRecord) { errorRecord.SerializeExtendedInfo = (_streamSerializationOptions & RemoteStreamOptions.AddInvocationInfoToErrorRecord) != 0; @@ -543,7 +543,7 @@ internal void SendErrorRecordToClient(ErrorRecord errorRecord) /// /// Send the specified warning record to client /// - /// warning record + /// warning record. internal void SendWarningRecordToClient(WarningRecord record) { record.SerializeExtendedInfo = (_streamSerializationOptions & RemoteStreamOptions.AddInvocationInfoToWarningRecord) != 0; @@ -555,7 +555,7 @@ internal void SendWarningRecordToClient(WarningRecord record) /// /// Send the specified debug record to client /// - /// debug record + /// debug record. internal void SendDebugRecordToClient(DebugRecord record) { record.SerializeExtendedInfo = (_streamSerializationOptions & RemoteStreamOptions.AddInvocationInfoToDebugRecord) != 0; @@ -567,7 +567,7 @@ internal void SendDebugRecordToClient(DebugRecord record) /// /// Send the specified verbose record to client /// - /// warning record + /// warning record. internal void SendVerboseRecordToClient(VerboseRecord record) { record.SerializeExtendedInfo = (_streamSerializationOptions & RemoteStreamOptions.AddInvocationInfoToVerboseRecord) != 0; @@ -579,7 +579,7 @@ internal void SendVerboseRecordToClient(VerboseRecord record) /// /// Send the specified progress record to client /// - /// progress record + /// progress record. internal void SendProgressRecordToClient(ProgressRecord record) { SendDataAsync(RemotingEncoder.GeneratePowerShellInformational( @@ -589,7 +589,7 @@ internal void SendProgressRecordToClient(ProgressRecord record) /// /// Send the specified information record to client /// - /// information record + /// information record. internal void SendInformationRecordToClient(InformationRecord record) { SendDataAsync(RemotingEncoder.GeneratePowerShellInformational( @@ -611,7 +611,7 @@ internal void ProcessConnect() /// Process the data received from the powershell on /// the client /// - /// data received + /// data received. internal void ProcessReceivedData(RemoteDataObject receivedData) { if (receivedData == null) @@ -784,7 +784,7 @@ internal Runspace RunspaceUsedToInvokePowerShell /// Send the data specified as a RemoteDataObject asynchronously /// to the runspace pool on the remote session /// - /// data to send + /// data to send. /// This overload takes a RemoteDataObject and should /// be the one thats used to send data from within this /// data structure handler class diff --git a/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs b/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs index a952bb29450..08257b1bd14 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs @@ -99,13 +99,13 @@ private Dictionary _associatedShells /// /// Creates the runspace pool driver /// - /// client runspace pool id to associate + /// client runspace pool id to associate. /// transport manager associated with this /// runspace pool driver - /// maximum runspaces to open - /// minimum runspaces to open - /// threading options for the runspaces in the pool - /// host information about client side host + /// maximum runspaces to open. + /// minimum runspaces to open. + /// threading options for the runspaces in the pool. + /// host information about client side host. /// /// Contains: /// 1. Script to run after a RunspacePool/Runspace is created in this session. @@ -114,10 +114,10 @@ private Dictionary _associatedShells /// 2. ThreadOptions for RunspacePool/Runspace /// 3. ThreadApartment for RunspacePool/Runspace /// - /// configuration of the runspace - /// application private data - /// True if the driver is being created by an administrator - /// server capability reported to the client during negotiation (not the actual capability) + /// configuration of the runspace. + /// application private data. + /// True if the driver is being created by an administrator. + /// server capability reported to the client during negotiation (not the actual capability). /// Client PowerShell version. /// Optional endpoint configuration name to create a pushed configured runspace. internal ServerRunspacePoolDriver( @@ -138,14 +138,14 @@ internal ServerRunspacePoolDriver( /// /// Creates the runspace pool driver /// - /// client runspace pool id to associate + /// client runspace pool id to associate. /// transport manager associated with this /// runspace pool driver - /// maximum runspaces to open - /// minimum runspaces to open - /// threading options for the runspaces in the pool - /// apartment state for the runspaces in the pool - /// host information about client side host + /// maximum runspaces to open. + /// minimum runspaces to open. + /// threading options for the runspaces in the pool. + /// apartment state for the runspaces in the pool. + /// host information about client side host. /// /// Contains: /// 1. Script to run after a RunspacePool/Runspace is created in this session. @@ -154,10 +154,10 @@ internal ServerRunspacePoolDriver( /// 2. ThreadOptions for RunspacePool/Runspace /// 3. ThreadApartment for RunspacePool/Runspace /// - /// configuration of the runspace - /// application private data - /// True if the driver is being created by an administrator - /// server capability reported to the client during negotiation (not the actual capability) + /// configuration of the runspace. + /// application private data. + /// True if the driver is being created by an administrator. + /// server capability reported to the client during negotiation (not the actual capability). /// Client PowerShell version. /// Optional endpoint configuration name to create a pushed configured runspace. internal ServerRunspacePoolDriver( @@ -705,7 +705,7 @@ private void InvokeStartupScripts(RunspaceCreatedEventArgs args) /// /// handler to the runspace pool state changed events /// - /// sender of this events + /// sender of this events. /// arguments which describe the /// RunspacePool's StateChanged event private void HandleRunspacePoolStateChanged(object sender, @@ -749,8 +749,8 @@ private void HandleRunspacePoolForwardEvent(object sender, PSEventArgs e) /// /// Handle the invocation of powershell /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleCreateAndInvokePowerShell(object sender, RemoteDataEventArgs> eventArgs) { RemoteDataObject data = eventArgs.Data; @@ -1030,8 +1030,8 @@ private bool DoesInitialSessionStateIncludeGetCommandWithListImportedSwitch() /// /// Handle the invocation of command discovery pipeline /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleGetCommandMetadata(object sender, RemoteDataEventArgs> eventArgs) { RemoteDataObject data = eventArgs.Data; @@ -1100,8 +1100,8 @@ private void HandleGetCommandMetadata(object sender, RemoteDataEventArgs /// Handles host responses /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleHostResponseReceived(object sender, RemoteDataEventArgs eventArgs) { @@ -1111,7 +1111,7 @@ private void HandleHostResponseReceived(object sender, /// /// Sets the maximum runspace of the runspace pool and sends a response back /// - /// sender of this event, unused + /// sender of this event, unused. /// contains information about the new maxRunspaces /// and the callId at the client private void HandleSetMaxRunspacesReceived(object sender, RemoteDataEventArgs eventArgs) @@ -1127,7 +1127,7 @@ private void HandleSetMaxRunspacesReceived(object sender, RemoteDataEventArgs /// Sets the minimum runspace of the runspace pool and sends a response back /// - /// sender of this event, unused + /// sender of this event, unused. /// contains information about the new minRunspaces /// and the callId at the client private void HandleSetMinRunspacesReceived(object sender, RemoteDataEventArgs eventArgs) @@ -1144,8 +1144,8 @@ private void HandleSetMinRunspacesReceived(object sender, RemoteDataEventArgs - /// sender of this event, unused - /// contains information on the callid + /// sender of this event, unused. + /// contains information on the callid. private void HandleGetAvailableRunspacesReceived(object sender, RemoteDataEventArgs eventArgs) { PSObject data = eventArgs.Data; @@ -1197,14 +1197,14 @@ private bool ResetRunspaceState() /// /// Starts the PowerShell command on the currently pushed Runspace /// - /// PowerShell command or script - /// PowerShell command to run after first completes - /// PowerShell Id - /// RunspacePool Id - /// Host Info - /// Remote stream options - /// False when input is provided - /// Add to history + /// PowerShell command or script. + /// PowerShell command to run after first completes. + /// PowerShell Id. + /// RunspacePool Id. + /// Host Info. + /// Remote stream options. + /// False when input is provided. + /// Add to history. private void StartPowerShellCommandOnPushedRunspace( PowerShell powershell, PowerShell extraPowerShell, @@ -1306,7 +1306,7 @@ private class DebuggerCommandArgument /// Pre-processor for debugger commands. /// Parses special debugger commands and converts to equivalent script for remote execution as needed. /// - /// PSCommand + /// PSCommand. /// True if debugger is active. /// True if active debugger is pushed and is a remote debugger. /// Command argument. @@ -1532,7 +1532,7 @@ public bool IsAvailable /// /// Submit a driver object to be invoked. /// - /// ServerPowerShellDriver + /// ServerPowerShellDriver. public void InvokeDriverAsync(ServerPowerShellDriver driver) { InvokePump currentPump; @@ -1770,7 +1770,7 @@ public override bool InBreakpoint /// /// Exits debugger mode with the provided resume action. /// - /// DebuggerResumeAction + /// DebuggerResumeAction. public override void SetDebuggerAction(DebuggerResumeAction resumeAction) { if (!_inDebugMode) @@ -1794,8 +1794,8 @@ public override DebuggerStopEventArgs GetDebuggerStopArgs() /// /// ProcessCommand /// - /// Command - /// Output + /// Command. + /// Output. /// public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output) { @@ -1868,7 +1868,7 @@ public override bool IsActive /// /// Sets debugger stepping mode. /// - /// True if stepping is to be enabled + /// True if stepping is to be enabled. public override void SetDebuggerStepMode(bool enabled) { // Enable both the wrapper and wrapped debuggers for debugging before setting step mode. @@ -1906,7 +1906,7 @@ internal override void DebugJob(Job job) /// Removes job from debugger job list and pops its /// debugger from the active debugger stack. /// - /// Job + /// Job. internal override void StopDebugJob(Job job) { _wrappedDebugger.Value.StopDebugJob(job); @@ -1915,7 +1915,7 @@ internal override void StopDebugJob(Job job) /// /// Sets up debugger to debug provided Runspace in a nested debug session. /// - /// Runspace to debug + /// Runspace to debug. internal override void DebugRunspace(Runspace runspace) { _wrappedDebugger.Value.DebugRunspace(runspace); @@ -1924,7 +1924,7 @@ internal override void DebugRunspace(Runspace runspace) /// /// Removes the provided Runspace from the nested "active" debugger state. /// - /// Runspace + /// Runspace. internal override void StopDebugRunspace(Runspace runspace) { _wrappedDebugger.Value.StopDebugRunspace(runspace); diff --git a/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineDriver.cs b/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineDriver.cs index 8aa52a93209..62fe1e8b5c0 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineDriver.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineDriver.cs @@ -88,15 +88,15 @@ internal class ServerSteppablePipelineDriver /// Default constructor for creating ServerSteppablePipelineDriver...Used by server to concurrently /// run 2 pipelines. /// - /// decoded powershell object - /// whether there is input for this powershell - /// the client powershell id - /// the client runspacepool id + /// decoded powershell object. + /// whether there is input for this powershell. + /// the client powershell id. + /// the client runspacepool id. /// runspace pool driver /// which is creating this powershell driver /// host info using which the host for /// this powershell will be constructed - /// serialization options for the streams in this powershell + /// serialization options for the streams in this powershell. /// /// true if the command is to be added to history list of the runspace. false, otherwise. /// @@ -107,7 +107,7 @@ internal class ServerSteppablePipelineDriver /// /// Steppable pipeline event subscriber /// - /// input collection of the PowerShell pipeline + /// input collection of the PowerShell pipeline. internal ServerSteppablePipelineDriver(PowerShell powershell, bool noInput, Guid clientPowerShellId, Guid clientRunspacePoolId, ServerRunspacePoolDriver runspacePoolDriver, HostInfo hostInfo, RemoteStreamOptions streamOptions, @@ -117,16 +117,16 @@ internal ServerSteppablePipelineDriver(PowerShell powershell, bool noInput, Guid /// Default constructor for creating ServerSteppablePipelineDriver...Used by server to concurrently /// run 2 pipelines. /// - /// decoded powershell object - /// whether there is input for this powershell - /// the client powershell id - /// the client runspacepool id + /// decoded powershell object. + /// whether there is input for this powershell. + /// the client powershell id. + /// the client runspacepool id. /// runspace pool driver /// which is creating this powershell driver - /// apartment state for this powershell + /// apartment state for this powershell. /// host info using which the host for /// this powershell will be constructed - /// serialization options for the streams in this powershell + /// serialization options for the streams in this powershell. /// /// true if the command is to be added to history list of the runspace. false, otherwise. /// @@ -137,7 +137,7 @@ internal ServerSteppablePipelineDriver(PowerShell powershell, bool noInput, Guid /// /// Steppable pipeline event subscriber /// - /// input collection of the PowerShell pipeline + /// input collection of the PowerShell pipeline. internal ServerSteppablePipelineDriver(PowerShell powershell, bool noInput, Guid clientPowerShellId, Guid clientRunspacePoolId, ServerRunspacePoolDriver runspacePoolDriver, ApartmentState apartmentState, HostInfo hostInfo, RemoteStreamOptions streamOptions, @@ -289,8 +289,8 @@ internal void Start() /// /// Close the input collection of the local powershell /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. internal void HandleInputEndReceived(object sender, EventArgs eventArgs) { Input.Complete(); @@ -316,8 +316,8 @@ private void HandleSessionConnected(object sender, EventArgs eventArgs) /// /// Handle a host message response received /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. internal void HandleHostResponseReceived(object sender, RemoteDataEventArgs eventArgs) { RemoteHost.ServerMethodExecutor.HandleRemoteHostResponseFromClient(eventArgs.Data); @@ -326,8 +326,8 @@ internal void HandleHostResponseReceived(object sender, RemoteDataEventArgs /// Stop the local powershell /// - /// sender of this event, unused - /// unused + /// sender of this event, unused. + /// unused. private void HandleStopReceived(object sender, EventArgs eventArgs) { lock (SyncObject) @@ -346,8 +346,8 @@ private void HandleStopReceived(object sender, EventArgs eventArgs) /// /// Add input to the local powershell's input collection /// - /// sender of this event, unused - /// arguments describing this event + /// sender of this event, unused. + /// arguments describing this event. private void HandleInputReceived(object sender, RemoteDataEventArgs eventArgs) { Dbg.Assert(!NoInput, "Input data should not be received for powershells created with no input"); @@ -524,4 +524,4 @@ internal void SetState(PSInvocationState newState, Exception reason) #endregion } -} \ No newline at end of file +} diff --git a/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineSubscriber.cs b/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineSubscriber.cs index 258879e3455..cb742b4c262 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineSubscriber.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineSubscriber.cs @@ -268,7 +268,7 @@ private void HandleProcessRecord(object sender, PSEventArgs args) /// /// Fires the start event /// - /// steppable pipeline driver + /// steppable pipeline driver. internal void FireStartSteppablePipeline(ServerSteppablePipelineDriver driver) { lock (_syncObject) @@ -284,7 +284,7 @@ internal void FireStartSteppablePipeline(ServerSteppablePipelineDriver driver) /// /// Fires the process record event /// - /// steppable pipeline driver + /// steppable pipeline driver. internal void FireHandleProcessRecord(ServerSteppablePipelineDriver driver) { lock (_syncObject) diff --git a/src/System.Management.Automation/engine/remoting/server/serverremotesession.cs b/src/System.Management.Automation/engine/remoting/server/serverremotesession.cs index 2d27075788d..29405b58888 100644 --- a/src/System.Management.Automation/engine/remoting/server/serverremotesession.cs +++ b/src/System.Management.Automation/engine/remoting/server/serverremotesession.cs @@ -175,7 +175,7 @@ internal ServerRemoteSession(PSSenderInfo senderInfo, /// xml. /// /// - /// Optional configuration endpoint name for OutOfProc sessions + /// Optional configuration endpoint name for OutOfProc sessions. /// /// /// InitialSessionState provider with does @@ -378,7 +378,7 @@ internal void DispatchInputQueueData(object sender, RemoteDataEventArgs dataEven /// Have received a public key from the other side /// Import or take other action based on the state /// - /// sender of this event, unused + /// sender of this event, unused. /// event arguments which contains the /// remote public key private void HandlePublicKeyReceived(object sender, RemoteDataEventArgs eventArgs) diff --git a/src/System.Management.Automation/engine/remoting/server/serverremotesessionstatemachine.cs b/src/System.Management.Automation/engine/remoting/server/serverremotesessionstatemachine.cs index ad4ea4fab9f..ac5303c590c 100644 --- a/src/System.Management.Automation/engine/remoting/server/serverremotesessionstatemachine.cs +++ b/src/System.Management.Automation/engine/remoting/server/serverremotesessionstatemachine.cs @@ -895,8 +895,8 @@ private void DoReceiveFailed(object sender, RemoteSessionStateMachineEventArgs f /// This method contains all the logic for handling the state machine /// for key exchange. All the different scenarios are covered in this /// - /// sender of this event, unused - /// event args + /// sender of this event, unused. + /// event args. private void DoKeyExchange(object sender, RemoteSessionStateMachineEventArgs eventArgs) { //There are corner cases with disconnect that can result in client receiving outdated key exchange packets @@ -979,7 +979,7 @@ private void DoKeyExchange(object sender, RemoteSessionStateMachineEventArgs eve /// /// Handles the timeout for key exchange /// - /// sender of this event + /// sender of this event. private void HandleKeyExchangeTimeout(object sender) { Dbg.Assert(_state == RemoteSessionState.EstablishedAndKeyRequested, "timeout should only happen when waiting for a key"); diff --git a/src/System.Management.Automation/engine/remoting/server/serverremotingprotocolimplementation.cs b/src/System.Management.Automation/engine/remoting/server/serverremotingprotocolimplementation.cs index a1590ba5320..8580f4bca20 100644 --- a/src/System.Management.Automation/engine/remoting/server/serverremotingprotocolimplementation.cs +++ b/src/System.Management.Automation/engine/remoting/server/serverremotingprotocolimplementation.cs @@ -113,7 +113,7 @@ internal override void SendRequestForPublicKey() /// /// Raise the public key received event /// - /// received data + /// received data. /// This method is a hook to be called /// from the transport manager internal override void RaiseKeyExchangeMessageReceived(RemoteDataObject receivedData) diff --git a/src/System.Management.Automation/engine/runtime/Binding/Binders.cs b/src/System.Management.Automation/engine/runtime/Binding/Binders.cs index 86baaf687db..cfb9dffde60 100644 --- a/src/System.Management.Automation/engine/runtime/Binding/Binders.cs +++ b/src/System.Management.Automation/engine/runtime/Binding/Binders.cs @@ -7252,7 +7252,7 @@ private static DynamicMetaObject GetTargetAsEnumerable(DynamicMetaObject target) return enumerableTarget; } - /// The target to operate against + /// The target to operate against. /// /// Arguments to the operator. The first argument must be either a scriptblock /// or a string representing a 'simple where' expression. The second is an enum that controls diff --git a/src/System.Management.Automation/engine/runtime/Operations/ArrayOps.cs b/src/System.Management.Automation/engine/runtime/Operations/ArrayOps.cs index d6a9bcad1e3..9e78e90c610 100644 --- a/src/System.Management.Automation/engine/runtime/Operations/ArrayOps.cs +++ b/src/System.Management.Automation/engine/runtime/Operations/ArrayOps.cs @@ -38,8 +38,8 @@ internal static object[] SlicingIndex(object target, object[] indexes, Func /// Efficiently multiplies collection by integer /// - /// collection to multiply - /// number of times the collection is to be multiplied/copied + /// collection to multiply. + /// number of times the collection is to be multiplied/copied. /// Collection multiplied by integer. internal static T[] Multiply(T[] array, uint times) { diff --git a/src/System.Management.Automation/engine/runtime/Operations/ClassOps.cs b/src/System.Management.Automation/engine/runtime/Operations/ClassOps.cs index c07058843fb..53d227fa970 100644 --- a/src/System.Management.Automation/engine/runtime/Operations/ClassOps.cs +++ b/src/System.Management.Automation/engine/runtime/Operations/ClassOps.cs @@ -224,8 +224,8 @@ private void PrepareScriptBlockToInvoke(object instance, object sessionStateInte /// /// - /// target object or null for static call - /// sessionStateInternal from private field of instance or null for static call + /// target object or null for static call. + /// sessionStateInternal from private field of instance or null for static call. /// public void InvokeHelper(object instance, object sessionStateInternal, object[] args) { @@ -247,8 +247,8 @@ public void InvokeHelper(object instance, object sessionStateInternal, object[] /// /// /// - /// target object or null for static call - /// sessionStateInternal from private field of instance or null for static call + /// target object or null for static call. + /// sessionStateInternal from private field of instance or null for static call. /// /// public T InvokeHelperT(object instance, object sessionStateInternal, object[] args) @@ -295,9 +295,9 @@ public static void ValidateSetProperty(Type type, string propertyName, object va /// /// Performs base ctor call as a method call. /// - /// object for invocation - /// ctor info for invocation - /// arguments for invocation + /// object for invocation. + /// ctor info for invocation. + /// arguments for invocation. [SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] public static void CallBaseCtor(object target, ConstructorInfo ci, object[] args) { @@ -307,9 +307,9 @@ public static void CallBaseCtor(object target, ConstructorInfo ci, object[] args /// /// Performs non-virtual method call with return value. Main usage: base class method call inside subclass method. /// - /// object for invocation - /// method info for invocation - /// arguments for invocation + /// object for invocation. + /// method info for invocation. + /// arguments for invocation. public static object CallMethodNonVirtually(object target, MethodInfo mi, object[] args) { return CallMethodNonVirtuallyImpl(target, mi, args); @@ -318,9 +318,9 @@ public static object CallMethodNonVirtually(object target, MethodInfo mi, object /// /// Performs non-virtual void method call. Main usage: base class method call inside subclass method. /// - /// object for invocation - /// method info for invocation - /// arguments for invocation + /// object for invocation. + /// method info for invocation. + /// arguments for invocation. public static void CallVoidMethodNonVirtually(object target, MethodInfo mi, object[] args) { CallMethodNonVirtuallyImpl(target, mi, args); @@ -336,9 +336,9 @@ public static void CallVoidMethodNonVirtually(object target, MethodInfo mi, obje /// /// Implementation of non-virtual method call. /// - /// object for invocation - /// method info for invocation - /// arguments for invocation + /// object for invocation. + /// method info for invocation. + /// arguments for invocation. private static object CallMethodNonVirtuallyImpl(object target, MethodInfo mi, object[] args) { DynamicMethod dm = s_nonVirtualCallCache.GetValue(mi, CreateDynamicMethod); diff --git a/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs b/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs index 07dd912f1e7..e280ab0f0f5 100644 --- a/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs +++ b/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs @@ -1753,9 +1753,9 @@ private static ActionPreference ProcessTraps(FunctionContext funcContext, /// /// Determine if we should continue or not after and error or exception.... /// - /// The RuntimeException which was reported - /// The message to display - /// The execution context + /// The RuntimeException which was reported. + /// The message to display. + /// The execution context. /// The preference the user selected. /// /// Error action is decided by error action preference. If preference is inquire, we will @@ -1779,7 +1779,7 @@ internal static ActionPreference QueryForAction(RuntimeException rte, string mes /// This is a helper function for prompting for user preference. /// /// - /// The execution context + /// The execution context. /// /// /// This method will allow user to enter suspend mode. @@ -1826,8 +1826,8 @@ internal static ActionPreference InquireForActionPreference(string message, Exec /// /// /// - /// The execution context - /// the output pipe of the statement + /// The execution context. + /// the output pipe of the statement. internal static void SetErrorVariables(IScriptExtent extent, RuntimeException rte, ExecutionContext context, Pipe outputPipe) { string stack = null; @@ -1874,8 +1874,8 @@ internal static bool NeedToQueryForActionPreference(RuntimeException rte, Execut /// Report error into error pipe. /// /// - /// The runtime error to report - /// The execution context + /// The runtime error to report. + /// The execution context. /// True if it was able to report the error. internal static bool ReportErrorRecord(IScriptExtent extent, RuntimeException rte, ExecutionContext context) { @@ -2451,7 +2451,7 @@ internal static class EnumerableOps /// /// Implements the Where(expression) operation on collections /// - /// The enumerator over the collection to search + /// The enumerator over the collection to search. /// /// A ScriptBlock where its result is treated as a boolean, or null to /// return all collection objects with WhereOperatorSelectionMode. @@ -2460,7 +2460,7 @@ internal static class EnumerableOps /// Sets the WhereOperatorSelectionMode for operator, defaults to All. /// This is of type object to allow either enum values or strings to be passed. /// - /// The number of elements to return + /// The number of elements to return. /// internal static object Where(IEnumerator enumerator, ScriptBlock expressionSB, WhereOperatorSelectionMode selectionMode, int numberToReturn) { @@ -2690,7 +2690,7 @@ internal static object Where(IEnumerator enumerator, ScriptBlock expressionSB, W /// /// Implements the ForEach() operator. /// - /// The collection to operate over + /// The collection to operate over. /// /// /// @@ -3268,9 +3268,9 @@ internal static IEnumerator GetGenericEnumerator(IEnumerable enumerable) /// A routine used to advance an enumerator and catch errors that might occur /// performing the operation /// - /// The execution context used to see if the pipeline is stopping + /// The execution context used to see if the pipeline is stopping. /// THe enumerator to advance. - /// An error occurred moving to the next element in the enumeration + /// An error occurred moving to the next element in the enumeration. /// True if the move succeeded. internal static bool MoveNext(ExecutionContext context, IEnumerator enumerator) { @@ -3304,7 +3304,7 @@ internal static bool MoveNext(ExecutionContext context, IEnumerator enumerator) /// /// Wrapper caller for enumerator.Current - handles and republishes errors... /// - /// The enumerator to read from + /// The enumerator to read from. /// internal static object Current(IEnumerator enumerator) { diff --git a/src/System.Management.Automation/engine/runtime/ScriptBlockToPowerShell.cs b/src/System.Management.Automation/engine/runtime/ScriptBlockToPowerShell.cs index f9b39cff49c..8b856fc4471 100644 --- a/src/System.Management.Automation/engine/runtime/ScriptBlockToPowerShell.cs +++ b/src/System.Management.Automation/engine/runtime/ScriptBlockToPowerShell.cs @@ -462,9 +462,9 @@ private static Tuple, object[]> GetUsingValues(Ast bo /// Note that the value of is retrieved by calling 'UsingExpressionAstSearcher.FindAllUsingExpressionExceptForWorkflow'. /// So is guaranteed not inside a workflow. /// - /// The UsingExpression to analyze - /// The top level Ast, should be either ScriptBlockAst or FunctionDefinitionAst - /// The ScriptBlockAst that represents the scope of the previously analyzed UsingExpressions + /// The UsingExpression to analyze. + /// The top level Ast, should be either ScriptBlockAst or FunctionDefinitionAst. + /// The ScriptBlockAst that represents the scope of the previously analyzed UsingExpressions. private static bool HasUsingExpressionsInDifferentScopes(UsingExpressionAst usingExpr, Ast topLevelParent, ref ScriptBlockAst sbClosestToPreviousUsingExpr) { Diagnostics.Assert(topLevelParent is ScriptBlockAst || topLevelParent is FunctionDefinitionAst, diff --git a/src/System.Management.Automation/engine/scriptparameterbinder.cs b/src/System.Management.Automation/engine/scriptparameterbinder.cs index 8dd08be1c04..f64dc3bdc0a 100644 --- a/src/System.Management.Automation/engine/scriptparameterbinder.cs +++ b/src/System.Management.Automation/engine/scriptparameterbinder.cs @@ -69,7 +69,7 @@ internal object CopyMutableValues(object o) /// /// The default value of the specified parameter. /// - /// see SessionStateInternal.GetVariableValue + /// see SessionStateInternal.GetVariableValue. internal override object GetDefaultParameterValue(string name) { RuntimeDefinedParameter runtimeDefinedParameter; diff --git a/src/System.Management.Automation/engine/serialization.cs b/src/System.Management.Automation/engine/serialization.cs index 8753a0ba224..d606a25bc53 100644 --- a/src/System.Management.Automation/engine/serialization.cs +++ b/src/System.Management.Automation/engine/serialization.cs @@ -87,7 +87,7 @@ internal PSSerializer() { } /// /// Serializes an object into PowerShell CliXml /// - /// The input object to serialize. Serializes to a default depth of 1 + /// The input object to serialize. Serializes to a default depth of 1. /// The serialized object, as CliXml. public static string Serialize(Object source) { @@ -97,8 +97,8 @@ public static string Serialize(Object source) /// /// Serializes an object into PowerShell CliXml /// - /// The input object to serialize - /// The depth of the members to serialize + /// The input object to serialize. + /// The depth of the members to serialize. /// The serialized object, as CliXml. public static string Serialize(Object source, int depth) { @@ -187,7 +187,7 @@ internal class Serializer /// /// Creates a Serializer using default serialization context /// - /// writer to be used for serialization + /// writer to be used for serialization. internal Serializer(XmlWriter writer) : this(writer, new SerializationContext()) { @@ -196,8 +196,8 @@ internal Serializer(XmlWriter writer) /// /// Creates a Serializer using specified serialization context /// - /// writer to be used for serialization - /// depth of serialization + /// writer to be used for serialization. + /// depth of serialization. /// /// if true then types.ps1xml can override depth /// for a particular types (using SerializationDepth property) @@ -210,8 +210,8 @@ internal Serializer(XmlWriter writer, int depth, bool useDepthFromTypes) /// /// Creates a Serializer using specified serialization context /// - /// writer to be used for serialization - /// serialization context + /// writer to be used for serialization. + /// serialization context. internal Serializer(XmlWriter writer, SerializationContext context) { if (writer == null) @@ -247,7 +247,7 @@ internal TypeTable TypeTable /// /// Serializes the object /// - /// object to be serialized + /// object to be serialized. /// /// Please note that this method shouldn't throw any exceptions. /// If it throws - please open a bug. @@ -461,7 +461,7 @@ internal class Deserializer /// /// Creates a Deserializer using default deserialization context /// - /// reader to be used for deserialization + /// reader to be used for deserialization. /// /// Thrown when the xml is in an incorrect format /// @@ -473,8 +473,8 @@ internal Deserializer(XmlReader reader) /// /// Creates a Deserializer using specified serialization context /// - /// reader to be used for deserialization - /// serialization context + /// reader to be used for deserialization. + /// serialization context. /// /// Thrown when the xml is in an incorrect format /// @@ -615,7 +615,7 @@ internal object Deserialize() /// /// Deserializes next object. /// - /// stream the object belongs to (i.e. "Error", "Output", etc.) + /// stream the object belongs to (i.e. "Error", "Output", etc.). /// /// Thrown when the xml is in an incorrect format /// @@ -1648,7 +1648,7 @@ private void PrepareCimInstanceForSerialization(PSObject psObject, CimInstance c /// /// /// if true, TypeName information is written, else not. - /// if not null then ToString information is written + /// if not null then ToString information is written. private void WriteStartOfPSObject ( PSObject mshObject, @@ -2100,7 +2100,7 @@ int depth /// /// Serializes IDictionary /// - /// dictionary which is serialized + /// dictionary which is serialized. /// /// private void WriteDictionary @@ -2251,7 +2251,7 @@ private string GetSerializationString(PSObject source) /// and returns true if this object should be serialized as /// string /// - /// PSObject to be serialized + /// PSObject to be serialized. /// True if the object needs to be serialized as a string. private bool SerializeAsString(PSObject source) { @@ -2277,8 +2277,8 @@ private bool SerializeAsString(PSObject source) /// /// compute the serialization depth for an PSObject instance subtree /// - /// PSObject whose serialization depth has to be computed - /// current depth + /// PSObject whose serialization depth has to be computed. + /// current depth. /// private int GetDepthOfSerialization(object source, int depth) { @@ -2370,9 +2370,9 @@ private void WriteNull(string streamName, string property) /// /// The serializer to which the object is serialized. /// name of the stream to write. Do not write if null. - /// name of property. Pass null for item - /// string to write - /// serialization information + /// name of property. Pass null for item. + /// string to write. + /// serialization information. private static void WriteRawString ( InternalSerializer serializer, @@ -2410,9 +2410,9 @@ TypeSerializationInfo entry /// /// The serializer to which the object is serialized. /// - /// name of property. Pass null for item - /// object to be written - /// serialization information about source + /// name of property. Pass null for item. + /// object to be written. + /// serialization information about source. private static void WriteOnePrimitiveKnownType ( InternalSerializer serializer, @@ -2445,9 +2445,9 @@ TypeSerializationInfo entry /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// DateTime to write - /// serialization information about source + /// name of property. pass null for item. + /// DateTime to write. + /// serialization information about source. internal static void WriteDateTime(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2462,9 +2462,9 @@ internal static void WriteDateTime(InternalSerializer serializer, string streamN /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// Version to write - /// serialization information about source + /// name of property. pass null for item. + /// Version to write. + /// serialization information about source. internal static void WriteVersion(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2480,9 +2480,9 @@ internal static void WriteVersion(InternalSerializer serializer, string streamNa /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// Version to write - /// serialization information about source + /// name of property. pass null for item. + /// Version to write. + /// serialization information about source. internal static void WriteSemanticVersion(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2498,9 +2498,9 @@ internal static void WriteSemanticVersion(InternalSerializer serializer, string /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// scriptblock to write - /// serialization information about source + /// name of property. pass null for item. + /// scriptblock to write. + /// serialization information about source. internal static void WriteScriptBlock(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2516,9 +2516,9 @@ internal static void WriteScriptBlock(InternalSerializer serializer, string stre /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// URI to write - /// serialization information about source + /// name of property. pass null for item. + /// URI to write. + /// serialization information about source. internal static void WriteUri(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2534,9 +2534,9 @@ internal static void WriteUri(InternalSerializer serializer, string streamName, /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// string to write - /// serialization information about source + /// name of property. pass null for item. + /// string to write. + /// serialization information about source. internal static void WriteEncodedString(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2575,9 +2575,9 @@ internal static void WriteEncodedString(InternalSerializer serializer, string st /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// Double to write - /// serialization information about source + /// name of property. pass null for item. + /// Double to write. + /// serialization information about source. internal static void WriteDouble(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2592,9 +2592,9 @@ internal static void WriteDouble(InternalSerializer serializer, string streamNam /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// Char to write - /// serialization information about source + /// name of property. pass null for item. + /// Char to write. + /// serialization information about source. internal static void WriteChar(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2610,9 +2610,9 @@ internal static void WriteChar(InternalSerializer serializer, string streamName, /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// Boolean to write - /// serialization information about source + /// name of property. pass null for item. + /// Boolean to write. + /// serialization information about source. internal static void WriteBoolean(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2627,9 +2627,9 @@ internal static void WriteBoolean(InternalSerializer serializer, string streamNa /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// single to write - /// serialization information about source + /// name of property. pass null for item. + /// single to write. + /// serialization information about source. internal static void WriteSingle(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2644,9 +2644,9 @@ internal static void WriteSingle(InternalSerializer serializer, string streamNam /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// DateTime to write - /// serialization information about source + /// name of property. pass null for item. + /// DateTime to write. + /// serialization information about source. internal static void WriteTimeSpan(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2661,9 +2661,9 @@ internal static void WriteTimeSpan(InternalSerializer serializer, string streamN /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item - /// bytearray to write - /// serialization information about source + /// name of property. pass null for item. + /// bytearray to write. + /// serialization information about source. internal static void WriteByteArray(InternalSerializer serializer, string streamName, string property, object source, TypeSerializationInfo entry) { Dbg.Assert(serializer != null, "caller should have validated the information"); @@ -2746,7 +2746,7 @@ internal static void WriteSecureString(InternalSerializer serializer, string str /// /// Writes start element in Monad namespace /// - /// tag of element + /// tag of element. private void WriteStartElement(string elementTag) { Dbg.Assert(!string.IsNullOrEmpty(elementTag), "Caller should validate the parameter"); @@ -2763,8 +2763,8 @@ private void WriteStartElement(string elementTag) /// /// Writes attribute in monad namespace /// - /// name of attribute - /// value of attribute + /// name of attribute. + /// value of attribute. private void WriteAttribute(string name, string value) { Dbg.Assert(!string.IsNullOrEmpty(name), "Caller should validate the parameter"); @@ -2783,7 +2783,7 @@ private void WriteNameAttribute(string value) /// /// Encodes the string to escape characters which would make XmlWriter.WriteString throw an exception. /// - /// string to encode + /// string to encode. /// Encoded string. /// /// Output from this method can be reverted using XmlConvert.DecodeName method @@ -2830,8 +2830,8 @@ internal static string EncodeString(string s) /// This is the real workhorse that encodes strings. /// See for more information. /// - /// string to encode - /// indexOfFirstEncodableCharacter + /// string to encode. + /// indexOfFirstEncodableCharacter. /// Encoded string. private static string EncodeString(string s, int indexOfFirstEncodableCharacter) { @@ -4748,7 +4748,7 @@ private bool IsNextElement(string tag) /// /// Read start element in monad namespace /// - /// element tag to read + /// element tag to read. /// True if not an empty element else false. internal bool ReadStartElementAndHandleEmpty(string element) { @@ -4957,7 +4957,7 @@ internal ReferenceIdHandlerForSerializer(IDictionary dictionary) /// /// Assigns a RefId to the given object /// - /// object to assign a RefId to + /// object to assign a RefId to. /// RefId assigned to the object. internal string SetRefId(T t) { @@ -5040,11 +5040,11 @@ internal class TypeSerializationInfo /// /// Constructor /// - /// Type for which this entry is created - /// ItemTag for the type - /// PropertyTag for the type - /// TypeSerializerDelegate for serializing the type - /// TypeDeserializerDelegate for deserializing the type + /// Type for which this entry is created. + /// ItemTag for the type. + /// PropertyTag for the type. + /// TypeSerializerDelegate for serializing the type. + /// TypeDeserializerDelegate for deserializing the type. internal TypeSerializationInfo(Type type, string itemTag, string propertyTag, TypeSerializerDelegate serializer, TypeDeserializerDelegate deserializer) { Type = type; @@ -5110,7 +5110,7 @@ static KnownTypes() /// /// Gets the type serialization information about a type /// - /// Type for which information is retrieved + /// Type for which information is retrieved. /// TypeSerializationInfo for the type, null if it doesn't exist. internal static TypeSerializationInfo GetTypeSerializationInfo(Type type) { @@ -5126,7 +5126,7 @@ internal static TypeSerializationInfo GetTypeSerializationInfo(Type type) /// /// Get TypeSerializationInfo using ItemTag as key /// - /// ItemTag for which TypeSerializationInfo is to be fetched + /// ItemTag for which TypeSerializationInfo is to be fetched. /// TypeSerializationInfo entry, null if no entry exist for the tag. internal static TypeSerializationInfo GetTypeSerializationInfoFromItemTag(string itemTag) { @@ -6027,8 +6027,8 @@ private void VerifyValue(object value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. /// /// This method will throw if the is not a string and the /// is not one of primitive types that will work during PowerShell remoting handshake. @@ -6044,7 +6044,7 @@ public override void Add(object key, object value) /// /// Gets or sets the value associated with the specified key. /// - /// The key whose value to get or set + /// The key whose value to get or set. /// The value associated with the specified key. /// /// If the specified key is not found, attempting to get it returns null @@ -6073,7 +6073,7 @@ public override object this[object key] /// /// Gets or sets the value associated with the specified key. /// - /// The key whose value to get or set + /// The key whose value to get or set. /// The value associated with the specified key. /// /// If the specified key is not found, attempting to get it returns null @@ -6114,8 +6114,8 @@ public override object Clone() /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Boolean value) { this.Add((object)key, (object)value); @@ -6124,8 +6124,8 @@ public void Add(string key, Boolean value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Boolean[] value) { this.Add((object)key, (object)value); @@ -6134,8 +6134,8 @@ public void Add(string key, Boolean[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Byte value) { this.Add((object)key, (object)value); @@ -6144,8 +6144,8 @@ public void Add(string key, Byte value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, byte[] value) { this.Add((object)key, (object)value); @@ -6154,8 +6154,8 @@ public void Add(string key, byte[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Char value) { this.Add((object)key, (object)value); @@ -6164,8 +6164,8 @@ public void Add(string key, Char value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Char[] value) { this.Add((object)key, (object)value); @@ -6174,8 +6174,8 @@ public void Add(string key, Char[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, DateTime value) { this.Add((object)key, (object)value); @@ -6184,8 +6184,8 @@ public void Add(string key, DateTime value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, DateTime[] value) { this.Add((object)key, (object)value); @@ -6194,8 +6194,8 @@ public void Add(string key, DateTime[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Decimal value) { this.Add((object)key, (object)value); @@ -6204,8 +6204,8 @@ public void Add(string key, Decimal value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Decimal[] value) { this.Add((object)key, (object)value); @@ -6214,8 +6214,8 @@ public void Add(string key, Decimal[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Double value) { this.Add((object)key, (object)value); @@ -6224,8 +6224,8 @@ public void Add(string key, Double value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Double[] value) { this.Add((object)key, (object)value); @@ -6234,8 +6234,8 @@ public void Add(string key, Double[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Guid value) { this.Add((object)key, (object)value); @@ -6244,8 +6244,8 @@ public void Add(string key, Guid value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Guid[] value) { this.Add((object)key, (object)value); @@ -6254,8 +6254,8 @@ public void Add(string key, Guid[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Int32 value) { this.Add((object)key, (object)value); @@ -6264,8 +6264,8 @@ public void Add(string key, Int32 value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Int32[] value) { this.Add((object)key, (object)value); @@ -6274,8 +6274,8 @@ public void Add(string key, Int32[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Int64 value) { this.Add((object)key, (object)value); @@ -6284,8 +6284,8 @@ public void Add(string key, Int64 value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Int64[] value) { this.Add((object)key, (object)value); @@ -6294,8 +6294,8 @@ public void Add(string key, Int64[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, SByte value) { this.Add((object)key, (object)value); @@ -6304,8 +6304,8 @@ public void Add(string key, SByte value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, SByte[] value) { this.Add((object)key, (object)value); @@ -6314,8 +6314,8 @@ public void Add(string key, SByte[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Single value) { this.Add((object)key, (object)value); @@ -6324,8 +6324,8 @@ public void Add(string key, Single value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Single[] value) { this.Add((object)key, (object)value); @@ -6334,8 +6334,8 @@ public void Add(string key, Single[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, String value) { this.Add((object)key, (object)value); @@ -6344,8 +6344,8 @@ public void Add(string key, String value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, String[] value) { this.Add((object)key, (object)value); @@ -6354,8 +6354,8 @@ public void Add(string key, String[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, TimeSpan value) { this.Add((object)key, (object)value); @@ -6364,8 +6364,8 @@ public void Add(string key, TimeSpan value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, TimeSpan[] value) { this.Add((object)key, (object)value); @@ -6374,8 +6374,8 @@ public void Add(string key, TimeSpan[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, UInt16 value) { this.Add((object)key, (object)value); @@ -6384,8 +6384,8 @@ public void Add(string key, UInt16 value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, UInt16[] value) { this.Add((object)key, (object)value); @@ -6394,8 +6394,8 @@ public void Add(string key, UInt16[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, UInt32 value) { this.Add((object)key, (object)value); @@ -6404,8 +6404,8 @@ public void Add(string key, UInt32 value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, UInt32[] value) { this.Add((object)key, (object)value); @@ -6414,8 +6414,8 @@ public void Add(string key, UInt32[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, UInt64 value) { this.Add((object)key, (object)value); @@ -6424,8 +6424,8 @@ public void Add(string key, UInt64 value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, UInt64[] value) { this.Add((object)key, (object)value); @@ -6434,8 +6434,8 @@ public void Add(string key, UInt64[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Uri value) { this.Add((object)key, (object)value); @@ -6444,8 +6444,8 @@ public void Add(string key, Uri value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Uri[] value) { this.Add((object)key, (object)value); @@ -6454,8 +6454,8 @@ public void Add(string key, Uri[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Version value) { this.Add((object)key, (object)value); @@ -6464,8 +6464,8 @@ public void Add(string key, Version value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, Version[] value) { this.Add((object)key, (object)value); @@ -6474,8 +6474,8 @@ public void Add(string key, Version[] value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, PSPrimitiveDictionary value) { this.Add((object)key, (object)value); @@ -6484,8 +6484,8 @@ public void Add(string key, PSPrimitiveDictionary value) /// /// Adds an element with the specified key and value into the Hashtable /// - /// The key of the element to add - /// The value of the element to add + /// The key of the element to add. + /// The value of the element to add. public void Add(string key, PSPrimitiveDictionary[] value) { this.Add((object)key, (object)value); @@ -6535,9 +6535,9 @@ internal static PSPrimitiveDictionary CloneAndAddPSVersionTable(PSPrimitiveDicti /// TryPathGet<string>($sessionInfo.ApplicationPrivateData, out myHash, "ImplicitRemoting", "Hash"). /// /// Expected type of the value - /// The root dictionary + /// The root dictionary. /// - /// A chain of keys leading from the root dictionary () to the value + /// A chain of keys leading from the root dictionary () to the value. /// true if the value was found and was of the correct type; false otherwise. internal static bool TryPathGet(IDictionary data, out T result, params string[] keys) { @@ -6663,8 +6663,8 @@ static DeserializingTypeConverter() /// /// Determines if the converter can convert the parameter to the parameter. /// - /// The value to convert from - /// The type to convert to + /// The value to convert from. + /// The type to convert to. /// True if the converter can convert the parameter to the parameter, otherwise false. public override bool CanConvertFrom(PSObject sourceValue, Type destinationType) { @@ -6682,12 +6682,12 @@ public override bool CanConvertFrom(PSObject sourceValue, Type destinationType) /// /// Converts the parameter to the parameter using formatProvider and ignoreCase /// - /// The value to convert from - /// The type to convert to - /// The format provider to use like in IFormattable's ToString - /// true if case should be ignored + /// The value to convert from. + /// The type to convert to. + /// The format provider to use like in IFormattable's ToString. + /// true if case should be ignored. /// The parameter converted to the parameter using formatProvider and ignoreCase. - /// if no conversion was possible + /// if no conversion was possible. public override object ConvertFrom(PSObject sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { if (destinationType == null) @@ -6759,8 +6759,8 @@ private static object ConvertFrom(PSObject o, Func converter) /// /// Returns true if the converter can convert the parameter to the parameter /// - /// The value to convert from - /// The type to convert to + /// The value to convert from. + /// The type to convert to. /// True if the converter can convert the parameter to the parameter, otherwise false. public override bool CanConvertTo(object sourceValue, Type destinationType) { @@ -6770,12 +6770,12 @@ public override bool CanConvertTo(object sourceValue, Type destinationType) /// /// Converts the parameter to the parameter using formatProvider and ignoreCase /// - /// The value to convert from - /// The type to convert to - /// The format provider to use like in IFormattable's ToString - /// true if case should be ignored + /// The value to convert from. + /// The type to convert to. + /// The format provider to use like in IFormattable's ToString. + /// true if case should be ignored. /// SourceValue converted to the parameter using formatProvider and ignoreCase. - /// if no conversion was possible + /// if no conversion was possible. public override object ConvertTo(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { throw PSTraceSource.NewNotSupportedException(); @@ -6833,8 +6833,8 @@ internal enum RehydrationFlags /// Can throw any exception (which is ok - LanguagePrimitives.ConvertTo will catch that). /// /// Expected type of the property - /// Deserialized object - /// Property name + /// Deserialized object. + /// Property name. /// private static T GetPropertyValue(PSObject pso, string propertyName) { @@ -6845,8 +6845,8 @@ private static T GetPropertyValue(PSObject pso, string propertyName) /// Gets value of a property. Can throw any exception (which is ok - LanguagePrimitives.ConvertTo will catch that). /// /// Expected type of the property - /// Deserialized object - /// Property name + /// Deserialized object. + /// Property name. /// /// internal static T GetPropertyValue(PSObject pso, string propertyName, RehydrationFlags flags) diff --git a/src/System.Management.Automation/help/AliasHelpProvider.cs b/src/System.Management.Automation/help/AliasHelpProvider.cs index 059aa803a32..31e269d77ec 100644 --- a/src/System.Management.Automation/help/AliasHelpProvider.cs +++ b/src/System.Management.Automation/help/AliasHelpProvider.cs @@ -90,7 +90,7 @@ internal override HelpCategory HelpCategory /// a. use _commandDiscovery object to retrieve AliasInfo object. /// b. Create AliasHelpInfo object based on AliasInfo object /// - /// help request object + /// help request object. /// Help info found. internal override IEnumerable ExactMatchHelp(HelpRequest helpRequest) { @@ -126,7 +126,7 @@ internal override IEnumerable ExactMatchHelp(HelpRequest helpRequest) /// a. use _sessionState object to get a list of alias that match the target. /// b. for each alias, retrieve help info as in ExactMatchHelp. /// - /// help request object + /// help request object. /// /// If true, searches for pattern in the help content. Individual /// provider can decide which content to search in. diff --git a/src/System.Management.Automation/help/BaseCommandHelpInfo.cs b/src/System.Management.Automation/help/BaseCommandHelpInfo.cs index ed28836e10a..a420253cbc9 100644 --- a/src/System.Management.Automation/help/BaseCommandHelpInfo.cs +++ b/src/System.Management.Automation/help/BaseCommandHelpInfo.cs @@ -372,7 +372,7 @@ internal override bool MatchPatternInContent(WildcardPattern pattern) /// /// Returns help information for a parameter(s) identified by pattern /// - /// pattern to search for parameters + /// pattern to search for parameters. /// A collection of parameters that match pattern. internal override PSObject[] GetParameter(string pattern) { diff --git a/src/System.Management.Automation/help/CabinetAPI.cs b/src/System.Management.Automation/help/CabinetAPI.cs index 150ff94ce69..544550050a3 100644 --- a/src/System.Management.Automation/help/CabinetAPI.cs +++ b/src/System.Management.Automation/help/CabinetAPI.cs @@ -14,9 +14,9 @@ internal abstract class ICabinetExtractor : IDisposable /// /// Extracts a cabinet file /// - /// cabinet file name - /// cabinet directory name, must be back slash terminated - /// destination directory name, must be back slash terminated + /// cabinet file name. + /// cabinet directory name, must be back slash terminated. + /// destination directory name, must be back slash terminated. internal abstract bool Extract(string cabinetName, string srcPath, string destPath); #region IDisposable Interface @@ -117,9 +117,9 @@ internal sealed class EmptyCabinetExtractor : ICabinetExtractor /// /// Extracts a cabinet file /// - /// cabinet file name - /// cabinet directory name, must be back slash terminated - /// destination directory name, must be back slash terminated + /// cabinet file name. + /// cabinet directory name, must be back slash terminated. + /// destination directory name, must be back slash terminated. internal override bool Extract(string cabinetName, string srcPath, string destPath) { // its intentional that this method has no definition diff --git a/src/System.Management.Automation/help/CabinetNativeApi.cs b/src/System.Management.Automation/help/CabinetNativeApi.cs index dc259a319a1..cf7dfaa394c 100644 --- a/src/System.Management.Automation/help/CabinetNativeApi.cs +++ b/src/System.Management.Automation/help/CabinetNativeApi.cs @@ -451,7 +451,7 @@ internal static SeekOrigin ConvertOriginToSeekOrigin(int origin) /// /// Converts an unmanaged define into a known managed type. /// - /// Operation mode defined in fcntl.h + /// Operation mode defined in fcntl.h. /// The appropriate System.IO.FileMode type. internal static FileMode ConvertOpflagToFileMode(int oflag) { @@ -490,7 +490,7 @@ internal static FileMode ConvertOpflagToFileMode(int oflag) /// /// Converts an unmanaged define into a known managed type. /// - /// Permission mode defined in stat.h + /// Permission mode defined in stat.h. /// The appropriate System.IO.FileAccess type. internal static FileAccess ConvertPermissionModeToFileAccess(int pmode) { @@ -517,7 +517,7 @@ internal static FileAccess ConvertPermissionModeToFileAccess(int pmode) /// /// Converts an unmanaged define into a known managed type. /// - /// Permission mode defined in stat.h + /// Permission mode defined in stat.h. /// The appropriate System.IO.FileShare type. internal static FileShare ConvertPermissionModeToFileShare(int pmode) { @@ -628,15 +628,15 @@ protected override bool ReleaseHandle() /// /// Creates an FDI context /// - /// _In_ PFNALLOC - Memory allocation delegate - /// _In_ PFNFREE - Memory free delegate - /// _In_ PFNOPEN - File open delegate - /// _In_ PFNREAD - File read delegate - /// _In_ PFNWRITE - File write delegate - /// _In_ PFNCLOSE - File close delegate - /// _In_ PFNSEEK - File seek delegate - /// _In_ int - CPU type - /// _Inout_ PERF - Error structure containing error information + /// _In_ PFNALLOC - Memory allocation delegate. + /// _In_ PFNFREE - Memory free delegate. + /// _In_ PFNOPEN - File open delegate. + /// _In_ PFNREAD - File read delegate. + /// _In_ PFNWRITE - File write delegate. + /// _In_ PFNCLOSE - File close delegate. + /// _In_ PFNSEEK - File seek delegate. + /// _In_ int - CPU type. + /// _Inout_ PERF - Error structure containing error information. /// [DllImport("cabinet.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl, SetLastError = true)] internal static extern FdiContextHandle FDICreate( @@ -653,13 +653,13 @@ internal static extern FdiContextHandle FDICreate( /// /// Extracts files from cabinets /// - /// _In_ HFDI - A valid FDI context handle returned by FDICreate - /// _In_ LPSTR - The name of the cabinet file - /// _In_ LPSTR - The path to the cabinet file excluding the file name - /// _In_ int - Not defined - /// _In_ PFNFDINOTIFY - Pointer to the notification callback delegate - /// _In_ PFNFDIDECRYPT - Not used - /// _In_opt_ void FAR * - Path string passed to the notification function + /// _In_ HFDI - A valid FDI context handle returned by FDICreate. + /// _In_ LPSTR - The name of the cabinet file. + /// _In_ LPSTR - The path to the cabinet file excluding the file name. + /// _In_ int - Not defined. + /// _In_ PFNFDINOTIFY - Pointer to the notification callback delegate. + /// _In_ PFNFDIDECRYPT - Not used. + /// _In_opt_ void FAR * - Path string passed to the notification function. /// [DllImport("cabinet.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl, SetLastError = true, BestFitMapping = false)] internal static extern bool FDICopy( @@ -674,7 +674,7 @@ internal static extern bool FDICopy( /// /// Deletes an open FDI context /// - /// _In_ HFDI - The FDI context handle to destroy + /// _In_ HFDI - The FDI context handle to destroy. /// [DllImport("cabinet.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl, SetLastError = true)] internal static extern bool FDIDestroy( diff --git a/src/System.Management.Automation/help/CommandHelpProvider.cs b/src/System.Management.Automation/help/CommandHelpProvider.cs index 81e886d0121..8ee1b6022bd 100644 --- a/src/System.Management.Automation/help/CommandHelpProvider.cs +++ b/src/System.Management.Automation/help/CommandHelpProvider.cs @@ -420,7 +420,7 @@ private HelpInfo GetHelpInfo(CommandInfo commandInfo, bool reportErrors, bool se /// help item. Forcing each ExactMatchHelp to go through command discovery /// will make sure helpInfo for invalid command will not be returned. /// - /// help request object + /// help request object. /// internal override IEnumerable ExactMatchHelp(HelpRequest helpRequest) { @@ -778,7 +778,7 @@ private void ProcessUserDefinedHelpData(string mshSnapInId, UserDefinedHelpData /// /// Gets the HelpInfo object corresponding to the command. /// - /// help file identifier (either name of PSSnapIn or simply full path to help file) + /// help file identifier (either name of PSSnapIn or simply full path to help file). /// Name of the command. /// /// HelpInfo object. @@ -807,7 +807,7 @@ private HelpInfo GetFromCommandCache(string helpFileIdentifier, string commandNa /// /// Gets the HelpInfo object corresponding to the CommandInfo. /// - /// help file identifier (simply full path to help file) + /// help file identifier (simply full path to help file). /// /// HelpInfo object. private HelpInfo GetFromCommandCache(string helpFileIdentifier, CommandInfo commandInfo) @@ -1002,7 +1002,7 @@ internal static bool IsMamlHelp(string helpFile, XmlNode helpItemsNode) /// /// Search help for a specific target. /// - /// help request object + /// help request object. /// /// If true, searches for pattern in the help content of all cmdlets. /// Otherwise, searches for pattern in the cmdlet names. @@ -1247,8 +1247,8 @@ private static bool Match(string target, ICollection patterns) /// Process helpInfo forwarded over from other other providers, specificly AliasHelpProvider. /// This can return more than 1 helpinfo object. /// - /// HelpInfo that is forwarded over - /// Help request object + /// HelpInfo that is forwarded over. + /// Help request object. /// The result helpInfo objects after processing. internal override IEnumerable ProcessForwardedHelp(HelpInfo helpInfo, HelpRequest helpRequest) { diff --git a/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs b/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs index 56c1dfc36b2..7e1e721b6ee 100644 --- a/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs +++ b/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs @@ -46,7 +46,7 @@ internal class DefaultCommandHelpObjectBuilder /// /// Generates a HelpInfo PSObject from a CmdletInfo object /// - /// command info + /// command info. /// HelpInfo PSObject. internal static PSObject GetPSObjectFromCmdletInfo(CommandInfo input) { @@ -150,12 +150,12 @@ internal static PSObject GetPSObjectFromCmdletInfo(CommandInfo input) /// /// Adds the details properties /// - /// HelpInfo object - /// command name - /// command noun - /// command verb - /// type name for help - /// synopsis + /// HelpInfo object. + /// command name. + /// command noun. + /// command verb. + /// type name for help. + /// synopsis. internal static void AddDetailsProperties(PSObject obj, string name, string noun, string verb, string typeNameForHelp, string synopsis = null) { @@ -184,11 +184,11 @@ internal static void AddDetailsProperties(PSObject obj, string name, string noun /// /// Adds the syntax properties /// - /// HelpInfo object - /// command name - /// parameter sets - /// common parameters - /// type name for help + /// HelpInfo object. + /// command name. + /// parameter sets. + /// common parameters. + /// type name for help. internal static void AddSyntaxProperties(PSObject obj, string cmdletName, ReadOnlyCollection parameterSets, bool common, string typeNameForHelp) { PSObject mshObject = new PSObject(); @@ -204,11 +204,11 @@ internal static void AddSyntaxProperties(PSObject obj, string cmdletName, ReadOn /// /// Add the syntax item properties /// - /// HelpInfo object - /// cmdlet name, you can't get this from parameterSets - /// a collection of parameter sets - /// common parameters - /// type name for help + /// HelpInfo object. + /// cmdlet name, you can't get this from parameterSets. + /// a collection of parameter sets. + /// common parameters. + /// type name for help. private static void AddSyntaxItemProperties(PSObject obj, string cmdletName, ReadOnlyCollection parameterSets, bool common, string typeNameForHelp) { ArrayList mshObjects = new ArrayList(); @@ -241,15 +241,15 @@ private static void AddSyntaxItemProperties(PSObject obj, string cmdletName, Rea /// /// Add the syntax parameters properties (these parameters are used to create the syntax section) /// - /// HelpInfo object + /// HelpInfo object. /// /// a collection of parameters in display order /// ie., Positional followed by /// Named Mandatory (in alpha numeric) followed by /// Named (in alpha numeric) /// - /// common parameters - /// Name of the parameter set for which the syntax is generated + /// common parameters. + /// Name of the parameter set for which the syntax is generated. private static void AddSyntaxParametersProperties(PSObject obj, IEnumerable parameters, bool common, string parameterSetName) { @@ -334,8 +334,8 @@ private static void AddSyntaxParametersProperties(PSObject obj, IEnumerable /// Adds a parameter value group (for enums) /// - /// object - /// parameter group values + /// object. + /// parameter group values. private static void AddParameterValueGroupProperties(PSObject obj, string[] values) { PSObject paramValueGroup = new PSObject(); @@ -352,10 +352,10 @@ private static void AddParameterValueGroupProperties(PSObject obj, string[] valu /// /// Add the parameters properties (these parameters are used to create the parameters section) /// - /// HelpInfo object - /// parameters - /// common parameters - /// type name for help + /// HelpInfo object. + /// parameters. + /// common parameters. + /// type name for help. internal static void AddParametersProperties(PSObject obj, Dictionary parameters, bool common, string typeNameForHelp) { PSObject paramsObject = new PSObject(); @@ -402,13 +402,13 @@ internal static void AddParametersProperties(PSObject obj, Dictionary /// Adds the parameter properties /// - /// HelpInfo object - /// parameter name - /// parameter aliases + /// HelpInfo object. + /// parameter name. + /// parameter aliases. /// is dynamic parameter? - /// parameter type - /// parameter attributes - /// Name of the parameter set for which the syntax is generated + /// parameter type. + /// parameter attributes. + /// Name of the parameter set for which the syntax is generated. private static void AddParameterProperties(PSObject obj, string name, Collection aliases, bool dynamic, Type type, Collection attributes, string parameterSetName = null) { @@ -522,9 +522,9 @@ private static void AddParameterProperties(PSObject obj, string name, Collection /// /// Adds the parameterType properties /// - /// HelpInfo object - /// the type of a parameter - /// the attributes of the parameter (needed to look for PSTypeName) + /// HelpInfo object. + /// the type of a parameter. + /// the attributes of the parameter (needed to look for PSTypeName). private static void AddParameterTypeProperties(PSObject obj, Type parameterType, IEnumerable attributes) { PSObject mshObject = new PSObject(); @@ -541,9 +541,9 @@ private static void AddParameterTypeProperties(PSObject obj, Type parameterType, /// /// Adds the parameterValue properties /// - /// HelpInfo object - /// the type of a parameter - /// the attributes of the parameter (needed to look for PSTypeName) + /// HelpInfo object. + /// the type of a parameter. + /// the attributes of the parameter (needed to look for PSTypeName). private static void AddParameterValueProperties(PSObject obj, Type parameterType, IEnumerable attributes) { PSObject mshObject; @@ -570,8 +570,8 @@ private static void AddParameterValueProperties(PSObject obj, Type parameterType /// /// Adds the InputTypes properties /// - /// HelpInfo object - /// command parameters + /// HelpInfo object. + /// command parameters. internal static void AddInputTypesProperties(PSObject obj, Dictionary parameters) { Collection inputs = new Collection(); @@ -633,8 +633,8 @@ internal static void AddInputTypesProperties(PSObject obj, Dictionary /// Adds the OutputTypes properties /// - /// HelpInfo object - /// output types + /// HelpInfo object. + /// output types. private static void AddOutputTypesProperties(PSObject obj, ReadOnlyCollection outputTypes) { PSObject returnValuesObj = new PSObject(); @@ -676,9 +676,9 @@ private static void AddOutputTypesProperties(PSObject obj, ReadOnlyCollection /// Adds the aliases properties /// - /// HelpInfo object - /// command name - /// execution context + /// HelpInfo object. + /// command name. + /// execution context. private static void AddAliasesProperties(PSObject obj, string name, ExecutionContext context) { StringBuilder sb = new StringBuilder(); @@ -705,7 +705,7 @@ private static void AddAliasesProperties(PSObject obj, string name, ExecutionCon /// /// Adds the remarks properties /// - /// HelpInfo object + /// HelpInfo object. /// /// private static void AddRemarksProperties(PSObject obj, string cmdletName, string helpUri) @@ -778,7 +778,7 @@ internal static void AddRelatedLinksProperties(PSObject obj, string relatedLink) /// /// Gets the parameter attribute from parameter metadata /// - /// parameter attributes + /// parameter attributes. /// Parameter attributes. private static Collection GetParameterAttribute(Collection attributes) { @@ -800,7 +800,7 @@ private static Collection GetParameterAttribute(Collection /// Gets the validate set attribute from parameter metadata /// - /// parameter attributes + /// parameter attributes. /// Parameter attributes. private static Collection GetValidateSetAttribute(Collection attributes) { @@ -822,7 +822,7 @@ private static Collection GetValidateSetAttribute(Collecti /// /// Gets the pipeline input type /// - /// parameter attribute + /// parameter attribute. /// Pipeline input type. private static string GetPipelineInputString(ParameterAttribute paramAttrib) { @@ -873,7 +873,7 @@ private static string GetPipelineInputString(ParameterAttribute paramAttrib) /// /// Checks if a set of parameters contains any of the common parameters /// - /// parameters to check + /// parameters to check. /// True if it contains common parameters, false otherwise. internal static bool HasCommonParameters(Dictionary parameters) { diff --git a/src/System.Management.Automation/help/DefaultHelpProvider.cs b/src/System.Management.Automation/help/DefaultHelpProvider.cs index ac2f0df4bbc..ee594ea79b3 100644 --- a/src/System.Management.Automation/help/DefaultHelpProvider.cs +++ b/src/System.Management.Automation/help/DefaultHelpProvider.cs @@ -51,7 +51,7 @@ internal override HelpCategory HelpCategory /// /// - /// help request object + /// help request object. /// internal override IEnumerable ExactMatchHelp(HelpRequest helpRequest) { diff --git a/src/System.Management.Automation/help/DscResourceHelpProvider.cs b/src/System.Management.Automation/help/DscResourceHelpProvider.cs index b5f4f574bbb..7eff5434237 100644 --- a/src/System.Management.Automation/help/DscResourceHelpProvider.cs +++ b/src/System.Management.Automation/help/DscResourceHelpProvider.cs @@ -227,7 +227,7 @@ private HelpInfo GetHelpInfoFromHelpFile(DscResourceInfo resourceInfo, string he /// /// Gets the HelpInfo object corresponding to the command. /// - /// help file identifier (either name of PSSnapIn or simply full path to help file) + /// help file identifier (either name of PSSnapIn or simply full path to help file). /// Help Category for search. /// HelpInfo object. private HelpInfo GetFromResourceHelpCache(string helpFileIdentifier, HelpCategory helpCategory) diff --git a/src/System.Management.Automation/help/HelpCategoryInvalidException.cs b/src/System.Management.Automation/help/HelpCategoryInvalidException.cs index 373611818fe..fc1071ec4a0 100644 --- a/src/System.Management.Automation/help/HelpCategoryInvalidException.cs +++ b/src/System.Management.Automation/help/HelpCategoryInvalidException.cs @@ -41,7 +41,7 @@ public HelpCategoryInvalidException() : base() /// Initializes a new instance of the HelpCategoryInvalidException class. /// /// The name of help category that is invalid. - /// The inner exception of this exception + /// The inner exception of this exception. public HelpCategoryInvalidException(string helpCategory, Exception innerException) : base((innerException != null) ? innerException.Message : string.Empty, innerException) { diff --git a/src/System.Management.Automation/help/HelpCommands.cs b/src/System.Management.Automation/help/HelpCommands.cs index e22b3efd4ba..64a77671c56 100644 --- a/src/System.Management.Automation/help/HelpCommands.cs +++ b/src/System.Management.Automation/help/HelpCommands.cs @@ -461,7 +461,7 @@ private void GetAndWriteParameterInfo(HelpInfo helpInfo) /// /// Validates input parameters /// - /// Category specified by the user + /// Category specified by the user. /// /// If the request cant be serviced. /// diff --git a/src/System.Management.Automation/help/HelpCommentsParser.cs b/src/System.Management.Automation/help/HelpCommentsParser.cs index de6d43db983..7f82bf2e2e0 100644 --- a/src/System.Management.Automation/help/HelpCommentsParser.cs +++ b/src/System.Management.Automation/help/HelpCommentsParser.cs @@ -542,7 +542,7 @@ private static void GetExampleSections(string content, out string prompt_str, ou /// /// Split the text in the comment token into multiple lines, appending commentLines. /// - /// A single line or multiline comment token + /// A single line or multiline comment token. /// private static void CollectCommentText(Token comment, List commentLines) { @@ -712,7 +712,7 @@ internal RemoteHelpInfo GetRemoteHelpInfo(ExecutionContext context, CommandInfo /// Look for special comments indicating the comment block is meant /// to be used for help. /// - /// The list of comments to process + /// The list of comments to process. /// True if any special comments are found, false otherwise. internal bool AnalyzeCommentBlock(List comments) { diff --git a/src/System.Management.Automation/help/HelpFileHelpInfo.cs b/src/System.Management.Automation/help/HelpFileHelpInfo.cs index af7ba0fd6d5..331eabfefc3 100644 --- a/src/System.Management.Automation/help/HelpFileHelpInfo.cs +++ b/src/System.Management.Automation/help/HelpFileHelpInfo.cs @@ -19,9 +19,9 @@ internal class HelpFileHelpInfo : HelpInfo /// is through /// GetHelpInfo(string name, string text, string filename) /// - /// help topic name - /// help text - /// file name that contains the help text + /// help topic name. + /// help text. + /// file name that contains the help text. private HelpFileHelpInfo(string name, string text, string filename) { FullHelp = PSObject.AsPSObject(text); @@ -85,9 +85,9 @@ internal override HelpCategory HelpCategory /// /// Get help info based on name, text and filename /// - /// help topic name - /// help text - /// file name that contains the help text + /// help topic name. + /// help text. + /// file name that contains the help text. /// HelpFileHelpInfo object created based on information provided. internal static HelpFileHelpInfo GetHelpInfo(string name, string text, string filename) { @@ -107,8 +107,8 @@ internal static HelpFileHelpInfo GetHelpInfo(string name, string text, string fi /// /// Get the text corresponding to a line in input text. /// - /// text to get the line for - /// line number + /// text to get the line for. + /// line number. /// The part of string in text that is in specified line. private static string GetLine(string text, int line) { diff --git a/src/System.Management.Automation/help/HelpFileHelpProvider.cs b/src/System.Management.Automation/help/HelpFileHelpProvider.cs index 731327a5470..4577392c7c4 100644 --- a/src/System.Management.Automation/help/HelpFileHelpProvider.cs +++ b/src/System.Management.Automation/help/HelpFileHelpProvider.cs @@ -291,7 +291,7 @@ private void GetModuleNameAndVersion(string psmodulePathRoot, string filePath, o /// /// Load help file based on the file path. /// - /// file path to load help from + /// file path to load help from. /// Help info object loaded from the file. private HelpInfo LoadHelpFile(string path) { diff --git a/src/System.Management.Automation/help/HelpInfo.cs b/src/System.Management.Automation/help/HelpInfo.cs index 6c3d9184828..b3affdbddee 100644 --- a/src/System.Management.Automation/help/HelpInfo.cs +++ b/src/System.Management.Automation/help/HelpInfo.cs @@ -139,7 +139,7 @@ internal PSObject ShortHelp /// /// Returns help information for a parameter(s) identified by pattern /// - /// pattern to search for parameters + /// pattern to search for parameters. /// A collection of parameters that match pattern. /// /// The base method returns an empty list. diff --git a/src/System.Management.Automation/help/HelpProvider.cs b/src/System.Management.Automation/help/HelpProvider.cs index 2f68100b0a2..8e7a2a48ce3 100644 --- a/src/System.Management.Automation/help/HelpProvider.cs +++ b/src/System.Management.Automation/help/HelpProvider.cs @@ -139,14 +139,14 @@ internal PSObject ProviderInfo /// /// Retrieve help info that exactly match the target. /// - /// help request object + /// help request object. /// List of HelpInfo objects retrieved. internal abstract IEnumerable ExactMatchHelp(HelpRequest helpRequest); /// /// Search help info that match the target search pattern. /// - /// help request object + /// help request object. /// /// If true, searches for pattern in the help content. Individual /// provider can decide which content to search in. @@ -168,8 +168,8 @@ internal PSObject ProviderInfo /// since the helpInfo object passed in is usually stored in cache, which can /// used in later queries. /// - /// helpInfo passed over by another HelpProvider - /// help request object + /// helpInfo passed over by another HelpProvider. + /// help request object. /// internal virtual IEnumerable ProcessForwardedHelp(HelpInfo helpInfo, HelpRequest helpRequest) { diff --git a/src/System.Management.Automation/help/HelpProviderWithCache.cs b/src/System.Management.Automation/help/HelpProviderWithCache.cs index fa5280291d4..8dffd6f6f6b 100644 --- a/src/System.Management.Automation/help/HelpProviderWithCache.cs +++ b/src/System.Management.Automation/help/HelpProviderWithCache.cs @@ -33,7 +33,7 @@ internal HelpProviderWithCache(HelpSystem helpSystem) : base(helpSystem) /// /// Exact match help for a target. /// - /// Help request object + /// Help request object. /// The HelpInfo found. Null if nothing is found. internal override IEnumerable ExactMatchHelp(HelpRequest helpRequest) { @@ -77,8 +77,8 @@ internal override IEnumerable ExactMatchHelp(HelpRequest helpRequest) /// /// This is for implementing custom match algorithm. /// - /// target to search - /// key used in cache table + /// target to search. + /// key used in cache table. /// protected virtual bool CustomMatch(string target, string key) { @@ -94,7 +94,7 @@ protected virtual bool CustomMatch(string target, string key) /// If DoExactMatchHelp is overridden, cache check will be done first in ExactMatchHelp before the /// logic in DoExactMatchHelp is in place. /// - /// help request object + /// help request object. internal virtual void DoExactMatchHelp(HelpRequest helpRequest) { } @@ -102,7 +102,7 @@ internal virtual void DoExactMatchHelp(HelpRequest helpRequest) /// /// Search help for a target /// - /// help request object + /// help request object. /// /// If true, searches for pattern in the help content. Individual /// provider can decide which content to search in. @@ -159,7 +159,7 @@ internal override IEnumerable SearchHelp(HelpRequest helpRequest, bool /// /// Child class of this one may choose to override this function. /// - /// target string + /// target string. /// Wild card pattern created. internal virtual string GetWildCardPattern(string target) { @@ -176,7 +176,7 @@ internal virtual string GetWildCardPattern(string target) /// Child class can choose to override SearchHelp of DoSearchHelp depending on /// whether it want to reuse the logic in SearchHelp for this class. /// - /// help request object + /// help request object. /// A collection of help info objects. internal virtual IEnumerable DoSearchHelp(HelpRequest helpRequest) { @@ -186,8 +186,8 @@ internal virtual IEnumerable DoSearchHelp(HelpRequest helpRequest) /// /// Add an help entry to cache. /// - /// the key of the help entry - /// helpInfo object as the value of the help entry + /// the key of the help entry. + /// helpInfo object as the value of the help entry. internal void AddCache(string target, HelpInfo helpInfo) { _helpCache[target] = helpInfo; @@ -196,7 +196,7 @@ internal void AddCache(string target, HelpInfo helpInfo) /// /// Get help entry from cache /// - /// the key for the help entry to retrieve + /// the key for the help entry to retrieve. /// The HelpInfo in cache corresponding the key specified. internal HelpInfo GetCache(string target) { diff --git a/src/System.Management.Automation/help/HelpProviderWithFullCache.cs b/src/System.Management.Automation/help/HelpProviderWithFullCache.cs index 88deda817b6..d999d82a649 100644 --- a/src/System.Management.Automation/help/HelpProviderWithFullCache.cs +++ b/src/System.Management.Automation/help/HelpProviderWithFullCache.cs @@ -27,7 +27,7 @@ internal HelpProviderWithFullCache(HelpSystem helpSystem) : base(helpSystem) /// Exact match help for a target. This function will be sealed right here /// since this is no need for children class to override this member. /// - /// help request object + /// help request object. /// The HelpInfo found. Null if nothing is found. internal sealed override IEnumerable ExactMatchHelp(HelpRequest helpRequest) { @@ -45,7 +45,7 @@ internal sealed override IEnumerable ExactMatchHelp(HelpRequest helpRe /// Do exact match help for a target. This member is sealed right here since /// children class don't need to override this member. /// - /// help request object + /// help request object. internal sealed override void DoExactMatchHelp(HelpRequest helpRequest) { } @@ -54,7 +54,7 @@ internal sealed override void DoExactMatchHelp(HelpRequest helpRequest) /// Search help for a target. This function will be sealed right here /// since this is no need for children class to override this member. /// - /// help request object + /// help request object. /// /// If true, searches for pattern in the help content. Individual /// provider can decide which content to search in. @@ -78,7 +78,7 @@ internal sealed override IEnumerable SearchHelp(HelpRequest helpReques /// Do search help. This function will be sealed right here /// since this is no need for children class to override this member. /// - /// help request object + /// help request object. /// A collection of help info objects. internal sealed override IEnumerable DoSearchHelp(HelpRequest helpRequest) { diff --git a/src/System.Management.Automation/help/HelpSystem.cs b/src/System.Management.Automation/help/HelpSystem.cs index c537a78d873..8476f82af72 100644 --- a/src/System.Management.Automation/help/HelpSystem.cs +++ b/src/System.Management.Automation/help/HelpSystem.cs @@ -89,7 +89,7 @@ internal class HelpSystem /// /// Constructor for HelpSystem. /// - /// Execution context for this help system + /// Execution context for this help system. internal HelpSystem(ExecutionContext context) { if (context == null) @@ -154,7 +154,7 @@ internal void Initialize() /// Variants of this function are defined below, which will create help request /// object on fly. /// - /// helpRequest object + /// helpRequest object. /// An array of HelpInfo object. internal IEnumerable GetHelp(HelpRequest helpRequest) { @@ -279,7 +279,7 @@ internal Collection GetSearchPaths() /// (Search for pattern in command name followed by pattern match in help content) /// 4. if step 3 returns exact one helpInfo object, try to retrieve exact help. /// - /// Help request object + /// Help request object. /// An array of HelpInfo object. private IEnumerable DoGetHelp(HelpRequest helpRequest) { @@ -348,7 +348,7 @@ private IEnumerable DoGetHelp(HelpRequest helpRequest) /// helpInfo object to appropriate help provider for further processing. /// (this is implemented by ForwardHelp) /// - /// Help request object + /// Help request object. /// HelpInfo object retrieved. Can be Null. internal IEnumerable ExactMatchHelp(HelpRequest helpRequest) { @@ -387,7 +387,7 @@ internal IEnumerable ExactMatchHelp(HelpRequest helpRequest) /// The real help can be retrieved from Command help provider. /// /// - /// Help request object + /// Help request object. /// Never returns null. /// helpInfos is not null or empty. private IEnumerable ForwardHelp(HelpInfo helpInfo, HelpRequest helpRequest) @@ -455,7 +455,7 @@ private HelpInfo GetDefaultHelp() /// /// Get help that exactly match the target /// - /// help request object + /// help request object. /// An IEnumerable of HelpInfo object. private IEnumerable SearchHelp(HelpRequest helpRequest) { @@ -821,9 +821,9 @@ internal class HelpProviderInfo /// /// Constructor /// - /// assembly that contains this help provider - /// the class that implements this help provider - /// help category of this help provider + /// assembly that contains this help provider. + /// the class that implements this help provider. + /// help category of this help provider. internal HelpProviderInfo(string assemblyName, string className, HelpCategory helpCategory) { this.AssemblyName = assemblyName; diff --git a/src/System.Management.Automation/help/MUIFileSearcher.cs b/src/System.Management.Automation/help/MUIFileSearcher.cs index e78466d10d7..1be35ce9d62 100644 --- a/src/System.Management.Automation/help/MUIFileSearcher.cs +++ b/src/System.Management.Automation/help/MUIFileSearcher.cs @@ -341,8 +341,8 @@ internal static string LocateFile(string file) /// The file name to search is the filename part of path parameter. (Normally path /// parameter should contain only the filename part). /// - /// This is the path to the file. If it has a path, we need to search under that path first - /// Additional search paths + /// This is the path to the file. If it has a path, we need to search under that path first. + /// Additional search paths. /// internal static string LocateFile(string file, Collection searchPaths) { diff --git a/src/System.Management.Automation/help/MamlClassHelpInfo.cs b/src/System.Management.Automation/help/MamlClassHelpInfo.cs index 82d6a4719d3..d9694a06f33 100644 --- a/src/System.Management.Automation/help/MamlClassHelpInfo.cs +++ b/src/System.Management.Automation/help/MamlClassHelpInfo.cs @@ -49,8 +49,8 @@ private MamlClassHelpInfo(XmlNode xmlNode, HelpCategory helpCategory) /// /// Create a MamlClassHelpInfo object from an XmlNode. /// - /// xmlNode that contains help info - /// help category this maml object fits into + /// xmlNode that contains help info. + /// help category this maml object fits into. /// MamlCommandHelpInfo object created. internal static MamlClassHelpInfo Load(XmlNode xmlNode, HelpCategory helpCategory) { diff --git a/src/System.Management.Automation/help/MamlCommandHelpInfo.cs b/src/System.Management.Automation/help/MamlCommandHelpInfo.cs index d9d8f5c083a..677a170b618 100644 --- a/src/System.Management.Automation/help/MamlCommandHelpInfo.cs +++ b/src/System.Management.Automation/help/MamlCommandHelpInfo.cs @@ -217,7 +217,7 @@ internal void SetAdditionalDataFromHelpComment(string component, string function /// /// Add user-defined command help data to command help. /// - /// User defined data object + /// User defined data object. internal void AddUserDefinedData(UserDefinedHelpData userDefinedData) { if (userDefinedData == null) @@ -251,8 +251,8 @@ internal void AddUserDefinedData(UserDefinedHelpData userDefinedData) /// /// Create a MamlCommandHelpInfo object from an XmlNode. /// - /// xmlNode that contains help info - /// help category this maml object fits into + /// xmlNode that contains help info. + /// help category this maml object fits into. /// MamlCommandHelpInfo object created. internal static MamlCommandHelpInfo Load(XmlNode xmlNode, HelpCategory helpCategory) { @@ -279,8 +279,8 @@ internal static MamlCommandHelpInfo Load(XmlNode xmlNode, HelpCategory helpCateg /// /// A new MamlCommandHelpInfo is created to avoid polluting the provider help cache. /// - /// provider-specific cmdletHelp to merge into current MamlCommandHelpInfo object - /// provider-specific dynamic parameter help to merge into current MamlCommandHelpInfo object + /// provider-specific cmdletHelp to merge into current MamlCommandHelpInfo object. + /// provider-specific dynamic parameter help to merge into current MamlCommandHelpInfo object. /// Merged command help info object. internal MamlCommandHelpInfo MergeProviderSpecificHelp(PSObject cmdletHelp, PSObject[] dynamicParameterHelp) { @@ -310,7 +310,7 @@ internal MamlCommandHelpInfo MergeProviderSpecificHelp(PSObject cmdletHelp, PSOb /// /// Extracts text for a given property from the full help object /// - /// FullHelp object + /// FullHelp object. /// /// Name of the property for which text needs to be extracted. /// diff --git a/src/System.Management.Automation/help/MamlNode.cs b/src/System.Management.Automation/help/MamlNode.cs index 4c7d41ef53b..4656fd07ed8 100644 --- a/src/System.Management.Automation/help/MamlNode.cs +++ b/src/System.Management.Automation/help/MamlNode.cs @@ -371,9 +371,9 @@ private void RemoveUnsupportedNodes(XmlNode xmlNode) /// "attrib1" will be lost. This seems to be OK with current practice of authoring /// monad command help. /// - /// property hashtable - /// property name - /// property value + /// property hashtable. + /// property name. + /// property value. private static void AddProperty(Hashtable properties, string name, PSObject mshObject) { ArrayList propertyValues = (ArrayList)properties[name]; @@ -1142,7 +1142,7 @@ private static string GetPreformattedText(string text) /// /// Trim empty lines from the either end of an string array. /// - /// lines to trim + /// lines to trim. /// An string array with empty lines trimed on either end. private static string[] TrimLines(string[] lines) { diff --git a/src/System.Management.Automation/help/PSClassHelpProvider.cs b/src/System.Management.Automation/help/PSClassHelpProvider.cs index 355c7f050c7..815f528511c 100644 --- a/src/System.Management.Automation/help/PSClassHelpProvider.cs +++ b/src/System.Management.Automation/help/PSClassHelpProvider.cs @@ -232,7 +232,7 @@ private HelpInfo GetHelpInfoFromHelpFile(PSClassInfo classInfo, string helpFileT /// /// Gets the HelpInfo object corresponding to the command. /// - /// help file identifier (either name of PSSnapIn or simply full path to help file) + /// help file identifier (either name of PSSnapIn or simply full path to help file). /// Help Category for search. /// HelpInfo object. private HelpInfo GetFromPSClassHelpCache(string helpFileIdentifier, HelpCategory helpCategory) diff --git a/src/System.Management.Automation/help/ProviderHelpInfo.cs b/src/System.Management.Automation/help/ProviderHelpInfo.cs index cf3b70dc97d..1546abc6372 100644 --- a/src/System.Management.Automation/help/ProviderHelpInfo.cs +++ b/src/System.Management.Automation/help/ProviderHelpInfo.cs @@ -190,7 +190,7 @@ internal override bool MatchPatternInContent(WildcardPattern pattern) /// /// Return the provider-specific cmdlet help based on input cmdletName /// - /// cmdletName on which to get provider-specific help + /// cmdletName on which to get provider-specific help. /// An mshObject that contains provider-specific commandlet help. internal PSObject GetCmdletHelp(string cmdletName) { @@ -261,7 +261,7 @@ private void LoadCmdletHelps() /// /// Return the provider-specific dynamic parameter help based on input parameter name /// - /// an array of parameters to retrieve help + /// an array of parameters to retrieve help. /// An array of mshObject that contains the parameter help. internal PSObject[] GetDynamicParameterHelp(string[] parameters) { @@ -345,7 +345,7 @@ private void LoadDynamicParameterHelps() /// /// Create providerHelpInfo from an xmlNode /// - /// xml node that contains the provider help info + /// xml node that contains the provider help info. /// The providerHelpInfo object created. internal static ProviderHelpInfo Load(XmlNode xmlNode) { diff --git a/src/System.Management.Automation/help/ProviderHelpProvider.cs b/src/System.Management.Automation/help/ProviderHelpProvider.cs index 721d0df2362..fd78e17b482 100644 --- a/src/System.Management.Automation/help/ProviderHelpProvider.cs +++ b/src/System.Management.Automation/help/ProviderHelpProvider.cs @@ -63,7 +63,7 @@ internal override HelpCategory HelpCategory /// /// Do exact match help based on the target. /// - /// help request object + /// help request object. internal override IEnumerable ExactMatchHelp(HelpRequest helpRequest) { Collection matchingProviders = null; @@ -257,7 +257,7 @@ private void LoadHelpFile(ProviderInfo providerInfo) /// /// Search for provider help based on a search target. /// - /// help request object + /// help request object. /// /// If true, searches for pattern in the help content. Individual /// provider can decide which content to search in. @@ -372,8 +372,8 @@ internal override IEnumerable ProcessForwardedHelp(HelpInfo helpInfo, /// 1. check whether provider-specific commandlet help exists. /// 2. merge found provider-specific help with commandlet help provided. /// - /// helpInfo forwarded in - /// help request object + /// helpInfo forwarded in. + /// help request object. /// The help info object after processing. override internal HelpInfo ProcessForwardedHelp(HelpInfo helpInfo, HelpRequest helpRequest) { diff --git a/src/System.Management.Automation/help/SaveHelpCommand.cs b/src/System.Management.Automation/help/SaveHelpCommand.cs index e3703806dd2..41129fa356f 100644 --- a/src/System.Management.Automation/help/SaveHelpCommand.cs +++ b/src/System.Management.Automation/help/SaveHelpCommand.cs @@ -163,8 +163,8 @@ protected override void ProcessRecord() /// /// Process a single module with a given culture /// - /// module to process - /// culture to use + /// module to process. + /// culture to use. /// True if the module has been processed, false if not. internal override bool ProcessModuleWithCulture(UpdatableHelpModuleInfo module, string culture) { diff --git a/src/System.Management.Automation/help/SyntaxHelpInfo.cs b/src/System.Management.Automation/help/SyntaxHelpInfo.cs index 9d7c435e567..590ca8e9e64 100644 --- a/src/System.Management.Automation/help/SyntaxHelpInfo.cs +++ b/src/System.Management.Automation/help/SyntaxHelpInfo.cs @@ -41,9 +41,9 @@ private SyntaxHelpInfo(string name, string text, HelpCategory category) /// /// Get help info based on name, text and filename /// - /// help topic name - /// help text - /// help category + /// help topic name. + /// help text. + /// help category. /// SyntaxHelpInfo object created based on information provided. internal static SyntaxHelpInfo GetHelpInfo(string name, string text, HelpCategory category) { diff --git a/src/System.Management.Automation/help/UpdatableHelpCommandBase.cs b/src/System.Management.Automation/help/UpdatableHelpCommandBase.cs index 4e082e18510..056be46431c 100644 --- a/src/System.Management.Automation/help/UpdatableHelpCommandBase.cs +++ b/src/System.Management.Automation/help/UpdatableHelpCommandBase.cs @@ -140,8 +140,8 @@ public UpdateHelpScope Scope /// /// Handles help system progress events /// - /// event sender - /// event arguments + /// event sender. + /// event arguments. private void HandleProgressChanged(object sender, UpdatableHelpProgressEventArgs e) { Debug.Assert(e.CommandType == UpdatableHelpCommandType.UpdateHelpCommand @@ -188,7 +188,7 @@ static UpdatableHelpCommandBase() /// Checks if a module is a system module, a module is a system module /// if it exists in the metadata cache. /// - /// module name + /// module name. /// True if system module, false if not. internal static bool IsSystemModule(string module) { @@ -198,7 +198,7 @@ internal static bool IsSystemModule(string module) /// /// Class constructor /// - /// command type + /// command type. internal UpdatableHelpCommandBase(UpdatableHelpCommandType commandType) { _commandType = commandType; @@ -269,10 +269,10 @@ private void ProcessSingleModuleObject(PSModuleInfo module, ExecutionContext con /// /// Gets a list of modules from the given pattern /// - /// execution context - /// pattern to search - /// Module Specification - /// do not generate errors for modules without HelpInfoUri + /// execution context. + /// pattern to search. + /// Module Specification. + /// do not generate errors for modules without HelpInfoUri. /// A list of modules. private Dictionary, UpdatableHelpModuleInfo> GetModuleInfo(ExecutionContext context, string pattern, ModuleSpecification fullyQualifiedName, bool noErrors) { @@ -393,8 +393,8 @@ protected override void EndProcessing() /// /// Main cmdlet logic for processing module names or fully qualified module names /// - /// module names given by the user - /// fullyQualifiedNames + /// module names given by the user. + /// fullyQualifiedNames. internal void Process(IEnumerable moduleNames, IEnumerable fullyQualifiedNames) { _helpSystem.WebClient.UseDefaultCredentials = _useDefaultCredentials; @@ -440,7 +440,7 @@ internal void Process(IEnumerable moduleNames, IEnumerable /// Processing module objects for Save-Help /// - /// module objects given by the user + /// module objects given by the user. internal void Process(IEnumerable modules) { if (modules == null || !modules.Any()) { return; } @@ -461,7 +461,7 @@ internal void Process(IEnumerable modules) /// /// Processes a module with potential globbing /// - /// module name with globbing + /// module name with globbing. private void ProcessModuleWithGlobbing(string name) { if (String.IsNullOrEmpty(name)) @@ -480,7 +480,7 @@ private void ProcessModuleWithGlobbing(string name) /// /// Processes a ModuleSpecification with potential globbing /// - /// ModuleSpecification + /// ModuleSpecification. private void ProcessModuleWithGlobbing(ModuleSpecification fullyQualifiedName) { foreach (KeyValuePair, UpdatableHelpModuleInfo> module in GetModuleInfo(null, fullyQualifiedName, false)) @@ -492,7 +492,7 @@ private void ProcessModuleWithGlobbing(ModuleSpecification fullyQualifiedName) /// /// Processes a single module with multiple cultures /// - /// module to process + /// module to process. private void ProcessModule(UpdatableHelpModuleInfo module) { _helpSystem.CurrentModule = module.ModuleName; @@ -593,8 +593,8 @@ private void ProcessModule(UpdatableHelpModuleInfo module) /// /// Process a single module with a given culture /// - /// module to process - /// culture to use + /// module to process. + /// culture to use. /// True if the module has been processed, false if not. internal virtual bool ProcessModuleWithCulture(UpdatableHelpModuleInfo module, string culture) { @@ -608,9 +608,9 @@ internal virtual bool ProcessModuleWithCulture(UpdatableHelpModuleInfo module, s /// /// Gets a list of modules from the given pattern or ModuleSpecification /// - /// pattern to match - /// ModuleSpecification - /// skip errors + /// pattern to match. + /// ModuleSpecification. + /// skip errors. /// A list of modules. internal Dictionary, UpdatableHelpModuleInfo> GetModuleInfo(string pattern, ModuleSpecification fullyQualifiedName, bool noErrors) { @@ -633,11 +633,11 @@ internal Dictionary, UpdatableHelpModuleInfo> GetModuleIn /// /// Checks if it is necessary to update help /// - /// ModuleInfo - /// current HelpInfo.xml - /// new HelpInfo.xml - /// current culture - /// force update + /// ModuleInfo. + /// current HelpInfo.xml. + /// new HelpInfo.xml. + /// current culture. + /// force update. /// True if it is necessary to update help, false if not. internal bool IsUpdateNecessary(UpdatableHelpModuleInfo module, UpdatableHelpInfo currentHelpInfo, UpdatableHelpInfo newHelpInfo, CultureInfo culture, bool force) @@ -671,11 +671,11 @@ internal bool IsUpdateNecessary(UpdatableHelpModuleInfo module, UpdatableHelpInf /// /// Checks if the user has attempted to update more than once per day per module /// - /// module name - /// path to help info - /// help info file name - /// current time (UTC) - /// if -Force is specified + /// module name. + /// path to help info. + /// help info file name. + /// current time (UTC). + /// if -Force is specified. /// True if we are okay to update, false if not. internal bool CheckOncePerDayPerModule(string moduleName, string path, string filename, DateTime time, bool force) { @@ -716,7 +716,7 @@ internal bool CheckOncePerDayPerModule(string moduleName, string path, string fi /// /// Resolves a given path to a list of directories /// - /// path to resolve + /// path to resolve. /// resolve recursively? /// Treat the path / start path as a literal path?/// /// A list of directories. @@ -776,7 +776,7 @@ internal IEnumerable ResolvePath(string path, bool recurse, bool isLiter /// /// Resolves a given path to a list of directories recursively /// - /// path to resolve + /// path to resolve. /// A list of directories. private IEnumerable RecursiveResolvePathHelper(string path) { @@ -803,7 +803,7 @@ private IEnumerable RecursiveResolvePathHelper(string path) /// /// Validates the provider of the path, only FileSystem provider is accepted. /// - /// path to validate + /// path to validate. internal void ValidatePathProvider(PathInfo path) { if (path.Provider == null || path.Provider.Name != FileSystemProvider.ProviderName) @@ -820,7 +820,7 @@ internal void ValidatePathProvider(PathInfo path) /// /// Logs a command message /// - /// message to log + /// message to log. internal void LogMessage(string message) { List details = new List(); @@ -838,9 +838,9 @@ internal void LogMessage(string message) /// /// Processes an exception for help cmdlets /// - /// module name - /// culture info - /// exception to check + /// module name. + /// culture info. + /// exception to check. internal void ProcessException(string moduleName, string culture, Exception e) { UpdatableHelpSystemException except = null; diff --git a/src/System.Management.Automation/help/UpdatableHelpInfo.cs b/src/System.Management.Automation/help/UpdatableHelpInfo.cs index 2a6be8b01ad..a990ea2a75b 100644 --- a/src/System.Management.Automation/help/UpdatableHelpInfo.cs +++ b/src/System.Management.Automation/help/UpdatableHelpInfo.cs @@ -17,8 +17,8 @@ internal class CultureSpecificUpdatableHelp /// /// Class constructor /// - /// culture info - /// version info + /// culture info. + /// version info. internal CultureSpecificUpdatableHelp(CultureInfo culture, Version version) { Debug.Assert(version != null); @@ -47,8 +47,8 @@ internal class UpdatableHelpInfo /// /// Class constructor /// - /// unresolved help content URI - /// supported UI cultures + /// unresolved help content URI. + /// supported UI cultures. internal UpdatableHelpInfo(string unresolvedUri, CultureSpecificUpdatableHelp[] cultures) { Debug.Assert(cultures != null); @@ -76,8 +76,8 @@ internal UpdatableHelpInfo(string unresolvedUri, CultureSpecificUpdatableHelp[] /// /// Checks if the other HelpInfo has a newer version /// - /// HelpInfo object to check - /// culture to check + /// HelpInfo object to check. + /// culture to check. /// True if the other HelpInfo is newer, false if not. internal bool IsNewerVersion(UpdatableHelpInfo helpInfo, CultureInfo culture) { @@ -99,7 +99,7 @@ internal bool IsNewerVersion(UpdatableHelpInfo helpInfo, CultureInfo culture) /// /// Checks if a culture is supported /// - /// culture to check + /// culture to check. /// True if supported, false if not. internal bool IsCultureSupported(CultureInfo culture) { @@ -146,7 +146,7 @@ internal string GetSupportedCultures() /// /// Gets the culture version /// - /// culture info + /// culture info. /// Culture version. internal Version GetCultureVersion(CultureInfo culture) { diff --git a/src/System.Management.Automation/help/UpdatableHelpModuleInfo.cs b/src/System.Management.Automation/help/UpdatableHelpModuleInfo.cs index d61c89f2232..a6147c9d4f1 100644 --- a/src/System.Management.Automation/help/UpdatableHelpModuleInfo.cs +++ b/src/System.Management.Automation/help/UpdatableHelpModuleInfo.cs @@ -21,10 +21,10 @@ internal class UpdatableHelpModuleInfo /// /// Class constructor /// - /// module name - /// module GUID - /// module path - /// HelpInfo URI + /// module name. + /// module GUID. + /// module path. + /// HelpInfo URI. internal UpdatableHelpModuleInfo(string name, Guid guid, string path, string uri) { Debug.Assert(!String.IsNullOrEmpty(name)); @@ -69,7 +69,7 @@ internal Guid ModuleGuid /// /// Gets the combined HelpContent.zip name /// - /// current culture + /// current culture. /// HelpContent name. internal string GetHelpContentName(CultureInfo culture) { diff --git a/src/System.Management.Automation/help/UpdatableHelpSystem.cs b/src/System.Management.Automation/help/UpdatableHelpSystem.cs index c93697e63b0..de5466e28e5 100644 --- a/src/System.Management.Automation/help/UpdatableHelpSystem.cs +++ b/src/System.Management.Automation/help/UpdatableHelpSystem.cs @@ -34,11 +34,11 @@ internal class UpdatableHelpSystemException : Exception /// /// Class constructor /// - /// FullyQualifiedErrorId - /// exception message - /// category - /// target object - /// inner exception + /// FullyQualifiedErrorId. + /// exception message. + /// category. + /// target object. + /// inner exception. internal UpdatableHelpSystemException(string errorId, string message, ErrorCategory cat, object targetObject, Exception innerException) : base(message, innerException) { @@ -51,8 +51,8 @@ internal UpdatableHelpSystemException(string errorId, string message, ErrorCateg /// /// Class constructor /// - /// serialization info - /// streaming context + /// serialization info. + /// streaming context. protected UpdatableHelpSystemException(SerializationInfo serializationInfo, StreamingContext streamingContext) : base(serializationInfo, streamingContext) { @@ -83,7 +83,7 @@ internal class UpdatableHelpExceptionContext /// /// Class constructor /// - /// exception to wrap + /// exception to wrap. internal UpdatableHelpExceptionContext(UpdatableHelpSystemException exception) { Exception = exception; @@ -109,7 +109,7 @@ internal UpdatableHelpExceptionContext(UpdatableHelpSystemException exception) /// /// Creates an error record from this context /// - /// command type + /// command type. /// Error record. internal ErrorRecord CreateErrorRecord(UpdatableHelpCommandType commandType) { @@ -177,9 +177,9 @@ internal class UpdatableHelpProgressEventArgs : EventArgs /// /// Class constructor /// - /// module name - /// progress status - /// progress percentage + /// module name. + /// progress status. + /// progress percentage. internal UpdatableHelpProgressEventArgs(string moduleName, string status, int percent) { Debug.Assert(!String.IsNullOrEmpty(status)); @@ -193,10 +193,10 @@ internal UpdatableHelpProgressEventArgs(string moduleName, string status, int pe /// /// Class constructor /// - /// module name - /// command type - /// progress status - /// progress percentage + /// module name. + /// command type. + /// progress status. + /// progress percentage. internal UpdatableHelpProgressEventArgs(string moduleName, UpdatableHelpCommandType type, string status, int percent) { Debug.Assert(!String.IsNullOrEmpty(status)); @@ -312,8 +312,8 @@ internal IEnumerable GetCurrentUICulture() /// /// Gets an internal help URI /// - /// internal module information - /// help content culture + /// internal module information. + /// help content culture. /// Internal help uri representation. internal UpdatableHelpUri GetHelpInfoUri(UpdatableHelpModuleInfo module, CultureInfo culture) { @@ -323,11 +323,11 @@ internal UpdatableHelpUri GetHelpInfoUri(UpdatableHelpModuleInfo module, Culture /// /// Gets the HelpInfo xml from the given URI /// - /// command type - /// HelpInfo URI - /// module name - /// module GUID - /// current UI culture + /// command type. + /// HelpInfo URI. + /// module name. + /// module GUID. + /// current UI culture. /// HelpInfo object. internal UpdatableHelpInfo GetHelpInfo(UpdatableHelpCommandType commandType, string uri, string moduleName, Guid moduleGuid, string culture) { @@ -374,7 +374,7 @@ internal UpdatableHelpInfo GetHelpInfo(UpdatableHelpCommandType commandType, str /// /// Sends a standard HTTP request to get the resolved URI (potential FwLinks) /// - /// base URI + /// base URI. /// /// Resolved URI. private string ResolveUri(string baseUri, bool verbose) @@ -516,17 +516,17 @@ private string ResolveUri(string baseUri, bool verbose) /// /// Creates a HelpInfo object /// - /// XML text - /// module name - /// module GUID - /// current UI cultures - /// overrides the path contained within HelpInfo.xml + /// XML text. + /// module name. + /// module GUID. + /// current UI cultures. + /// overrides the path contained within HelpInfo.xml. /// /// /// Resolve the uri retrieved from the content. The uri is resolved /// to handle redirections if any. /// - /// ignore the xsd validation exception and return null in such case + /// ignore the xsd validation exception and return null in such case. /// HelpInfo object. internal UpdatableHelpInfo CreateHelpInfo(string xml, string moduleName, Guid moduleGuid, string currentCulture, string pathOverride, bool verbose, bool shouldResolveUri, bool ignoreValidationException) @@ -611,10 +611,10 @@ internal UpdatableHelpInfo CreateHelpInfo(string xml, string moduleName, Guid mo /// /// Creates a valid xml document /// - /// input xml - /// schema namespace - /// xml schema - /// validation event handler + /// input xml. + /// schema namespace. + /// xml schema. + /// validation event handler. /// HelpInfo or HelpContent? private XmlDocument CreateValidXmlDocument(string xml, string ns, string schema, ValidationEventHandler handler, bool helpInfo) @@ -654,8 +654,8 @@ private XmlDocument CreateValidXmlDocument(string xml, string ns, string schema, /// /// Handles HelpInfo XML validation events /// - /// event sender - /// event arguments + /// event sender. + /// event arguments. private void HelpInfoValidationHandler(object sender, ValidationEventArgs arg) { switch (arg.Severity) @@ -674,8 +674,8 @@ private void HelpInfoValidationHandler(object sender, ValidationEventArgs arg) /// /// Handles Help content MAML validation events /// - /// event sender - /// event arguments + /// event sender. + /// event arguments. private void HelpContentValidationHandler(object sender, ValidationEventArgs arg) { switch (arg.Severity) @@ -707,14 +707,14 @@ internal void CancelDownload() /// /// Downloads and installs help content /// - /// command type - /// execution context - /// destination paths - /// file names - /// culture to update - /// help content uri - /// path of the maml XSDs - /// files installed + /// command type. + /// execution context. + /// destination paths. + /// file names. + /// culture to update. + /// help content uri. + /// path of the maml XSDs. + /// files installed. /// True if the operation succeeded, false if not. internal bool DownloadAndInstallHelpContent(UpdatableHelpCommandType commandType, ExecutionContext context, Collection destPaths, string fileName, CultureInfo culture, string helpContentUri, string xsdPath, out Collection installed) @@ -741,11 +741,11 @@ internal bool DownloadAndInstallHelpContent(UpdatableHelpCommandType commandType /// /// Downloads the help content /// - /// command type - /// destination path - /// help content uri - /// combined file name - /// culture name + /// command type. + /// destination path. + /// help content uri. + /// combined file name. + /// culture name. /// True if the operation succeeded, false if not. internal bool DownloadHelpContent(UpdatableHelpCommandType commandType, string path, string helpContentUri, string fileName, string culture) { @@ -875,12 +875,12 @@ private void SendProgressEvents(UpdatableHelpCommandType commandType) /// /// /// - /// culture updated - /// version updated - /// help content uri - /// destination name - /// combined file name - /// forces the file to copy + /// culture updated. + /// version updated. + /// help content uri. + /// destination name. + /// combined file name. + /// forces the file to copy. internal void GenerateHelpInfo(string moduleName, Guid moduleGuid, string contentUri, string culture, Version version, string destPath, string fileName, bool force) { Debug.Assert(Directory.Exists(destPath)); @@ -1010,15 +1010,15 @@ private void RemoveReadOnly(string path) /// /// Installs (unzips) the help content /// - /// command type - /// execution context - /// source directory - /// destination paths - /// help content file name - /// temporary path - /// current culture - /// path of the maml XSDs - /// files installed + /// command type. + /// execution context. + /// source directory. + /// destination paths. + /// help content file name. + /// temporary path. + /// current culture. + /// path of the maml XSDs. + /// files installed. /// /// Directory pointed by (if any) will be deleted. /// @@ -1116,10 +1116,10 @@ private bool ExpandArchive(string source, string destination) /// /// Unzips to help content to a given location /// - /// execution context - /// source path - /// destination path - /// Is set to false if we find a single file placeholder.txt in cab. This means we no longer need to install help files + /// execution context. + /// source path. + /// destination path. + /// Is set to false if we find a single file placeholder.txt in cab. This means we no longer need to install help files. private void UnzipHelpContent(ExecutionContext context, string srcPath, string destPath, out bool needToCopy) { needToCopy = true; @@ -1216,11 +1216,11 @@ private void UnzipHelpContent(ExecutionContext context, string srcPath, string d /// /// Validates all XML files within a given path /// - /// path containing files to validate - /// destination paths - /// culture name - /// path of the maml XSDs - /// installed files + /// path containing files to validate. + /// destination paths. + /// culture name. + /// path of the maml XSDs. + /// installed files. private void ValidateAndCopyHelpContent(string sourcePath, Collection destPaths, string culture, string xsdPath, out Collection installed) { @@ -1409,9 +1409,9 @@ private void ValidateAndCopyHelpContent(string sourcePath, Collection de /// /// Loads string from the given path /// - /// cmdlet instance - /// path to load - /// credential + /// cmdlet instance. + /// path to load. + /// credential. /// String loaded. internal static string LoadStringFromPath(PSCmdlet cmdlet, string path, PSCredential credential) { @@ -1557,8 +1557,8 @@ internal static bool ShouldPromptToUpdateHelp() /// /// Handles the download completion event /// - /// event sender - /// event arguments + /// event sender. + /// event arguments. private void HandleDownloadFileCompleted(object sender, AsyncCompletedEventArgs e) { if (_stopping) @@ -1597,8 +1597,8 @@ private void HandleDownloadFileCompleted(object sender, AsyncCompletedEventArgs /// /// Handles the download progress changed event /// - /// event sender - /// event arguments + /// event sender. + /// event arguments. private void HandleDownloadProgressChanged(object sender, DownloadProgressChangedEventArgs e) { if (_stopping) diff --git a/src/System.Management.Automation/help/UpdatableHelpUri.cs b/src/System.Management.Automation/help/UpdatableHelpUri.cs index 25ddb4d85c9..dd4063f7567 100644 --- a/src/System.Management.Automation/help/UpdatableHelpUri.cs +++ b/src/System.Management.Automation/help/UpdatableHelpUri.cs @@ -14,10 +14,10 @@ internal class UpdatableHelpUri /// /// Class constructor /// - /// module name - /// module guid - /// UI culture - /// resolved URI + /// module name. + /// module guid. + /// UI culture. + /// resolved URI. internal UpdatableHelpUri(string moduleName, Guid moduleGuid, CultureInfo culture, string resolvedUri) { Debug.Assert(!String.IsNullOrEmpty(moduleName)); diff --git a/src/System.Management.Automation/help/UpdateHelpCommand.cs b/src/System.Management.Automation/help/UpdateHelpCommand.cs index 319369ef6df..0e9f1da22ce 100644 --- a/src/System.Management.Automation/help/UpdateHelpCommand.cs +++ b/src/System.Management.Automation/help/UpdateHelpCommand.cs @@ -212,8 +212,8 @@ protected override void ProcessRecord() /// /// Process a single module with a given culture /// - /// module to process - /// culture to use + /// module to process. + /// culture to use. /// True if the module has been processed, false if not. internal override bool ProcessModuleWithCulture(UpdatableHelpModuleInfo module, string culture) { diff --git a/src/System.Management.Automation/logging/LogProvider.cs b/src/System.Management.Automation/logging/LogProvider.cs index d88f5ef1c1d..f67c58c6e2c 100644 --- a/src/System.Management.Automation/logging/LogProvider.cs +++ b/src/System.Management.Automation/logging/LogProvider.cs @@ -233,7 +233,7 @@ protected static PSLevel GetPSLevelFromSeverity(string severity) /// /// Converts log context to string /// - /// log context + /// log context. /// String representation. protected static string LogContextToString(LogContext context) { diff --git a/src/System.Management.Automation/logging/MshLog.cs b/src/System.Management.Automation/logging/MshLog.cs index ee838ee8394..c12ac7f5877 100644 --- a/src/System.Management.Automation/logging/MshLog.cs +++ b/src/System.Management.Automation/logging/MshLog.cs @@ -190,12 +190,12 @@ internal static void SetDummyLog(string shellId) /// Variant form of this function is defined below, which will make parameters additionalInfo /// and newEngineState optional. /// - /// Execution context for the engine that is running - /// EventId for the event to be logged - /// Exception associated with this event - /// Severity of this event - /// Additional information for this event - /// New engine state + /// Execution context for the engine that is running. + /// EventId for the event to be logged. + /// Exception associated with this event. + /// Severity of this event. + /// Additional information for this event. + /// New engine state. internal static void LogEngineHealthEvent(ExecutionContext executionContext, int eventId, Exception exception, @@ -308,10 +308,10 @@ internal static void LogEngineHealthEvent(ExecutionContext executionContext, /// /// This API is currently used only by runspace before engine start. /// - /// logContext to be - /// EventId for the event to be logged - /// Exception associated with this event - /// Additional information for this event + /// logContext to be. + /// EventId for the event to be logged. + /// Exception associated with this event. + /// Additional information for this event. internal static void LogEngineHealthEvent(LogContext logContext, int eventId, Exception exception, @@ -350,9 +350,9 @@ Dictionary additionalInfo /// Variant form of this function is defined below, which will make parameter additionalInfo /// optional. /// - /// execution context for current engine instance - /// new engine state - /// invocationInfo for current command that is running + /// execution context for current engine instance. + /// new engine state. + /// invocationInfo for current command that is running. internal static void LogEngineLifecycleEvent(ExecutionContext executionContext, EngineState engineState, InvocationInfo invocationInfo) @@ -397,9 +397,9 @@ internal static void LogEngineLifecycleEvent(ExecutionContext executionContext, /// /// LogProviderHealthEvent: Log a command health event. /// - /// Execution context for the engine that is running - /// Exception associated with this event - /// Severity of this event + /// Execution context for the engine that is running. + /// Exception associated with this event. + /// Severity of this event. internal static void LogCommandHealthEvent(ExecutionContext executionContext, Exception exception, Severity severity @@ -439,9 +439,9 @@ Severity severity /// /// This is the only form of CommandLifecycleEvent logging api. /// - /// Execution Context for the current running engine - /// new command state - /// invocation data for current command that is running + /// Execution Context for the current running engine. + /// new command state. + /// invocation data for current command that is running. internal static void LogCommandLifecycleEvent(ExecutionContext executionContext, CommandState commandState, InvocationInfo invocationInfo) @@ -481,9 +481,9 @@ internal static void LogCommandLifecycleEvent(ExecutionContext executionContext, /// of invocationInfo. It is likely that invocationInfo is not available if /// the command failed security check. /// - /// Execution Context for the current running engine - /// new command state - /// current command that is running + /// Execution Context for the current running engine. + /// new command state. + /// current command that is running. internal static void LogCommandLifecycleEvent(ExecutionContext executionContext, CommandState commandState, string commandName) @@ -521,9 +521,9 @@ internal static void LogCommandLifecycleEvent(ExecutionContext executionContext, /// /// LogPipelineExecutionDetailEvent: Log a pipeline execution detail event. /// - /// Execution Context for the current running engine - /// detail to be logged for this pipeline execution detail - /// invocation data for current command that is running + /// Execution Context for the current running engine. + /// detail to be logged for this pipeline execution detail. + /// invocation data for current command that is running. internal static void LogPipelineExecutionDetailEvent(ExecutionContext executionContext, List detail, InvocationInfo invocationInfo) @@ -551,10 +551,10 @@ internal static void LogPipelineExecutionDetailEvent(ExecutionContext executionC /// instead of invocationInfo. This will save the need to fill in the commandName for /// this event. /// - /// Execution Context for the current running engine - /// detail to be logged for this pipeline execution detail - /// script that is currently running - /// command line that is currently running + /// Execution Context for the current running engine. + /// detail to be logged for this pipeline execution detail. + /// script that is currently running. + /// command line that is currently running. internal static void LogPipelineExecutionDetailEvent(ExecutionContext executionContext, List detail, string scriptName, @@ -586,10 +586,10 @@ internal static void LogPipelineExecutionDetailEvent(ExecutionContext executionC /// /// LogProviderHealthEvent: Log a Provider health event. /// - /// Execution context for the engine that is running - /// Name of the provider - /// Exception associated with this event - /// Severity of this event + /// Execution context for the engine that is running. + /// Name of the provider. + /// Exception associated with this event. + /// Severity of this event. internal static void LogProviderHealthEvent(ExecutionContext executionContext, string providerName, Exception exception, @@ -630,9 +630,9 @@ Severity severity /// /// This is the only form of ProviderLifecycleEvent logging api. /// - /// Execution Context for current engine that is running - /// Provider name - /// New provider state + /// Execution Context for current engine that is running. + /// Provider name. + /// New provider state. internal static void LogProviderLifecycleEvent(ExecutionContext executionContext, string providerName, ProviderState providerState) @@ -662,11 +662,11 @@ internal static void LogProviderLifecycleEvent(ExecutionContext executionContext /// This is the basic form of LoggingSettingsEvent API. Variation of this function defined /// below will make parameter invocationInfo optional. /// - /// Execution context for current running engine - /// Variable name - /// New value for the variable - /// Previous value for the variable - /// Invocation data for the command that is currently running + /// Execution context for current running engine. + /// Variable name. + /// New value for the variable. + /// Previous value for the variable. + /// Invocation data for the command that is currently running. internal static void LogSettingsEvent(ExecutionContext executionContext, string variableName, string newValue, diff --git a/src/System.Management.Automation/logging/eventlog/EventLogLogProvider.cs b/src/System.Management.Automation/logging/eventlog/EventLogLogProvider.cs index 34e68a2f02b..21cf361e4bc 100644 --- a/src/System.Management.Automation/logging/eventlog/EventLogLogProvider.cs +++ b/src/System.Management.Automation/logging/eventlog/EventLogLogProvider.cs @@ -549,8 +549,8 @@ private void LogEvent(EventInstance entry, params object[] args) /// /// In EventLog Api, arguments are passed in as an array of objects. /// - /// An ArrayList to contain the event arguments - /// The log context containing the info to fill in + /// An ArrayList to contain the event arguments. + /// The log context containing the info to fill in. private static void FillEventArgs(Hashtable mapArgs, LogContext logContext) { mapArgs["Severity"] = logContext.Severity; @@ -574,8 +574,8 @@ private static void FillEventArgs(Hashtable mapArgs, LogContext logContext) /// /// Fill event arguments with additionalInfo stored in a string dictionary. /// - /// An arraylist to contain the event arguments - /// A string dictionary to fill in + /// An arraylist to contain the event arguments. + /// A string dictionary to fill in. private static void FillEventArgs(Hashtable mapArgs, Dictionary additionalInfo) { if (additionalInfo == null) diff --git a/src/System.Management.Automation/namespaces/CoreCommandContext.cs b/src/System.Management.Automation/namespaces/CoreCommandContext.cs index fb0d6dde350..e3f1cc5e1de 100644 --- a/src/System.Management.Automation/namespaces/CoreCommandContext.cs +++ b/src/System.Management.Automation/namespaces/CoreCommandContext.cs @@ -581,7 +581,7 @@ internal bool ShouldProcess( /// /// Name of the target resource being acted upon /// - /// What action was being performed + /// What action was being performed. /// true iff the action should be performed /// /// The ActionPreference.Stop or ActionPreference.Inquire policy diff --git a/src/System.Management.Automation/namespaces/FileSystemContentStream.cs b/src/System.Management.Automation/namespaces/FileSystemContentStream.cs index 54e99e9922a..3ef1c744b29 100644 --- a/src/System.Management.Automation/namespaces/FileSystemContentStream.cs +++ b/src/System.Management.Automation/namespaces/FileSystemContentStream.cs @@ -861,11 +861,11 @@ private void CreateStreams(string filePath, string streamName, FileMode fileMode /// and then monitors for changes. Once a change appears, it reopens the streams /// and seeks to the last read position. /// - /// The path of the file to read / monitor - /// The FileMode of the file (ie: Open / Append) - /// The access properties of the file (ie: Read / Write) - /// The sharing properties of the file (ie: Read / ReadWrite) - /// The encoding of the file + /// The path of the file to read / monitor. + /// The FileMode of the file (ie: Open / Append). + /// The access properties of the file (ie: Read / Write). + /// The sharing properties of the file (ie: Read / ReadWrite). + /// The encoding of the file. private void WaitForChanges(string filePath, FileMode fileMode, FileAccess fileAccess, FileShare fileShare, Encoding fileEncoding) { // Close the old stream, and store our current position. diff --git a/src/System.Management.Automation/namespaces/FileSystemProvider.cs b/src/System.Management.Automation/namespaces/FileSystemProvider.cs index 4d9cea94029..9e47759818e 100644 --- a/src/System.Management.Automation/namespaces/FileSystemProvider.cs +++ b/src/System.Management.Automation/namespaces/FileSystemProvider.cs @@ -1010,7 +1010,7 @@ protected override Collection InitializeDefaultDrives() /// /// Retrieves the dynamic parameters required for the Get-Item cmdlet /// - /// The path of the file to process + /// The path of the file to process. /// An instance of the FileSystemProviderGetItemDynamicParameters class that represents the dynamic parameters. protected override object GetItemDynamicParameters(string path) { @@ -1831,7 +1831,7 @@ private FlagsExpression FormatAttributeSwitchParameters() /// /// Provides a mode property for FileSystemInfo /// - /// instance of PSObject wrapping a FileSystemInfo + /// instance of PSObject wrapping a FileSystemInfo. [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2001:AvoidCallingProblematicMethods")] public static string Mode(PSObject instance) { @@ -2796,8 +2796,8 @@ protected override void RemoveItem(string path, bool recurse) /// /// Retrieves the dynamic parameters required for the Remove-Item cmdlet /// - /// The path of the file to process - /// Whether to recurse into containers + /// The path of the file to process. + /// Whether to recurse into containers. /// An instance of the FileSystemProviderRemoveItemDynamicParameters class that represents the dynamic parameters. protected override object RemoveItemDynamicParameters(string path, bool recurse) { @@ -5192,8 +5192,8 @@ private string RemoveRelativeTokens(string path) /// /// Get the common base path of two paths /// - /// One path - /// Another path + /// One path. + /// Another path. private string GetCommonBase(string path1, string path2) { // Always see if the shorter path is a substring of the @@ -7023,7 +7023,7 @@ internal static bool PathIsNetworkPath(string path) /// Creates a hard link using the native API. /// /// Name of the hard link. - /// Path to the target of the hard link + /// Path to the target of the hard link. /// /// [DllImport(PinvokeDllNames.CreateHardLinkDllName, CharSet = CharSet.Unicode, SetLastError = true)] diff --git a/src/System.Management.Automation/namespaces/LocationGlobber.cs b/src/System.Management.Automation/namespaces/LocationGlobber.cs index 567af9525ce..becfd852c28 100644 --- a/src/System.Management.Automation/namespaces/LocationGlobber.cs +++ b/src/System.Management.Automation/namespaces/LocationGlobber.cs @@ -1201,11 +1201,11 @@ internal string GetProviderPath( /// /// Returns a provider specific path for given PowerShell path. /// - /// Path to resolve - /// Cmdlet context - /// When true bypass trust check - /// Provider - /// Drive + /// Path to resolve. + /// Cmdlet context. + /// When true bypass trust check. + /// Provider. + /// Drive. /// internal string GetProviderPath( string path, diff --git a/src/System.Management.Automation/namespaces/NavigationProviderBase.cs b/src/System.Management.Automation/namespaces/NavigationProviderBase.cs index b26fec86ff6..0b3dac347cc 100644 --- a/src/System.Management.Automation/namespaces/NavigationProviderBase.cs +++ b/src/System.Management.Automation/namespaces/NavigationProviderBase.cs @@ -704,8 +704,8 @@ internal string ContractRelativePath( /// /// Get the common base path of two paths /// - /// One path - /// Another path + /// One path. + /// Another path. private string GetCommonBase(string path1, string path2) { // Always see if the shorter path is a substring of the diff --git a/src/System.Management.Automation/namespaces/RegistryProvider.cs b/src/System.Management.Automation/namespaces/RegistryProvider.cs index 079da50efad..ba47fd06942 100644 --- a/src/System.Management.Automation/namespaces/RegistryProvider.cs +++ b/src/System.Management.Automation/namespaces/RegistryProvider.cs @@ -3101,8 +3101,8 @@ private void WriteErrorIfPerfectMatchNotFound(bool hadAMatch, string path, strin /// /// IT resets the a registry key value to its default /// - /// Key whose value has to be reset - /// name of the value to reset + /// Key whose value has to be reset. + /// name of the value to reset. /// Default value the key was set to. private object ResetRegistryKeyValue(IRegistryWrapper key, string valueName) { @@ -3207,7 +3207,7 @@ private bool IsHiveContainer(string path) /// checks the container. if the container is the hive container (Registry::\) /// it throws an exception /// - /// path to check + /// path to check. /// False if the operation is not allowed. private bool CheckOperationNotAllowedOnHiveContainer(string path) { @@ -3227,8 +3227,8 @@ private bool CheckOperationNotAllowedOnHiveContainer(string path) /// checks the container. if the container is the hive container (Registry::\) /// it throws an exception /// - /// source path to check - /// destination path to check + /// source path to check. + /// destination path to check. private bool CheckOperationNotAllowedOnHiveContainer(string sourcePath, string destinationPath) { if (IsHiveContainer(sourcePath)) @@ -3297,7 +3297,7 @@ private IRegistryWrapper GetHiveRoot(string path) /// /// Creates the parent for the keypath specified by . /// - /// RegistryKey path + /// RegistryKey path. /// /// True if key is created or already exist,False otherwise. /// @@ -3763,9 +3763,9 @@ private void SetRegistryValue( /// 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 - /// Name of the property being written - /// The path of the item being written + /// The property to be written. + /// Name of the property being written. + /// The path of the item being written. private void WriteWrappedPropertyObject(object value, string propertyName, string path) { PSObject result = new PSObject(); @@ -3881,7 +3881,7 @@ private static object ConvertValueToKind(object value, RegistryValueKind kind) /// /// helper to infer the RegistryValueKind from an object /// - /// object whose RegistryValueKind has to be determined + /// object whose RegistryValueKind has to be determined. /// Corresponding RegistryValueKind. private static RegistryValueKind GetValueKindFromObject(object value) { @@ -3923,8 +3923,8 @@ private static RegistryValueKind GetValueKindFromObject(object value) /// /// Helper to get RegistryValueKind for a Property /// - /// RegistryKey containing property - /// Property for which RegistryValueKind is requested + /// RegistryKey containing property. + /// Property for which RegistryValueKind is requested. /// RegistryValueKind of the property. If the property does not exit,returns RegistryValueKind.Unknown. private static RegistryValueKind GetValueKindForProperty(IRegistryWrapper key, string valueName) { @@ -3952,8 +3952,8 @@ private static RegistryValueKind GetValueKindForProperty(IRegistryWrapper key, s /// /// helper to read back an existing registry key value /// - /// key to read the value from - /// name of the value to read + /// key to read the value from. + /// name of the value to read. /// Value of the key, null if it could not retrieve /// it because known exceptions were thrown, else an exception is percolated up /// @@ -4037,7 +4037,7 @@ private void WriteRegistryItemObject( /// /// The type as specified by the user that should be parsed into a RegistryValueKind enum. /// - /// output for the RegistryValueKind for the string + /// output for the RegistryValueKind for the string. /// /// true if the conversion succeeded /// diff --git a/src/System.Management.Automation/namespaces/Win32Native.cs b/src/System.Management.Automation/namespaces/Win32Native.cs index cfba77e6eeb..5f492391f4e 100644 --- a/src/System.Management.Automation/namespaces/Win32Native.cs +++ b/src/System.Management.Automation/namespaces/Win32Native.cs @@ -134,9 +134,9 @@ internal static extern bool LookupAccountSid(string lpSystemName, /// /// Retrieves the current process token. /// - /// process handle - /// token access - /// process token + /// process handle. + /// token access. + /// process token. /// The current process token. [DllImport(PinvokeDllNames.OpenProcessTokenDllName, CharSet = CharSet.Unicode, SetLastError = true, BestFitMapping = false)] [ResourceExposure(ResourceScope.Machine)] diff --git a/src/System.Management.Automation/security/Authenticode.cs b/src/System.Management.Automation/security/Authenticode.cs index 64341cbebfd..a252a689f55 100644 --- a/src/System.Management.Automation/security/Authenticode.cs +++ b/src/System.Management.Automation/security/Authenticode.cs @@ -60,12 +60,12 @@ internal static class SignatureHelper /// /// Sign a file /// - /// option that controls what gets embedded in the signature blob - /// name of file to sign - /// signing cert - /// URL of time stamping server + /// option that controls what gets embedded in the signature blob. + /// name of file to sign. + /// signing cert. + /// URL of time stamping server. /// The name of the hash - /// algorithm to use. + /// algorithm to use. /// Does not return a value. /// /// Thrown if argument fileName or certificate is null. @@ -256,8 +256,8 @@ internal static Signature SignFile(SigningOption option, /// /// Get signature on the specified file /// - /// name of file to check - /// content of file to check + /// name of file to check. + /// content of file to check. /// Signature object. /// /// Thrown if argument fileName is empty. diff --git a/src/System.Management.Automation/security/CatalogHelper.cs b/src/System.Management.Automation/security/CatalogHelper.cs index 5d28c2bfc43..ef17b23b3b9 100644 --- a/src/System.Management.Automation/security/CatalogHelper.cs +++ b/src/System.Management.Automation/security/CatalogHelper.cs @@ -86,7 +86,7 @@ internal static class CatalogHelper /// /// Find out the Version of Catalog by reading its Meta data. We can have either version 1 or version 2 catalog /// - /// Handle to open catalog file + /// Handle to open catalog file. /// Version of the catalog. private static int GetCatalogVersion(IntPtr catalogHandle) { @@ -123,7 +123,7 @@ private static int GetCatalogVersion(IntPtr catalogHandle) /// /// HashAlgorithm used by the Catalog. It is based on the version of Catalog. /// - /// Path of the output catalog file + /// Path of the output catalog file. /// Version of the catalog. private static string GetCatalogHashAlgorithm(int catalogVersion) { @@ -154,11 +154,11 @@ private static string GetCatalogHashAlgorithm(int catalogVersion) /// /// Generate the Catalog Definition File representing files and folders /// - /// Path of expected output .cdf file - /// Path of the output catalog file - /// Path of the catalog definition file - /// Version of catalog - /// hash method used to generate hashes for the Catalog + /// Path of expected output .cdf file. + /// Path of the output catalog file. + /// Path of the catalog definition file. + /// Version of catalog. + /// hash method used to generate hashes for the Catalog. /// HashSet for the relative Path for files in Catalog. internal static string GenerateCDFFile(Collection Path, string catalogFilePath, string cdfFilePath, int catalogVersion, string hashAlgorithm) { @@ -204,12 +204,12 @@ internal static string GenerateCDFFile(Collection Path, string catalogFi /// /// Get file attribute (Relative path in our case) from catalog /// - /// file to hash + /// file to hash. /// directory information about file needed to calculate relative file path. /// working set of relative paths of all files. - /// content to be added in CatalogHeader section of cdf File - /// content to be added in CatalogFiles section of cdf File - /// indicating the current no of catalog header level attributes + /// content to be added in CatalogHeader section of cdf File. + /// content to be added in CatalogFiles section of cdf File. + /// indicating the current no of catalog header level attributes. /// Void. internal static void ProcessFileToBeAddedInCatalogDefinitionFile(FileInfo fileToHash, DirectoryInfo dirInfo, ref HashSet relativePaths, ref string cdfHeaderContent, ref string cdfFilesContent, ref int catAttributeCount) { @@ -250,7 +250,7 @@ internal static void ProcessFileToBeAddedInCatalogDefinitionFile(FileInfo fileTo /// /// Generate the Catalog file for Input Catalog Definition File /// - /// Path to the Input .cdf file + /// Path to the Input .cdf file. internal static void GenerateCatalogFile(string cdfFilePath) { string pwszFilePath = cdfFilePath; @@ -328,10 +328,10 @@ internal static void GenerateCatalogFile(string cdfFilePath) /// /// To generate Catalog for the folder /// - /// Path to folder or File - /// Catalog File Path - /// Catalog File Path - /// Instance of cmdlet calling this method + /// Path to folder or File. + /// Catalog File Path. + /// Catalog File Path. + /// Instance of cmdlet calling this method. /// True if able to generate .cat file or false. internal static FileInfo GenerateCatalog(PSCmdlet cmdlet, Collection Path, string catalogFilePath, int catalogVersion) { @@ -399,8 +399,8 @@ internal static string ProcessFilePathAttributeInCatalog(IntPtr memberAttrInfo) /// /// Make a hash for the file /// - /// Path of the file - /// Used to calculate Hash + /// Path of the file. + /// Used to calculate Hash. /// HashValue for the file. internal static string CalculateFileHash(string filePath, string hashAlgorithm) { @@ -476,7 +476,7 @@ internal static string CalculateFileHash(string filePath, string hashAlgorithm) /// /// Make list of hashes for given Catalog File /// - /// Path to the folder having catalog file + /// Path to the folder having catalog file. /// /// The version of input catalog we read from catalog meta data after opening it. /// Dictionary mapping files relative paths to HashValues. @@ -574,10 +574,10 @@ internal static Dictionary GetHashesFromCatalog(string catalogFi /// /// Process file in path for its relative paths /// - /// relative path of file found in catalog + /// relative path of file found in catalog. /// hash of file found in catalog. - /// skip file from validation if it matches these patterns - /// collection of hashes of catalog + /// skip file from validation if it matches these patterns. + /// collection of hashes of catalog. /// Void. internal static void ProcessCatalogFile(string relativePath, string fileHash, WildcardPattern[] excludedPatterns, ref Dictionary catalogHashes) { @@ -599,11 +599,11 @@ internal static void ProcessCatalogFile(string relativePath, string fileHash, Wi /// /// Process file in path for its relative paths /// - /// file to hash + /// file to hash. /// directory information about file needed to calculate relative file path. - /// Used to calculate Hash - /// skip file if it matches these patterns - /// collection of hashes of files + /// Used to calculate Hash. + /// skip file if it matches these patterns. + /// collection of hashes of files. /// Void. internal static void ProcessPathFile(FileInfo fileToHash, DirectoryInfo dirInfo, string hashAlgorithm, WildcardPattern[] excludedPatterns, ref Dictionary fileHashes) { @@ -652,9 +652,9 @@ internal static void ProcessPathFile(FileInfo fileToHash, DirectoryInfo dirInfo, /// /// Generate the hashes of all the files in given folder /// - /// Path to folder or File - /// catalog file path it should be skipped when calculating the hashes - /// Used to calculate Hash + /// Path to folder or File. + /// catalog file path it should be skipped when calculating the hashes. + /// Used to calculate Hash. /// /// Dictionary mapping file relative paths to hashes.. internal static Dictionary CalculateHashesFromPath(Collection folderPaths, string catalogFilePath, string hashAlgorithm, WildcardPattern[] excludedPatterns) @@ -688,8 +688,8 @@ internal static Dictionary CalculateHashesFromPath(Collection /// Compare Dictionary objects /// - /// Hashes extracted from Catalog - /// Hashes created from folders path + /// Hashes extracted from Catalog. + /// Hashes created from folders path. /// True if both collections are same. internal static bool CompareDictionaries(Dictionary catalogItems, Dictionary pathItems) { @@ -731,10 +731,10 @@ internal static bool CompareDictionaries(Dictionary catalogItems /// /// To Validate the Integrity of Catalog /// - /// Folder for which catalog is created - /// File Name of the Catalog + /// Folder for which catalog is created. + /// File Name of the Catalog. /// - /// Instance of cmdlet calling this method + /// Instance of cmdlet calling this method. /// Information about Catalog. internal static CatalogInformation ValidateCatalog(PSCmdlet cmdlet, Collection catalogFolders, string catalogFilePath, WildcardPattern[] excludedPatterns) { diff --git a/src/System.Management.Automation/security/MshSignature.cs b/src/System.Management.Automation/security/MshSignature.cs index 8b4923b234d..c14cfe6975a 100644 --- a/src/System.Management.Automation/security/MshSignature.cs +++ b/src/System.Management.Automation/security/MshSignature.cs @@ -190,10 +190,10 @@ public string Path /// /// Call this to create a validated time-stamped signature object. /// - /// this signature is found in this file - /// win32 error code - /// cert of the signer - /// cert of the time stamper + /// this signature is found in this file. + /// win32 error code. + /// cert of the signer. + /// cert of the time stamper. /// Constructed object. internal Signature(string filePath, DWORD error, @@ -212,8 +212,8 @@ internal Signature(string filePath, /// /// Call this to create a validated signature object. /// - /// this signature is found in this file - /// cert of the signer + /// this signature is found in this file. + /// cert of the signer. /// Constructed object. internal Signature(string filePath, X509Certificate2 signer) @@ -229,9 +229,9 @@ internal Signature(string filePath, /// /// Call this ctor when creating an invalid signature object /// - /// this signature is found in this file - /// win32 error code - /// cert of the signer + /// this signature is found in this file. + /// win32 error code. + /// cert of the signer. /// Constructed object. internal Signature(string filePath, DWORD error, @@ -248,8 +248,8 @@ internal Signature(string filePath, /// /// Call this ctor when creating an invalid signature object /// - /// this signature is found in this file - /// win32 error code + /// this signature is found in this file. + /// win32 error code. /// Constructed object. internal Signature(string filePath, DWORD error) { diff --git a/src/System.Management.Automation/security/SecureStringHelper.cs b/src/System.Management.Automation/security/SecureStringHelper.cs index 886092c6ea7..29fa143140d 100644 --- a/src/System.Management.Automation/security/SecureStringHelper.cs +++ b/src/System.Management.Automation/security/SecureStringHelper.cs @@ -28,7 +28,7 @@ internal static class SecureStringHelper /// The binary data must be byte[] version of unicode char[], /// otherwise the results are unpredictable. /// - /// input data + /// input data. /// A SecureString . private static SecureString New(byte[] data) { @@ -65,7 +65,7 @@ private static SecureString New(byte[] data) /// /// get the contents of a SecureString as byte[] /// - /// input string + /// input string. /// Contents of s (char[]) converted to byte[]. [ArchitectureSensitive] internal static byte[] GetData(SecureString s) @@ -99,7 +99,7 @@ internal static byte[] GetData(SecureString s) /// method can be changed to use a better encoding /// such as base64. /// - /// binary data to encode + /// binary data to encode. /// A string representing encoded data. internal static string ByteArrayToString(byte[] data) { @@ -117,7 +117,7 @@ internal static string ByteArrayToString(byte[] data) /// Convert a string obtained using ByteArrayToString() /// back to byte[] format. /// - /// encoded input string + /// encoded input string. /// Bin data as byte[]. internal static byte[] ByteArrayFromString(string s) { @@ -144,7 +144,7 @@ internal static byte[] ByteArrayFromString(string s) /// return contents of the SecureString after encrypting /// using DPAPI and encoding the encrypted blob as a string /// - /// SecureString to protect + /// SecureString to protect. /// A string (see summary) . internal static string Protect(SecureString input) { @@ -173,7 +173,7 @@ internal static string Protect(SecureString input) /// /// The string must be obtained earlier by a call to Protect() /// - /// encrypted string + /// encrypted string. /// SecureString . internal static SecureString Unprotect(string input) { @@ -201,8 +201,8 @@ internal static SecureString Unprotect(string input) /// return contents of the SecureString after encrypting /// using the specified key and encoding the encrypted blob as a string /// - /// input string to encrypt - /// encryption key + /// input string to encrypt. + /// encryption key. /// A string (see summary). internal static EncryptionResult Encrypt(SecureString input, SecureString key) { @@ -230,8 +230,8 @@ internal static EncryptionResult Encrypt(SecureString input, SecureString key) /// return contents of the SecureString after encrypting /// using the specified key and encoding the encrypted blob as a string /// - /// input string to encrypt - /// encryption key + /// input string to encrypt. + /// encryption key. /// A string (see summary). internal static EncryptionResult Encrypt(SecureString input, byte[] key) { @@ -294,9 +294,9 @@ internal static EncryptionResult Encrypt(SecureString input, byte[] key, byte[] /// /// The string must be obtained earlier by a call to Encrypt() /// - /// encrypted string - /// encryption key - /// encryption initialization vector. If this is set to null, the method uses internally computed strong random number as IV + /// encrypted string. + /// encryption key. + /// encryption initialization vector. If this is set to null, the method uses internally computed strong random number as IV. /// SecureString . internal static SecureString Decrypt(string input, SecureString key, byte[] IV) { @@ -326,9 +326,9 @@ internal static SecureString Decrypt(string input, SecureString key, byte[] IV) /// /// The string must be obtained earlier by a call to Encrypt() /// - /// encrypted string - /// encryption key - /// encryption initialization vector. If this is set to null, the method uses internally computed strong random number as IV + /// encrypted string. + /// encryption key. + /// encryption initialization vector. If this is set to null, the method uses internally computed strong random number as IV. /// SecureString . internal static SecureString Decrypt(string input, byte[] key, byte[] IV) { diff --git a/src/System.Management.Automation/security/SecuritySupport.cs b/src/System.Management.Automation/security/SecuritySupport.cs index e62d20d1dad..32432a5b155 100644 --- a/src/System.Management.Automation/security/SecuritySupport.cs +++ b/src/System.Management.Automation/security/SecuritySupport.cs @@ -374,7 +374,7 @@ internal static string GetExecutionPolicy(ExecutionPolicy policy) /// /// Returns true if file has product binary signature /// - /// Name of file to check + /// Name of file to check. /// True when file has product binary signature. public static bool IsProductBinary(string file) { @@ -484,7 +484,7 @@ private static string GetLocalPreferenceValue(string shellId, ExecutionPolicySco /// /// Get the pass / fail result of calling the SAFER API /// - /// The path to the file in question + /// The path to the file in question. /// A file handle to the file in question, if available. [ArchitectureSensitive] [SuppressMessage("Microsoft.Reliability", "CA2001:AvoidCallingProblematicMethods")] @@ -580,7 +580,7 @@ internal static SaferPolicy GetSaferPolicy(string path, SafeHandle handle) /// /// throw if file does not exist /// - /// path to file + /// path to file. /// Does not return a value. internal static void CheckIfFileExists(string filePath) { @@ -594,7 +594,7 @@ internal static void CheckIfFileExists(string filePath) /// check to see if the specified cert is suitable to be /// used as a code signing cert /// - /// certificate object + /// certificate object. /// True on success, false otherwise. internal static bool CertIsGoodForSigning(X509Certificate2 c) { @@ -611,7 +611,7 @@ internal static bool CertIsGoodForSigning(X509Certificate2 c) /// used as an encryption cert for PKI encryption. Note /// that this cert doesn't require the private key. /// - /// certificate object + /// certificate object. /// True on success, false otherwise. internal static bool CertIsGoodForEncryption(X509Certificate2 c) { @@ -658,7 +658,7 @@ private static bool CertHasKeyUsage(X509Certificate2 c, X509KeyUsageFlags keyUsa /// /// check if the specified cert has a private key in it /// - /// certificate object + /// certificate object. /// True on success, false otherwise. internal static bool CertHasPrivatekey(X509Certificate2 cert) { @@ -668,7 +668,7 @@ internal static bool CertHasPrivatekey(X509Certificate2 cert) /// /// Get the EKUs of a cert /// - /// certificate object + /// certificate object. /// A collection of cert eku strings. [ArchitectureSensitive] internal static Collection GetCertEKU(X509Certificate2 cert) @@ -726,7 +726,7 @@ internal static Collection GetCertEKU(X509Certificate2 cert) /// /// convert an int to a DWORD /// - /// signed int number + /// signed int number. /// DWORD. internal static DWORD GetDWORDFromInt(int n) { @@ -737,7 +737,7 @@ internal static DWORD GetDWORDFromInt(int n) /// /// convert a DWORD to int /// - /// number + /// number. /// Int. internal static int GetIntFromDWORD(DWORD n) { @@ -1029,7 +1029,7 @@ internal static string Encrypt(byte[] contentBytes, CmsMessageRecipient[] recipi /// /// Adds Ascii armour to a byte stream in Base64 format /// - /// The bytes to encode + /// The bytes to encode. internal static string GetAsciiArmor(byte[] bytes) { StringBuilder output = new StringBuilder(); @@ -1045,11 +1045,11 @@ internal static string GetAsciiArmor(byte[] bytes) /// /// Removes Ascii armour from a byte stream /// - /// The Ascii armored content - /// The marker of the start of the Base64 content - /// The marker of the end of the Base64 content - /// The beginning of where the Ascii armor was detected - /// The end of where the Ascii armor was detected + /// The Ascii armored content. + /// The marker of the start of the Base64 content. + /// The marker of the end of the Base64 content. + /// The beginning of where the Ascii armor was detected. + /// The end of where the Ascii armor was detected. internal static byte[] RemoveAsciiArmor(string actualContent, string beginMarker, string endMarker, out int startIndex, out int endIndex) { byte[] messageBytes = null; @@ -1538,8 +1538,8 @@ internal static int Init() /// Caller is responsible for calling AmsiCloseSession when a "session" (script) /// is complete, and for calling AmsiUninitialize when the runspace is being torn down. /// - /// The string to be scanned - /// Information about the source (filename, etc.) + /// The string to be scanned. + /// Information about the source (filename, etc.). /// AMSI_RESULT_DETECTED if malware was detected in the sample. internal static AmsiNativeMethods.AMSI_RESULT ScanContent(string content, string sourceMetadata) { diff --git a/src/System.Management.Automation/singleshell/config/MshConsoleLoadException.cs b/src/System.Management.Automation/singleshell/config/MshConsoleLoadException.cs index 1d6160a57b7..259002e4ca1 100644 --- a/src/System.Management.Automation/singleshell/config/MshConsoleLoadException.cs +++ b/src/System.Management.Automation/singleshell/config/MshConsoleLoadException.cs @@ -33,7 +33,7 @@ public PSConsoleLoadException() : base() /// /// Initiate an instance of PSConsoleLoadException. /// - /// Error message + /// Error message. public PSConsoleLoadException(string message) : base(message) { @@ -42,8 +42,8 @@ public PSConsoleLoadException(string message) /// /// Initiate an instance of PSConsoleLoadException. /// - /// Error message - /// Inner exception + /// Error message. + /// Inner exception. public PSConsoleLoadException(string message, Exception innerException) : base(message, innerException) { diff --git a/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs b/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs index 39716d27618..940ecb1d3f4 100644 --- a/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs +++ b/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs @@ -422,7 +422,7 @@ internal PSSnapInInfo Clone() /// Returns true if the PSSnapIn Id is valid. A PSSnapIn is valid iff it contains only /// "Alpha Numeric","-","_","." characters. /// - /// PSSnapIn Id to validate + /// PSSnapIn Id to validate. internal static bool IsPSSnapinIdValid(string psSnapinId) { if (String.IsNullOrEmpty(psSnapinId)) @@ -437,7 +437,7 @@ internal static bool IsPSSnapinIdValid(string psSnapinId) /// Validates the PSSnapIn Id. A PSSnapIn is valid iff it contains only /// "Alpha Numeric","-","_","." characters. /// - /// PSSnapIn Id to validate + /// PSSnapIn Id to validate. /// /// 1. Specified PSSnapIn is not valid /// @@ -917,7 +917,7 @@ internal static void ReadRegistryInfo(out Version assemblyVersion, out string pu /// /// PublicKeyToken is in the form of byte[]. Use this function to convert to a string /// - /// array of byte's + /// array of byte's. /// internal static string ConvertByteArrayToString(byte[] tokens) { diff --git a/src/System.Management.Automation/singleshell/config/MshSnapinLoadException.cs b/src/System.Management.Automation/singleshell/config/MshSnapinLoadException.cs index 637b09dbc2f..d23eccfa7e1 100644 --- a/src/System.Management.Automation/singleshell/config/MshSnapinLoadException.cs +++ b/src/System.Management.Automation/singleshell/config/MshSnapinLoadException.cs @@ -25,7 +25,7 @@ public class PSSnapInException : RuntimeException /// /// Initiate an instance of PSSnapInException. /// - /// PSSnapin for the exception + /// PSSnapin for the exception. /// Message with load failure detail. internal PSSnapInException(string PSSnapin, string message) : base() @@ -38,7 +38,7 @@ internal PSSnapInException(string PSSnapin, string message) /// /// Initiate an instance of PSSnapInException. /// - /// PSSnapin for the exception + /// PSSnapin for the exception. /// Message with load failure detail. /// Whether this is just a warning for PSSnapin load. internal PSSnapInException(string PSSnapin, string message, bool warning) @@ -53,9 +53,9 @@ internal PSSnapInException(string PSSnapin, string message, bool warning) /// /// Initiate an instance of PSSnapInException. /// - /// PSSnapin for the exception + /// PSSnapin for the exception. /// Message with load failure detail. - /// Exception for PSSnapin load failure + /// Exception for PSSnapin load failure. internal PSSnapInException(string PSSnapin, string message, Exception exception) : base(message, exception) { @@ -74,7 +74,7 @@ public PSSnapInException() : base() /// /// Initiate an instance of PSSnapInException. /// - /// Error message + /// Error message. public PSSnapInException(string message) : base(message) { @@ -83,8 +83,8 @@ public PSSnapInException(string message) /// /// Initiate an instance of PSSnapInException. /// - /// Error message - /// Inner exception + /// Error message. + /// Inner exception. public PSSnapInException(string message, Exception innerException) : base(message, innerException) { @@ -170,8 +170,8 @@ public override string Message /// /// Initiate a PSSnapInException instance. /// - /// Serialization information - /// Streaming context + /// Serialization information. + /// Streaming context. protected PSSnapInException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -185,8 +185,8 @@ protected PSSnapInException(SerializationInfo info, /// /// Get object data from serialization information. /// - /// Serialization information - /// Streaming context + /// Serialization information. + /// Streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/System.Management.Automation/utils/CommandProcessorExceptions.cs b/src/System.Management.Automation/utils/CommandProcessorExceptions.cs index a17909d27e0..d0ee48167f6 100644 --- a/src/System.Management.Automation/utils/CommandProcessorExceptions.cs +++ b/src/System.Management.Automation/utils/CommandProcessorExceptions.cs @@ -22,8 +22,8 @@ public class ApplicationFailedException : RuntimeException /// Initializes a new instance of the ApplicationFailedException class and defines the serialization information, /// and streaming context. /// - /// The serialization information to use when initializing this object - /// The streaming context to use when initializing this object + /// The serialization information to use when initializing this object. + /// The streaming context to use when initializing this object. /// Constructed object. protected ApplicationFailedException(SerializationInfo info, StreamingContext context) @@ -45,7 +45,7 @@ public ApplicationFailedException() : base() /// /// Initializes a new instance of the ApplicationFailedException class and defines the error message. /// - /// The error message to use when initializing this object + /// The error message to use when initializing this object. /// Constructed object. public ApplicationFailedException(string message) : base(message) { @@ -57,8 +57,8 @@ public ApplicationFailedException(string message) : base(message) /// Initializes a new instance of the ApplicationFailedException class and defines the error message and /// errorID. /// - /// The error message to use when initializing this object - /// The errorId to use when initializing this object + /// The error message to use when initializing this object. + /// The errorId to use when initializing this object. /// Constructed object. internal ApplicationFailedException(string message, string errorId) : base(message) { @@ -70,9 +70,9 @@ internal ApplicationFailedException(string message, string errorId) : base(messa /// Initializes a new instance of the ApplicationFailedException class and defines the error message, /// error ID and inner exception. /// - /// The error message to use when initializing this object - /// The errorId to use when initializing this object - /// The inner exception to use when initializing this object + /// The error message to use when initializing this object. + /// The errorId to use when initializing this object. + /// The inner exception to use when initializing this object. /// Constructed object. internal ApplicationFailedException(string message, string errorId, Exception innerException) : base(message, innerException) @@ -85,8 +85,8 @@ internal ApplicationFailedException(string message, string errorId, Exception in /// Initializes a new instance of the ApplicationFailedException class and defines the error message and /// inner exception. /// - /// The error message to use when initializing this object - /// The inner exception to use when initializing this object + /// The error message to use when initializing this object. + /// The inner exception to use when initializing this object. /// Constructed object. public ApplicationFailedException(string message, Exception innerException) diff --git a/src/System.Management.Automation/utils/CryptoUtils.cs b/src/System.Management.Automation/utils/CryptoUtils.cs index bfca1c58eaa..3aedff823c2 100644 --- a/src/System.Management.Automation/utils/CryptoUtils.cs +++ b/src/System.Management.Automation/utils/CryptoUtils.cs @@ -343,7 +343,7 @@ internal uint ErrorCode /// /// error code returned by native /// crypto application - /// error message associated with this failure + /// error message associated with this failure. public PSCryptoException(uint errorCode, StringBuilder message) : base(message.ToString()) { @@ -353,14 +353,14 @@ public PSCryptoException(uint errorCode, StringBuilder message) /// /// Constructor with just message but no inner exception /// - /// error message associated with this failure + /// error message associated with this failure. public PSCryptoException(string message) : this(message, null) { } /// /// Constructor with inner exception /// - /// error message - /// inner exception + /// error message. + /// inner exception. /// This constructor is currently not called /// explicitly from crypto utils public PSCryptoException(string message, Exception innerException) : @@ -372,8 +372,8 @@ public PSCryptoException(string message, Exception innerException) : /// /// Constructor which has type specific serialization logic /// - /// serialization info - /// context in which this constructor is called + /// serialization info. + /// context in which this constructor is called. /// Currently no custom type-specific serialization logic is /// implemented protected PSCryptoException(SerializationInfo info, StreamingContext context) @@ -390,8 +390,8 @@ protected PSCryptoException(SerializationInfo info, StreamingContext context) /// /// Returns base implementation /// - /// serialization info - /// context + /// serialization info. + /// context. public override void GetObjectData(SerializationInfo info, StreamingContext context) { base.GetObjectData(info, context); @@ -567,7 +567,7 @@ internal string SafeExportSessionKey() /// Import a public key into the provider whose context /// has been obtained /// - /// base64 encoded public key to import + /// base64 encoded public key to import. internal void ImportPublicKeyFromBase64EncodedString(string publicKey) { Dbg.Assert(!string.IsNullOrEmpty(publicKey), "key cannot be null or empty"); @@ -612,7 +612,7 @@ internal void ImportSessionKeyFromBase64EncodedString(string sessionKey) /// /// Encrypt the specified byte array /// - /// data to encrypt + /// data to encrypt. /// Encrypted byte array. internal byte[] EncryptWithSessionKey(byte[] data) { @@ -673,7 +673,7 @@ internal byte[] EncryptWithSessionKey(byte[] data) /// /// Decrypt the specified buffer /// - /// data to decrypt + /// data to decrypt. /// Decrypted buffer. internal byte[] DecryptWithSessionKey(byte[] data) { @@ -828,7 +828,7 @@ internal static PSRSACryptoServiceProvider GetRSACryptoServiceProviderForServer( /// then obtains the last error, wraps it in an exception and /// throws the same /// - /// value to examine + /// value to examine. private void CheckStatus(bool value) { if (value) @@ -1104,7 +1104,7 @@ protected SecureString DecryptSecureStringCore(string encryptedString) /// /// Encrypt a secure string /// - /// secure string to encrypt + /// secure string to encrypt. /// Encrypted string. /// This method zeroes out all interim buffers used internal abstract string EncryptSecureString(SecureString secureString); @@ -1113,7 +1113,7 @@ protected SecureString DecryptSecureStringCore(string encryptedString) /// Decrypt a string and construct a secure string from its /// contents /// - /// encrypted string + /// encrypted string. /// Secure string object. /// This method zeroes out any interim buffers used internal abstract SecureString DecryptSecureString(string encryptedString); @@ -1224,7 +1224,7 @@ internal override SecureString DecryptSecureString(string encryptedString) /// /// Imports a public key from its base64 encoded string representation /// - /// public key in its string representation + /// public key in its string representation. /// True on success. internal bool ImportRemotePublicKey(string publicKeyAsString) { diff --git a/src/System.Management.Automation/utils/ExecutionExceptions.cs b/src/System.Management.Automation/utils/ExecutionExceptions.cs index bea979ae974..b5af2fedc05 100644 --- a/src/System.Management.Automation/utils/ExecutionExceptions.cs +++ b/src/System.Management.Automation/utils/ExecutionExceptions.cs @@ -48,7 +48,7 @@ internal CmdletInvocationException(ErrorRecord errorRecord) /// /// Instantiates a new instance of the CmdletInvocationException class /// - /// wrapped exception + /// wrapped exception. /// /// identity of cmdlet, null is unknown /// @@ -120,8 +120,8 @@ public CmdletInvocationException(string message, /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected CmdletInvocationException(SerializationInfo info, StreamingContext context) @@ -135,8 +135,8 @@ protected CmdletInvocationException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -196,7 +196,7 @@ public class CmdletProviderInvocationException : CmdletInvocationException /// /// Instantiates a new instance of the CmdletProviderInvocationException class /// - /// wrapped exception + /// wrapped exception. /// /// identity of cmdlet, null is unknown /// @@ -228,8 +228,8 @@ public CmdletProviderInvocationException() /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected CmdletProviderInvocationException(SerializationInfo info, StreamingContext context) @@ -342,8 +342,8 @@ public PipelineStoppedException() /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PipelineStoppedException(SerializationInfo info, StreamingContext context) @@ -427,8 +427,8 @@ public PipelineClosedException(string message, /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PipelineClosedException(SerializationInfo info, StreamingContext context) @@ -513,8 +513,8 @@ internal ActionPreferenceStopException(InvocationInfo invocationInfo, /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected ActionPreferenceStopException(SerializationInfo info, StreamingContext context) @@ -535,8 +535,8 @@ protected ActionPreferenceStopException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -694,10 +694,10 @@ public ParentContainsErrorRecordException(string message, /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Doesn't return. - /// always + /// always. protected ParentContainsErrorRecordException( SerializationInfo info, StreamingContext context) : base(info, context) @@ -718,8 +718,8 @@ public override string Message /// /// Serializer for /// - /// serialization information - /// context + /// serialization information. + /// context. public override void GetObjectData(SerializationInfo info, StreamingContext context) { if (info == null) @@ -796,8 +796,8 @@ public RedirectedException(string message, /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected RedirectedException(SerializationInfo info, StreamingContext context) @@ -864,8 +864,8 @@ public ScriptCallDepthException(string message, /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected ScriptCallDepthException(SerializationInfo info, StreamingContext context) @@ -875,8 +875,8 @@ protected ScriptCallDepthException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// context + /// serialization information. + /// context. [SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) @@ -973,8 +973,8 @@ public PipelineDepthException(string message, /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PipelineDepthException(SerializationInfo info, StreamingContext context) @@ -984,8 +984,8 @@ protected PipelineDepthException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// context + /// serialization information. + /// context. [SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) @@ -1090,8 +1090,8 @@ public HaltCommandException(string message, /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected HaltCommandException(SerializationInfo info, StreamingContext context) diff --git a/src/System.Management.Automation/utils/ExtensionMethods.cs b/src/System.Management.Automation/utils/ExtensionMethods.cs index f633b24bacc..130f62d60cb 100644 --- a/src/System.Management.Automation/utils/ExtensionMethods.cs +++ b/src/System.Management.Automation/utils/ExtensionMethods.cs @@ -78,7 +78,7 @@ internal static partial class PSTypeExtensions /// /// Check does the type have an instance default constructor with visibility that allows calling it from subclass. /// - /// type + /// type. /// True when type has a default ctor. internal static bool HasDefaultCtor(this Type type) { diff --git a/src/System.Management.Automation/utils/GraphicalHostReflectionWrapper.cs b/src/System.Management.Automation/utils/GraphicalHostReflectionWrapper.cs index 49821d9634b..c7966c0c112 100644 --- a/src/System.Management.Automation/utils/GraphicalHostReflectionWrapper.cs +++ b/src/System.Management.Automation/utils/GraphicalHostReflectionWrapper.cs @@ -46,13 +46,13 @@ private GraphicalHostReflectionWrapper() /// Retrieves a wrapper used to invoke members of the type with name /// in Microsoft.PowerShell.GraphicalHost.dll /// - /// the cmdlet requesting the wrapper (used to throw terminating errors) - /// the type name we want to invoke members from + /// the cmdlet requesting the wrapper (used to throw terminating errors). + /// the type name we want to invoke members from. /// /// wrapper used to invoke members of the type with name /// in Microsoft.PowerShell.GraphicalHost.dll /// - /// When it was not possible to load Microsoft.PowerShell.GraphicalHost.dlly + /// When it was not possible to load Microsoft.PowerShell.GraphicalHost.dlly. internal static GraphicalHostReflectionWrapper GetGraphicalHostReflectionWrapper(PSCmdlet parentCmdlet, string graphicalHostHelperTypeName) { return GraphicalHostReflectionWrapper.GetGraphicalHostReflectionWrapper(parentCmdlet, graphicalHostHelperTypeName, parentCmdlet.CommandInfo.Name); @@ -62,14 +62,14 @@ internal static GraphicalHostReflectionWrapper GetGraphicalHostReflectionWrapper /// Retrieves a wrapper used to invoke members of the type with name /// in Microsoft.PowerShell.GraphicalHost.dll /// - /// the cmdlet requesting the wrapper (used to throw terminating errors) - /// the type name we want to invoke members from - /// used for error messages + /// the cmdlet requesting the wrapper (used to throw terminating errors). + /// the type name we want to invoke members from. + /// used for error messages. /// /// wrapper used to invoke members of the type with name /// in Microsoft.PowerShell.GraphicalHost.dll /// - /// When it was not possible to load Microsoft.PowerShell.GraphicalHost.dlly + /// When it was not possible to load Microsoft.PowerShell.GraphicalHost.dlly. [SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Justification = "Assembly.Load has been found to throw unadvertised exceptions")] internal static GraphicalHostReflectionWrapper GetGraphicalHostReflectionWrapper(PSCmdlet parentCmdlet, string graphicalHostHelperTypeName, string featureName) { @@ -143,7 +143,7 @@ internal static GraphicalHostReflectionWrapper GetGraphicalHostReflectionWrapper /// /// Used to escape characters that are not friendly to WPF binding /// - /// property name to be used in binding + /// property name to be used in binding. /// String with escaped characters. internal static string EscapeBinding(string propertyName) { @@ -153,8 +153,8 @@ internal static string EscapeBinding(string propertyName) /// /// Calls an instance method with name passing the /// - /// name of the method to call - /// arguments to call the method with + /// name of the method to call. + /// arguments to call the method with. /// The method return value. internal object CallMethod(string methodName, params object[] arguments) { @@ -167,8 +167,8 @@ internal object CallMethod(string methodName, params object[] arguments) /// /// Calls a static method with name passing the /// - /// name of the method to call - /// arguments to call the method with + /// name of the method to call. + /// arguments to call the method with. /// The method return value. internal object CallStaticMethod(string methodName, params object[] arguments) { @@ -180,7 +180,7 @@ internal object CallStaticMethod(string methodName, params object[] arguments) /// /// Gets the value of an instance property with name /// - /// name of the instance property to get the value from + /// name of the instance property to get the value from. /// The value of an instance property with name internal object GetPropertyValue(string propertyName) { @@ -193,7 +193,7 @@ internal object GetPropertyValue(string propertyName) /// /// Gets the value of a static property with name /// - /// name of the static property to get the value from + /// name of the static property to get the value from. /// The value of a static property with name internal object GetStaticPropertyValue(string propertyName) { @@ -205,7 +205,7 @@ internal object GetStaticPropertyValue(string propertyName) /// /// Returns true if the is being run remotely /// - /// cmdlet we want to see if is running remotely + /// cmdlet we want to see if is running remotely. /// True if the is being run remotely. private static bool IsInputFromRemoting(PSCmdlet parentCmdlet) { diff --git a/src/System.Management.Automation/utils/IObjectReader.cs b/src/System.Management.Automation/utils/IObjectReader.cs index 4646be9aa06..67e04f323c7 100644 --- a/src/System.Management.Automation/utils/IObjectReader.cs +++ b/src/System.Management.Automation/utils/IObjectReader.cs @@ -96,7 +96,7 @@ public abstract int MaxCapacity /// /// Read at most objects /// - /// The maximum number of objects to read + /// The maximum number of objects to read. /// The objects read. /// /// This method blocks if the number of objects in the stream is less than @@ -152,7 +152,7 @@ public abstract int MaxCapacity /// /// The next object in the stream or AutomationNull.Value if the stream is empty /// - /// The stream is closed + /// The stream is closed. public abstract T Peek(); #region IEnumerable Members diff --git a/src/System.Management.Automation/utils/IObjectWriter.cs b/src/System.Management.Automation/utils/IObjectWriter.cs index cde26beff0b..71e5b91ee3b 100644 --- a/src/System.Management.Automation/utils/IObjectWriter.cs +++ b/src/System.Management.Automation/utils/IObjectWriter.cs @@ -84,7 +84,7 @@ public abstract int MaxCapacity /// /// Write a single object into the underlying stream /// - /// The object to add to the stream + /// The object to add to the stream. /// /// One, if the write was successful, otherwise; /// zero if the stream was closed before the object could be written, @@ -101,7 +101,7 @@ public abstract int MaxCapacity /// /// Write multiple objects to the underlying stream /// - /// object or enumeration to read from + /// object or enumeration to read from. /// /// If enumerateCollection is true, and /// is an enumeration according to LanguagePrimitives.GetEnumerable, diff --git a/src/System.Management.Automation/utils/MetadataExceptions.cs b/src/System.Management.Automation/utils/MetadataExceptions.cs index 284996ded18..3609f73e1ba 100644 --- a/src/System.Management.Automation/utils/MetadataExceptions.cs +++ b/src/System.Management.Automation/utils/MetadataExceptions.cs @@ -19,8 +19,8 @@ public class MetadataException : RuntimeException /// /// Initializes a new instance of MetadataException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected MetadataException(SerializationInfo info, StreamingContext context) : base(info, context) { SetErrorCategory(ErrorCategory.MetadataError); @@ -38,7 +38,7 @@ public MetadataException() : base(typeof(MetadataException).FullName) /// /// Initializes a new instance of MetadataException setting the message /// - /// the exception's message + /// the exception's message. public MetadataException(string message) : base(message) { SetErrorCategory(ErrorCategory.MetadataError); @@ -47,8 +47,8 @@ public MetadataException(string message) : base(message) /// /// Initializes a new instance of MetadataException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public MetadataException(string message, Exception innerException) : base(message, innerException) { SetErrorCategory(ErrorCategory.MetadataError); @@ -101,8 +101,8 @@ public class ValidationMetadataException : MetadataException /// /// Initializes a new instance of ValidationMetadataException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected ValidationMetadataException(SerializationInfo info, StreamingContext context) : base(info, context) { } /// /// Initializes a new instance of ValidationMetadataException with the message set @@ -112,13 +112,13 @@ public ValidationMetadataException() : base(typeof(ValidationMetadataException). /// /// Initializes a new instance of ValidationMetadataException setting the message /// - /// the exception's message + /// the exception's message. public ValidationMetadataException(string message) : this(message, false) { } /// /// Initializes a new instance of ValidationMetadataException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public ValidationMetadataException(string message, Exception innerException) : base(message, innerException) { } internal ValidationMetadataException(string errorId, Exception innerException, string resourceStr, params object[] arguments) : @@ -165,8 +165,8 @@ public class ArgumentTransformationMetadataException : MetadataException /// /// Initializes a new instance of ArgumentTransformationMetadataException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected ArgumentTransformationMetadataException(SerializationInfo info, StreamingContext context) : base(info, context) { } /// /// Initializes a new instance of ArgumentTransformationMetadataException with the message set @@ -176,13 +176,13 @@ public ArgumentTransformationMetadataException() : base(typeof(ArgumentTransform /// /// Initializes a new instance of ArgumentTransformationMetadataException setting the message /// - /// the exception's message + /// the exception's message. public ArgumentTransformationMetadataException(string message) : base(message) { } /// /// Initializes a new instance of ArgumentTransformationMetadataException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public ArgumentTransformationMetadataException(string message, Exception innerException) : base(message, innerException) { } internal ArgumentTransformationMetadataException(string errorId, Exception innerException, string resourceStr, params object[] arguments) : @@ -202,8 +202,8 @@ public class ParsingMetadataException : MetadataException /// /// Initializes a new instance of ParsingMetadataException with serialization parameters /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected ParsingMetadataException(SerializationInfo info, StreamingContext context) : base(info, context) { } /// /// Initializes a new instance of ParsingMetadataException with the message set @@ -213,13 +213,13 @@ public ParsingMetadataException() : base(typeof(ParsingMetadataException).FullNa /// /// Initializes a new instance of ParsingMetadataException setting the message /// - /// the exception's message + /// the exception's message. public ParsingMetadataException(string message) : base(message) { } /// /// Initializes a new instance of ParsingMetadataException setting the message and innerException /// - /// the exception's message - /// the exceptions's inner exception + /// the exception's message. + /// the exceptions's inner exception. public ParsingMetadataException(string message, Exception innerException) : base(message, innerException) { } internal ParsingMetadataException(string errorId, Exception innerException, string resourceStr, params object[] arguments) : diff --git a/src/System.Management.Automation/utils/MshArgumentException.cs b/src/System.Management.Automation/utils/MshArgumentException.cs index fc3fd0b1c9f..2af015daa28 100644 --- a/src/System.Management.Automation/utils/MshArgumentException.cs +++ b/src/System.Management.Automation/utils/MshArgumentException.cs @@ -67,8 +67,8 @@ public PSArgumentException(string message, string paramName) /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PSArgumentException(SerializationInfo info, StreamingContext context) @@ -81,8 +81,8 @@ protected PSArgumentException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/System.Management.Automation/utils/MshArgumentNullException.cs b/src/System.Management.Automation/utils/MshArgumentNullException.cs index a1a49115c72..216e8057995 100644 --- a/src/System.Management.Automation/utils/MshArgumentNullException.cs +++ b/src/System.Management.Automation/utils/MshArgumentNullException.cs @@ -78,8 +78,8 @@ public PSArgumentNullException(string paramName, string message) /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PSArgumentNullException(SerializationInfo info, StreamingContext context) @@ -92,8 +92,8 @@ protected PSArgumentNullException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/System.Management.Automation/utils/MshArgumentOutOfRangeException.cs b/src/System.Management.Automation/utils/MshArgumentOutOfRangeException.cs index 32e14916c18..4e0f904a0ed 100644 --- a/src/System.Management.Automation/utils/MshArgumentOutOfRangeException.cs +++ b/src/System.Management.Automation/utils/MshArgumentOutOfRangeException.cs @@ -66,8 +66,8 @@ public PSArgumentOutOfRangeException(string paramName, object actualValue, strin /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PSArgumentOutOfRangeException(SerializationInfo info, StreamingContext context) @@ -79,8 +79,8 @@ protected PSArgumentOutOfRangeException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/System.Management.Automation/utils/MshInvalidOperationException.cs b/src/System.Management.Automation/utils/MshInvalidOperationException.cs index 0537b8a3304..09a3551584b 100644 --- a/src/System.Management.Automation/utils/MshInvalidOperationException.cs +++ b/src/System.Management.Automation/utils/MshInvalidOperationException.cs @@ -37,8 +37,8 @@ public PSInvalidOperationException() /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PSInvalidOperationException(SerializationInfo info, StreamingContext context) @@ -50,8 +50,8 @@ protected PSInvalidOperationException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/System.Management.Automation/utils/MshNotImplementedException.cs b/src/System.Management.Automation/utils/MshNotImplementedException.cs index f370dcd7730..157ed74a41f 100644 --- a/src/System.Management.Automation/utils/MshNotImplementedException.cs +++ b/src/System.Management.Automation/utils/MshNotImplementedException.cs @@ -37,8 +37,8 @@ public PSNotImplementedException() /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PSNotImplementedException(SerializationInfo info, StreamingContext context) @@ -50,8 +50,8 @@ protected PSNotImplementedException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/System.Management.Automation/utils/MshNotSupportedException.cs b/src/System.Management.Automation/utils/MshNotSupportedException.cs index 40969b8032a..c03a670b771 100644 --- a/src/System.Management.Automation/utils/MshNotSupportedException.cs +++ b/src/System.Management.Automation/utils/MshNotSupportedException.cs @@ -37,8 +37,8 @@ public PSNotSupportedException() /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PSNotSupportedException(SerializationInfo info, StreamingContext context) @@ -50,8 +50,8 @@ protected PSNotSupportedException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/System.Management.Automation/utils/MshObjectDisposedException.cs b/src/System.Management.Automation/utils/MshObjectDisposedException.cs index 1afa0f21107..c4e00987ac9 100644 --- a/src/System.Management.Automation/utils/MshObjectDisposedException.cs +++ b/src/System.Management.Automation/utils/MshObjectDisposedException.cs @@ -65,8 +65,8 @@ public PSObjectDisposedException(string message, Exception innerException) /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected PSObjectDisposedException(SerializationInfo info, StreamingContext context) @@ -78,8 +78,8 @@ protected PSObjectDisposedException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { diff --git a/src/System.Management.Automation/utils/ObjectReader.cs b/src/System.Management.Automation/utils/ObjectReader.cs index ab13cb49045..8c12d239fd4 100644 --- a/src/System.Management.Automation/utils/ObjectReader.cs +++ b/src/System.Management.Automation/utils/ObjectReader.cs @@ -21,8 +21,8 @@ internal abstract class ObjectReaderBase : PipelineReader, IDisposable /// /// Construct with an existing ObjectStream /// - /// the stream to read - /// Thrown if the specified stream is null + /// the stream to read. + /// Thrown if the specified stream is null. public ObjectReaderBase([In, Out] ObjectStreamBase stream) { if (stream == null) @@ -174,7 +174,7 @@ public override void Close() /// /// Handle DataReady events from the underlying stream /// - /// The stream raising the event + /// The stream raising the event. /// standard event args. private void OnDataReady(object sender, EventArgs args) { @@ -222,7 +222,7 @@ public void Dispose() /// /// release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. protected abstract void Dispose(bool disposing); #endregion IDisposable @@ -240,8 +240,8 @@ internal class ObjectReader : ObjectReaderBase /// /// Construct with an existing ObjectStream /// - /// the stream to read - /// Thrown if the specified stream is null + /// the stream to read. + /// Thrown if the specified stream is null. public ObjectReader([In, Out] ObjectStream stream) : base(stream) { } @@ -250,7 +250,7 @@ public ObjectReader([In, Out] ObjectStream stream) /// /// Read at most objects /// - /// The maximum number of objects to read + /// The maximum number of objects to read. /// The objects read. /// /// This method blocks if the number of objects in the stream is less than @@ -328,7 +328,7 @@ public override object Peek() /// /// release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. protected override void Dispose(bool disposing) { if (disposing) @@ -350,8 +350,8 @@ internal class PSObjectReader : ObjectReaderBase /// /// Construct with an existing ObjectStream /// - /// the stream to read - /// Thrown if the specified stream is null + /// the stream to read. + /// Thrown if the specified stream is null. public PSObjectReader([In, Out] ObjectStream stream) : base(stream) { } @@ -360,7 +360,7 @@ public PSObjectReader([In, Out] ObjectStream stream) /// /// Read at most objects /// - /// The maximum number of objects to read + /// The maximum number of objects to read. /// The objects read. /// /// This method blocks if the number of objects in the stream is less than @@ -438,7 +438,7 @@ public override PSObject Peek() /// /// release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. protected override void Dispose(bool disposing) { if (disposing) @@ -498,8 +498,8 @@ internal class PSDataCollectionReader /// /// Construct with an existing ObjectStream /// - /// the stream to read - /// Thrown if the specified stream is null + /// the stream to read. + /// Thrown if the specified stream is null. public PSDataCollectionReader(PSDataCollectionStream stream) : base(stream) { @@ -513,7 +513,7 @@ public PSDataCollectionReader(PSDataCollectionStream stream) /// /// This method is not supported. /// - /// The maximum number of objects to read + /// The maximum number of objects to read. /// The objects read. public override Collection Read(int count) { @@ -610,7 +610,7 @@ public override ReturnType Peek() /// /// release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. protected override void Dispose(bool disposing) { if (disposing) @@ -657,7 +657,7 @@ internal class PSDataCollectionPipelineReader /// /// Construct with an existing ObjectStream /// - /// the stream to read + /// the stream to read. /// /// internal PSDataCollectionPipelineReader(PSDataCollectionStream stream, @@ -688,7 +688,7 @@ internal PSDataCollectionPipelineReader(PSDataCollectionStream st /// /// This method is not supported. /// - /// The maximum number of objects to read + /// The maximum number of objects to read. /// The objects read. public override Collection Read(int count) { @@ -793,7 +793,7 @@ public override ReturnType Peek() /// /// Converts to the return type based on language primitives /// - /// input object to convert + /// input object to convert. /// Input object converted to the specified return type. private ReturnType ConvertToReturnType(object inputObject) { @@ -815,7 +815,7 @@ private ReturnType ConvertToReturnType(object inputObject) /// /// release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. protected override void Dispose(bool disposing) { if (disposing) diff --git a/src/System.Management.Automation/utils/ObjectStream.cs b/src/System.Management.Automation/utils/ObjectStream.cs index 6981f3741b1..eee7bc1a13d 100644 --- a/src/System.Management.Automation/utils/ObjectStream.cs +++ b/src/System.Management.Automation/utils/ObjectStream.cs @@ -162,7 +162,7 @@ internal virtual object Read() /// /// Read at most objects /// - /// The maximum number of objects to read + /// The maximum number of objects to read. /// The objects read. /// /// is less than 0 @@ -239,7 +239,7 @@ internal virtual Collection NonBlockingRead(int maxRequested) /// /// The next object in the stream or AutomationNull.Value if the stream is empty /// - /// The ObjectStream is closed + /// The ObjectStream is closed. internal virtual object Peek() { throw PSTraceSource.NewNotSupportedException(); @@ -273,7 +273,7 @@ internal virtual int Write(object value) /// /// Write objects to the underlying stream /// - /// object or enumeration to read from + /// object or enumeration to read from. /// /// If enumerateCollection is true, and /// is an enumeration according to LanguagePrimitives.GetEnumerable, @@ -338,7 +338,7 @@ public void Dispose() /// /// release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. protected abstract void Dispose(bool disposing); #endregion IDisposable @@ -1099,7 +1099,7 @@ internal override object Read() /// /// Read at most objects /// - /// The maximum number of objects to read + /// The maximum number of objects to read. /// The objects read. /// /// is less than 0 @@ -1276,7 +1276,7 @@ internal override Collection NonBlockingRead(int maxRequested) /// /// The next object in the stream or AutomationNull.Value if the stream is empty /// - /// The ObjectStream is closed + /// The ObjectStream is closed. internal override object Peek() { object result = null; @@ -1303,7 +1303,7 @@ internal override object Peek() /// /// Write objects to the underlying stream /// - /// object or enumeration to read from + /// object or enumeration to read from. /// /// If enumerateCollection is true, and /// is an enumeration according to LanguagePrimitives.GetEnumerable, @@ -1487,7 +1487,7 @@ private void DFT_RemoveHandler_OnDataReady(EventHandler eventHandler) /// /// release all resources /// - /// if true, release all managed resources + /// if true, release all managed resources. protected override void Dispose(bool disposing) { if (_disposed) @@ -1700,8 +1700,8 @@ internal override PipelineReader ObjectReader /// /// Creates an Object Reader for the pipeline /// - /// computer name that the pipeline specifies - /// runspace id that the pipeline specifies + /// computer name that the pipeline specifies. + /// runspace id that the pipeline specifies. /// the computer name and runspace id are associated with the /// reader so as to enable cmdlets to identify which computer name runspace does /// the object that this stream writes belongs to @@ -1747,8 +1747,8 @@ internal override PipelineReader PSObjectReader /// /// Creates a PSObject Reader for this pipeline /// - /// computer name that the pipeline specifies - /// runspace id that the pipeline specifies + /// computer name that the pipeline specifies. + /// runspace id that the pipeline specifies. /// the computer name and runspace id are associated with the /// reader so as to enable cmdlets to identify which computer name runspace does /// the object that this stream writes belongs to @@ -1941,7 +1941,7 @@ private void HandleDataAdded(object sender, DataAddedEventArgs e) /// /// release all resources /// - /// if true, release all resources + /// if true, release all resources. protected override void Dispose(bool disposing) { if (_disposed) diff --git a/src/System.Management.Automation/utils/ObjectWriter.cs b/src/System.Management.Automation/utils/ObjectWriter.cs index e41acbf6f2a..9b5403e7d85 100644 --- a/src/System.Management.Automation/utils/ObjectWriter.cs +++ b/src/System.Management.Automation/utils/ObjectWriter.cs @@ -19,8 +19,8 @@ internal class ObjectWriter : PipelineWriter /// /// Construct with an existing ObjectStream /// - /// the stream to write - /// Thrown if the specified stream is null + /// the stream to write. + /// Thrown if the specified stream is null. public ObjectWriter([In, Out] ObjectStreamBase stream) { if (stream == null) @@ -130,7 +130,7 @@ public override void Flush() /// /// Write a single object into the underlying stream /// - /// The object to add to the stream + /// The object to add to the stream. /// /// One, if the write was successful, otherwise; /// zero if the stream was closed before the object could be written, @@ -150,7 +150,7 @@ public override int Write(object obj) /// /// Write objects to the underlying stream /// - /// object or enumeration to read from + /// object or enumeration to read from. /// /// If enumerateCollection is true, and /// is an enumeration according to LanguagePrimitives.GetEnumerable, @@ -177,7 +177,7 @@ public override int Write(object obj, bool enumerateCollection) /// /// Handle WriteReady events from the underlying stream /// - /// The stream raising the event + /// The stream raising the event. /// standard event args. private void OnWriteReady (object sender, EventArgs args) { @@ -220,7 +220,7 @@ internal class PSDataCollectionWriter : ObjectWriter /// /// Construct with an existing PSDataCollectionStream /// - /// the stream to write + /// the stream to write. /// /// Thrown if the specified stream is null /// diff --git a/src/System.Management.Automation/utils/ParserException.cs b/src/System.Management.Automation/utils/ParserException.cs index 34706da0681..aaba2a0c5be 100644 --- a/src/System.Management.Automation/utils/ParserException.cs +++ b/src/System.Management.Automation/utils/ParserException.cs @@ -30,8 +30,8 @@ public ParseError[] Errors /// Initializes a new instance of the ParseException class and defines the serialization information, /// and streaming context. /// - /// The serialization information to use when initializing this object - /// The streaming context to use when initializing this object + /// The serialization information to use when initializing this object. + /// The streaming context to use when initializing this object. /// Constructed object. protected ParseException(SerializationInfo info, StreamingContext context) @@ -71,7 +71,7 @@ public ParseException() : base() /// /// Initializes a new instance of the ParseException class and defines the error message. /// - /// The error message to use when initializing this object + /// The error message to use when initializing this object. /// Constructed object. public ParseException(string message) : base(message) { @@ -83,8 +83,8 @@ public ParseException(string message) : base(message) /// Initializes a new instance of the ParseException class and defines the error message and /// errorID. /// - /// The error message to use when initializing this object - /// The errorId to use when initializing this object + /// The error message to use when initializing this object. + /// The errorId to use when initializing this object. /// Constructed object. internal ParseException(string message, string errorId) : base(message) { @@ -96,9 +96,9 @@ internal ParseException(string message, string errorId) : base(message) /// Initializes a new instance of the ParseException class and defines the error message, /// error ID and inner exception. /// - /// The error message to use when initializing this object - /// The errorId to use when initializing this object - /// The inner exception to use when initializing this object + /// The error message to use when initializing this object. + /// The errorId to use when initializing this object. + /// The inner exception to use when initializing this object. /// Constructed object. internal ParseException(string message, string errorId, Exception innerException) : base(message, innerException) @@ -111,8 +111,8 @@ internal ParseException(string message, string errorId, Exception innerException /// Initializes a new instance of the ParseException class and defines the error message and /// inner exception. /// - /// The error message to use when initializing this object - /// The inner exception to use when initializing this object + /// The error message to use when initializing this object. + /// The inner exception to use when initializing this object. /// Constructed object. public ParseException(string message, Exception innerException) @@ -191,8 +191,8 @@ public class IncompleteParseException /// Initializes a new instance of the IncompleteParseException class and defines the serialization information, /// and streaming context. /// - /// The serialization information to use when initializing this object - /// The streaming context to use when initializing this object + /// The serialization information to use when initializing this object. + /// The streaming context to use when initializing this object. /// Constructed object. protected IncompleteParseException(SerializationInfo info, StreamingContext context) @@ -214,7 +214,7 @@ public IncompleteParseException() : base() /// /// Initializes a new instance of the IncompleteParseException class and defines the error message. /// - /// The error message to use when initializing this object + /// The error message to use when initializing this object. /// Constructed object. public IncompleteParseException(string message) : base(message) { @@ -226,8 +226,8 @@ public IncompleteParseException(string message) : base(message) /// Initializes a new instance of the IncompleteParseException class and defines the error message and /// errorID. /// - /// The error message to use when initializing this object - /// The errorId to use when initializing this object + /// The error message to use when initializing this object. + /// The errorId to use when initializing this object. /// Constructed object. internal IncompleteParseException(string message, string errorId) : base(message, errorId) { @@ -238,9 +238,9 @@ internal IncompleteParseException(string message, string errorId) : base(message /// Initializes a new instance of the IncompleteParseException class and defines the error message, /// error ID and inner exception. /// - /// The error message to use when initializing this object - /// The errorId to use when initializing this object - /// The inner exception to use when initializing this object + /// The error message to use when initializing this object. + /// The errorId to use when initializing this object. + /// The inner exception to use when initializing this object. /// Constructed object. internal IncompleteParseException(string message, string errorId, Exception innerException) : base(message, errorId, innerException) @@ -252,8 +252,8 @@ internal IncompleteParseException(string message, string errorId, Exception inne /// Initializes a new instance of the IncompleteParseException class and defines the error message and /// inner exception. /// - /// The error message to use when initializing this object - /// The inner exception to use when initializing this object + /// The error message to use when initializing this object. + /// The inner exception to use when initializing this object. /// Constructed object. public IncompleteParseException(string message, Exception innerException) diff --git a/src/System.Management.Automation/utils/PathUtils.cs b/src/System.Management.Automation/utils/PathUtils.cs index 844ebac54fc..ca43043b37a 100644 --- a/src/System.Management.Automation/utils/PathUtils.cs +++ b/src/System.Management.Automation/utils/PathUtils.cs @@ -20,16 +20,16 @@ internal static class PathUtils /// THE method for opening a file for writing. /// Should be used by all cmdlets that write to a file. /// - /// cmdlet that is opening the file (used mainly for error reporting) - /// path to the file (as specified on the command line - this method will resolve the path) - /// encoding (this method will convert the command line string to an Encoding instance) - /// if true, then we will use default .NET encoding instead of the encoding specified in parameter + /// cmdlet that is opening the file (used mainly for error reporting). + /// path to the file (as specified on the command line - this method will resolve the path). + /// encoding (this method will convert the command line string to an Encoding instance). + /// if true, then we will use default .NET encoding instead of the encoding specified in parameter. /// /// /// - /// Result1: opened for writing - /// Result2: (inherits from ) opened for writing - /// Result3: file info that should be used to restore file attributes after done with the file (null is this is not needed) + /// Result1: opened for writing. + /// Result2: (inherits from ) opened for writing. + /// Result3: file info that should be used to restore file attributes after done with the file (null is this is not needed). /// True if wildcard expansion should be bypassed. internal static void MasterStreamOpen( PSCmdlet cmdlet, @@ -54,16 +54,16 @@ bool isLiteralPath /// THE method for opening a file for writing. /// Should be used by all cmdlets that write to a file. /// - /// cmdlet that is opening the file (used mainly for error reporting) - /// path to the file (as specified on the command line - this method will resolve the path) - /// encoding (this method will convert the command line string to an Encoding instance) - /// if true, then we will use default .NET encoding instead of the encoding specified in parameter + /// cmdlet that is opening the file (used mainly for error reporting). + /// path to the file (as specified on the command line - this method will resolve the path). + /// encoding (this method will convert the command line string to an Encoding instance). + /// if true, then we will use default .NET encoding instead of the encoding specified in parameter. /// /// /// - /// Result1: opened for writing - /// Result2: (inherits from ) opened for writing - /// Result3: file info that should be used to restore file attributes after done with the file (null is this is not needed) + /// Result1: opened for writing. + /// Result2: (inherits from ) opened for writing. + /// Result3: file info that should be used to restore file attributes after done with the file (null is this is not needed). /// True if wildcard expansion should be bypassed. internal static void MasterStreamOpen( PSCmdlet cmdlet, diff --git a/src/System.Management.Automation/utils/PlatformInvokes.cs b/src/System.Management.Automation/utils/PlatformInvokes.cs index 12ac6fee3cf..88f061ff44a 100644 --- a/src/System.Management.Automation/utils/PlatformInvokes.cs +++ b/src/System.Management.Automation/utils/PlatformInvokes.cs @@ -517,9 +517,9 @@ internal struct PRIVILEGE_SET /// Retrieves the current process token. /// This function exists just for backward compatibility. It is prefered to use the other override that takes 'SafeHandle' as parameter. /// - /// process handle - /// token access - /// process token + /// process handle. + /// token access. + /// process token. /// The current process token. [DllImport(PinvokeDllNames.OpenProcessTokenDllName, CharSet = CharSet.Unicode, SetLastError = true, BestFitMapping = false)] [SuppressMessage("Microsoft.Security", "CA2118:ReviewSuppressUnmanagedCodeSecurityUsage")] diff --git a/src/System.Management.Automation/utils/PowerShellExecutionHelper.cs b/src/System.Management.Automation/utils/PowerShellExecutionHelper.cs index 1054bbf59fc..af6fa2d5c28 100644 --- a/src/System.Management.Automation/utils/PowerShellExecutionHelper.cs +++ b/src/System.Management.Automation/utils/PowerShellExecutionHelper.cs @@ -173,7 +173,7 @@ internal Collection ExecuteCurrentPowerShell(out Exception exceptionTh /// /// Converts an object to a string safely... /// - /// The object to convert + /// The object to convert. /// The result of the conversion... internal static string SafeToString(object obj) { @@ -211,7 +211,7 @@ internal static string SafeToString(object obj) /// /// Converts an object to a string adn, if the string is not empty, adds it to the list /// - /// The list to update + /// The list to update. /// The object to convert to a string... internal static void SafeAddToStringList(List list, object obj) { diff --git a/src/System.Management.Automation/utils/PsUtils.cs b/src/System.Management.Automation/utils/PsUtils.cs index 0ce9c52f5d8..9de90f35a00 100644 --- a/src/System.Management.Automation/utils/PsUtils.cs +++ b/src/System.Management.Automation/utils/PsUtils.cs @@ -282,7 +282,7 @@ internal struct SYSTEM_INFO /// to the remote end that contains the key of each UsingExpressionAst and its value. This method /// is used to generate the key. /// - /// A using expression + /// A using expression. /// Base64 encoded string as the key of the UsingExpressionAst. internal static string GetUsingExpressionKey(Language.UsingExpressionAst usingAst) { @@ -552,7 +552,7 @@ internal static class StringToBase64Converter /// /// Converts string to base64 encoded string /// - /// string to encode + /// string to encode. /// Base64 encoded string. internal static string StringToBase64String(string input) { @@ -573,7 +573,7 @@ internal static string StringToBase64String(string input) /// /// Decodes base64 encoded string /// - /// base64 string to decode + /// base64 string to decode. /// Decoded string. internal static string Base64ToString(string base64) { diff --git a/src/System.Management.Automation/utils/RuntimeException.cs b/src/System.Management.Automation/utils/RuntimeException.cs index 990335466c5..6df08fe2546 100644 --- a/src/System.Management.Automation/utils/RuntimeException.cs +++ b/src/System.Management.Automation/utils/RuntimeException.cs @@ -39,8 +39,8 @@ public RuntimeException() /// using data serialized via /// /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. /// Constructed object. protected RuntimeException(SerializationInfo info, StreamingContext context) @@ -53,8 +53,8 @@ protected RuntimeException(SerializationInfo info, /// /// Serializer for /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -177,7 +177,7 @@ public virtual ErrorRecord ErrorRecord /// to change this before writing to ErrorRecord.ErrorDetails /// or the like. /// - /// per ErrorRecord constructors + /// per ErrorRecord constructors. internal void SetErrorId(string errorId) { if (_errorId != errorId) diff --git a/src/System.Management.Automation/utils/SessionStateExceptions.cs b/src/System.Management.Automation/utils/SessionStateExceptions.cs index 1d48256289b..b9859f32229 100644 --- a/src/System.Management.Automation/utils/SessionStateExceptions.cs +++ b/src/System.Management.Automation/utils/SessionStateExceptions.cs @@ -396,15 +396,15 @@ public class SessionStateException : RuntimeException /// /// Constructs a SessionStateException /// - /// name of session state object - /// category of session state object + /// name of session state object. + /// category of session state object. /// This string is the message template string. /// /// This string is the ErrorId passed to the ErrorRecord, and is also /// the resourceId used to look up the message template string in /// SessionStateStrings.txt. /// - /// ErrorRecord.CategoryInfo.Category + /// ErrorRecord.CategoryInfo.Category. /// /// Additional insertion strings used to construct the message. /// Note that itemName is always the first insertion string. @@ -463,8 +463,8 @@ public SessionStateException(string message, /// /// Constructs a SessionStateException using serialized data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected SessionStateException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -475,8 +475,8 @@ protected SessionStateException(SerializationInfo info, /// /// Serializes the exception data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)] public override void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -642,8 +642,8 @@ public SessionStateUnauthorizedAccessException(string message, /// /// Constructs a SessionStateUnauthorizedAccessException using serialized data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected SessionStateUnauthorizedAccessException( SerializationInfo info, StreamingContext context) @@ -736,8 +736,8 @@ public ProviderNotFoundException(string message, /// /// Constructs a ProviderNotFoundException using serialized data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected ProviderNotFoundException( SerializationInfo info, StreamingContext context) @@ -831,8 +831,8 @@ public ProviderNameAmbiguousException(string message, /// /// Constructs a ProviderNameAmbiguousException using serialized data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected ProviderNameAmbiguousException( SerializationInfo info, StreamingContext context) @@ -931,8 +931,8 @@ public DriveNotFoundException(string message, /// /// Constructs a DriveNotFoundException using serialized data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected DriveNotFoundException( SerializationInfo info, StreamingContext context) @@ -1015,8 +1015,8 @@ public ItemNotFoundException(string message, /// /// Constructs a ItemNotFoundException using serialized data. /// - /// serialization information - /// streaming context + /// serialization information. + /// streaming context. protected ItemNotFoundException( SerializationInfo info, StreamingContext context) diff --git a/src/System.Management.Automation/utils/StructuredTraceSource.cs b/src/System.Management.Automation/utils/StructuredTraceSource.cs index 1d090050209..a45f91086e9 100644 --- a/src/System.Management.Automation/utils/StructuredTraceSource.cs +++ b/src/System.Management.Automation/utils/StructuredTraceSource.cs @@ -910,7 +910,7 @@ internal void WriteLine(string format) /// /// Traces the formatted output when PSTraceSourceOptions.WriteLine is enabled /// - /// The format string + /// The format string. /// internal void WriteLine(string format, object arg1) { @@ -927,7 +927,7 @@ internal void WriteLine(string format, object arg1) /// /// Traces the formatted output when PSTraceSourceOptions.WriteLine is enabled /// - /// The format string + /// The format string. /// /// internal void WriteLine(string format, object arg1, object arg2) @@ -945,7 +945,7 @@ internal void WriteLine(string format, object arg1, object arg2) /// /// Traces the formatted output when PSTraceSourceOptions.WriteLine is enabled /// - /// The format string + /// The format string. /// /// /// @@ -964,7 +964,7 @@ internal void WriteLine(string format, object arg1, object arg2, object arg3) /// /// Traces the formatted output when PSTraceSourceOptions.WriteLine is enabled /// - /// The format string + /// The format string. /// /// /// @@ -984,7 +984,7 @@ internal void WriteLine(string format, object arg1, object arg2, object arg3, ob /// /// Traces the formatted output when PSTraceSourceOptions.WriteLine is enabled /// - /// The format string + /// The format string. /// /// /// @@ -1005,7 +1005,7 @@ internal void WriteLine(string format, object arg1, object arg2, object arg3, ob /// /// Traces the formatted output when PSTraceSourceOptions.WriteLine is enabled /// - /// The format string + /// The format string. /// /// /// diff --git a/src/System.Management.Automation/utils/assert.cs b/src/System.Management.Automation/utils/assert.cs index 8d8577a861f..627db136e25 100644 --- a/src/System.Management.Automation/utils/assert.cs +++ b/src/System.Management.Automation/utils/assert.cs @@ -23,7 +23,7 @@ internal class AssertException : SystemException /// /// calls the base class with message and sets the stack frame /// - /// repassed to the base class + /// repassed to the base class. internal AssertException(string message) : base(message) { // 3 will skip the assertion caller, this method and AssertException.StackTrace diff --git a/src/System.Management.Automation/utils/tracing/EtwActivity.cs b/src/System.Management.Automation/utils/tracing/EtwActivity.cs index 29c135a4471..9ca169ffdcf 100644 --- a/src/System.Management.Automation/utils/tracing/EtwActivity.cs +++ b/src/System.Management.Automation/utils/tracing/EtwActivity.cs @@ -80,9 +80,9 @@ public object[] Payload /// /// Creates a new instance of EtwEventArgs class. /// - /// Event descriptor - /// Indicate whether the event is successfully written - /// Event payload + /// Event descriptor. + /// Indicate whether the event is successfully written. + /// Event payload. public EtwEventArgs(EventDescriptor descriptor, bool success, object[] payload) { this.Descriptor = descriptor; @@ -357,8 +357,8 @@ public bool IsEnabled /// /// Checks whether a provider matching certain levels and keyword is enabled /// - /// Levels to check - /// Keywords to check + /// Levels to check. + /// Keywords to check. /// True, if any ETW listener is enabled else false. public bool IsProviderEnabled(byte levels, long keywords) { @@ -464,8 +464,8 @@ protected virtual EventDescriptor TransferEvent /// This is the main method that write the messages to the trace. /// All derived classes must use this method to write to the provider log. /// - /// EventDescriptor - /// payload + /// EventDescriptor. + /// payload. protected void WriteEvent(EventDescriptor ed, params object[] payload) { EventProvider provider = GetProvider(); diff --git a/src/System.Management.Automation/utils/tracing/PSEtwLogProvider.cs b/src/System.Management.Automation/utils/tracing/PSEtwLogProvider.cs index 7a078a30d7c..71936df99ad 100755 --- a/src/System.Management.Automation/utils/tracing/PSEtwLogProvider.cs +++ b/src/System.Management.Automation/utils/tracing/PSEtwLogProvider.cs @@ -244,11 +244,11 @@ internal override bool UseLoggingVariables() /// /// Writes a single event /// - /// event id + /// event id. /// /// /// - /// log context + /// log context. /// internal void WriteEvent(PSEventId id, PSChannel channel, PSOpcode opcode, PSTask task, LogContext logContext, string payLoad) { diff --git a/src/System.Management.Automation/utils/tracing/PSSysLogProvider.cs b/src/System.Management.Automation/utils/tracing/PSSysLogProvider.cs index f60ece39bf8..babff5c83ef 100755 --- a/src/System.Management.Automation/utils/tracing/PSSysLogProvider.cs +++ b/src/System.Management.Automation/utils/tracing/PSSysLogProvider.cs @@ -284,11 +284,11 @@ internal override bool UseLoggingVariables() /// /// Writes a single event /// - /// event id + /// event id. /// /// /// - /// log context + /// log context. /// internal void WriteEvent(PSEventId id, PSChannel channel, PSOpcode opcode, PSTask task, LogContext logContext, string payLoad) {