From 7207db6360d1527238975526e299d7bacde0d9d8 Mon Sep 17 00:00:00 2001 From: Ilya Date: Sat, 29 Dec 2018 08:25:49 +0500 Subject: [PATCH] Style: Convert to upper first char in and doc tags (#8556) --- .../CimAsyncOperation.cs | 12 +- .../CimCommandBase.cs | 2 +- .../CimRegisterCimIndication.cs | 6 +- .../CimResultObserver.cs | 6 +- .../CimSessionProxy.cs | 8 +- .../CimWriteError.cs | 12 +- .../cimSupport/cmdletization/cim/cimQuery.cs | 8 +- .../commands/management/Process.cs | 12 +- .../commands/management/Service.cs | 32 +- .../management/SetClipboardCommand.cs | 8 +- .../commands/management/WMIHelper.cs | 12 +- .../commands/utility/CSVCommands.cs | 2 +- .../commands/utility/CustomSerialization.cs | 16 +- .../FormatAndOutput/OutGridView/ColumnInfo.cs | 2 +- .../OutGridView/OutGridViewCommand.cs | 4 +- .../OutGridView/OutWindowProxy.cs | 2 +- .../out-printer/PrinterLineOutput.cs | 12 +- .../utility/ImplicitRemotingCommands.cs | 38 +-- .../commands/utility/Measure-Object.cs | 8 +- .../utility/ShowCommand/ShowCommand.cs | 34 +- .../utility/WebCmdlet/ConvertToJsonCommand.cs | 4 +- .../commands/utility/convert-HTML.cs | 2 +- .../commands/utility/select-object.cs | 2 +- .../utility/trace/TraceExpressionCommand.cs | 2 +- .../commands/utility/write.cs | 4 +- .../host/msh/ConsoleControl.cs | 2 +- .../host/msh/ConsoleHost.cs | 8 +- .../host/msh/ConsoleHostUserInterface.cs | 2 +- .../msh/ConsoleHostUserInterfacePrompt.cs | 18 +- .../msh/ConsoleHostUserInterfaceSecurity.cs | 20 +- .../ScheduledJobDefinition.cs | 2 +- .../ScheduledJobSourceAdapter.cs | 6 +- .../ScheduledJobTrigger.cs | 8 +- .../commands/SchedJobCmdletBase.cs | 4 +- .../security/CertificateProvider.cs | 70 ++-- .../security/SignatureCommands.cs | 2 +- .../security/Utils.cs | 30 +- src/Microsoft.WSMan.Management/WsManHelper.cs | 4 +- .../DscSupport/CimDSCParser.cs | 12 +- .../FormatAndOutput/common/BaseCommand.cs | 12 +- .../common/BaseFormattingCommand.cs | 6 +- .../common/BaseOutputtingCommand.cs | 56 ++-- .../common/ColumnWidthManager.cs | 16 +- .../FormatAndOutput/common/ComplexWriter.cs | 14 +- .../common/DisplayDatabase/FormatTable.cs | 4 +- .../common/DisplayDatabase/XmlLoaderBase.cs | 12 +- .../common/DisplayDatabase/typeDataManager.cs | 16 +- .../common/DisplayDatabase/typeDataQuery.cs | 4 +- .../DisplayDatabase/typeDataXmlLoader.cs | 26 +- .../common/FormatGroupManager.cs | 6 +- .../common/FormatMsgCtxManager.cs | 4 +- .../common/FormatViewGenerator.cs | 2 +- .../common/FormatViewGenerator_Complex.cs | 28 +- .../common/FormatViewManager.cs | 6 +- .../FormatAndOutput/common/FormatXMLWriter.cs | 14 +- .../common/FormattingObjectsDeserializer.cs | 14 +- .../FormatAndOutput/common/ILineOutput.cs | 38 +-- .../FormatAndOutput/common/ListWriter.cs | 16 +- .../FormatAndOutput/common/OutputManager.cs | 6 +- .../FormatAndOutput/common/OutputQueue.cs | 26 +- .../common/Utilities/MshObjectUtil.cs | 46 +-- .../common/Utilities/MshParameter.cs | 4 +- .../common/Utilities/Mshexpression.cs | 2 +- .../out-console/ConsoleLineOutput.cs | 18 +- .../cimSupport/cmdletization/QueryBuilder.cs | 8 +- .../engine/Attributes.cs | 74 ++--- .../engine/AutomationEngine.cs | 2 +- .../engine/COM/ComAdapter.cs | 46 +-- .../engine/COM/ComMethod.cs | 6 +- .../engine/COM/ComProperty.cs | 24 +- .../engine/COM/ComTypeInfo.cs | 4 +- .../engine/COM/ComUtil.cs | 4 +- .../engine/CmdletParameterBinderController.cs | 22 +- .../engine/CodeMethods.cs | 2 +- .../engine/ComInterop/ComBinder.cs | 2 +- .../CommandCompletion/CompletionCompleters.cs | 4 +- .../CommandCompletion/ExtensibleCompletion.cs | 6 +- .../engine/CommandDiscovery.cs | 4 +- .../engine/CommandMetadata.cs | 2 +- .../engine/CommandProcessor.cs | 4 +- .../engine/CommandProcessorBase.cs | 10 +- .../engine/CommandSearcher.cs | 2 +- .../engine/CoreAdapter.cs | 294 ++++++++-------- .../engine/DefaultCommandRuntime.cs | 46 +-- .../engine/ErrorPackage.cs | 28 +- .../engine/EventManager.cs | 2 +- .../engine/ExecutionContext.cs | 6 +- .../engine/ExtendedTypeSystemException.cs | 90 ++--- .../engine/ExtraAdapter.cs | 18 +- .../engine/ICommandRuntime.cs | 12 +- .../engine/InitialSessionState.cs | 2 +- .../engine/InternalCommands.cs | 24 +- .../engine/LanguagePrimitives.cs | 176 +++++----- .../engine/ManagementObjectAdapter.cs | 40 +-- .../MinishellParameterBinderController.cs | 2 +- .../engine/Modules/ModuleCmdletBase.cs | 30 +- .../engine/Modules/ModuleSpecification.cs | 6 +- .../engine/Modules/ModuleUtils.cs | 4 +- .../Modules/NewModuleManifestCommand.cs | 2 +- .../engine/Modules/PSModuleInfo.cs | 14 +- .../engine/MshCmdlet.cs | 26 +- .../engine/MshCommandRuntime.cs | 18 +- .../engine/MshMemberInfo.cs | 314 +++++++++--------- .../engine/MshObject.cs | 28 +- .../engine/MshObjectTypeDescriptor.cs | 4 +- .../engine/MshSecurityException.cs | 4 +- .../engine/NativeCommandParameterBinder.cs | 2 +- .../engine/NativeCommandProcessor.cs | 2 +- .../engine/ScriptCommandProcessor.cs | 4 +- .../engine/SecurityManagerBase.cs | 6 +- .../engine/SessionStateContainer.cs | 4 +- .../engine/SessionStateProviderAPIs.cs | 2 +- .../engine/SessionStateScope.cs | 2 +- .../engine/TypeMetadata.cs | 4 +- .../engine/TypeTable.cs | 20 +- .../engine/UserFeedbackParameters.cs | 2 +- .../engine/Utils.cs | 2 +- .../engine/WorkflowInfo.cs | 2 +- .../engine/cmdlet.cs | 16 +- .../engine/debugger/debugger.cs | 4 +- .../engine/hostifaces/Command.cs | 14 +- .../engine/hostifaces/Connection.cs | 6 +- .../engine/hostifaces/ConnectionBase.cs | 10 +- .../engine/hostifaces/History.cs | 22 +- .../engine/hostifaces/HostUtilities.cs | 28 +- .../engine/hostifaces/LocalConnection.cs | 16 +- .../engine/hostifaces/LocalPipeline.cs | 6 +- .../engine/hostifaces/PSDataCollection.cs | 6 +- .../engine/hostifaces/Parameter.cs | 12 +- .../engine/hostifaces/Pipeline.cs | 6 +- .../engine/hostifaces/PowerShell.cs | 26 +- .../engine/hostifaces/RunspaceInvoke.cs | 12 +- .../engine/hostifaces/RunspacePoolInternal.cs | 2 +- .../engine/hostifaces/pipelinebase.cs | 8 +- .../engine/lang/interface/PSParser.cs | 8 +- .../engine/lang/parserutils.cs | 50 +-- .../engine/lang/scriptblock.cs | 14 +- .../engine/parser/Compiler.cs | 2 +- .../engine/parser/PSType.cs | 2 +- .../engine/parser/Parser.cs | 4 +- .../engine/parser/SemanticChecks.cs | 10 +- .../engine/parser/SymbolResolver.cs | 2 +- .../engine/parser/tokenizer.cs | 10 +- .../engine/pipeline.cs | 8 +- .../engine/regex.cs | 4 +- .../remoting/client/ClientRemotePowerShell.cs | 28 +- .../engine/remoting/client/Job.cs | 62 ++-- .../engine/remoting/client/Job2.cs | 12 +- .../engine/remoting/client/JobManager.cs | 14 +- .../remoting/client/JobSourceAdapter.cs | 20 +- .../engine/remoting/client/PSProxyJob.cs | 24 +- .../client/RemoteRunspacePoolInternal.cs | 32 +- .../remoting/client/RemotingErrorRecord.cs | 18 +- .../remoting/client/RemotingProtocol2.cs | 52 +-- .../engine/remoting/client/RunspaceRef.cs | 6 +- .../engine/remoting/client/ThrottlingJob.cs | 2 +- .../remoting/client/clientremotesession.cs | 8 +- ...clientremotesessionprotocolstatemachine.cs | 16 +- .../engine/remoting/client/remotepipeline.cs | 22 +- .../engine/remoting/client/remoterunspace.cs | 18 +- .../remoting/client/remoterunspaceinfo.cs | 2 +- .../client/remotingprotocolimplementation.cs | 6 +- .../remoting/commands/InvokeCommandCommand.cs | 8 +- .../engine/remoting/commands/JobRepository.cs | 8 +- .../commands/NewPSSessionConfigurationFile.cs | 2 +- .../remoting/commands/PSRemotingCmdlet.cs | 48 +-- .../engine/remoting/commands/ReceiveJob.cs | 4 +- .../engine/remoting/commands/RemoveJob.cs | 20 +- .../engine/remoting/commands/StartJob.cs | 2 +- .../remoting/commands/newrunspacecommand.cs | 2 +- .../remoting/common/RemoteSessionNamedPipe.cs | 4 +- .../remoting/common/RunspaceConnectionInfo.cs | 22 +- .../remoting/common/RunspacePoolStateInfo.cs | 2 +- .../common/WireDataFormat/EncodeAndDecode.cs | 106 +++--- .../common/WireDataFormat/RemoteHost.cs | 6 +- .../engine/remoting/common/psstreamobject.cs | 6 +- .../remoting/common/remotingexceptions.cs | 8 +- .../engine/remoting/common/throttlemanager.cs | 6 +- .../fanin/InitialSessionStateProvider.cs | 8 +- .../engine/remoting/fanin/WSManNativeAPI.cs | 2 +- .../remoting/fanin/WSManTransportManager.cs | 8 +- .../remoting/server/ServerPowerShellDriver.cs | 98 +++--- .../server/ServerRemotingProtocol2.cs | 58 ++-- .../server/ServerRunspacePoolDriver.cs | 56 ++-- .../server/ServerSteppablePipelineDriver.cs | 42 +-- .../ServerSteppablePipelineSubscriber.cs | 4 +- .../remoting/server/serverremotesession.cs | 2 +- .../server/serverremotesessionstatemachine.cs | 6 +- .../serverremotingprotocolimplementation.cs | 2 +- .../engine/runtime/Operations/ArrayOps.cs | 4 +- .../engine/runtime/Operations/ClassOps.cs | 32 +- .../engine/runtime/Operations/MiscOps.cs | 2 +- .../engine/scriptparameterbinder.cs | 2 +- .../engine/serialization.cs | 124 +++---- .../help/AliasHelpProvider.cs | 4 +- .../help/BaseCommandHelpInfo.cs | 2 +- .../help/CabinetAPI.cs | 12 +- .../help/CommandHelpProvider.cs | 12 +- .../help/DefaultCommandHelpObjectBuilder.cs | 78 ++--- .../help/DefaultHelpProvider.cs | 2 +- .../help/DscResourceHelpProvider.cs | 2 +- .../help/HelpFileHelpInfo.cs | 16 +- .../help/HelpFileHelpProvider.cs | 2 +- .../help/HelpInfo.cs | 2 +- .../help/HelpProvider.cs | 8 +- .../help/HelpProviderWithCache.cs | 18 +- .../help/HelpProviderWithFullCache.cs | 8 +- .../help/HelpSystem.cs | 10 +- .../help/MamlClassHelpInfo.cs | 4 +- .../help/MamlCommandHelpInfo.cs | 8 +- .../help/MamlNode.cs | 8 +- .../help/PSClassHelpProvider.cs | 2 +- .../help/ProviderHelpInfo.cs | 6 +- .../help/ProviderHelpProvider.cs | 10 +- .../help/SaveHelpCommand.cs | 4 +- .../help/SyntaxHelpInfo.cs | 6 +- .../help/UpdatableHelpCommandBase.cs | 66 ++-- .../help/UpdatableHelpInfo.cs | 14 +- .../help/UpdatableHelpModuleInfo.cs | 8 +- .../help/UpdatableHelpSystem.cs | 156 ++++----- .../help/UpdatableHelpUri.cs | 6 +- .../help/UpdateHelpCommand.cs | 4 +- .../logging/LogProvider.cs | 12 +- .../logging/MshLog.cs | 26 +- .../namespaces/FileSystemProvider.cs | 2 +- .../namespaces/RegistryProvider.cs | 16 +- .../namespaces/Win32Native.cs | 6 +- .../security/Authenticode.cs | 10 +- .../security/CatalogHelper.cs | 32 +- .../security/MshSignature.cs | 22 +- .../security/SecureStringHelper.cs | 30 +- .../security/SecuritySupport.cs | 14 +- .../singleshell/config/MshSnapinInfo.cs | 2 +- .../utils/CryptoUtils.cs | 30 +- .../utils/ExecutionExceptions.cs | 66 ++-- .../utils/ExtensionMethods.cs | 2 +- .../utils/GraphicalHostReflectionWrapper.cs | 26 +- .../utils/IObjectWriter.cs | 2 +- .../utils/MetadataExceptions.cs | 40 +-- .../utils/MshArgumentException.cs | 8 +- .../utils/MshArgumentNullException.cs | 8 +- .../utils/MshArgumentOutOfRangeException.cs | 8 +- .../utils/MshInvalidOperationException.cs | 8 +- .../utils/MshNotImplementedException.cs | 8 +- .../utils/MshNotSupportedException.cs | 8 +- .../utils/MshObjectDisposedException.cs | 8 +- .../utils/ObjectReader.cs | 24 +- .../utils/ObjectStream.cs | 18 +- .../utils/ObjectWriter.cs | 8 +- .../utils/PathUtils.cs | 16 +- .../utils/PlatformInvokes.cs | 6 +- .../utils/PsUtils.cs | 4 +- .../utils/RuntimeException.cs | 10 +- .../utils/SessionStateExceptions.cs | 32 +- .../utils/assert.cs | 2 +- .../utils/tracing/EtwActivity.cs | 2 +- .../utils/tracing/PSEtwLogProvider.cs | 4 +- .../utils/tracing/PSSysLogProvider.cs | 6 +- 258 files changed, 2330 insertions(+), 2330 deletions(-) diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs index 9bfddec1c..e5211b444 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs @@ -50,7 +50,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// 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 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// object raised the event /// - /// event argument. + /// Event argument. protected void OperationCreatedHandler(object cimSession, OperationEventArgs actionArgs) { DebugHelper.WriteLogEx(); @@ -103,7 +103,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// object raised the event /// - /// event argument. + /// Event argument. protected void OperationDeletedHandler(object cimSession, OperationEventArgs actionArgs) { DebugHelper.WriteLogEx(); @@ -190,7 +190,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// 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) { @@ -203,7 +203,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// Computer name of the cimsession. - /// cimsession wrapper object. + /// Cimsession wrapper object. protected void AddCimSessionProxy(CimSessionProxy sessionproxy) { lock (cimSessionProxyCacheLock) @@ -382,7 +382,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// 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) { diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs index b3d7260c2..ac9690468 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs @@ -310,7 +310,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// - /// 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); diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs index d2ba9a6ec..9daf761d0 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs @@ -132,7 +132,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// Start an indication subscription target to the given computer. /// - /// null stands for localhost. + /// Null stands for localhost. /// /// /// @@ -159,7 +159,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// - /// throw if cimSession is null. + /// Throw if cimSession is null. public void RegisterCimIndication( CimSession cimSession, string nameSpace, @@ -206,7 +206,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// 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/CimResultObserver.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs index a36557189..508e678ff 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs @@ -220,7 +220,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Define delegate that handles new cmdlet action come from /// the operations related to the current CimSession object. /// - /// cimSession object, which raised the event. + /// CimSession object, which raised the event. /// Event args. public delegate void ResultEventHandler( object observer, @@ -285,7 +285,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Operation completed with an error /// /// - /// error object. + /// Error object. public virtual void OnError(Exception error) { try @@ -326,7 +326,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// 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/CimSessionProxy.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs index 7f4de014f..73351cf74 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs @@ -308,7 +308,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Define delegate that handles new cmdlet action come from /// the operations related to the current CimSession object. /// - /// cimSession object, which raised the event. + /// CimSession object, which raised the event. /// Event args. public delegate void NewCmdletActionHandler( object cimSession, @@ -323,7 +323,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Define delegate that handles operation creation and complete /// issued by the current CimSession object. /// - /// cimSession object, which raised the event. + /// CimSession object, which raised the event. /// Event args. public delegate void OperationEventHandler( object cimSession, @@ -982,8 +982,8 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// 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) diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteError.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteError.cs index 118c3bc30..df42bd348 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteError.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimWriteError.cs @@ -29,8 +29,8 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// - /// the context starting the operation, which generated the error. - /// the CimResultContext used to provide ErrorSource, etc. info. + /// The context starting the operation, which generated the error. + /// The CimResultContext used to provide ErrorSource, etc. info. /// internal static ErrorRecord ErrorRecordFromAnyException( InvocationContext context, @@ -70,7 +70,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// - /// the CimResultContext used to provide ErrorSource, etc. info. + /// The CimResultContext used to provide ErrorSource, etc. info. /// internal static ErrorRecord CreateFromCimException( InvocationContext context, @@ -89,7 +89,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// - /// the CimResultContext used to provide ErrorSource, etc. info. + /// The CimResultContext used to provide ErrorSource, etc. info. /// internal static ErrorRecord InitializeErrorRecord( InvocationContext context, @@ -111,7 +111,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// - /// the CimResultContext used to provide ErrorSource, etc. info. + /// The CimResultContext used to provide ErrorSource, etc. info. /// internal static ErrorRecord InitializeErrorRecord( InvocationContext context, @@ -140,7 +140,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// - /// the CimResultContext used to provide ErrorSource, etc. info. + /// The CimResultContext used to provide ErrorSource, etc. info. /// internal static ErrorRecord InitializeErrorRecordCore( InvocationContext context, 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 b97ed83b9..325c0da7e 100644 --- a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimQuery.cs +++ b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimQuery.cs @@ -291,10 +291,10 @@ namespace Microsoft.PowerShell.Cmdletization.Cim /// /// 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/commands/management/Process.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs index cd8f15553..41c2c9e2f 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 522c592d8..755130dfd 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 5ee07d19f..88c57c83b 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ EndSelection:<<<<<<<<4"; /// /// 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 cd188dc8e..eba405ce5 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs @@ -55,9 +55,9 @@ namespace Microsoft.PowerShell.Commands /// Internal Constructor /// /// Job associated with this operation. - /// object associated with this operation. - /// computer on which the operation is invoked. - /// sink to get wmi objects. + /// 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; @@ -1735,7 +1735,7 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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.Utility/commands/utility/CSVCommands.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CSVCommands.cs index d00952444..ea4a9ad66 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 @@ namespace Microsoft.PowerShell.Commands /// /// /// - /// 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 5cf288cdb..c3f909f54 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 @@ namespace System.Management.Automation /// /// Serializes IDictionary. /// - /// dictionary which is serialized. + /// Dictionary which is serialized. /// private void WriteDictionary(IDictionary dictionary, int depth) { @@ -1009,7 +1009,7 @@ namespace System.Management.Automation /// Compute the serialization depth for an PSObject instance subtree. /// /// PSObject whose serialization depth has to be computed. - /// current depth. + /// Current depth. /// private static int GetDepthOfSerialization(PSObject source, int depth) { @@ -1100,9 +1100,9 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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/FormatAndOutput/OutGridView/ColumnInfo.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/OutGridView/ColumnInfo.cs index ef0964053..f56b7bc69 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 cbc4948c9..062988e78 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 654b881c2..d49f58903 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 0861777fe..16abcce5e 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// Write a line to the output device. /// - /// line to write. + /// Line to write. internal override void WriteLine(string s) { CheckStopProcessing(); @@ -83,7 +83,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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); @@ -206,8 +206,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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/ImplicitRemotingCommands.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs index e211d984e..a9a9e4323 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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) { @@ -1859,13 +1859,13 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ function Get-PSImplicitRemotingClientSideParameters /// /// 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 ef7a08cfb..ccb2f6332 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Measure-Object.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Measure-Object.cs @@ -650,8 +650,8 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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/ShowCommand/ShowCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs index 79426a5d2..3e26aaac7 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs @@ -270,7 +270,7 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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/ConvertToJsonCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs index 215e3243a..b18e8072e 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs @@ -276,8 +276,8 @@ namespace Microsoft.PowerShell.Commands /// 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 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 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 4663ff62e..b150c656c 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 7d97d46b8..8f1fb5307 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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) 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 4a1cf839c..eb3f2fb89 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/trace/TraceExpressionCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/trace/TraceExpressionCommand.cs @@ -462,7 +462,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 5a53c73e5..5c26342c7 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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/host/msh/ConsoleControl.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs index 1422ac8e7..c74fdc6ca 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs @@ -1214,7 +1214,7 @@ namespace Microsoft.PowerShell /// /// /// - /// 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 22074d584..288ae7f2c 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs @@ -609,8 +609,8 @@ namespace Microsoft.PowerShell /// 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 @@ namespace Microsoft.PowerShell /// 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/ConsoleHostUserInterface.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs index 1db09710b..6c3ec0eb0 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs @@ -1717,7 +1717,7 @@ namespace Microsoft.PowerShell /// /// 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) { diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs index 873d44edc..16bcb07ea 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs @@ -334,12 +334,12 @@ namespace Microsoft.PowerShell /// /// 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 @@ namespace Microsoft.PowerShell /// 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 34b011b18..dbbbc7216 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfaceSecurity.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfaceSecurity.cs @@ -23,10 +23,10 @@ namespace Microsoft.PowerShell /// this function will be modified to prompt using secure-path /// 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. - /// message to be displayed. - /// caption for the message. + /// 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. + /// Message to be displayed. + /// Caption for the message. /// PSCredential object. public override PSCredential PromptForCredential( @@ -46,12 +46,12 @@ namespace Microsoft.PowerShell /// /// 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. - /// 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. + /// 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. + /// 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. /// 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.ScheduledJob/ScheduledJobDefinition.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs index 7c0e73e62..e77151afe 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs @@ -1524,7 +1524,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Sets the execution history length property. /// - /// execution history length. + /// Execution history length. /// Save to store. public void SetExecutionHistoryLength( int executionHistoryLength, diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs index b0103d327..ac1b55d9b 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs @@ -172,7 +172,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Get list of jobs that run the specified command /// - /// command to match. + /// Command to match. /// /// Collection of jobs that match the specified /// criteria. @@ -243,7 +243,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// 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 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Remove a job from the store /// - /// job object to remove. + /// Job object to remove. public override void RemoveJob(Job2 job) { if (job == null) diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs index 7edcb390e..f5e12f005 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs @@ -724,9 +724,9 @@ namespace Microsoft.PowerShell.ScheduledJob /// 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. + /// 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) @@ -781,9 +781,9 @@ namespace Microsoft.PowerShell.ScheduledJob /// 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. + /// 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/commands/SchedJobCmdletBase.cs b/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs index e1b87ed0d..f01d5b5ad 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs @@ -351,8 +351,8 @@ namespace Microsoft.PowerShell.ScheduledJob /// definition object. /// /// ScheduledJobDefinition. - /// rep interval. - /// save definition change. + /// 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 ae72b04a0..832b6e57d 100644 --- a/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs +++ b/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs @@ -1558,7 +1558,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// get the X509NativeStore object at path /// - /// path to store. + /// Path to store. /// True if this should be a test for path existence. Returns True or False. - /// path elements. + /// Path elements. /// X509NativeStore object. private X509NativeStore GetStore(string path, bool test, string[] pathElements) { @@ -2475,9 +2475,9 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 edf4b8cd9..c6dea0181 100644 --- a/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs +++ b/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs @@ -615,7 +615,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 17a298850..227c15744 100644 --- a/src/Microsoft.PowerShell.Security/security/Utils.cs +++ b/src/Microsoft.PowerShell.Security/security/Utils.cs @@ -15,7 +15,7 @@ namespace Microsoft.PowerShell /// /// gets the size of a file /// - /// path to file. + /// Path to file. /// File size. internal static long GetFileSize(string filePath) { @@ -32,8 +32,8 @@ namespace Microsoft.PowerShell /// /// 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 @@ namespace Microsoft.PowerShell /// /// - /// 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 @@ namespace Microsoft.PowerShell /// /// - /// 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 @@ namespace Microsoft.PowerShell /// /// 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 @@ namespace Microsoft.PowerShell /// /// 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 @@ namespace Microsoft.PowerShell /// -- 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/WsManHelper.cs b/src/Microsoft.WSMan.Management/WsManHelper.cs index 8c55db242..0cd3bada0 100644 --- a/src/Microsoft.WSMan.Management/WsManHelper.cs +++ b/src/Microsoft.WSMan.Management/WsManHelper.cs @@ -202,8 +202,8 @@ namespace Microsoft.WSMan.Management /// /// 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/DscSupport/CimDSCParser.cs b/src/System.Management.Automation/DscSupport/CimDSCParser.cs index 226c8fd86..4cbcfa94f 100644 --- a/src/System.Management.Automation/DscSupport/CimDSCParser.cs +++ b/src/System.Management.Automation/DscSupport/CimDSCParser.cs @@ -987,7 +987,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal /// /// get text from SecureString /// - /// value of SecureString. + /// Value of SecureString. /// Decoded string. public static string GetStringFromSecureString(SecureString value) { @@ -3141,7 +3141,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal /// /// 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,7 +3278,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal /// /// Returns an error record to use in the case of a malformed resource reference in the DependsOn list /// - /// the malformed resource. + /// The malformed resource. /// The referencing resource instance. /// public static ErrorRecord GetBadlyFormedRequiredResourceIdErrorRecord(string badDependsOnReference, string definingResource) @@ -3293,7 +3293,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal /// /// Returns an error record to use in the case of a malformed resource reference in the exclusive resources list /// - /// the malformed resource. + /// The malformed resource. /// The referencing resource instance. /// public static ErrorRecord GetBadlyFormedExclusiveResourceIdErrorRecord(string badExclusiveResourcereference, string definingResource) @@ -3337,7 +3337,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal /// Returns an error record to use in the case of a malformed resource reference in the DependsOn list /// /// The duplicate resource identifier. - /// the node being defined. + /// The node being defined. /// The error record to use. public static ErrorRecord DuplicateResourceIdInNodeStatementErrorRecord(string duplicateResourceId, string nodeName) { @@ -3461,7 +3461,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal /// /// 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 62476d3fd..c90f67f7f 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs @@ -41,7 +41,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// Initialize the command before executing /// /// ExecutionContext used to create sub pipeline. - /// name of the command to run. + /// Name of the command to run. /// Type of the command to run. internal void Initialize(ExecutionContext execContext, string nameOfCommand, Type typeOfCommand) { @@ -54,8 +54,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 46fbd0e41..7b9663e83 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs @@ -203,7 +203,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 83ab47e04..1d0838393 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs @@ -258,7 +258,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ -457,7 +457,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// callback for Fe processing /// /// Fe notification message. - /// current context, with Fs in it. + /// Current context, with Fs in it. private void ProcessFormatEnd(FormatEndData fe, FormatMessagesContextManager.OutputContext c) { //Console.WriteLine("ProcessFormatEnd"); @@ -468,7 +468,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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"); @@ -490,7 +490,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// callback for Ge processing /// /// Ge notification message. - /// current context, with Gs in it. + /// Current context, with Gs in it. private void ProcessGroupEnd(GroupEndData ge, FormatMessagesContextManager.OutputContext c) { //Console.WriteLine("ProcessGroupEnd"); @@ -503,7 +503,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// process the current payload object /// /// FormatEntryData to process. - /// currently active context. + /// Currently active context. private void ProcessPayload(FormatEntryData fed, FormatMessagesContextManager.OutputContext c) { // we assume FormatEntryData as a standard wrapper @@ -858,8 +858,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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) { @@ -927,9 +927,9 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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) @@ -1095,9 +1095,9 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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) @@ -1185,9 +1185,9 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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) @@ -1304,7 +1304,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// add an item to the buffer /// - /// string to add. + /// String to add. internal void Add(string s) { _arr[_lastEmptySpot++] = s; @@ -1370,9 +1370,9 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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) diff --git a/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs b/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs index 34a4f4fce..ef487b261 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs @@ -14,9 +14,9 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 4cadafd85..205fa6e1d 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs @@ -20,7 +20,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// initialization method to be called before any other operation /// /// LineOutput interfaces to write to. - /// number of columns used to write out. + /// Number of columns used to write out. internal void Initialize(LineOutput lineOutput, int numberOfTextColumns) { _lo = lineOutput; @@ -43,7 +43,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 cf9ef6e4d..4f508e66c 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 @@ namespace System.Management.Automation.Runspaces /// /// 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 8e3d6c9f9..784020cf4 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// log an entry /// - /// entry to log. + /// Entry to log. internal void LogEntry(XmlLoaderLoggerEntry entry) { if (entry.entryType == XmlLoaderLoggerEntry.EntryType.Error) @@ -265,7 +265,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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) { @@ -361,8 +361,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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. + /// 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/typeDataManager.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs index 57fb25919..f0603fb20 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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) /// @@ -301,8 +301,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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. + /// 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) /// @@ -363,7 +363,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// it loads a database from file(s). /// /// *.formal.xml files to be loaded. - /// expression factory to validate script blocks. + /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 4f6958a50..a37f475bc 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 31bcaa239..f0fe63927 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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. - /// do we implicitly trust the script blocks (so they should run in full langauge mode)? - /// true when the view is for help output. + /// 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. /// internal bool LoadFormattingData( ExtendedTypeDefinition typeDefinition, @@ -333,7 +333,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// It assumes that the XML document has been successfully loaded /// /// XML document to load from, cannot be null. - /// instance of the databaseto load into. + /// Instance of the databaseto load into. private void LoadData(XmlDocument doc, TypeInfoDataBase db) { if (doc == null) @@ -420,8 +420,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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. + /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// Load the view into a ViewDefinition /// - /// the TypeName tag under SelectedBy tag. + /// The TypeName tag under SelectedBy tag. /// /// /// @@ -1918,7 +1918,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 a97dac07c..a83534446 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs @@ -18,8 +18,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 13b90a7f1..1c3c61514 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatMsgCtxManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatMsgCtxManager.cs @@ -41,7 +41,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format { /// /// - /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 265005cd4..6426b4794 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs @@ -274,7 +274,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 eecb9596a..70b5db3c2 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 d397ef85f..cef9125ae 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs @@ -614,7 +614,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// log a failed evaluation of an PSPropertyExpression /// /// PSPropertyExpressionResult containing the failed evaluation data. - /// object used to evaluate the PSPropertyExpression. + /// Object used to evaluate the PSPropertyExpression. internal void LogPSPropertyExpressionFailedResult(PSPropertyExpressionResult result, object sourceObject) { if (!_formatErrorPolicy.ShowErrorsAsMessages) @@ -628,7 +628,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 25dd42797..4b7561988 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatXMLWriter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatXMLWriter.cs @@ -23,13 +23,13 @@ namespace Microsoft.PowerShell.Commands /// /// 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/FormattingObjectsDeserializer.cs b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs index b2bbc59f7..6867ee923 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs @@ -84,7 +84,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 5a2c9affa..da15359fd 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs @@ -62,10 +62,10 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// delegate definition /// - /// string to write. + /// String to write. internal delegate void WriteCallback(string s); /// @@ -258,10 +258,10 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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)) @@ -410,7 +410,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// attempting any operation /// /// TextWriter to write to. - /// max columns widths for the text. + /// Max columns widths for the text. internal TextWriterLineOutput(TextWriter writer, int columns) { _writer = writer; @@ -422,8 +422,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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. + /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 8a1f4643e..47b32e2bb 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ListWriter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ListWriter.cs @@ -31,9 +31,9 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// - /// 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,7 +107,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// write the values of the properties of an object /// - /// array with the values in form of formatted strings. + /// Array with the values in form of formatted strings. /// LineOutput interface to write to. internal void WriteProperties(string[] values, LineOutput lo) { @@ -159,8 +159,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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. + /// 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) { @@ -195,8 +195,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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. + /// String to add to the left. + /// Line to print. /// LineOuput to write to. private void WriteSingleLineHelper(string prependString, string line, LineOutput lo) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs b/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs index b984473c2..71429e51f 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs @@ -239,7 +239,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// register the default output command /// /// ExecutionContext to pass to the child pipeline. - /// name of the command to execute. + /// Name of the command to execute. /// Type of the command to execute. private void RegisterCommandDefault(ExecutionContext context, string commandName, Type commandType) { @@ -253,7 +253,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 164e601d7..495c6b40c 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs @@ -17,8 +17,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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/Utilities/MshObjectUtil.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs index bde9034e7..a63b39d14 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// create an expression from an expression token /// - /// expression token to use. + /// Expression token to use. /// Constructed expression. /// internal PSPropertyExpression CreateFromExpressionToken(ExpressionToken et) @@ -647,7 +647,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// create an expression from an expression token /// - /// expression token to use. + /// Expression token to use. /// The context from which the file was loaded. /// Constructed expression. /// diff --git a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs index d5bb6d8fc..cf205887b 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 756186dae..3a0d0fd47 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 @@ namespace Microsoft.PowerShell.Commands /// /// constructor /// - /// expression. + /// Expression. /// public PSPropertyExpression(string s) : this(s, false) diff --git a/src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs b/src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs index 8f11684a8..34f32a772 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// write a line to the output device /// - /// line to write. + /// Line to write. internal override void WriteLine(string s) { CheckStopProcessing(); @@ -246,8 +246,8 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// constructor for the ConsoleLineOutput /// /// PSHostUserInterface to wrap. - /// true if we require prompting for page breaks. - /// error context to throw exceptions. + /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// 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) { diff --git a/src/System.Management.Automation/cimSupport/cmdletization/QueryBuilder.cs b/src/System.Management.Automation/cimSupport/cmdletization/QueryBuilder.cs index 10508eb95..92459d19b 100644 --- a/src/System.Management.Automation/cimSupport/cmdletization/QueryBuilder.cs +++ b/src/System.Management.Automation/cimSupport/cmdletization/QueryBuilder.cs @@ -109,10 +109,10 @@ namespace Microsoft.PowerShell.Cmdletization /// /// 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 b9edd1e43..14238f496 100644 --- a/src/System.Management.Automation/engine/Attributes.cs +++ b/src/System.Management.Automation/engine/Attributes.cs @@ -121,7 +121,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ -593,7 +593,7 @@ namespace System.Management.Automation /// Initializes a new instance of the AliasAttribute class /// /// The name for this alias. - /// for invalid arguments. + /// For invalid arguments. public AliasAttribute(params string[] aliasNames) { if (aliasNames == null) @@ -726,7 +726,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// Validates that the length of each parameter argument's Length falls in the range /// specified by MinLength and MaxLength /// - /// object to validate. - /// if is not a string + /// 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; @@ -931,8 +931,8 @@ namespace System.Management.Automation /// /// Minimum required length. /// Maximum required length. - /// for invalid arguments. - /// if maxLength is less than minLength. + /// For invalid arguments. + /// If maxLength is less than minLength. public ValidateLengthAttribute(int minLength, int maxLength) : base() { if (minLength < 0) @@ -1014,7 +1014,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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,8 +1334,8 @@ namespace System.Management.Automation /// /// Validates that each parameter argument matches the RegexPattern /// - /// object to validate. - /// if is not a string + /// Object to validate. + /// If is not a string /// that matches the pattern /// and for invalid arguments protected override void ValidateElement(object element) @@ -1365,7 +1365,7 @@ namespace System.Management.Automation /// Initializes a new instance of the ValidatePatternAttribute class /// /// Pattern string to match. - /// for invalid arguments. + /// For invalid arguments. public ValidatePatternAttribute(string regexPattern) { if (String.IsNullOrEmpty(regexPattern)) @@ -1403,8 +1403,8 @@ namespace System.Management.Automation /// /// 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) @@ -1436,7 +1436,7 @@ namespace System.Management.Automation /// Initializes a new instance of the ValidateScriptBlockAttribute class /// /// Scriptblock to match. - /// for invalid arguments. + /// For invalid arguments. public ValidateScriptAttribute(ScriptBlock scriptBlock) { if (scriptBlock == null) @@ -1540,7 +1540,7 @@ namespace System.Management.Automation /// /// Minimum number of values required. /// Maximum number of values required. - /// for invalid arguments. + /// For invalid arguments. /// /// if minLength is greater than maxLength /// @@ -1726,9 +1726,9 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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. @@ -2199,7 +2199,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 1d0c1402a..5db6c6fe4 100644 --- a/src/System.Management.Automation/engine/AutomationEngine.cs +++ b/src/System.Management.Automation/engine/AutomationEngine.cs @@ -61,7 +61,7 @@ namespace System.Management.Automation /// 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. + /// 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 077fa10c9..b8a0dd0f6 100644 --- a/src/System.Management.Automation/engine/COM/ComAdapter.cs +++ b/src/System.Management.Automation/engine/COM/ComAdapter.cs @@ -19,7 +19,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -162,7 +162,7 @@ namespace System.Management.Automation /// 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. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -207,7 +207,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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/ComMethod.cs b/src/System.Management.Automation/engine/COM/ComMethod.cs index b5e69a281..6381b03ca 100644 --- a/src/System.Management.Automation/engine/COM/ComMethod.cs +++ b/src/System.Management.Automation/engine/COM/ComMethod.cs @@ -49,7 +49,7 @@ namespace System.Management.Automation /// /// Updates funcdesc for method information. /// - /// index of funcdesc for method in type information. + /// Index of funcdesc for method in type information. internal void AddFuncDesc(int index) { _methods.Add(index); @@ -82,8 +82,8 @@ namespace System.Management.Automation /// /// 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 284a085f2..e6ed1a72d 100644 --- a/src/System.Management.Automation/engine/COM/ComProperty.cs +++ b/src/System.Management.Automation/engine/COM/ComProperty.cs @@ -26,8 +26,8 @@ namespace System.Management.Automation /// /// Initializes a new instance of ComProperty. /// - /// reference to the ITypeInfo of the COM object. - /// name of the property being created. + /// Reference to the ITypeInfo of the COM object. + /// Name of the property being created. internal ComProperty(COM.ITypeInfo typeinfo, string name) { _typeInfo = typeinfo; @@ -141,7 +141,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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,9 +247,9 @@ namespace System.Management.Automation /// /// Sets the value of the property. /// - /// instance of the object to which to set the property value. - /// value to set this property. - /// parameters 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) { object[] newarguments; @@ -296,8 +296,8 @@ namespace System.Management.Automation /// /// 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 790c53ce9..bf3dab044 100644 --- a/src/System.Management.Automation/engine/COM/ComTypeInfo.cs +++ b/src/System.Management.Automation/engine/COM/ComTypeInfo.cs @@ -139,7 +139,7 @@ namespace System.Management.Automation /// /// Get the typeinfo interface for the given comobject. /// - /// reference to com object for which we are getting type information. + /// Reference to com object for which we are getting type information. /// ComTypeInfo object which wraps the ITypeInfo interface of the given COM object. [SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults", Justification = "Code uses the out parameter of 'GetTypeInfo' to check if the call succeeded.")] internal static ComTypeInfo GetDispatchTypeInfo(object comObject) @@ -206,7 +206,7 @@ namespace System.Management.Automation /// /// 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) diff --git a/src/System.Management.Automation/engine/COM/ComUtil.cs b/src/System.Management.Automation/engine/COM/ComUtil.cs index e99580727..1739d8ddd 100644 --- a/src/System.Management.Automation/engine/COM/ComUtil.cs +++ b/src/System.Management.Automation/engine/COM/ComUtil.cs @@ -116,7 +116,7 @@ namespace System.Management.Automation /// Gets the name of the custom type defined in the type library /// /// ITypeInfo interface of the type. - /// reference to the custom type. + /// Reference to the custom type. /// Name of the custom type. private static string GetStringFromCustomType(COM.ITypeInfo typeinfo, IntPtr refptr) { @@ -144,7 +144,7 @@ namespace System.Management.Automation /// 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 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) { diff --git a/src/System.Management.Automation/engine/CmdletParameterBinderController.cs b/src/System.Management.Automation/engine/CmdletParameterBinderController.cs index e7b563bf4..570de169a 100644 --- a/src/System.Management.Automation/engine/CmdletParameterBinderController.cs +++ b/src/System.Management.Automation/engine/CmdletParameterBinderController.cs @@ -391,8 +391,8 @@ namespace System.Management.Automation /// /// 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 @@ -2527,7 +2527,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// Check for the keys' formats and make it versionable /// - /// a hashtable instance. + /// A hashtable instance. public DefaultParameterDictionary(IDictionary dictionary) : this() { @@ -4494,8 +4494,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Override the Remove to make it versionable /// - /// key. + /// Key. public override void Remove(object key) { if (key == null) @@ -4651,8 +4651,8 @@ namespace System.Management.Automation /// /// 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. /// @@ -4720,8 +4720,8 @@ namespace System.Management.Automation /// /// 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 abdda335a..b4bf10f29 100644 --- a/src/System.Management.Automation/engine/CodeMethods.cs +++ b/src/System.Management.Automation/engine/CodeMethods.cs @@ -21,7 +21,7 @@ namespace Microsoft.PowerShell /// /// 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) diff --git a/src/System.Management.Automation/engine/ComInterop/ComBinder.cs b/src/System.Management.Automation/engine/ComInterop/ComBinder.cs index b45bc2eeb..ac24cbb42 100644 --- a/src/System.Management.Automation/engine/ComInterop/ComBinder.cs +++ b/src/System.Management.Automation/engine/ComInterop/ComBinder.cs @@ -47,7 +47,7 @@ namespace System.Management.Automation.ComInterop /// An instance of the that represents the details of the dynamic operation. /// The target of the dynamic operation. /// The new representing the result of the binding. - /// true if member evaluation may be delayed. + /// True if member evaluation may be delayed. /// True if operation was bound successfully; otherwise, false. public static bool TryBindGetMember(GetMemberBinder binder, DynamicMetaObject instance, out DynamicMetaObject result, bool delayInvocation) { diff --git a/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs b/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs index 12f0db21d..0a2b9facf 100644 --- a/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs +++ b/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs @@ -3969,8 +3969,8 @@ namespace System.Management.Automation /// /// - /// 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) { diff --git a/src/System.Management.Automation/engine/CommandCompletion/ExtensibleCompletion.cs b/src/System.Management.Automation/engine/CommandCompletion/ExtensibleCompletion.cs index 07c866b26..f14342b84 100644 --- a/src/System.Management.Automation/engine/CommandCompletion/ExtensibleCompletion.cs +++ b/src/System.Management.Automation/engine/CommandCompletion/ExtensibleCompletion.cs @@ -169,9 +169,9 @@ namespace System.Management.Automation /// /// 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/CommandDiscovery.cs b/src/System.Management.Automation/engine/CommandDiscovery.cs index 0aeb0441f..414837983 100644 --- a/src/System.Management.Automation/engine/CommandDiscovery.cs +++ b/src/System.Management.Automation/engine/CommandDiscovery.cs @@ -516,8 +516,8 @@ namespace System.Management.Automation /// 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/CommandMetadata.cs b/src/System.Management.Automation/engine/CommandMetadata.cs index 2c5561dfc..d6360521a 100644 --- a/src/System.Management.Automation/engine/CommandMetadata.cs +++ b/src/System.Management.Automation/engine/CommandMetadata.cs @@ -156,7 +156,7 @@ namespace System.Management.Automation /// 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/CommandProcessor.cs b/src/System.Management.Automation/engine/CommandProcessor.cs index 19ec6cdd2..f30dfddb2 100644 --- a/src/System.Management.Automation/engine/CommandProcessor.cs +++ b/src/System.Management.Automation/engine/CommandProcessor.cs @@ -820,8 +820,8 @@ namespace System.Management.Automation /// 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 ec42ba925..8b98c796d 100644 --- a/src/System.Management.Automation/engine/CommandProcessorBase.cs +++ b/src/System.Management.Automation/engine/CommandProcessorBase.cs @@ -251,8 +251,8 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 6d4589ae2..88015960b 100644 --- a/src/System.Management.Automation/engine/CommandSearcher.cs +++ b/src/System.Management.Automation/engine/CommandSearcher.cs @@ -1160,7 +1160,7 @@ namespace System.Management.Automation /// /// 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/CoreAdapter.cs b/src/System.Management.Automation/engine/CoreAdapter.cs index 9f4c63d36..19033430f 100644 --- a/src/System.Management.Automation/engine/CoreAdapter.cs +++ b/src/System.Management.Automation/engine/CoreAdapter.cs @@ -64,7 +64,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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; @@ -118,21 +118,21 @@ namespace System.Management.Automation /// 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. + /// 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); @@ -147,14 +147,14 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) @@ -3663,8 +3663,8 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -3805,8 +3805,8 @@ namespace System.Management.Automation /// 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. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -3907,11 +3907,11 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -4515,8 +4515,8 @@ namespace System.Management.Automation /// 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. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -4560,7 +4560,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -5078,8 +5078,8 @@ namespace System.Management.Automation /// 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. + /// 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 @@ -5165,8 +5165,8 @@ namespace System.Management.Automation /// in the child nodes /// /// XmlNode to extract property from. - /// property to look for. - /// type pf comparison to perform. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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) { @@ -5266,7 +5266,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -5299,8 +5299,8 @@ namespace System.Management.Automation /// 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. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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) { @@ -5373,7 +5373,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -5406,8 +5406,8 @@ namespace System.Management.Automation /// 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. + /// 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 f3b35b9dc..ffe9e5f36 100644 --- a/src/System.Management.Automation/engine/DefaultCommandRuntime.cs +++ b/src/System.Management.Automation/engine/DefaultCommandRuntime.cs @@ -96,14 +96,14 @@ namespace System.Management.Automation /// /// Default implementation - just discards it's arguments /// - /// progress record to write. + /// Progress record to write. public void WriteProgress(ProgressRecord progressRecord) {; } /// /// Default implementation - just discards it's arguments /// /// Source ID to write for. - /// record to write. + /// Record to write. public void WriteProgress(Int64 sourceId, ProgressRecord progressRecord) {; } /// @@ -136,63 +136,63 @@ namespace System.Management.Automation /// /// 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; } diff --git a/src/System.Management.Automation/engine/ErrorPackage.cs b/src/System.Management.Automation/engine/ErrorPackage.cs index daa5a2581..5eee053df 100644 --- a/src/System.Management.Automation/engine/ErrorPackage.cs +++ b/src/System.Management.Automation/engine/ErrorPackage.cs @@ -474,8 +474,8 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected ErrorDetails(SerializationInfo info, StreamingContext context) @@ -705,8 +705,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. /// /// ErrorRecord instances which are serialized using @@ -1043,8 +1043,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 759b4d247..9cd7a4ac2 100644 --- a/src/System.Management.Automation/engine/EventManager.cs +++ b/src/System.Management.Automation/engine/EventManager.cs @@ -2179,7 +2179,7 @@ namespace System.Management.Automation /// /// 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 5ad60ba55..bdb61ee4d 100644 --- a/src/System.Management.Automation/engine/ExecutionContext.cs +++ b/src/System.Management.Automation/engine/ExecutionContext.cs @@ -1422,8 +1422,8 @@ namespace System.Management.Automation /// /// Report an initialization-time error. /// - /// resource string. - /// arguments. + /// Resource string. + /// Arguments. internal void ReportEngineStartupError(string resourceString, params object[] arguments) { try @@ -1453,7 +1453,7 @@ namespace System.Management.Automation /// /// Report an initialization-time error /// - /// error to report. + /// Error to report. internal void ReportEngineStartupError(string error) { try diff --git a/src/System.Management.Automation/engine/ExtendedTypeSystemException.cs b/src/System.Management.Automation/engine/ExtendedTypeSystemException.cs index dbdbd5d5c..38906e73e 100644 --- a/src/System.Management.Automation/engine/ExtendedTypeSystemException.cs +++ b/src/System.Management.Automation/engine/ExtendedTypeSystemException.cs @@ -25,7 +25,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { } @@ -57,8 +57,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { } @@ -124,8 +124,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { } @@ -189,8 +189,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { } @@ -252,8 +252,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -316,8 +316,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { } @@ -379,8 +379,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { } @@ -440,8 +440,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { } @@ -501,8 +501,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 301bd17be..3392b19f3 100644 --- a/src/System.Management.Automation/engine/ExtraAdapter.cs +++ b/src/System.Management.Automation/engine/ExtraAdapter.cs @@ -39,8 +39,8 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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) { @@ -186,8 +186,8 @@ namespace System.Management.Automation /// 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. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -304,8 +304,8 @@ namespace System.Management.Automation /// 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 537c0ff08..4c6bbedfb 100644 --- a/src/System.Management.Automation/engine/ICommandRuntime.cs +++ b/src/System.Management.Automation/engine/ICommandRuntime.cs @@ -31,7 +31,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// a /// rather than the real exception. /// - /// error. + /// Error. void WriteError(ErrorRecord errorRecord); /// @@ -88,7 +88,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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/InitialSessionState.cs b/src/System.Management.Automation/engine/InitialSessionState.cs index cd74a44fc..231121c94 100644 --- a/src/System.Management.Automation/engine/InitialSessionState.cs +++ b/src/System.Management.Automation/engine/InitialSessionState.cs @@ -3461,7 +3461,7 @@ namespace System.Management.Automation.Runspaces /// Update the type metadata loaded into this runspace. /// /// The execution context for the runspace to update. - /// if true, re-initialize the metadata collection... + /// If true, re-initialize the metadata collection... internal void UpdateTypes(ExecutionContext context, bool updateOnly) { if (Types.Count == 1) diff --git a/src/System.Management.Automation/engine/InternalCommands.cs b/src/System.Management.Automation/engine/InternalCommands.cs index 1728611ad..640e4d14e 100644 --- a/src/System.Management.Automation/engine/InternalCommands.cs +++ b/src/System.Management.Automation/engine/InternalCommands.cs @@ -202,9 +202,9 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 9ceacbe05..23555de63 100644 --- a/src/System.Management.Automation/engine/LanguagePrimitives.cs +++ b/src/System.Management.Automation/engine/LanguagePrimitives.cs @@ -72,16 +72,16 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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. + /// 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. + /// 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. + /// 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. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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. + /// 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. + /// 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. + /// 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. + /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -192,7 +192,7 @@ namespace System.Management.Automation /// The value to convert from. /// The type this converter is associated with. /// The IFormatProvider to use. - /// true if case should be ignored. + /// True if case should be ignored. /// SourceValue converted to destinationType. /// When no conversion was possible. public override object ConvertFrom(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) @@ -220,7 +220,7 @@ namespace System.Management.Automation /// The value to convert from. /// The value to convert from. /// The IFormatProvider to use. - /// true if case should be ignored. + /// True if case should be ignored. /// This method does not return a value. /// NotSupportedException is always thrown. public override object ConvertTo(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) @@ -586,8 +586,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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,8 +746,8 @@ namespace System.Management.Automation /// 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. /// 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,8 +764,8 @@ namespace System.Management.Automation /// 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. /// 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 @@ -979,7 +979,7 @@ namespace System.Management.Automation /// /// 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) @@ -1263,7 +1263,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) @@ -1678,11 +1678,11 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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. /// 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); @@ -1747,8 +1747,8 @@ namespace System.Management.Automation /// /// Converts PSObject to resultType. /// - /// value to be converted and returned. - /// type to convert psobject. + /// 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. /// Indicates if Unknown members in the psobject have to be ignored if the corresponding members in resultType do not exist. @@ -1787,8 +1787,8 @@ namespace System.Management.Automation /// /// This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. /// - /// value to be converted and returned. - /// result of the conversion. This is valid only if the return is true. + /// 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,9 +1807,9 @@ namespace System.Management.Automation /// /// 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. - /// result of the conversion. This is valid only if the return is true. + /// 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,9 +1830,9 @@ namespace System.Management.Automation /// /// 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. - /// result of the conversion. This is valid only if the return is true. + /// 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) { @@ -1846,10 +1846,10 @@ namespace System.Management.Automation /// /// 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. - /// governing conversion of types. - /// result of the conversion. This is valid only if the return is true. + /// Value to be converted and returned. + /// Type to convert valueToConvert. + /// 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, Type resultType, IFormatProvider formatProvider, out object result) { @@ -1984,8 +1984,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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); @@ -2065,9 +2065,9 @@ namespace System.Management.Automation /// defined in enumType. /// /// 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. + /// 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 /// to contain a different value than the one that is validated. @@ -2252,7 +2252,7 @@ namespace System.Management.Automation /// 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. + /// 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. @@ -4710,18 +4710,18 @@ namespace System.Management.Automation /// /// - /// 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 c73fd34b3..80a95db5a 100644 --- a/src/System.Management.Automation/engine/ManagementObjectAdapter.cs +++ b/src/System.Management.Automation/engine/ManagementObjectAdapter.cs @@ -127,7 +127,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -349,8 +349,8 @@ namespace System.Management.Automation /// 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. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -433,8 +433,8 @@ namespace System.Management.Automation /// /// Retrieves the table for instance methods /// - /// object containing methods to load in typeTable. - /// controls what methods are adapted. + /// Object containing methods to load in typeTable. + /// Controls what methods are adapted. protected static CacheTable GetInstanceMethodTable(ManagementBaseObject wmiObject, bool staticBinding) { @@ -487,7 +487,7 @@ namespace System.Management.Automation /// /// Class to get the method info from. /// Cachetable to update. - /// controls what methods are adapted. + /// Controls what methods are adapted. /// /// private static void PopulateMethodTable(ManagementClass mgmtClass, CacheTable methodTable, bool staticBinding) @@ -875,8 +875,8 @@ namespace System.Management.Automation /// /// 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; @@ -912,8 +912,8 @@ namespace System.Management.Automation /// 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 0d4ab38f5..ad254e3af 100644 --- a/src/System.Management.Automation/engine/MinishellParameterBinderController.cs +++ b/src/System.Management.Automation/engine/MinishellParameterBinderController.cs @@ -296,7 +296,7 @@ namespace System.Management.Automation /// 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. + /// Value to process. /// Processed value. private string ProcessFormatParameterValue(string parameterName, object value) diff --git a/src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs b/src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs index 965cf6058..8fb0ef962 100644 --- a/src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs +++ b/src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs @@ -361,7 +361,7 @@ namespace Microsoft.PowerShell.Commands /// /// Loads the latest valid version if moduleBase is a multi-versioned module directory /// - /// module directory path. + /// 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. @@ -1300,7 +1300,7 @@ namespace Microsoft.PowerShell.Commands /// Routine to process the module manifest data language script. /// /// The script info for the manifest script. - /// processing flags (whether to write errors / load elements). + /// 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. @@ -1322,7 +1322,7 @@ namespace Microsoft.PowerShell.Commands /// Routine to process the module manifest data language script. /// /// The script info for the manifest script. - /// processing flags (whether to write errors / load elements). + /// 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. @@ -1438,7 +1438,7 @@ namespace Microsoft.PowerShell.Commands /// 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). + /// 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. @@ -4319,7 +4319,7 @@ namespace Microsoft.PowerShell.Commands /// /// The hashtable to look for the key in. /// The manifest that generated the hashtable. - /// the table key to use. + /// The table key to use. /// Specifies how to treat errors and whether to load elements. /// Returns the extracted version. /// @@ -4358,7 +4358,7 @@ namespace Microsoft.PowerShell.Commands /// /// The hashtable to look for the key in. /// The manifest that generated the hashtable. - /// the table key to use. + /// The table key to use. /// Specifies how to treat errors and whether to load elements. /// Returns the extracted version. /// @@ -4411,11 +4411,11 @@ namespace Microsoft.PowerShell.Commands /// /// The hashtable to look for the key in. /// The manifest that generated the hashtable. - /// the table key to use. + /// 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. + /// 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( @@ -4570,7 +4570,7 @@ namespace Microsoft.PowerShell.Commands /// /// The hashtable to look for the key in. /// The manifest that generated the hashtable. - /// the table key to use. + /// The table key to use. /// Specifies how to treat errors and whether to load elements. /// Value from the manifest converted to the right type. /// true if success; false if there were errors. @@ -4876,7 +4876,7 @@ namespace Microsoft.PowerShell.Commands /// /// Removes a module from the session state. /// - /// module to remove. + /// Module to remove. internal void RemoveModule(PSModuleInfo module) { RemoveModule(module, null); @@ -5435,7 +5435,7 @@ namespace Microsoft.PowerShell.Commands /// /// The path to the file. /// The base name of the script. - /// check the current execution policy. + /// Check the current execution policy. /// The ExternalScriptInfo object. internal ExternalScriptInfo GetScriptInfoForFile(string fileName, out string scriptName, bool checkExecutionPolicy) { @@ -6484,7 +6484,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 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. @@ -6515,7 +6515,7 @@ namespace Microsoft.PowerShell.Commands /// 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 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. diff --git a/src/System.Management.Automation/engine/Modules/ModuleSpecification.cs b/src/System.Management.Automation/engine/Modules/ModuleSpecification.cs index c2abfa6e8..1db899ba2 100644 --- a/src/System.Management.Automation/engine/Modules/ModuleSpecification.cs +++ b/src/System.Management.Automation/engine/Modules/ModuleSpecification.cs @@ -82,8 +82,8 @@ namespace Microsoft.PowerShell.Commands /// Initialize moduleSpecification from hashtable. Return exception object, if hashtable cannot be converted. /// Return null, in the success case. /// - /// object to initialize. - /// contains info about object to initialize. + /// Object to initialize. + /// Contains info about object to initialize. /// internal static Exception ModuleSpecificationInitHelper(ModuleSpecification moduleSpecification, Hashtable hashtable) { @@ -229,7 +229,7 @@ namespace Microsoft.PowerShell.Commands /// Parse the specified string into a ModuleSpecification object /// /// The module specification string. - /// the ModuleSpecification object. + /// The ModuleSpecification object. /// public static bool TryParse(string input, out ModuleSpecification result) { diff --git a/src/System.Management.Automation/engine/Modules/ModuleUtils.cs b/src/System.Management.Automation/engine/Modules/ModuleUtils.cs index 58165dbd9..64c802ea6 100644 --- a/src/System.Management.Automation/engine/Modules/ModuleUtils.cs +++ b/src/System.Management.Automation/engine/Modules/ModuleUtils.cs @@ -323,7 +323,7 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 b589ef29e..8684969de 100644 --- a/src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs +++ b/src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs @@ -890,7 +890,7 @@ namespace Microsoft.PowerShell.Commands /// a comment describing the key as well as the key and its value. /// /// The manifest key to use. - /// resourceString that holds the message. + /// ResourceString that holds the message. /// The formatted manifest fragment. /// Streamwriter to get end of line character from. /// diff --git a/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs b/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs index c169d8da0..dd3fcfa37 100644 --- a/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs +++ b/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs @@ -437,7 +437,7 @@ namespace System.Management.Automation /// /// Sets the module version /// - /// the version to set... + /// The version to set... internal void SetVersion(Version version) { Version = version; @@ -679,7 +679,7 @@ namespace System.Management.Automation /// /// 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"); @@ -735,7 +735,7 @@ namespace System.Management.Automation /// /// Add CmdletInfo to the fixed exports list... /// - /// the cmdlet to add... + /// The cmdlet to add... internal void AddDetectedCmdletExport(string cmdlet) { Dbg.Assert(cmdlet != null, "AddDetectedCmdletExport should not be called with a null value"); @@ -791,7 +791,7 @@ namespace System.Management.Automation /// /// Add CmdletInfo to the fixed exports list... /// - /// the cmdlet to add... + /// The cmdlet to add... internal void AddExportedCmdlet(CmdletInfo cmdlet) { Dbg.Assert(cmdlet != null, "AddExportedCmdlet should not be called with a null value"); @@ -831,7 +831,7 @@ namespace System.Management.Automation /// /// Add AliasInfo to the fixed exports list... /// - /// the cmdlet to add... + /// The cmdlet to add... internal void AddExportedAlias(AliasInfo aliasInfo) { Dbg.Assert(aliasInfo != null, "AddExportedAlias should not be called with a null value"); @@ -1194,8 +1194,8 @@ namespace System.Management.Automation /// /// 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"); diff --git a/src/System.Management.Automation/engine/MshCmdlet.cs b/src/System.Management.Automation/engine/MshCmdlet.cs index def826815..f171eba0a 100644 --- a/src/System.Management.Automation/engine/MshCmdlet.cs +++ b/src/System.Management.Automation/engine/MshCmdlet.cs @@ -159,8 +159,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -428,7 +428,7 @@ namespace System.Management.Automation /// 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) { diff --git a/src/System.Management.Automation/engine/MshCommandRuntime.cs b/src/System.Management.Automation/engine/MshCommandRuntime.cs index e2c7ed36d..27bc730f3 100644 --- a/src/System.Management.Automation/engine/MshCommandRuntime.cs +++ b/src/System.Management.Automation/engine/MshCommandRuntime.cs @@ -295,7 +295,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// The general pattern is to call /// throw ManageException(e); /// - /// the exception. + /// The exception. /// PipelineStoppedException. public Exception ManageException(Exception e) { @@ -2631,7 +2631,7 @@ namespace System.Management.Automation /// a /// rather than the real exception. /// - /// error. + /// Error. /// /// Not permitted at this time or from this thread /// @@ -3463,8 +3463,8 @@ namespace System.Management.Automation /// /// 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 77b60461f..2838f0a59 100644 --- a/src/System.Management.Automation/engine/MshMemberInfo.cs +++ b/src/System.Management.Automation/engine/MshMemberInfo.cs @@ -368,9 +368,9 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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)) @@ -781,10 +781,10 @@ namespace System.Management.Automation /// /// 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 getterCodeReference doesn't have the right format. + /// If name is null or empty or getterCodeReference is null. + /// If getterCodeReference doesn't have the right format. public PSCodeProperty(string name, MethodInfo getterCodeReference) { if (string.IsNullOrEmpty(name)) @@ -804,10 +804,10 @@ namespace System.Management.Automation /// /// 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, @@ -1054,8 +1054,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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)) @@ -1219,9 +1219,9 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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)) @@ -1434,7 +1434,7 @@ namespace System.Management.Automation /// a subclass of the NoteProperty that wraps a variable instead of a simple value. /// /// The variable to wrap. - /// for an empty or null name. + /// For an empty or null name. public PSVariableProperty(PSVariable variable) : base(variable?.Name, null) { @@ -1658,9 +1658,9 @@ namespace System.Management.Automation /// /// Initializes an instance of the PSScriptProperty class as a read only property. /// - /// name of the property. - /// script to be used for the property getter. $this will be this PSObject. - /// for invalid arguments. + /// Name of the property. + /// Script to be used for the property getter. $this will be this PSObject. + /// For invalid arguments. public PSScriptProperty(string name, ScriptBlock getterScript) { if (string.IsNullOrEmpty(name)) @@ -1678,9 +1678,9 @@ namespace System.Management.Automation /// property. getterScript or setterScript can be null, but not both. /// /// 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. + /// 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. public PSScriptProperty(string name, ScriptBlock getterScript, ScriptBlock setterScript) { if (string.IsNullOrEmpty(name)) @@ -1714,10 +1714,10 @@ namespace System.Management.Automation /// property, using the text of the properties to support lazy initialization. /// /// 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. + /// 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,9 +2050,9 @@ namespace System.Management.Automation /// /// 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. + /// 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. @@ -2165,10 +2165,10 @@ namespace System.Management.Automation /// /// Initializes a new instance of the PSCodeMethod class. /// - /// 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. + /// 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. public PSCodeMethod(string name, MethodInfo codeReference) { if (string.IsNullOrEmpty(name)) @@ -2216,9 +2216,9 @@ namespace System.Management.Automation /// /// 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 @@ -2319,9 +2319,9 @@ namespace System.Management.Automation /// /// Initializes a new instance of PSScriptMethod /// - /// name of the method. - /// script to be used when calling the method. - /// for invalid arguments. + /// Name of the method. + /// Script to be used when calling the method. + /// For invalid arguments. public PSScriptMethod(string name, ScriptBlock script) { if (string.IsNullOrEmpty(name)) @@ -2356,9 +2356,9 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Constructs a PSMethod /// - /// 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. + /// 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. internal PSMethod(string name, Adapter adapter, object baseObject, object adapterData, bool isSpecial, bool isHidden) : this(name, adapter, baseObject, adapterData) { @@ -2536,9 +2536,9 @@ namespace System.Management.Automation /// /// 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. + /// 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) @@ -2549,10 +2549,10 @@ namespace System.Management.Automation /// /// 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. + /// 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) @@ -2899,11 +2899,11 @@ namespace System.Management.Automation /// /// 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,9 +2942,9 @@ namespace System.Management.Automation /// /// 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. + /// If arguments is null. /// When getting the value of a property throws an exception. public override object Invoke(params object[] arguments) { @@ -2959,9 +2959,9 @@ namespace System.Management.Automation /// /// Invokes the setter method /// - /// value to set this property with. - /// arguments to the method. - /// if arguments is null. + /// 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) { @@ -3054,8 +3054,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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)) @@ -3424,9 +3424,9 @@ namespace System.Management.Automation /// /// 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)) @@ -3536,7 +3536,7 @@ namespace System.Management.Automation /// Constructs this event /// /// The actual event. - /// for invalid arguments. + /// For invalid arguments. internal PSEvent(EventInfo baseEvent) { this.baseEvent = baseEvent; @@ -3642,9 +3642,9 @@ namespace System.Management.Automation /// 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. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ -3759,28 +3759,28 @@ namespace System.Management.Automation /// /// Returns all members in the collection matching name /// - /// name of the members to be return. May contain wildcard characters. + /// 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); /// /// Returns all members in the collection matching name and types /// - /// name of the members to be return. May contain wildcard characters. - /// type of the members to be searched. + /// 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); /// /// Returns all members in the collection matching name and types /// - /// name of the members to be return. May contain wildcard characters. - /// type of the members to be searched. - /// match options. + /// Name of the members to be return. May contain wildcard characters. + /// Type of the members to be searched. + /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ -3862,9 +3862,9 @@ namespace System.Management.Automation /// /// Returns all members in the collection matching name /// - /// name of the members to be return. May contain wildcard characters. + /// 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)) @@ -3878,10 +3878,10 @@ namespace System.Management.Automation /// /// Returns all members in the collection matching name and types /// - /// name of the members to be return. May contain wildcard characters. - /// type of the members to be searched. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Removes a member from this collection /// - /// name of the member to be removed. + /// Name of the member to be removed. /// When removing a member with a reserved member name. - /// for invalid arguments. + /// For invalid arguments. public override void Remove(string name) { if (string.IsNullOrEmpty(name)) @@ -4084,9 +4084,9 @@ namespace System.Management.Automation /// /// 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 @@ -4111,9 +4111,9 @@ namespace System.Management.Automation /// /// Returns all members in the collection matching name /// - /// name of the members to be return. May contain wildcard characters. + /// 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)) @@ -4127,10 +4127,10 @@ namespace System.Management.Automation /// /// Returns all members in the collection matching name and types /// - /// name of the members to be return. May contain wildcard characters. - /// type of the members to be searched. + /// 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)) @@ -4144,11 +4144,11 @@ namespace System.Management.Automation /// /// Returns all members in the collection matching name and types /// - /// name of the members to be return. May contain wildcard characters. - /// type of the members to be searched. - /// match options. + /// Name of the members to be return. May contain wildcard characters. + /// Type of the members to be searched. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Adds member to the collection /// - /// member to be added. + /// Member to be added. /// /// When /// member is an PSProperty or PSMethod @@ -4441,7 +4441,7 @@ namespace System.Management.Automation /// 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) { Add(member, false); @@ -4450,7 +4450,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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) @@ -4593,7 +4593,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ -4831,9 +4831,9 @@ namespace System.Management.Automation /// /// Returns all members in the collection matching name /// - /// name of the members to be return. May contain wildcard characters. + /// 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)) @@ -4847,10 +4847,10 @@ namespace System.Management.Automation /// /// Returns all members in the collection matching name and types /// - /// name of the members to be return. May contain wildcard characters. - /// type of the members to be searched. + /// 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)) @@ -4864,11 +4864,11 @@ namespace System.Management.Automation /// /// Returns all members in the collection matching name and types /// - /// name of the members to be return. May contain wildcard characters. - /// type of the members to be searched. - /// search options. + /// Name of the members to be return. May contain wildcard characters. + /// Type of the members to be searched. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 ef1b3f7e3..97201b722 100644 --- a/src/System.Management.Automation/engine/MshObject.cs +++ b/src/System.Management.Automation/engine/MshObject.cs @@ -535,8 +535,8 @@ namespace System.Management.Automation /// /// 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) { @@ -1011,11 +1011,11 @@ namespace System.Management.Automation /// 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) { @@ -1241,8 +1241,8 @@ namespace System.Management.Automation /// 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 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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, @@ -2028,7 +2028,7 @@ namespace System.Management.Automation /// /// Set base object /// - /// object which is set as core. + /// 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 @@ namespace Microsoft.PowerShell /// /// 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 @@ namespace Microsoft.PowerShell /// /// 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 @@ namespace Microsoft.PowerShell /// /// 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 20eae17c4..fc7f76b92 100644 --- a/src/System.Management.Automation/engine/MshObjectTypeDescriptor.cs +++ b/src/System.Management.Automation/engine/MshObjectTypeDescriptor.cs @@ -165,7 +165,7 @@ namespace System.Management.Automation /// value of true to false. /// /// If is null. - /// if is not + /// If is not /// an or an . public override object GetValue(object component) { @@ -263,7 +263,7 @@ namespace System.Management.Automation /// from its default value of true to false. /// /// If is null. - /// if is not an + /// If is not an /// or an . /// public override void SetValue(object component, object value) diff --git a/src/System.Management.Automation/engine/MshSecurityException.cs b/src/System.Management.Automation/engine/MshSecurityException.cs index 56341a237..c9e0bf3f7 100644 --- a/src/System.Management.Automation/engine/MshSecurityException.cs +++ b/src/System.Management.Automation/engine/MshSecurityException.cs @@ -31,8 +31,8 @@ namespace System.Management.Automation /// /// 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 e9c03bf6d..72087a46f 100644 --- a/src/System.Management.Automation/engine/NativeCommandParameterBinder.cs +++ b/src/System.Management.Automation/engine/NativeCommandParameterBinder.cs @@ -155,7 +155,7 @@ namespace System.Management.Automation /// 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 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) { diff --git a/src/System.Management.Automation/engine/NativeCommandProcessor.cs b/src/System.Management.Automation/engine/NativeCommandProcessor.cs index 8603d6837..7d33b0ecd 100644 --- a/src/System.Management.Automation/engine/NativeCommandProcessor.cs +++ b/src/System.Management.Automation/engine/NativeCommandProcessor.cs @@ -123,7 +123,7 @@ namespace System.Management.Automation /// Build an output object /// /// The data to output. - /// stream to which data belongs. + /// Stream to which data belongs. internal ProcessOutputObject(object data, MinishellStream stream) { Data = data; diff --git a/src/System.Management.Automation/engine/ScriptCommandProcessor.cs b/src/System.Management.Automation/engine/ScriptCommandProcessor.cs index fbb258eb5..d46b3880d 100644 --- a/src/System.Management.Automation/engine/ScriptCommandProcessor.cs +++ b/src/System.Management.Automation/engine/ScriptCommandProcessor.cs @@ -127,8 +127,8 @@ namespace System.Management.Automation /// 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 9a248b1a6..7413bbf03 100644 --- a/src/System.Management.Automation/engine/SecurityManagerBase.cs +++ b/src/System.Management.Automation/engine/SecurityManagerBase.cs @@ -61,9 +61,9 @@ namespace System.Management.Automation /// /// determine if we should run the specified file /// - /// info on entity to be run. - /// the dispatch origin of a command. - /// allows access to the host. + /// 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. /// diff --git a/src/System.Management.Automation/engine/SessionStateContainer.cs b/src/System.Management.Automation/engine/SessionStateContainer.cs index 7c960055a..f40dab0fe 100644 --- a/src/System.Management.Automation/engine/SessionStateContainer.cs +++ b/src/System.Management.Automation/engine/SessionStateContainer.cs @@ -1673,7 +1673,7 @@ namespace System.Management.Automation /// 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. + /// A hint used to skip IsItemContainer checks. /// /// If the refers to a provider that could not be found. /// @@ -1725,7 +1725,7 @@ namespace System.Management.Automation /// 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. + /// 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/SessionStateProviderAPIs.cs b/src/System.Management.Automation/engine/SessionStateProviderAPIs.cs index 5c5bd0b58..dfc2ab9b6 100644 --- a/src/System.Management.Automation/engine/SessionStateProviderAPIs.cs +++ b/src/System.Management.Automation/engine/SessionStateProviderAPIs.cs @@ -935,7 +935,7 @@ namespace System.Management.Automation /// /// Copy the Providers from another session state instance... /// - /// the session state instance to copy from... + /// The session state instance to copy from... internal void CopyProviders(SessionStateInternal ss) { if (ss == null || ss.Providers == null) diff --git a/src/System.Management.Automation/engine/SessionStateScope.cs b/src/System.Management.Automation/engine/SessionStateScope.cs index 84c00d417..56bca6ff3 100644 --- a/src/System.Management.Automation/engine/SessionStateScope.cs +++ b/src/System.Management.Automation/engine/SessionStateScope.cs @@ -313,7 +313,7 @@ namespace System.Management.Automation /// /// 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. + /// 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. diff --git a/src/System.Management.Automation/engine/TypeMetadata.cs b/src/System.Management.Automation/engine/TypeMetadata.cs index 2fdd54ca2..7e8a0faa4 100644 --- a/src/System.Management.Automation/engine/TypeMetadata.cs +++ b/src/System.Management.Automation/engine/TypeMetadata.cs @@ -44,7 +44,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 7c225d32f..a6d2c31cb 100644 --- a/src/System.Management.Automation/engine/TypeTable.cs +++ b/src/System.Management.Automation/engine/TypeTable.cs @@ -1647,8 +1647,8 @@ namespace System.Management.Automation.Runspaces /// /// 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) { @@ -3626,7 +3626,7 @@ namespace System.Management.Automation.Runspaces /// 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 @@ namespace System.Management.Automation.Runspaces /// /// 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) { @@ -4284,9 +4284,9 @@ namespace System.Management.Automation.Runspaces /// /// 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 @@ namespace System.Management.Automation.Runspaces /// /// 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)) diff --git a/src/System.Management.Automation/engine/UserFeedbackParameters.cs b/src/System.Management.Automation/engine/UserFeedbackParameters.cs index 1a88d6b32..f671b8266 100644 --- a/src/System.Management.Automation/engine/UserFeedbackParameters.cs +++ b/src/System.Management.Automation/engine/UserFeedbackParameters.cs @@ -57,7 +57,7 @@ namespace System.Management.Automation /// 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 65b7867d3..2a33e3c9f 100644 --- a/src/System.Management.Automation/engine/Utils.cs +++ b/src/System.Management.Automation/engine/Utils.cs @@ -361,7 +361,7 @@ namespace System.Management.Automation /// 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) { diff --git a/src/System.Management.Automation/engine/WorkflowInfo.cs b/src/System.Management.Automation/engine/WorkflowInfo.cs index 3b94c6819..fb5b3595c 100644 --- a/src/System.Management.Automation/engine/WorkflowInfo.cs +++ b/src/System.Management.Automation/engine/WorkflowInfo.cs @@ -67,7 +67,7 @@ namespace System.Management.Automation /// /// 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 384133372..ce08df2b0 100644 --- a/src/System.Management.Automation/engine/cmdlet.cs +++ b/src/System.Management.Automation/engine/cmdlet.cs @@ -230,8 +230,8 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// a /// rather than the real exception. /// - /// error. + /// Error. /// /// Not permitted at this time or from this thread /// @@ -419,7 +419,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Display debug information /// - /// debug output. + /// Debug output. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. diff --git a/src/System.Management.Automation/engine/debugger/debugger.cs b/src/System.Management.Automation/engine/debugger/debugger.cs index 00bce00ba..7df3c202e 100644 --- a/src/System.Management.Automation/engine/debugger/debugger.cs +++ b/src/System.Management.Automation/engine/debugger/debugger.cs @@ -588,7 +588,7 @@ namespace System.Management.Automation /// Parent debugger. /// List of breakpoints. /// Debugger mode. - /// host. + /// Host. /// Current path. public virtual void SetParent( Debugger parent, @@ -2419,7 +2419,7 @@ namespace System.Management.Automation /// is used internally to handle debugger commands such as list, help, etc. /// /// Command string. - /// output. + /// Output. /// DebuggerCommand containing information on whether and how the command was processed. internal override DebuggerCommand InternalProcessCommand(string command, IList output) { diff --git a/src/System.Management.Automation/engine/hostifaces/Command.cs b/src/System.Management.Automation/engine/hostifaces/Command.cs index c11ba595f..0c43c3cad 100644 --- a/src/System.Management.Automation/engine/hostifaces/Command.cs +++ b/src/System.Management.Automation/engine/hostifaces/Command.cs @@ -21,7 +21,7 @@ namespace System.Management.Automation.Runspaces /// Initializes a new instance of Command class using specified command parameter. /// /// Name of the command or script contents. - /// command is null. + /// Command is null. public Command(string command) : this(command, false, null) { @@ -32,7 +32,7 @@ namespace System.Management.Automation.Runspaces /// /// 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) { @@ -43,8 +43,8 @@ namespace System.Management.Automation.Runspaces /// /// 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; @@ -853,7 +853,7 @@ namespace System.Management.Automation.Runspaces /// /// Adds a new script command /// - /// script contents. + /// Script contents. /// /// scriptContents is null. /// @@ -865,8 +865,8 @@ namespace System.Management.Automation.Runspaces /// /// 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 3e76af103..d800b6a41 100644 --- a/src/System.Management.Automation/engine/hostifaces/Connection.cs +++ b/src/System.Management.Automation/engine/hostifaces/Connection.cs @@ -326,7 +326,7 @@ namespace System.Management.Automation.Runspaces /// /// The information about /// current state of the runspace. - /// runspaceStateInfo is null + /// RunspaceStateInfo is null /// internal RunspaceStateEventArgs(RunspaceStateInfo runspaceStateInfo) { @@ -1422,7 +1422,7 @@ namespace System.Management.Automation.Runspaces /// Create a pipeline from a command string. /// /// A valid command string. - /// if true command is added to history. + /// If true command is added to history. /// /// A pipeline pre-filled with a object for specified command parameter. /// @@ -1445,7 +1445,7 @@ namespace System.Management.Automation.Runspaces /// Creates a nested pipeline. /// /// A valid command string. - /// if true command is added to history. + /// If true command is added to history. /// /// A pipeline pre-filled with Command specified in commandString. /// diff --git a/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs b/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs index 7bf5e4d7a..3637ca574 100644 --- a/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs +++ b/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs @@ -551,7 +551,7 @@ namespace System.Management.Automation.Runspaces /// Create a pipeline from a command string. /// /// A valid command string. - /// if true command is added to history. + /// If true command is added to history. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -585,7 +585,7 @@ namespace System.Management.Automation.Runspaces /// Creates a nested pipeline. /// /// A valid command string. - /// if true command is added to history. + /// If true command is added to history. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -606,7 +606,7 @@ namespace System.Management.Automation.Runspaces /// Create a pipeline from a command string /// /// A valid command string or String.Empty. - /// if true command is added to history. + /// If true command is added to history. /// True for nested pipeline. /// /// A pipeline pre-filled with Commands specified in commandString. @@ -696,7 +696,7 @@ namespace System.Management.Automation.Runspaces /// /// 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 @@ namespace System.Management.Automation.Runspaces /// /// Set the current runspace state - no error /// - /// the new state. + /// The new state. protected void SetRunspaceState(RunspaceState state) { this.SetRunspaceState(state, null); diff --git a/src/System.Management.Automation/engine/hostifaces/History.cs b/src/System.Management.Automation/engine/hostifaces/History.cs index 1bc88f1f8..921264400 100644 --- a/src/System.Management.Automation/engine/hostifaces/History.cs +++ b/src/System.Management.Automation/engine/hostifaces/History.cs @@ -24,10 +24,10 @@ namespace Microsoft.PowerShell.Commands /// /// 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"); @@ -222,9 +222,9 @@ namespace Microsoft.PowerShell.Commands /// /// Update the history entry corresponding to id. /// - /// id of history entry to be updated. - /// status to be updated. - /// endTime to be updated. + /// 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) @@ -1893,10 +1893,10 @@ namespace Microsoft.PowerShell.Commands /// /// 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 f32fbf16d..7c837ebef 100644 --- a/src/System.Management.Automation/engine/hostifaces/HostUtilities.cs +++ b/src/System.Management.Automation/engine/hostifaces/HostUtilities.cs @@ -105,12 +105,12 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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,8 +160,8 @@ namespace System.Management.Automation /// /// 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. - /// false for all users, true for the current user. + /// 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 @@ namespace System.Management.Automation /// /// 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. - /// false for all users, true for the current user. - /// used from test not to overwrite the profile file names from development boxes. + /// 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. /// The profile file name matching the parameters. internal static string GetFullProfileFileName(string shellId, bool forCurrentUser, bool useTestProfile) { @@ -227,8 +227,8 @@ namespace System.Management.Automation /// /// 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) { diff --git a/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs b/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs index fc8c46f01..17c9d76cc 100644 --- a/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs +++ b/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs @@ -215,7 +215,7 @@ namespace System.Management.Automation.Runspaces /// Create a pipeline from a command string /// /// A valid command string. Can be null. - /// if true command is added to history. + /// If true command is added to history. /// True for nested pipeline. /// /// A pipeline pre-filled with Commands specified in commandString. @@ -1414,8 +1414,8 @@ namespace System.Management.Automation.Runspaces /// /// 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 @@ namespace System.Management.Automation.Runspaces /// /// 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 @@ namespace System.Management.Automation.Runspaces /// /// 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) { @@ -1566,8 +1566,8 @@ namespace System.Management.Automation.Runspaces /// /// 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 d700acf1d..b03933dc9 100644 --- a/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs +++ b/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs @@ -40,7 +40,7 @@ namespace System.Management.Automation.Runspaces /// pipeline. /// /// The command string to parse. - /// if true, add pipeline to history. + /// 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) @@ -934,7 +934,7 @@ namespace System.Management.Automation.Runspaces /// /// Resolves command.CommandInfo to an appropriate CommandProcessorBase implementation /// - /// command to resolve. + /// Command to resolve. /// private CommandProcessorBase CreateCommandProcessBase(Command command) { @@ -1064,7 +1064,7 @@ namespace System.Management.Automation.Runspaces /// /// 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/PSDataCollection.cs b/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs index a6cb7cb81..ccc2cc5fe 100644 --- a/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs +++ b/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs @@ -1173,7 +1173,7 @@ namespace System.Management.Automation /// /// 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"); @@ -1775,7 +1775,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 9b309dc81..cdc556e11 100644 --- a/src/System.Management.Automation/engine/hostifaces/Parameter.cs +++ b/src/System.Management.Automation/engine/hostifaces/Parameter.cs @@ -20,7 +20,7 @@ namespace System.Management.Automation.Runspaces /// /// Create a named parameter with a null value /// - /// parameter name. + /// Parameter name. /// /// name is null. /// @@ -39,8 +39,8 @@ namespace System.Management.Automation.Runspaces /// /// Create a named parameter /// - /// parameter name. - /// parameter value. + /// Parameter name. + /// Parameter value. /// /// Name is non null and name length is zero after trimming whitespace. /// @@ -279,7 +279,7 @@ namespace System.Management.Automation.Runspaces /// /// 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 @@ namespace System.Management.Automation.Runspaces /// /// 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 3e285316b..95e1ae827 100644 --- a/src/System.Management.Automation/engine/hostifaces/Pipeline.cs +++ b/src/System.Management.Automation/engine/hostifaces/Pipeline.cs @@ -193,7 +193,7 @@ namespace System.Management.Automation.Runspaces /// /// Copy constructor to support cloning /// - /// source information. + /// Source information. /// /// ArgumentNullException when is null. /// @@ -666,7 +666,7 @@ namespace System.Management.Automation.Runspaces /// /// Sets the command collection. /// - /// command collection to set. + /// Command collection to set. /// called by ClientRemotePipeline internal void SetCommandCollection(CommandCollection commands) { @@ -676,7 +676,7 @@ namespace System.Management.Automation.Runspaces /// /// 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 667a2b2b0..58314ce44 100644 --- a/src/System.Management.Automation/engine/hostifaces/PowerShell.cs +++ b/src/System.Management.Automation/engine/hostifaces/PowerShell.cs @@ -821,7 +821,7 @@ namespace System.Management.Automation /// /// 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) { @@ -3666,8 +3666,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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; diff --git a/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs b/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs index 344f6ca37..ff448edfe 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs @@ -61,7 +61,7 @@ namespace System.Management.Automation /// /// Invoke the specified script /// - /// msh script to invoke. + /// Msh script to invoke. /// Output of invocation. public Collection Invoke(string script) { @@ -71,8 +71,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 ffb1483ff..caa131973 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs @@ -1211,7 +1211,7 @@ namespace System.Management.Automation.Runspaces.Internal /// 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 f936ef4a7..498f961d9 100644 --- a/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs +++ b/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs @@ -25,8 +25,8 @@ namespace System.Management.Automation.Runspaces /// Create a pipeline initialized with a command string /// /// The associated Runspace/> - /// command string. - /// if true, add pipeline to history. + /// Command string. + /// If true, add pipeline to history. /// True for nested pipeline. /// /// Command is null and add to history is true @@ -783,7 +783,7 @@ namespace System.Management.Automation.Runspaces /// /// 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 @@ namespace System.Management.Automation.Runspaces /// /// 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 e626a8727..7cb3d16e9 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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/parserutils.cs b/src/System.Management.Automation/engine/lang/parserutils.cs index 8b1aa9ee0..b4d6d3e19 100644 --- a/src/System.Management.Automation/engine/lang/parserutils.cs +++ b/src/System.Management.Automation/engine/lang/parserutils.cs @@ -429,11 +429,11 @@ namespace System.Management.Automation /// /// 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. internal static object ImplicitOp(object lval, object rval, string op, IScriptExtent errorPosition, string errorOp) @@ -775,7 +775,7 @@ namespace System.Management.Automation /// /// 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) { @@ -787,8 +787,8 @@ namespace System.Management.Automation /// /// 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) { @@ -1018,8 +1018,8 @@ namespace System.Management.Automation /// /// 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) { @@ -1059,8 +1059,8 @@ namespace System.Management.Automation /// /// 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) { @@ -1100,9 +1100,9 @@ namespace System.Management.Automation /// /// 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) { @@ -1145,10 +1145,10 @@ namespace System.Management.Automation /// /// The execution context to use. /// The position to use for error reporting. - /// left operand. - /// right operand. - /// ignore case? - /// true for -notmatch, false for -match. + /// Left operand. + /// Right operand. + /// Ignore case? + /// 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) { @@ -1281,10 +1281,10 @@ namespace System.Management.Automation /// /// The execution context to use. /// The position to use for error reporting. - /// left operand. - /// right operand. - /// ignore case? - /// true for -contains, false for -notcontains. + /// Left operand. + /// Right operand. + /// Ignore case? + /// 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) { @@ -1437,7 +1437,7 @@ namespace System.Management.Automation /// /// 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) { @@ -1779,7 +1779,7 @@ namespace System.Management.Automation /// /// Resource string which holds the error message /// - /// inner exception. + /// Inner exception. /// Insertion parameters to message. /// New instance of an interpreter exception. internal static RuntimeException NewInterpreterExceptionWithInnerException(object targetObject, @@ -1855,7 +1855,7 @@ namespace System.Management.Automation /// The position to use for error reporting. /// Message. /// ErrorID. - /// inner exception. + /// 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 cff7f86a1..fa356cbf0 100644 --- a/src/System.Management.Automation/engine/lang/scriptblock.cs +++ b/src/System.Management.Automation/engine/lang/scriptblock.cs @@ -1065,7 +1065,7 @@ namespace System.Management.Automation /// out how to route the output and errors. /// /// true if you plan to write input into this pipe; false otherwise. - /// context used to figure out how to route the output and errors. + /// Context used to figure out how to route the output and errors. public void Begin(bool expectInput, EngineIntrinsics contextToRedirectTo) { if (contextToRedirectTo == null) @@ -1278,7 +1278,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -1315,8 +1315,8 @@ namespace System.Management.Automation /// /// 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) { @@ -1352,7 +1352,7 @@ namespace System.Management.Automation /// /// The information about current state of the runspace. /// The arguments to this script. - /// scriptBlock is null + /// ScriptBlock is null /// internal ScriptBlockInvocationEventArgs(ScriptBlock scriptBlock, bool useLocalScope, diff --git a/src/System.Management.Automation/engine/parser/Compiler.cs b/src/System.Management.Automation/engine/parser/Compiler.cs index 7e5b29c78..9f1471a91 100644 --- a/src/System.Management.Automation/engine/parser/Compiler.cs +++ b/src/System.Management.Automation/engine/parser/Compiler.cs @@ -2395,7 +2395,7 @@ namespace System.Management.Automation.Language /// 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/PSType.cs b/src/System.Management.Automation/engine/parser/PSType.cs index 18752762a..4edc241f4 100644 --- a/src/System.Management.Automation/engine/parser/PSType.cs +++ b/src/System.Management.Automation/engine/parser/PSType.cs @@ -308,7 +308,7 @@ namespace System.Management.Automation.Language /// /// /// - /// 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 e1f4d4577..183b4e637 100644 --- a/src/System.Management.Automation/engine/parser/Parser.cs +++ b/src/System.Management.Automation/engine/parser/Parser.cs @@ -717,7 +717,7 @@ namespace System.Management.Automation.Language /// Parses the specified constant hashtable string into a Hashtable object /// /// The Hashtable string. - /// the Hashtable object. + /// The Hashtable object. /// internal static bool TryParseAsConstantHashtable(string input, out Hashtable result) { @@ -3258,7 +3258,7 @@ namespace System.Management.Automation.Language /// 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(); diff --git a/src/System.Management.Automation/engine/parser/SemanticChecks.cs b/src/System.Management.Automation/engine/parser/SemanticChecks.cs index 53d45285c..97627af9c 100644 --- a/src/System.Management.Automation/engine/parser/SemanticChecks.cs +++ b/src/System.Management.Automation/engine/parser/SemanticChecks.cs @@ -569,7 +569,7 @@ namespace System.Management.Automation.Language /// Only call it, when label is present and can be calculated in compile time. /// /// BreakStatementAst or ContinueStatementAst. - /// label name. Can be null. + /// Label name. Can be null. private void CheckLabelExists(StatementAst ast, string label) { if (String.IsNullOrEmpty(label)) @@ -1544,10 +1544,10 @@ namespace System.Management.Automation.Language /// /// /// 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. - /// flag to indicate if the class contains Key property. + /// 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. + /// Flag to indicate if the class contains Key property. private static void LookupRequiredMembers(Parser parser, TypeDefinitionAst typeDefinitionAst, ref bool hasSet, ref bool hasGet, ref bool hasTest, ref bool hasKey) { if (typeDefinitionAst == null) diff --git a/src/System.Management.Automation/engine/parser/SymbolResolver.cs b/src/System.Management.Automation/engine/parser/SymbolResolver.cs index b49561e35..8ae7f0f62 100644 --- a/src/System.Management.Automation/engine/parser/SymbolResolver.cs +++ b/src/System.Management.Automation/engine/parser/SymbolResolver.cs @@ -446,7 +446,7 @@ namespace System.Management.Automation.Language /// 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/tokenizer.cs b/src/System.Management.Automation/engine/parser/tokenizer.cs index 45787cb8f..2406f747e 100644 --- a/src/System.Management.Automation/engine/parser/tokenizer.cs +++ b/src/System.Management.Automation/engine/parser/tokenizer.cs @@ -3665,11 +3665,11 @@ namespace System.Management.Automation.Language 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 3410a36be..997f207e6 100644 --- a/src/System.Management.Automation/engine/pipeline.cs +++ b/src/System.Management.Automation/engine/pipeline.cs @@ -296,8 +296,8 @@ namespace System.Management.Automation.Internal /// 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. /// /// @@ -1382,8 +1382,8 @@ namespace System.Management.Automation.Internal /// 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 8eca0f020..0526712f8 100644 --- a/src/System.Management.Automation/engine/regex.cs +++ b/src/System.Management.Automation/engine/regex.cs @@ -447,8 +447,8 @@ namespace System.Management.Automation /// /// Constructor for class WildcardPatternException for serialization. /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. protected WildcardPatternException(SerializationInfo info, StreamingContext context) : base(info, context) diff --git a/src/System.Management.Automation/engine/remoting/client/ClientRemotePowerShell.cs b/src/System.Management.Automation/engine/remoting/client/ClientRemotePowerShell.cs index b72e529e5..4250f1558 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 @@ namespace System.Management.Automation.Runspaces.Internal /// /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// 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) { @@ -513,8 +513,8 @@ namespace System.Management.Automation.Runspaces.Internal /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// /// 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 53fccf44b..54d818b22 100644 --- a/src/System.Management.Automation/engine/remoting/client/Job.cs +++ b/src/System.Management.Automation/engine/remoting/client/Job.cs @@ -248,7 +248,7 @@ namespace System.Management.Automation /// /// Copy constructor to support cloning /// - /// source information. + /// Source information. /// /// ArgumentNullException when is null. /// @@ -1596,7 +1596,7 @@ namespace System.Management.Automation /// /// Gets the job for the specified location /// - /// location to filter on. + /// Location to filter on. /// Collection of jobs. internal List GetJobsForLocation(string location) { @@ -1773,7 +1773,7 @@ namespace System.Management.Automation /// remote command corresponding to this /// result object /// Throttle limit to use. - /// a friendly name for the job object. + /// A friendly name for the job object. internal PSRemotingJob(string[] computerNames, List computerNameHelpers, string remoteCommand, int throttleLimit, string name) @@ -1805,7 +1805,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// Returns the PowerShell for the specified instance id /// - /// instance id of powershell. + /// Instance id of powershell. /// Powershell instance. internal virtual PowerShell GetPowerShell(Guid instanceId) { @@ -4094,7 +4094,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 baf187f96..8773a6784 100644 --- a/src/System.Management.Automation/engine/remoting/client/Job2.cs +++ b/src/System.Management.Automation/engine/remoting/client/Job2.cs @@ -189,7 +189,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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) { @@ -695,7 +695,7 @@ namespace System.Management.Automation /// /// 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) @@ -2149,8 +2149,8 @@ namespace System.Management.Automation /// /// Class constructor /// - /// serialization info. - /// streaming context. + /// Serialization info. + /// Streaming context. protected JobFailedException(SerializationInfo serializationInfo, StreamingContext streamingContext) : base(serializationInfo, streamingContext) { diff --git a/src/System.Management.Automation/engine/remoting/client/JobManager.cs b/src/System.Management.Automation/engine/remoting/client/JobManager.cs index ed33c7a30..b1d4d41bb 100644 --- a/src/System.Management.Automation/engine/remoting/client/JobManager.cs +++ b/src/System.Management.Automation/engine/remoting/client/JobManager.cs @@ -420,7 +420,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// /// - /// 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 @@ namespace System.Management.Automation /// /// /// - /// 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 @@ namespace System.Management.Automation /// /// /// - /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// /// - /// 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. diff --git a/src/System.Management.Automation/engine/remoting/client/JobSourceAdapter.cs b/src/System.Management.Automation/engine/remoting/client/JobSourceAdapter.cs index 56adcaa7c..3342d2516 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 @@ namespace System.Management.Automation /// 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(); @@ -127,8 +127,8 @@ namespace System.Management.Automation /// Public constructor for testing. /// /// Type of adapter to use to create a job. - /// the command string. - /// the job name. + /// The command string. + /// The job name. public JobDefinition(Type jobSourceAdapterType, string command, string name) { JobSourceAdapterType = jobSourceAdapterType; @@ -249,7 +249,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Load this specification from a file /// - /// stream to load from. + /// Stream to load from. public virtual void Load(Stream stream) { throw new NotImplementedException(); @@ -441,7 +441,7 @@ namespace System.Management.Automation /// /// Create a new job with the specified definition /// - /// job definition to use. + /// Job definition to use. /// Job object. public Job2 NewJob(JobDefinition definition) { @@ -465,7 +465,7 @@ namespace System.Management.Automation /// /// Create a new job with the specified JobSpecification /// - /// specification. + /// Specification. /// Job object. public abstract Job2 NewJob(JobInvocationInfo specification); @@ -489,7 +489,7 @@ namespace System.Management.Automation /// /// Get list of jobs that run the specified command /// - /// command to match. + /// Command to match. /// /// Collection of jobs that match the specified /// criteria. @@ -514,7 +514,7 @@ namespace System.Management.Automation /// /// Get list of jobs that are in the specified state /// - /// state to match. + /// State to match. /// /// Collection of jobs with the specified /// state. @@ -534,7 +534,7 @@ namespace System.Management.Automation /// /// Remove a job from the store /// - /// job object to remove. + /// Job object to remove. public abstract void RemoveJob(Job2 job); /// diff --git a/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs b/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs index 1510cc63f..d4a065efe 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 @@ namespace System.Management.Automation /// /// Internal constructor /// - /// the command to execute. + /// The command to execute. internal PSJobProxy(string command) : base(command) { @@ -378,8 +378,8 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 60f007e19..cc1d0ae50 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs @@ -492,8 +492,8 @@ namespace System.Management.Automation.Runspaces.Internal /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// 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) { @@ -1011,7 +1011,7 @@ namespace System.Management.Automation.Runspaces.Internal /// Asynchronous disconnect. /// /// AsyncCallback object. - /// state object. + /// State object. /// IAsyncResult. public override IAsyncResult BeginDisconnect(AsyncCallback callback, object state) { @@ -1102,7 +1102,7 @@ namespace System.Management.Automation.Runspaces.Internal /// Asynchronous connect. /// /// ASyncCallback object. - /// state Object. + /// State Object. /// IAsyncResult. public override IAsyncResult BeginConnect(AsyncCallback callback, object state) { @@ -1560,7 +1560,7 @@ namespace System.Management.Automation.Runspaces.Internal /// /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// 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 @@ namespace System.Management.Automation.Runspaces.Internal /// /// 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. diff --git a/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs b/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs index 47a8a707d..94fe18c61 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 @@ namespace System.Management.Automation.Runspaces /// /// 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) { } /// @@ -122,8 +122,8 @@ namespace System.Management.Automation.Runspaces /// /// 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) { @@ -343,8 +343,8 @@ namespace System.Management.Automation.Remoting /// /// 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 @@ namespace System.Management.Automation.Remoting /// /// 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 ed10f8ad0..e3c886627 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs @@ -29,8 +29,8 @@ namespace System.Management.Automation.Internal /// Constructor which takes a client runspace pool and creates /// an associated ClientRunspacePoolDataStructureHandler /// - /// client runspace pool object. - /// typetable to use for serialization/deserialization. + /// Client runspace pool object. + /// Typetable to use for serialization/deserialization. internal ClientRunspacePoolDataStructureHandler(RemoteRunspacePoolInternal clientRunspacePool, TypeTable typeTable) { @@ -116,7 +116,7 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ -272,7 +272,7 @@ namespace System.Management.Automation.Internal /// /// dispatch the message to the associated powershell data structure handler /// - /// message received. + /// Message received. internal void DispatchMessageToPowerShell(RemoteDataObject rcvdData) { ClientPowerShellDataStructureHandler dsHandler = @@ -290,7 +290,7 @@ namespace System.Management.Automation.Internal /// /// 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); @@ -311,7 +311,7 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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,7 +857,7 @@ namespace System.Management.Automation.Internal /// /// Forwards the session create completion event. /// - /// transport sender. + /// Transport sender. /// CreateCompleteEventArgs. private void HandleSessionCreateCompleted(object sender, CreateCompleteEventArgs eventArgs) { @@ -963,7 +963,7 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// /// 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. diff --git a/src/System.Management.Automation/engine/remoting/client/RunspaceRef.cs b/src/System.Management.Automation/engine/remoting/client/RunspaceRef.cs index 7f995f1f5..f1950373a 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 @@ namespace System.Management.Automation.Remoting /// /// 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 d8cf5e4db..7dad84579 100644 --- a/src/System.Management.Automation/engine/remoting/client/ThrottlingJob.cs +++ b/src/System.Management.Automation/engine/remoting/client/ThrottlingJob.cs @@ -363,7 +363,7 @@ namespace System.Management.Automation /// /// Child job to add. /// Flags of the child job. - /// action to run after enqueuing the 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 7089b6d75..597e3b58e 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 @@ namespace System.Management.Automation.Remoting /// /// 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 @@ namespace System.Management.Automation.Remoting /// /// 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 @@ namespace System.Management.Automation.Remoting /// /// 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 e2e59148e..2ca8fb86e 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 @@ namespace System.Management.Automation.Remoting /// 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 @@ namespace System.Management.Automation.Remoting /// /// 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 @@ namespace System.Management.Automation.Remoting /// 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 @@ namespace System.Management.Automation.Remoting /// 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 @@ namespace System.Management.Automation.Remoting /// 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 d3ce6c7db..8c628bffc 100644 --- a/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs +++ b/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs @@ -107,10 +107,10 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Disposes the pipeline /// - /// true, when called on Dispose(). + /// True, when called on Dispose(). protected override void Dispose(bool disposing) { try @@ -719,7 +719,7 @@ namespace System.Management.Automation /// /// 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,7 +863,7 @@ namespace System.Management.Automation /// command will be immediately disconnected after it begins /// running. /// - /// true if called from a sync call. + /// True if called from a sync call. /// Invoke and Disconnect. private void InitPowerShell(bool syncCall, bool invokeAndDisconnect = false) { @@ -938,8 +938,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 466b80dea..bdd783715 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Dispose this runspace /// - /// true if called from Dispose. + /// True if called from Dispose. protected override void Dispose(bool disposing) { try @@ -1053,7 +1053,7 @@ namespace System.Management.Automation /// Create a pipeline from a command string. /// /// A valid command string. - /// if true command is added to history. + /// If true command is added to history. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -1089,7 +1089,7 @@ namespace System.Management.Automation /// Creates a nested pipeline. /// /// A valid command string. - /// if true command is added to history. + /// If true command is added to history. /// /// A pipeline pre-filled with Commands specified in commandString. /// @@ -1184,7 +1184,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// reference to invoke command /// which is currently being processed - /// the local pipeline id. + /// The local pipeline id. internal void SetCurrentInvokeCommand(InvokeCommandCommand invokeCommand, long localPipelineId) { diff --git a/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs b/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs index 1f4694744..48408f1af 100644 --- a/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs +++ b/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs @@ -358,7 +358,7 @@ namespace System.Management.Automation.Runspaces /// /// Returns shell configuration name with shell prefix removed. /// - /// shell configuration name. + /// Shell configuration name. /// Display shell name. private string GetDisplayShellName(string shell) { diff --git a/src/System.Management.Automation/engine/remoting/client/remotingprotocolimplementation.cs b/src/System.Management.Automation/engine/remoting/client/remotingprotocolimplementation.cs index 90543f393..55f971a36 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 @@ namespace System.Management.Automation.Remoting /// /// 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 @@ namespace System.Management.Automation.Remoting /// /// 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 @@ namespace System.Management.Automation.Remoting /// /// 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/InvokeCommandCommand.cs b/src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs index 04fe8d087..4594940a4 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ -1869,7 +1869,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 3592b83e5..d8fe63d2f 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 @@ namespace System.Management.Automation /// /// Add an item to the repository /// - /// object to add. + /// Object to add. public void Add(T item) { if (item == null) @@ -42,7 +42,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 cb135424b..b888f35d5 100644 --- a/src/System.Management.Automation/engine/remoting/commands/NewPSSessionConfigurationFile.cs +++ b/src/System.Management.Automation/engine/remoting/commands/NewPSSessionConfigurationFile.cs @@ -2079,7 +2079,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 27c46dde0..998416b65 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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; @@ -1825,7 +1825,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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) { @@ -2927,10 +2927,10 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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. @@ -3134,7 +3134,7 @@ namespace Microsoft.PowerShell.Commands /// 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. + /// 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, @@ -3300,7 +3300,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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) { @@ -3689,7 +3689,7 @@ namespace Microsoft.PowerShell.Commands /// 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) { diff --git a/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs b/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs index 17bb57399..6ed292806 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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) { @@ -985,7 +985,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 diff --git a/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs b/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs index e1a478716..da7b5f03e 100644 --- a/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs +++ b/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs @@ -47,9 +47,9 @@ namespace Microsoft.PowerShell.Commands /// /// 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. + /// 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, @@ -180,9 +180,9 @@ namespace Microsoft.PowerShell.Commands /// /// 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. + /// 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) { @@ -297,9 +297,9 @@ namespace Microsoft.PowerShell.Commands /// /// 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. + /// 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) { @@ -552,7 +552,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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. + /// If true, only jobs which can be removed will be checked. /// internal List CopyJobsToList(Job[] jobs, bool writeobject, bool checkIfJobCanBeRemoved) { diff --git a/src/System.Management.Automation/engine/remoting/commands/StartJob.cs b/src/System.Management.Automation/engine/remoting/commands/StartJob.cs index 92a5548e7..0d5d8b691 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 659b5b9f3..fa6221f02 100644 --- a/src/System.Management.Automation/engine/remoting/commands/newrunspacecommand.cs +++ b/src/System.Management.Automation/engine/remoting/commands/newrunspacecommand.cs @@ -1199,7 +1199,7 @@ namespace Microsoft.PowerShell.Commands /// /// Handles the throttling complete event of the throttle manager /// - /// sender of this event. + /// Sender of this event. /// private void HandleThrottleComplete(object sender, EventArgs eventArgs) { diff --git a/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs b/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs index b7a3176cc..0ec20cbb2 100644 --- a/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs +++ b/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs @@ -683,7 +683,7 @@ namespace System.Management.Automation.Remoting /// /// 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 @@ namespace System.Management.Automation.Remoting /// 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; diff --git a/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs b/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs index 8e377086b..9979c57bb 100644 --- a/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs +++ b/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs @@ -804,10 +804,10 @@ namespace System.Management.Automation.Runspaces /// /// 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 @@ namespace System.Management.Automation.Runspaces /// /// 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 @@ namespace System.Management.Automation.Runspaces /// 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 @@ namespace System.Management.Automation.Runspaces /// 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 @@ namespace System.Management.Automation.Runspaces /// 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 @@ namespace System.Management.Automation.Runspaces /// /// 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; diff --git a/src/System.Management.Automation/engine/remoting/common/RunspacePoolStateInfo.cs b/src/System.Management.Automation/engine/remoting/common/RunspacePoolStateInfo.cs index 20d993211..b16634433 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 @@ namespace System.Management.Automation /// /// Constructor for creating the state info /// - /// state. + /// State. /// exception that resulted in this /// state change. Can be null public RunspacePoolStateInfo(RunspacePoolState state, Exception reason) 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 f84cdd2ac..45f031608 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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,7 +1181,7 @@ namespace System.Management.Automation /// This method creates a remoting data structure handler message for transporting a state /// information from server to client /// - /// id of the client RunspacePool. + /// 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,7 +1225,7 @@ namespace System.Management.Automation /// This method creates a remoting data structure handler message for transporting a PowerShell /// event from server to client /// - /// id of the client RunspacePool. + /// Id of the client RunspacePool. /// PowerShell event. /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message @@ -1300,9 +1300,9 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ -1841,7 +1841,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Gets the PSInvocationStateInfo from the data /// - /// object to decode. + /// Object to decode. /// PSInvocationInfo. internal static PSInvocationStateInfo GetPowerShellStateInfo(object data) { @@ -2114,7 +2114,7 @@ namespace System.Management.Automation /// /// Gets the ErrorRecord from the message /// - /// data to decode. + /// Data to decode. /// Error record. internal static ErrorRecord GetPowerShellError(object data) { @@ -2200,7 +2200,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Decodes a RemoteSessionCapability object /// - /// data to decode. + /// Data to decode. /// RemoteSessionCapability object. internal static RemoteSessionCapability GetSessionCapability(object data) { @@ -2410,7 +2410,7 @@ namespace System.Management.Automation /// /// 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 aace117db..c2d8c43f8 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 @@ namespace System.Management.Automation.Remoting /// 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 @@ namespace System.Management.Automation.Remoting /// 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 @@ namespace System.Management.Automation.Remoting /// /// 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 db10d626b..2c42fc8b9 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 @@ namespace System.Management.Automation.Remoting.Internal /// 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 @@ namespace System.Management.Automation.Remoting.Internal /// 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 @@ namespace System.Management.Automation.Remoting.Internal /// 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 42ae90ecc..a4214b25c 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 @@ namespace System.Management.Automation.Remoting /// /// 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 @@ namespace System.Management.Automation.Remoting /// /// 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 d5a67ee7a..0f0048c21 100644 --- a/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs +++ b/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs @@ -227,7 +227,7 @@ namespace System.Management.Automation.Remoting /// /// 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 /// @@ -366,7 +366,7 @@ namespace System.Management.Automation.Remoting /// /// 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 @@ namespace System.Management.Automation.Remoting /// 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/InitialSessionStateProvider.cs b/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs index 7b727f27a..9d9fd7792 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs @@ -1403,7 +1403,7 @@ namespace System.Management.Automation.Remoting /// /// Create an ExternalScriptInfo object from a file path. /// - /// execution context. + /// Execution context. /// The path to the file. /// The base name of the script. /// The ExternalScriptInfo object. @@ -1433,8 +1433,8 @@ namespace System.Management.Automation.Remoting /// /// 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 @@ namespace System.Management.Automation.Remoting /// /// Verifies the configuration hashtable /// - /// configuration hashtable. + /// Configuration hashtable. /// /// /// True if valid, false otherwise. diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs index b62eaaa13..afabb3da6 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 @@ namespace System.Management.Automation.Remoting.Client /// 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) diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs index 03e49585d..fa350fb13 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs @@ -251,7 +251,7 @@ namespace System.Management.Automation.Remoting.Client /// Helper method to convert a transport error code value /// to a fully qualified error Id string. /// - /// transport error code. + /// Transport error code. /// Default FQEID. /// Fully qualified error Id string. internal static string GetFQEIDFromTransportError( @@ -548,8 +548,8 @@ namespace System.Management.Automation.Remoting.Client /// /// 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 @@ namespace System.Management.Automation.Remoting.Client /// 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) diff --git a/src/System.Management.Automation/engine/remoting/server/ServerPowerShellDriver.cs b/src/System.Management.Automation/engine/remoting/server/ServerPowerShellDriver.cs index 8ad454907..01fda8b23 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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/ServerRemotingProtocol2.cs b/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs index 27bada709..eff609383 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Send the specified progress record to client /// - /// progress record. + /// Progress record. internal void SendProgressRecordToClient(ProgressRecord record) { SendDataAsync(RemotingEncoder.GeneratePowerShellInformational( @@ -589,7 +589,7 @@ namespace System.Management.Automation /// /// Send the specified information record to client /// - /// information record. + /// Information record. internal void SendInformationRecordToClient(InformationRecord record) { SendDataAsync(RemotingEncoder.GeneratePowerShellInformational( @@ -611,7 +611,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 08257b1bd..ada8a8ba9 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 2. ThreadOptions for RunspacePool/Runspace /// 3. ThreadApartment for RunspacePool/Runspace /// - /// configuration of the runspace. - /// application private data. + /// 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). + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 2. ThreadOptions for RunspacePool/Runspace /// 3. ThreadApartment for RunspacePool/Runspace /// - /// configuration of the runspace. - /// application private data. + /// 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). + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// Gets the available runspaces from the server and sends it across /// to the client /// - /// 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; diff --git a/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineDriver.cs b/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineDriver.cs index 62fe1e8b5..58a6679b0 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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"); diff --git a/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineSubscriber.cs b/src/System.Management.Automation/engine/remoting/server/ServerSteppablePipelineSubscriber.cs index cb742b4c2..df8cdf259 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 @@ namespace System.Management.Automation /// /// Fires the start event /// - /// steppable pipeline driver. + /// Steppable pipeline driver. internal void FireStartSteppablePipeline(ServerSteppablePipelineDriver driver) { lock (_syncObject) @@ -284,7 +284,7 @@ namespace System.Management.Automation /// /// 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 29405b588..1fe97497c 100644 --- a/src/System.Management.Automation/engine/remoting/server/serverremotesession.cs +++ b/src/System.Management.Automation/engine/remoting/server/serverremotesession.cs @@ -378,7 +378,7 @@ namespace System.Management.Automation.Remoting /// 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 ac5303c59..4a013e6fa 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 @@ namespace System.Management.Automation.Remoting /// 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 @@ namespace System.Management.Automation.Remoting /// /// 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 8580f4bca..211ce8120 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 @@ namespace System.Management.Automation.Remoting /// /// 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/Operations/ArrayOps.cs b/src/System.Management.Automation/engine/runtime/Operations/ArrayOps.cs index 9e78e90c6..8ac50eeb5 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 @@ namespace System.Management.Automation /// /// 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 53d227fa9..df2e604b4 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 @@ namespace System.Management.Automation.Internal /// /// - /// 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 @@ namespace System.Management.Automation.Internal /// /// /// - /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 e280ab0f0..fed66576e 100644 --- a/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs +++ b/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs @@ -1827,7 +1827,7 @@ namespace System.Management.Automation /// /// /// The execution context. - /// the output pipe of the statement. + /// The output pipe of the statement. internal static void SetErrorVariables(IScriptExtent extent, RuntimeException rte, ExecutionContext context, Pipe outputPipe) { string stack = null; diff --git a/src/System.Management.Automation/engine/scriptparameterbinder.cs b/src/System.Management.Automation/engine/scriptparameterbinder.cs index f64dc3bdc..a0a54d3eb 100644 --- a/src/System.Management.Automation/engine/scriptparameterbinder.cs +++ b/src/System.Management.Automation/engine/scriptparameterbinder.cs @@ -69,7 +69,7 @@ namespace System.Management.Automation /// /// 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 d606a25bc..0574424d7 100644 --- a/src/System.Management.Automation/engine/serialization.cs +++ b/src/System.Management.Automation/engine/serialization.cs @@ -187,7 +187,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 /// @@ -1647,8 +1647,8 @@ namespace System.Management.Automation /// /// /// - /// if true, TypeName information is written, else not. - /// if not null then ToString information is written. + /// If true, TypeName information is written, else not. + /// If not null then ToString information is written. private void WriteStartOfPSObject ( PSObject mshObject, @@ -2100,7 +2100,7 @@ namespace System.Management.Automation /// /// Serializes IDictionary /// - /// dictionary which is serialized. + /// Dictionary which is serialized. /// /// private void WriteDictionary @@ -2278,7 +2278,7 @@ namespace System.Management.Automation /// compute the serialization depth for an PSObject instance subtree /// /// PSObject whose serialization depth has to be computed. - /// current depth. + /// Current depth. /// private int GetDepthOfSerialization(object source, int depth) { @@ -2369,10 +2369,10 @@ namespace System.Management.Automation /// Writes raw string as item or property in Monad namespace /// /// 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 the stream to write. Do not write if null. + /// Name of property. Pass null for item. + /// String to write. + /// Serialization information. private static void WriteRawString ( InternalSerializer serializer, @@ -2410,9 +2410,9 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item. + /// Name of property. pass null for item. /// DateTime to write. - /// serialization information about source. + /// 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 @@ namespace System.Management.Automation /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item. + /// Name of property. pass null for item. /// Version to write. - /// serialization information about source. + /// 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 @@ namespace System.Management.Automation /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item. + /// Name of property. pass null for item. /// Version to write. - /// serialization information about source. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item. + /// Name of property. pass null for item. /// URI to write. - /// serialization information about source. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item. + /// Name of property. pass null for item. /// Double to write. - /// serialization information about source. + /// 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 @@ namespace System.Management.Automation /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item. + /// Name of property. pass null for item. /// Char to write. - /// serialization information about source. + /// 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 @@ namespace System.Management.Automation /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item. + /// Name of property. pass null for item. /// Boolean to write. - /// serialization information about source. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// The serializer to which the object is serialized. /// - /// name of property. pass null for item. + /// Name of property. pass null for item. /// DateTime to write. - /// serialization information about source. + /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { @@ -5895,7 +5895,7 @@ namespace System.Management.Automation /// Initializes a new instance of the class with contents /// copied from the hashtable. /// - /// hashtable to copy into the new instance of + /// Hashtable to copy into the new instance of /// /// This constructor will throw if the hashtable contains keys that are not a strings /// or values that are not one of primitive types that will work during PowerShell remoting handshake. @@ -6685,9 +6685,9 @@ namespace Microsoft.PowerShell /// 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. + /// 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) @@ -6773,9 +6773,9 @@ namespace Microsoft.PowerShell /// 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. + /// 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(); diff --git a/src/System.Management.Automation/help/AliasHelpProvider.cs b/src/System.Management.Automation/help/AliasHelpProvider.cs index 31e269d77..23c92b3c3 100644 --- a/src/System.Management.Automation/help/AliasHelpProvider.cs +++ b/src/System.Management.Automation/help/AliasHelpProvider.cs @@ -90,7 +90,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 a420253cb..4cea79343 100644 --- a/src/System.Management.Automation/help/BaseCommandHelpInfo.cs +++ b/src/System.Management.Automation/help/BaseCommandHelpInfo.cs @@ -372,7 +372,7 @@ namespace System.Management.Automation /// /// 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 544550050..693719e3b 100644 --- a/src/System.Management.Automation/help/CabinetAPI.cs +++ b/src/System.Management.Automation/help/CabinetAPI.cs @@ -14,9 +14,9 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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/CommandHelpProvider.cs b/src/System.Management.Automation/help/CommandHelpProvider.cs index 8ee1b6022..38fa8e3b9 100644 --- a/src/System.Management.Automation/help/CommandHelpProvider.cs +++ b/src/System.Management.Automation/help/CommandHelpProvider.cs @@ -420,7 +420,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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. @@ -1216,8 +1216,8 @@ namespace System.Management.Automation /// Checks whether matches any of the patterns /// present in /// - /// content to search in. - /// string patterns to look for. + /// Content to search in. + /// String patterns to look for. /// /// true if contains any of the patterns /// present in diff --git a/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs b/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs index 7e1e721b6..58000675e 100644 --- a/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs +++ b/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs @@ -46,7 +46,7 @@ namespace System.Management.Automation.Help /// /// Generates a HelpInfo PSObject from a CmdletInfo object /// - /// command info. + /// Command info. /// HelpInfo PSObject. internal static PSObject GetPSObjectFromCmdletInfo(CommandInfo input) { @@ -151,11 +151,11 @@ namespace System.Management.Automation.Help /// Adds the details properties /// /// HelpInfo object. - /// command name. - /// command noun. - /// command verb. - /// type name for help. - /// synopsis. + /// 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) { @@ -185,10 +185,10 @@ namespace System.Management.Automation.Help /// Adds the syntax properties /// /// HelpInfo object. - /// command name. - /// parameter sets. - /// common parameters. - /// type name for help. + /// 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(); @@ -205,10 +205,10 @@ namespace System.Management.Automation.Help /// 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. + /// 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(); @@ -248,7 +248,7 @@ namespace System.Management.Automation.Help /// Named Mandatory (in alpha numeric) followed by /// Named (in alpha numeric) /// - /// common parameters. + /// 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 @@ namespace System.Management.Automation.Help /// /// 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(); @@ -353,9 +353,9 @@ namespace System.Management.Automation.Help /// Add the parameters properties (these parameters are used to create the parameters section) /// /// HelpInfo object. - /// parameters. - /// common parameters. - /// type name for help. + /// Parameters. + /// Common parameters. + /// Type name for help. internal static void AddParametersProperties(PSObject obj, Dictionary parameters, bool common, string typeNameForHelp) { PSObject paramsObject = new PSObject(); @@ -403,11 +403,11 @@ namespace System.Management.Automation.Help /// Adds the parameter properties /// /// HelpInfo object. - /// parameter name. - /// parameter aliases. - /// is dynamic parameter? - /// parameter type. - /// parameter attributes. + /// Parameter name. + /// Parameter aliases. + /// Is dynamic parameter? + /// 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) @@ -523,8 +523,8 @@ namespace System.Management.Automation.Help /// Adds the parameterType properties /// /// HelpInfo object. - /// the type of a parameter. - /// the attributes of the parameter (needed to look for PSTypeName). + /// 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(); @@ -542,8 +542,8 @@ namespace System.Management.Automation.Help /// Adds the parameterValue properties /// /// HelpInfo object. - /// the type of a parameter. - /// the attributes of the parameter (needed to look for PSTypeName). + /// 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; @@ -571,7 +571,7 @@ namespace System.Management.Automation.Help /// Adds the InputTypes properties /// /// HelpInfo object. - /// command parameters. + /// Command parameters. internal static void AddInputTypesProperties(PSObject obj, Dictionary parameters) { Collection inputs = new Collection(); @@ -634,7 +634,7 @@ namespace System.Management.Automation.Help /// Adds the OutputTypes properties /// /// HelpInfo object. - /// output types. + /// Output types. private static void AddOutputTypesProperties(PSObject obj, ReadOnlyCollection outputTypes) { PSObject returnValuesObj = new PSObject(); @@ -677,8 +677,8 @@ namespace System.Management.Automation.Help /// Adds the aliases properties /// /// HelpInfo object. - /// command name. - /// execution context. + /// Command name. + /// Execution context. private static void AddAliasesProperties(PSObject obj, string name, ExecutionContext context) { StringBuilder sb = new StringBuilder(); @@ -778,8 +778,8 @@ namespace System.Management.Automation.Help /// /// Gets the parameter attribute from parameter metadata /// - /// parameter attributes. - /// Parameter attributes. + /// Parameter attributes. + /// Collection of parameter attributes. private static Collection GetParameterAttribute(Collection attributes) { Collection paramAttributes = new Collection(); @@ -800,8 +800,8 @@ namespace System.Management.Automation.Help /// /// Gets the validate set attribute from parameter metadata /// - /// parameter attributes. - /// Parameter attributes. + /// Parameter attributes. + /// Collection of parameter attributes. private static Collection GetValidateSetAttribute(Collection attributes) { Collection validateSetAttributes = new Collection(); @@ -822,7 +822,7 @@ namespace System.Management.Automation.Help /// /// Gets the pipeline input type /// - /// parameter attribute. + /// Parameter attribute. /// Pipeline input type. private static string GetPipelineInputString(ParameterAttribute paramAttrib) { @@ -873,7 +873,7 @@ namespace System.Management.Automation.Help /// /// 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 ee594ea79..0c3605b70 100644 --- a/src/System.Management.Automation/help/DefaultHelpProvider.cs +++ b/src/System.Management.Automation/help/DefaultHelpProvider.cs @@ -51,7 +51,7 @@ namespace System.Management.Automation /// /// - /// 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 7eff54342..40ee584c2 100644 --- a/src/System.Management.Automation/help/DscResourceHelpProvider.cs +++ b/src/System.Management.Automation/help/DscResourceHelpProvider.cs @@ -227,7 +227,7 @@ namespace System.Management.Automation /// /// 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/HelpFileHelpInfo.cs b/src/System.Management.Automation/help/HelpFileHelpInfo.cs index 331eabfef..34cdfb36e 100644 --- a/src/System.Management.Automation/help/HelpFileHelpInfo.cs +++ b/src/System.Management.Automation/help/HelpFileHelpInfo.cs @@ -19,9 +19,9 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 4577392c7..a8b6ad04f 100644 --- a/src/System.Management.Automation/help/HelpFileHelpProvider.cs +++ b/src/System.Management.Automation/help/HelpFileHelpProvider.cs @@ -291,7 +291,7 @@ namespace System.Management.Automation /// /// 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 b3affdbdd..d921cb3ff 100644 --- a/src/System.Management.Automation/help/HelpInfo.cs +++ b/src/System.Management.Automation/help/HelpInfo.cs @@ -139,7 +139,7 @@ namespace System.Management.Automation /// /// 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 8e7a2a48c..8b6006721 100644 --- a/src/System.Management.Automation/help/HelpProvider.cs +++ b/src/System.Management.Automation/help/HelpProvider.cs @@ -139,14 +139,14 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 8dffd6f6f..03ec1776c 100644 --- a/src/System.Management.Automation/help/HelpProviderWithCache.cs +++ b/src/System.Management.Automation/help/HelpProviderWithCache.cs @@ -77,8 +77,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 d999d82a6..2b0bb66a4 100644 --- a/src/System.Management.Automation/help/HelpProviderWithFullCache.cs +++ b/src/System.Management.Automation/help/HelpProviderWithFullCache.cs @@ -27,7 +27,7 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// 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 8476f82af..b629f6207 100644 --- a/src/System.Management.Automation/help/HelpSystem.cs +++ b/src/System.Management.Automation/help/HelpSystem.cs @@ -154,7 +154,7 @@ namespace System.Management.Automation /// 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) { @@ -455,7 +455,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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/MamlClassHelpInfo.cs b/src/System.Management.Automation/help/MamlClassHelpInfo.cs index d9694a06f..3c30b5a0e 100644 --- a/src/System.Management.Automation/help/MamlClassHelpInfo.cs +++ b/src/System.Management.Automation/help/MamlClassHelpInfo.cs @@ -49,8 +49,8 @@ namespace System.Management.Automation /// /// 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 677a170b6..0602e04f3 100644 --- a/src/System.Management.Automation/help/MamlCommandHelpInfo.cs +++ b/src/System.Management.Automation/help/MamlCommandHelpInfo.cs @@ -251,8 +251,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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) { diff --git a/src/System.Management.Automation/help/MamlNode.cs b/src/System.Management.Automation/help/MamlNode.cs index 4656fd07e..47442e370 100644 --- a/src/System.Management.Automation/help/MamlNode.cs +++ b/src/System.Management.Automation/help/MamlNode.cs @@ -371,9 +371,9 @@ namespace System.Management.Automation /// "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 @@ namespace System.Management.Automation /// /// 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 815f52851..c25da7e36 100644 --- a/src/System.Management.Automation/help/PSClassHelpProvider.cs +++ b/src/System.Management.Automation/help/PSClassHelpProvider.cs @@ -232,7 +232,7 @@ namespace System.Management.Automation /// /// 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 1546abc63..760037c90 100644 --- a/src/System.Management.Automation/help/ProviderHelpInfo.cs +++ b/src/System.Management.Automation/help/ProviderHelpInfo.cs @@ -190,7 +190,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 fd78e17b4..d3a1896c7 100644 --- a/src/System.Management.Automation/help/ProviderHelpProvider.cs +++ b/src/System.Management.Automation/help/ProviderHelpProvider.cs @@ -63,7 +63,7 @@ namespace System.Management.Automation /// /// Do exact match help based on the target. /// - /// help request object. + /// Help request object. internal override IEnumerable ExactMatchHelp(HelpRequest helpRequest) { Collection matchingProviders = null; @@ -144,7 +144,7 @@ namespace System.Management.Automation /// /// This will load providerHelpInfo from help file into help cache. /// - /// providerInfo for which to locate help. + /// ProviderInfo for which to locate help. private void LoadHelpFile(ProviderInfo providerInfo) { if (providerInfo == null) @@ -257,7 +257,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 41129fa35..7b0aa2209 100644 --- a/src/System.Management.Automation/help/SaveHelpCommand.cs +++ b/src/System.Management.Automation/help/SaveHelpCommand.cs @@ -163,8 +163,8 @@ namespace Microsoft.PowerShell.Commands /// /// 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 590ca8e9e..d2fd95f4b 100644 --- a/src/System.Management.Automation/help/SyntaxHelpInfo.cs +++ b/src/System.Management.Automation/help/SyntaxHelpInfo.cs @@ -41,9 +41,9 @@ namespace System.Management.Automation /// /// 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 056be4643..e144077aa 100644 --- a/src/System.Management.Automation/help/UpdatableHelpCommandBase.cs +++ b/src/System.Management.Automation/help/UpdatableHelpCommandBase.cs @@ -140,8 +140,8 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// Class constructor /// - /// command type. + /// Command type. internal UpdatableHelpCommandBase(UpdatableHelpCommandType commandType) { _commandType = commandType; @@ -269,10 +269,10 @@ namespace Microsoft.PowerShell.Commands /// /// Gets a list of modules from the given pattern /// - /// execution context. - /// pattern to search. + /// Execution context. + /// Pattern to search. /// Module Specification. - /// do not generate errors for modules without HelpInfoUri. + /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// Processes a module with potential globbing /// - /// module name with globbing. + /// Module name with globbing. private void ProcessModuleWithGlobbing(string name) { if (String.IsNullOrEmpty(name)) @@ -492,7 +492,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// Gets a list of modules from the given pattern or ModuleSpecification /// - /// pattern to match. + /// Pattern to match. /// ModuleSpecification. - /// skip errors. + /// Skip errors. /// A list of modules. internal Dictionary, UpdatableHelpModuleInfo> GetModuleInfo(string pattern, ModuleSpecification fullyQualifiedName, bool noErrors) { @@ -634,10 +634,10 @@ namespace Microsoft.PowerShell.Commands /// Checks if it is necessary to update help /// /// ModuleInfo. - /// current HelpInfo.xml. - /// new HelpInfo.xml. - /// current culture. - /// force update. + /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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,8 +716,8 @@ namespace Microsoft.PowerShell.Commands /// /// Resolves a given path to a list of directories /// - /// path to resolve. - /// resolve recursively? + /// Path to resolve. + /// Resolve recursively? /// Treat the path / start path as a literal path?/// /// A list of directories. internal IEnumerable ResolvePath(string path, bool recurse, bool isLiteralPath) @@ -776,7 +776,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// Logs a command message /// - /// message to log. + /// Message to log. internal void LogMessage(string message) { List details = new List(); @@ -838,9 +838,9 @@ namespace Microsoft.PowerShell.Commands /// /// 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 a990ea2a7..b36f2cf3d 100644 --- a/src/System.Management.Automation/help/UpdatableHelpInfo.cs +++ b/src/System.Management.Automation/help/UpdatableHelpInfo.cs @@ -17,8 +17,8 @@ namespace System.Management.Automation.Help /// /// Class constructor /// - /// culture info. - /// version info. + /// Culture info. + /// Version info. internal CultureSpecificUpdatableHelp(CultureInfo culture, Version version) { Debug.Assert(version != null); @@ -47,8 +47,8 @@ namespace System.Management.Automation.Help /// /// 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); @@ -77,7 +77,7 @@ namespace System.Management.Automation.Help /// Checks if the other HelpInfo has a newer version /// /// HelpInfo object to check. - /// culture 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 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// 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 a6147c9d4..c70d0e015 100644 --- a/src/System.Management.Automation/help/UpdatableHelpModuleInfo.cs +++ b/src/System.Management.Automation/help/UpdatableHelpModuleInfo.cs @@ -21,9 +21,9 @@ namespace System.Management.Automation.Help /// /// Class constructor /// - /// module name. - /// module GUID. - /// module path. + /// Module name. + /// Module GUID. + /// Module path. /// HelpInfo URI. internal UpdatableHelpModuleInfo(string name, Guid guid, string path, string uri) { @@ -69,7 +69,7 @@ namespace System.Management.Automation.Help /// /// 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 de5466e28..b1cf5199b 100644 --- a/src/System.Management.Automation/help/UpdatableHelpSystem.cs +++ b/src/System.Management.Automation/help/UpdatableHelpSystem.cs @@ -35,10 +35,10 @@ namespace System.Management.Automation.Help /// Class constructor /// /// FullyQualifiedErrorId. - /// exception message. - /// category. - /// target object. - /// inner exception. + /// 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 @@ namespace System.Management.Automation.Help /// /// Class constructor /// - /// serialization info. - /// streaming context. + /// Serialization info. + /// Streaming context. protected UpdatableHelpSystemException(SerializationInfo serializationInfo, StreamingContext streamingContext) : base(serializationInfo, streamingContext) { @@ -83,7 +83,7 @@ namespace System.Management.Automation.Help /// /// Class constructor /// - /// exception to wrap. + /// Exception to wrap. internal UpdatableHelpExceptionContext(UpdatableHelpSystemException exception) { Exception = exception; @@ -109,7 +109,7 @@ namespace System.Management.Automation.Help /// /// Creates an error record from this context /// - /// command type. + /// Command type. /// Error record. internal ErrorRecord CreateErrorRecord(UpdatableHelpCommandType commandType) { @@ -177,9 +177,9 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// Gets the HelpInfo xml from the given URI /// - /// command type. + /// Command type. /// HelpInfo URI. - /// module name. - /// module GUID. - /// current UI culture. + /// 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 @@ namespace System.Management.Automation.Help /// /// 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) @@ -517,16 +517,16 @@ namespace System.Management.Automation.Help /// Creates a HelpInfo object /// /// XML text. - /// module name. - /// module GUID. - /// current UI cultures. - /// overrides the path contained within HelpInfo.xml. + /// 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 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// /// - /// 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 @@ namespace System.Management.Automation.Help /// /// 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,9 +1116,9 @@ namespace System.Management.Automation.Help /// /// Unzips to help content to a given location /// - /// execution context. - /// source path. - /// destination path. + /// 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) { @@ -1216,11 +1216,11 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// 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 @@ namespace System.Management.Automation.Help /// /// 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 dd4063f75..099fbdbde 100644 --- a/src/System.Management.Automation/help/UpdatableHelpUri.cs +++ b/src/System.Management.Automation/help/UpdatableHelpUri.cs @@ -14,10 +14,10 @@ namespace System.Management.Automation.Help /// /// Class constructor /// - /// module name. - /// module guid. + /// Module name. + /// Module guid. /// UI culture. - /// resolved URI. + /// 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 0e9f1da22..ac40dbdac 100644 --- a/src/System.Management.Automation/help/UpdateHelpCommand.cs +++ b/src/System.Management.Automation/help/UpdateHelpCommand.cs @@ -212,8 +212,8 @@ namespace Microsoft.PowerShell.Commands /// /// 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 f67c58c6e..4f74f2aa8 100644 --- a/src/System.Management.Automation/logging/LogProvider.cs +++ b/src/System.Management.Automation/logging/LogProvider.cs @@ -163,8 +163,8 @@ namespace System.Management.Automation /// /// Appends exception information. /// - /// string builder. - /// exception. + /// String builder. + /// Exception. protected static void AppendException(StringBuilder sb, Exception except) { sb.AppendLine(StringUtil.Format(EtwLoggingStrings.ErrorRecordMessage, except.Message)); @@ -192,8 +192,8 @@ namespace System.Management.Automation /// /// Appends additional information. /// - /// string builder. - /// additional information. + /// String builder. + /// Additional information. protected static void AppendAdditionalInfo(StringBuilder sb, Dictionary additionalInfo) { if (additionalInfo != null) @@ -208,7 +208,7 @@ namespace System.Management.Automation /// /// Gets PSLevel from severity. /// - /// error severity. + /// Error severity. /// PS log level. protected static PSLevel GetPSLevelFromSeverity(string severity) { @@ -233,7 +233,7 @@ namespace System.Management.Automation /// /// 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 c12ac7f58..26f031def 100644 --- a/src/System.Management.Automation/logging/MshLog.cs +++ b/src/System.Management.Automation/logging/MshLog.cs @@ -308,7 +308,7 @@ namespace System.Management.Automation /// /// This API is currently used only by runspace before engine start. /// - /// logContext to be. + /// LogContext to be. /// EventId for the event to be logged. /// Exception associated with this event. /// Additional information for this event. @@ -350,9 +350,9 @@ namespace System.Management.Automation /// 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) @@ -440,8 +440,8 @@ namespace System.Management.Automation /// 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. + /// New command state. + /// Invocation data for current command that is running. internal static void LogCommandLifecycleEvent(ExecutionContext executionContext, CommandState commandState, InvocationInfo invocationInfo) @@ -482,8 +482,8 @@ namespace System.Management.Automation /// the command failed security check. /// /// Execution Context for the current running engine. - /// new command state. - /// current command that is running. + /// New command state. + /// Current command that is running. internal static void LogCommandLifecycleEvent(ExecutionContext executionContext, CommandState commandState, string commandName) @@ -522,8 +522,8 @@ namespace System.Management.Automation /// 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. + /// 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) @@ -552,9 +552,9 @@ namespace System.Management.Automation /// 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. + /// 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, diff --git a/src/System.Management.Automation/namespaces/FileSystemProvider.cs b/src/System.Management.Automation/namespaces/FileSystemProvider.cs index 9e4775981..1135f89f4 100644 --- a/src/System.Management.Automation/namespaces/FileSystemProvider.cs +++ b/src/System.Management.Automation/namespaces/FileSystemProvider.cs @@ -1831,7 +1831,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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) { diff --git a/src/System.Management.Automation/namespaces/RegistryProvider.cs b/src/System.Management.Automation/namespaces/RegistryProvider.cs index ba47fd069..82c5231df 100644 --- a/src/System.Management.Automation/namespaces/RegistryProvider.cs +++ b/src/System.Management.Automation/namespaces/RegistryProvider.cs @@ -3102,7 +3102,7 @@ namespace Microsoft.PowerShell.Commands /// IT resets the a registry key value to its default /// /// Key whose value has to be reset. - /// name of the value to 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 @@ namespace Microsoft.PowerShell.Commands /// 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 @@ namespace Microsoft.PowerShell.Commands /// 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)) @@ -3881,7 +3881,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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) { @@ -3952,8 +3952,8 @@ namespace Microsoft.PowerShell.Commands /// /// 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 @@ namespace Microsoft.PowerShell.Commands /// /// 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 5f492391f..bc8ad649a 100644 --- a/src/System.Management.Automation/namespaces/Win32Native.cs +++ b/src/System.Management.Automation/namespaces/Win32Native.cs @@ -134,9 +134,9 @@ namespace Microsoft.PowerShell.Commands.Internal /// /// 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 a252a689f..55e3f2407 100644 --- a/src/System.Management.Automation/security/Authenticode.cs +++ b/src/System.Management.Automation/security/Authenticode.cs @@ -60,9 +60,9 @@ namespace System.Management.Automation /// /// Sign a file /// - /// option that controls what gets embedded in the signature blob. - /// name of file to sign. - /// signing cert. + /// 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. @@ -256,8 +256,8 @@ namespace System.Management.Automation /// /// 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 ef17b23b3..f343423e2 100644 --- a/src/System.Management.Automation/security/CatalogHelper.cs +++ b/src/System.Management.Automation/security/CatalogHelper.cs @@ -158,7 +158,7 @@ namespace System.Management.Automation /// Path of the output catalog file. /// Path of the catalog definition file. /// Version of catalog. - /// hash method used to generate hashes for the 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 @@ namespace System.Management.Automation /// /// Get file attribute (Relative path in our case) from catalog /// - /// 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. + /// 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. /// Void. internal static void ProcessFileToBeAddedInCatalogDefinitionFile(FileInfo fileToHash, DirectoryInfo dirInfo, ref HashSet relativePaths, ref string cdfHeaderContent, ref string cdfFilesContent, ref int catAttributeCount) { @@ -574,10 +574,10 @@ namespace System.Management.Automation /// /// Process file in path for its relative paths /// - /// 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. + /// 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. /// Void. internal static void ProcessCatalogFile(string relativePath, string fileHash, WildcardPattern[] excludedPatterns, ref Dictionary catalogHashes) { @@ -599,11 +599,11 @@ namespace System.Management.Automation /// /// Process file in path for its relative paths /// - /// file to hash. - /// directory information about file needed to calculate relative file path. + /// 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. + /// 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) { @@ -653,7 +653,7 @@ namespace System.Management.Automation /// 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. + /// Catalog file path it should be skipped when calculating the hashes. /// Used to calculate Hash. /// /// Dictionary mapping file relative paths to hashes.. diff --git a/src/System.Management.Automation/security/MshSignature.cs b/src/System.Management.Automation/security/MshSignature.cs index c14cfe697..324394e7f 100644 --- a/src/System.Management.Automation/security/MshSignature.cs +++ b/src/System.Management.Automation/security/MshSignature.cs @@ -190,10 +190,10 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 29fa14314..cf79d3c65 100644 --- a/src/System.Management.Automation/security/SecureStringHelper.cs +++ b/src/System.Management.Automation/security/SecureStringHelper.cs @@ -28,7 +28,7 @@ namespace Microsoft.PowerShell /// 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 @@ namespace Microsoft.PowerShell /// /// 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 @@ namespace Microsoft.PowerShell /// 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 @@ namespace Microsoft.PowerShell /// 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) { @@ -173,7 +173,7 @@ namespace Microsoft.PowerShell /// /// 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 @@ namespace Microsoft.PowerShell /// 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 @@ namespace Microsoft.PowerShell /// 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 @@ namespace Microsoft.PowerShell /// /// 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 @@ namespace Microsoft.PowerShell /// /// 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 32432a5b1..5b67696ba 100644 --- a/src/System.Management.Automation/security/SecuritySupport.cs +++ b/src/System.Management.Automation/security/SecuritySupport.cs @@ -580,7 +580,7 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// convert an int to a DWORD /// - /// signed int number. + /// Signed int number. /// DWORD. internal static DWORD GetDWORDFromInt(int n) { @@ -737,7 +737,7 @@ namespace System.Management.Automation.Internal /// /// convert a DWORD to int /// - /// number. + /// Number. /// Int. internal static int GetIntFromDWORD(DWORD n) { diff --git a/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs b/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs index 940ecb1d3..c5ec6db90 100644 --- a/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs +++ b/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs @@ -917,7 +917,7 @@ namespace System.Management.Automation /// /// 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/utils/CryptoUtils.cs b/src/System.Management.Automation/utils/CryptoUtils.cs index 3aedff823..d028da352 100644 --- a/src/System.Management.Automation/utils/CryptoUtils.cs +++ b/src/System.Management.Automation/utils/CryptoUtils.cs @@ -343,7 +343,7 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// /// Encrypt the specified byte array /// - /// data to encrypt. + /// Data to encrypt. /// Encrypted byte array. internal byte[] EncryptWithSessionKey(byte[] data) { @@ -673,7 +673,7 @@ namespace System.Management.Automation.Internal /// /// Decrypt the specified buffer /// - /// data to decrypt. + /// Data to decrypt. /// Decrypted buffer. internal byte[] DecryptWithSessionKey(byte[] data) { @@ -828,7 +828,7 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 b5af2fedc..6abb90d37 100644 --- a/src/System.Management.Automation/utils/ExecutionExceptions.cs +++ b/src/System.Management.Automation/utils/ExecutionExceptions.cs @@ -48,7 +48,7 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the CmdletInvocationException class /// - /// wrapped exception. + /// Wrapped exception. /// /// identity of cmdlet, null is unknown /// @@ -120,8 +120,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected CmdletInvocationException(SerializationInfo info, StreamingContext context) @@ -135,8 +135,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the CmdletProviderInvocationException class /// - /// wrapped exception. + /// Wrapped exception. /// /// identity of cmdlet, null is unknown /// @@ -228,8 +228,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected CmdletProviderInvocationException(SerializationInfo info, StreamingContext context) @@ -342,8 +342,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected PipelineStoppedException(SerializationInfo info, StreamingContext context) @@ -427,8 +427,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected PipelineClosedException(SerializationInfo info, StreamingContext context) @@ -513,8 +513,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected ActionPreferenceStopException(SerializationInfo info, StreamingContext context) @@ -535,8 +535,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 @@ namespace System.Management.Automation /// /// Serializer for /// - /// serialization information. - /// context. + /// Serialization information. + /// Context. public override void GetObjectData(SerializationInfo info, StreamingContext context) { if (info == null) @@ -796,8 +796,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected RedirectedException(SerializationInfo info, StreamingContext context) @@ -864,8 +864,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected ScriptCallDepthException(SerializationInfo info, StreamingContext context) @@ -875,8 +875,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected PipelineDepthException(SerializationInfo info, StreamingContext context) @@ -984,8 +984,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 130f62d60..3614c7762 100644 --- a/src/System.Management.Automation/utils/ExtensionMethods.cs +++ b/src/System.Management.Automation/utils/ExtensionMethods.cs @@ -78,7 +78,7 @@ namespace System.Management.Automation /// /// 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 c7966c0c1..16b22b1ce 100644 --- a/src/System.Management.Automation/utils/GraphicalHostReflectionWrapper.cs +++ b/src/System.Management.Automation/utils/GraphicalHostReflectionWrapper.cs @@ -46,8 +46,8 @@ namespace System.Management.Automation.Internal /// 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 @@ -62,9 +62,9 @@ namespace System.Management.Automation.Internal /// 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 @@ -143,7 +143,7 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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/IObjectWriter.cs b/src/System.Management.Automation/utils/IObjectWriter.cs index 71e5b91ee..d329fb6bc 100644 --- a/src/System.Management.Automation/utils/IObjectWriter.cs +++ b/src/System.Management.Automation/utils/IObjectWriter.cs @@ -101,7 +101,7 @@ namespace System.Management.Automation.Runspaces /// /// 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 3609f73e1..5e961c744 100644 --- a/src/System.Management.Automation/utils/MetadataExceptions.cs +++ b/src/System.Management.Automation/utils/MetadataExceptions.cs @@ -19,8 +19,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 2af015daa..5443c0cf2 100644 --- a/src/System.Management.Automation/utils/MshArgumentException.cs +++ b/src/System.Management.Automation/utils/MshArgumentException.cs @@ -67,8 +67,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected PSArgumentException(SerializationInfo info, StreamingContext context) @@ -81,8 +81,8 @@ namespace System.Management.Automation /// /// 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 216e80579..535bd6381 100644 --- a/src/System.Management.Automation/utils/MshArgumentNullException.cs +++ b/src/System.Management.Automation/utils/MshArgumentNullException.cs @@ -78,8 +78,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected PSArgumentNullException(SerializationInfo info, StreamingContext context) @@ -92,8 +92,8 @@ namespace System.Management.Automation /// /// 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 4e0f904a0..e809eea42 100644 --- a/src/System.Management.Automation/utils/MshArgumentOutOfRangeException.cs +++ b/src/System.Management.Automation/utils/MshArgumentOutOfRangeException.cs @@ -66,8 +66,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected PSArgumentOutOfRangeException(SerializationInfo info, StreamingContext context) @@ -79,8 +79,8 @@ namespace System.Management.Automation /// /// 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 09a355158..d8ec84d7c 100644 --- a/src/System.Management.Automation/utils/MshInvalidOperationException.cs +++ b/src/System.Management.Automation/utils/MshInvalidOperationException.cs @@ -37,8 +37,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected PSInvalidOperationException(SerializationInfo info, StreamingContext context) @@ -50,8 +50,8 @@ namespace System.Management.Automation /// /// 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 157ed74a4..631f6e17b 100644 --- a/src/System.Management.Automation/utils/MshNotImplementedException.cs +++ b/src/System.Management.Automation/utils/MshNotImplementedException.cs @@ -37,8 +37,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected PSNotImplementedException(SerializationInfo info, StreamingContext context) @@ -50,8 +50,8 @@ namespace System.Management.Automation /// /// 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 c03a670b7..592e4182e 100644 --- a/src/System.Management.Automation/utils/MshNotSupportedException.cs +++ b/src/System.Management.Automation/utils/MshNotSupportedException.cs @@ -37,8 +37,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected PSNotSupportedException(SerializationInfo info, StreamingContext context) @@ -50,8 +50,8 @@ namespace System.Management.Automation /// /// 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 c4e00987a..61d40c155 100644 --- a/src/System.Management.Automation/utils/MshObjectDisposedException.cs +++ b/src/System.Management.Automation/utils/MshObjectDisposedException.cs @@ -65,8 +65,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected PSObjectDisposedException(SerializationInfo info, StreamingContext context) @@ -78,8 +78,8 @@ namespace System.Management.Automation /// /// 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 8c12d239f..8dbbbbb6d 100644 --- a/src/System.Management.Automation/utils/ObjectReader.cs +++ b/src/System.Management.Automation/utils/ObjectReader.cs @@ -21,7 +21,7 @@ namespace System.Management.Automation.Internal /// /// Construct with an existing ObjectStream /// - /// the stream to read. + /// The stream to read. /// Thrown if the specified stream is null. public ObjectReaderBase([In, Out] ObjectStreamBase stream) { @@ -175,7 +175,7 @@ namespace System.Management.Automation.Internal /// Handle DataReady events from the underlying stream /// /// The stream raising the event. - /// standard event args. + /// Standard event args. private void OnDataReady(object sender, EventArgs args) { // call any event handlers on this, replacing the @@ -222,7 +222,7 @@ namespace System.Management.Automation.Internal /// /// release all resources /// - /// if true, release all managed resources. + /// If true, release all managed resources. protected abstract void Dispose(bool disposing); #endregion IDisposable @@ -240,7 +240,7 @@ namespace System.Management.Automation.Internal /// /// Construct with an existing ObjectStream /// - /// the stream to read. + /// The stream to read. /// Thrown if the specified stream is null. public ObjectReader([In, Out] ObjectStream stream) : base(stream) @@ -328,7 +328,7 @@ namespace System.Management.Automation.Internal /// /// release all resources /// - /// if true, release all managed resources. + /// If true, release all managed resources. protected override void Dispose(bool disposing) { if (disposing) @@ -350,7 +350,7 @@ namespace System.Management.Automation.Internal /// /// Construct with an existing ObjectStream /// - /// the stream to read. + /// The stream to read. /// Thrown if the specified stream is null. public PSObjectReader([In, Out] ObjectStream stream) : base(stream) @@ -438,7 +438,7 @@ namespace System.Management.Automation.Internal /// /// release all resources /// - /// if true, release all managed resources. + /// If true, release all managed resources. protected override void Dispose(bool disposing) { if (disposing) @@ -498,7 +498,7 @@ namespace System.Management.Automation.Internal /// /// Construct with an existing ObjectStream /// - /// the stream to read. + /// The stream to read. /// Thrown if the specified stream is null. public PSDataCollectionReader(PSDataCollectionStream stream) : base(stream) @@ -610,7 +610,7 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// Construct with an existing ObjectStream /// - /// the stream to read. + /// The stream to read. /// /// internal PSDataCollectionPipelineReader(PSDataCollectionStream stream, @@ -793,7 +793,7 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 eee7bc1a1..0ae69cb8f 100644 --- a/src/System.Management.Automation/utils/ObjectStream.cs +++ b/src/System.Management.Automation/utils/ObjectStream.cs @@ -273,7 +273,7 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// release all resources /// - /// if true, release all managed resources. + /// If true, release all managed resources. protected abstract void Dispose(bool disposing); #endregion IDisposable @@ -1303,7 +1303,7 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 @@ namespace System.Management.Automation.Internal /// /// 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 9b5403e7d..6c72b6283 100644 --- a/src/System.Management.Automation/utils/ObjectWriter.cs +++ b/src/System.Management.Automation/utils/ObjectWriter.cs @@ -19,7 +19,7 @@ namespace System.Management.Automation.Internal /// /// Construct with an existing ObjectStream /// - /// the stream to write. + /// The stream to write. /// Thrown if the specified stream is null. public ObjectWriter([In, Out] ObjectStreamBase stream) { @@ -150,7 +150,7 @@ namespace System.Management.Automation.Internal /// /// 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, @@ -178,7 +178,7 @@ namespace System.Management.Automation.Internal /// Handle WriteReady events from the underlying stream /// /// The stream raising the event. - /// standard event args. + /// Standard event args. private void OnWriteReady (object sender, EventArgs args) { if (WriteReady != null) @@ -220,7 +220,7 @@ namespace System.Management.Automation.Internal /// /// 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/PathUtils.cs b/src/System.Management.Automation/utils/PathUtils.cs index ca43043b3..2e12e70c6 100644 --- a/src/System.Management.Automation/utils/PathUtils.cs +++ b/src/System.Management.Automation/utils/PathUtils.cs @@ -20,10 +20,10 @@ namespace System.Management.Automation /// 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. /// /// /// @@ -54,10 +54,10 @@ namespace System.Management.Automation /// 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. /// /// /// diff --git a/src/System.Management.Automation/utils/PlatformInvokes.cs b/src/System.Management.Automation/utils/PlatformInvokes.cs index 88f061ff4..c2d4f3990 100644 --- a/src/System.Management.Automation/utils/PlatformInvokes.cs +++ b/src/System.Management.Automation/utils/PlatformInvokes.cs @@ -517,9 +517,9 @@ namespace System.Management.Automation /// 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/PsUtils.cs b/src/System.Management.Automation/utils/PsUtils.cs index 9de90f35a..6ea59062c 100644 --- a/src/System.Management.Automation/utils/PsUtils.cs +++ b/src/System.Management.Automation/utils/PsUtils.cs @@ -552,7 +552,7 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 6df08fe25..728b41dc1 100644 --- a/src/System.Management.Automation/utils/RuntimeException.cs +++ b/src/System.Management.Automation/utils/RuntimeException.cs @@ -39,8 +39,8 @@ namespace System.Management.Automation /// using data serialized via /// /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. /// Constructed object. protected RuntimeException(SerializationInfo info, StreamingContext context) @@ -53,8 +53,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// 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 b9859f322..3a286be89 100644 --- a/src/System.Management.Automation/utils/SessionStateExceptions.cs +++ b/src/System.Management.Automation/utils/SessionStateExceptions.cs @@ -396,8 +396,8 @@ namespace System.Management.Automation /// /// 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 @@ -463,8 +463,8 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// 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 @@ namespace System.Management.Automation /// /// Constructs a SessionStateUnauthorizedAccessException using serialized data. /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. protected SessionStateUnauthorizedAccessException( SerializationInfo info, StreamingContext context) @@ -736,8 +736,8 @@ namespace System.Management.Automation /// /// Constructs a ProviderNotFoundException using serialized data. /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. protected ProviderNotFoundException( SerializationInfo info, StreamingContext context) @@ -831,8 +831,8 @@ namespace System.Management.Automation /// /// Constructs a ProviderNameAmbiguousException using serialized data. /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. protected ProviderNameAmbiguousException( SerializationInfo info, StreamingContext context) @@ -931,8 +931,8 @@ namespace System.Management.Automation /// /// Constructs a DriveNotFoundException using serialized data. /// - /// serialization information. - /// streaming context. + /// Serialization information. + /// Streaming context. protected DriveNotFoundException( SerializationInfo info, StreamingContext context) @@ -1015,8 +1015,8 @@ namespace System.Management.Automation /// /// 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/assert.cs b/src/System.Management.Automation/utils/assert.cs index 627db136e..a6d57e86e 100644 --- a/src/System.Management.Automation/utils/assert.cs +++ b/src/System.Management.Automation/utils/assert.cs @@ -23,7 +23,7 @@ namespace System.Management.Automation /// /// 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 9ca169ffd..94e1b35da 100644 --- a/src/System.Management.Automation/utils/tracing/EtwActivity.cs +++ b/src/System.Management.Automation/utils/tracing/EtwActivity.cs @@ -465,7 +465,7 @@ namespace System.Management.Automation.Tracing /// All derived classes must use this method to write to the provider log. /// /// EventDescriptor. - /// payload. + /// 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 71936df99..178855c94 100755 --- a/src/System.Management.Automation/utils/tracing/PSEtwLogProvider.cs +++ b/src/System.Management.Automation/utils/tracing/PSEtwLogProvider.cs @@ -244,11 +244,11 @@ namespace System.Management.Automation.Tracing /// /// 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 babff5c83..be6740ae2 100755 --- a/src/System.Management.Automation/utils/tracing/PSSysLogProvider.cs +++ b/src/System.Management.Automation/utils/tracing/PSSysLogProvider.cs @@ -284,11 +284,11 @@ namespace System.Management.Automation.Tracing /// /// 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) { @@ -324,7 +324,7 @@ namespace System.Management.Automation.Tracing /// /// Sets the activity id for the current thread. /// - /// the GUID identifying the activity. + /// The GUID identifying the activity. internal void SetActivityIdForCurrentThread(Guid newActivityId) { s_provider.SetActivity(newActivityId);