diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs index a12ec7c90..572d75820 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs @@ -191,7 +191,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// next action to execute - /// true indicates there is an valid action, otherwise false + /// True indicates there is an valid action, otherwise false. protected bool GetActionAndRemove(out CimBaseAction action) { return this.actionQueue.TryDequeue(out action); @@ -225,7 +225,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Are there active operations? /// /// - /// true for having active operations, otherwise false. + /// True for having active operations, otherwise false. protected bool IsActive() { DebugHelper.WriteLogEx("Disposed {0}, Operation Count {1}", 2, this.Disposed, this.operationCount); diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs index 0f0d21d63..35b3e600f 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs @@ -82,7 +82,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Block current thread until action completed /// /// - /// Response from user + /// Response from user. public virtual CimResponseType GetResponse() { this.Block(); diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs index deecc99f9..582732402 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs @@ -296,7 +296,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Generates an unique session id. /// /// - /// Unique session id under current runspace + /// Unique session id under current runspace. internal UInt32 GenerateSessionId() { return this.sessionNameCounter++; @@ -561,7 +561,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Query session list by given id array /// /// - /// List of session wrapper objects + /// List of session wrapper objects. internal IEnumerable QuerySession(IEnumerable ids, out IEnumerable errorRecords) { @@ -593,7 +593,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Query session list by given instance id array /// /// - /// List of session wrapper objects + /// List of session wrapper objects. internal IEnumerable QuerySession(IEnumerable instanceIds, out IEnumerable errorRecords) { @@ -625,7 +625,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Query session list by given name array /// /// - /// List of session wrapper objects + /// List of session wrapper objects. internal IEnumerable QuerySession(IEnumerable nameArray, out IEnumerable errorRecords) { @@ -667,7 +667,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Query session list by given computer name array /// /// - /// List of session wrapper objects + /// List of session wrapper objects. internal IEnumerable QuerySessionByComputerName( IEnumerable computernameArray, out IEnumerable errorRecords) @@ -706,7 +706,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Query session list by given session objects array /// /// - /// List of session wrapper objects + /// List of session wrapper objects. internal IEnumerable QuerySession(IEnumerable cimsessions, out IEnumerable errorRecords) { @@ -738,7 +738,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Query session wrapper object /// /// - /// session wrapper + /// Session wrapper. internal CimSessionWrapper QuerySession(CimSession cimsession) { CimSessionWrapper wrapper; @@ -750,7 +750,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Query session object with given CimSessionInstanceID /// /// - /// CimSession object + /// CimSession object. internal CimSession QuerySession(Guid cimSessionInstanceId) { if (this.curCimSessionsByInstanceId.ContainsKey(cimSessionInstanceId)) diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs index e19dd4d77..7805833bc 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs @@ -129,7 +129,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Performs pre processing of given result object. /// /// - /// Pre-processed object + /// Pre-processed object. object Process(object resultObject); } #endregion diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimSessionCommand.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimSessionCommand.cs index eb8935b2b..b724650d9 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimSessionCommand.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/NewCimSessionCommand.cs @@ -244,7 +244,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// Build a CimSessionOptions, used to create CimSession /// - /// Null means no prefer CimSessionOptions + /// Null means no prefer CimSessionOptions. internal void BuildSessionOptions(out CimSessionOptions outputOptions, out CimCredential outputCredential) { DebugHelper.WriteLogEx(); diff --git a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/SessionBasedWrapper.cs b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/SessionBasedWrapper.cs index 61cab210a..6916508b0 100644 --- a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/SessionBasedWrapper.cs +++ b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/SessionBasedWrapper.cs @@ -288,7 +288,7 @@ namespace Microsoft.PowerShell.Cmdletization /// /// Returns default sessions to use when the user doesn't specify the -Session cmdlet parameter. /// - /// Default sessions to use when the user doesn't specify the -Session cmdlet parameter + /// Default sessions to use when the user doesn't specify the -Session cmdlet parameter. protected abstract TSession DefaultSession { get; } /// @@ -373,7 +373,7 @@ namespace Microsoft.PowerShell.Cmdletization /// Queries for object instances in the object model. /// /// Query parameters - /// A lazy evaluated collection of object instances + /// A lazy evaluated collection of object instances. public override void ProcessRecord(QueryBuilder query) { _parentJob.DisableFlowControlForPendingCmdletActionsQueue(); 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 989cbcabe..8b6feaaa5 100644 --- a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimQuery.cs +++ b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimQuery.cs @@ -369,7 +369,7 @@ namespace Microsoft.PowerShell.Cmdletization.Cim /// /// Returns a string that represents the current CIM query /// - /// A string that represents the current CIM query + /// A string that represents the current CIM query. public override string ToString() { return _wqlCondition.ToString(); diff --git a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimWrapper.cs b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimWrapper.cs index 46bd4f016..d4100c5d3 100644 --- a/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimWrapper.cs +++ b/src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimWrapper.cs @@ -82,7 +82,7 @@ namespace Microsoft.PowerShell.Cmdletization.Cim /// /// Creates a query builder for CIM OM /// - /// Query builder for CIM OM + /// Query builder for CIM OM. public override QueryBuilder GetQueryBuilder() { return new CimQuery(); @@ -136,7 +136,7 @@ namespace Microsoft.PowerShell.Cmdletization.Cim /// /// Returns a new job name to use for the parent job that handles throttling of the child jobs that actually perform querying and method invocation. /// - /// Job name + /// Job name. protected override string GenerateParentJobName() { return "CimJob" + Interlocked.Increment(ref CimCmdletAdapter.s_jobNumber).ToString(CultureInfo.InvariantCulture); @@ -145,7 +145,7 @@ namespace Microsoft.PowerShell.Cmdletization.Cim /// /// Returns default sessions to use when the user doesn't specify the -Session cmdlet parameter. /// - /// Default sessions to use when the user doesn't specify the -Session cmdlet parameter + /// Default sessions to use when the user doesn't specify the -Session cmdlet parameter. protected override CimSession DefaultSession { get @@ -167,7 +167,7 @@ namespace Microsoft.PowerShell.Cmdletization.Cim /// /// Remote session to query /// Query parameters - /// object that performs a query against the wrapped object model + /// object that performs a query against the wrapped object model. internal override StartableJob CreateQueryJob(CimSession session, QueryBuilder baseQuery) { CimQuery query = baseQuery as CimQuery; diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs index 80cdb8fa1..08be29140 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Computer.cs @@ -2075,7 +2075,7 @@ $result /// Error message format string that takes two parameters /// Fully qualified error Id /// Cancel token - /// True on success + /// True on success. internal static bool InvokeWin32ShutdownUsingWsman( PSCmdlet cmdlet, bool isLocalhost, @@ -2192,7 +2192,7 @@ $result /// /// /// - /// Valid computer name + /// Valid computer name. internal static string ValidateComputerName( string nameToCheck, string shortLocalMachineName, diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs index fe655c18c..d4b486d2d 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs @@ -5135,7 +5135,7 @@ namespace Microsoft.PowerShell.Commands /// Import WINAPI function PowerDeterminePlatformRoleEx /// /// The version of the POWER_PLATFORM_ROLE enumeration for the platform - /// POWER_PLATFORM_ROLE enumeration + /// POWER_PLATFORM_ROLE enumeration. [DllImport(PInvokeDllNames.PowerDeterminePlatformRoleExDllName, EntryPoint = "PowerDeterminePlatformRoleEx", CharSet = CharSet.Ansi)] public static extern uint PowerDeterminePlatformRoleEx(uint version); diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs index 8fdd8146a..ced36b437 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs @@ -1305,7 +1305,7 @@ namespace Microsoft.PowerShell.Commands /// Gets the owner of the process. /// /// - /// returns the owner + /// Returns the owner. private bool IsProcessOwnedByCurrentUser(Process process) { const uint TOKEN_QUERY = 0x0008; @@ -1388,7 +1388,7 @@ namespace Microsoft.PowerShell.Commands /// /// Stops the given process throws non terminating error if can't. /// process to be stopped - /// true if process stopped successfully else false + /// True if process stopped successfully else false. /// private void StopProcess(Process process) { @@ -2909,7 +2909,7 @@ namespace Microsoft.PowerShell.Commands /// /// Unimplemented standard constructor. /// - /// doesn't return + /// Doesn't return. public ProcessCommandException() : base() { throw new NotImplementedException(); @@ -2919,7 +2919,7 @@ namespace Microsoft.PowerShell.Commands /// Standard constructor. /// /// - /// constructed object + /// Constructed object. public ProcessCommandException(string message) : base(message) { } @@ -2941,7 +2941,7 @@ namespace Microsoft.PowerShell.Commands /// /// /// - /// constructed object + /// Constructed object. protected ProcessCommandException( SerializationInfo info, StreamingContext context) diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs index 871c9564f..aa3f2db5f 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs @@ -32,7 +32,7 @@ namespace Microsoft.PowerShell.Commands /// Confirm that the operation should proceed /// /// service object to be acted on - /// true if operation should continue, false otherwise + /// True if operation should continue, false otherwise. protected bool ShouldProcessServiceOperation(ServiceController service) { return ShouldProcessServiceOperation( @@ -45,7 +45,7 @@ namespace Microsoft.PowerShell.Commands /// /// display name of service to be acted on /// service name of service to be acted on - /// true if operation should continue, false otherwise + /// True if operation should continue, false otherwise. protected bool ShouldProcessServiceOperation( string displayName, string serviceName) { @@ -619,7 +619,7 @@ namespace Microsoft.PowerShell.Commands /// Adds UserName, Description, BinaryPathName, DelayedAutoStart and StartupType to a ServiceController object. /// /// - /// ServiceController as PSObject with UserName, Description and StartupType added + /// ServiceController as PSObject with UserName, Description and StartupType added. private PSObject AddProperties(ServiceController service) { NakedWin32Handle hScManager = IntPtr.Zero; @@ -809,7 +809,7 @@ namespace Microsoft.PowerShell.Commands /// /// errorMessage for a nonterminating error if operation fails /// - /// true if action succeeded + /// True if action succeeded. /// /// WriteWarning will throw this if the pipeline has been stopped. /// This means that the delay between hitting CTRL-C and stopping @@ -864,7 +864,7 @@ namespace Microsoft.PowerShell.Commands /// This will start the service. /// /// service to start - /// true iff the service was started + /// True iff the service was started. internal bool DoStartService(ServiceController serviceController) { Exception exception = null; @@ -921,7 +921,7 @@ namespace Microsoft.PowerShell.Commands /// service to stop /// stop dependent services /// - /// true iff the service was stopped + /// True iff the service was stopped. internal List DoStopService(ServiceController serviceController, bool force, bool waitForServiceToStop) { // Ignore ServiceController.CanStop. CanStop will be set false @@ -1085,7 +1085,7 @@ namespace Microsoft.PowerShell.Commands /// This will pause the service. /// /// service to pause - /// true iff the service was paused + /// True iff the service was paused. internal bool DoPauseService(ServiceController serviceController) { Exception exception = null; @@ -1166,7 +1166,7 @@ namespace Microsoft.PowerShell.Commands /// This will resume the service. /// /// service to resume - /// true iff the service was resumed + /// True iff the service was resumed. internal bool DoResumeService(ServiceController serviceController) { Exception exception = null; @@ -2467,7 +2467,7 @@ namespace Microsoft.PowerShell.Commands /// /// unimplemented standard constructor /// - /// doesn't return + /// Doesn't return. public ServiceCommandException() : base() { @@ -2478,7 +2478,7 @@ namespace Microsoft.PowerShell.Commands /// standard constructor /// /// - /// constructed object + /// Constructed object. public ServiceCommandException(string message) : base(message) { @@ -2501,7 +2501,7 @@ namespace Microsoft.PowerShell.Commands /// /// /// - /// constructed object + /// Constructed object. protected ServiceCommandException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/SetClipboardCommand.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/SetClipboardCommand.cs index a158ac69b..2852f255a 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/SetClipboardCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/SetClipboardCommand.cs @@ -309,7 +309,7 @@ namespace Microsoft.PowerShell.Commands /// Generate HTML fragment data string with header that is required for the clipboard. /// /// the html to generate for - /// the resulted string + /// The resulted string. private static string GetHtmlDataString(string html) { // The string contains index references to other spots in the string, so we need placeholders so we can compute the offsets. @@ -409,7 +409,7 @@ EndSelection:<<<<<<<<4"; /// 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 + /// The number of bytes required to encode the string in UTF-8. private static int GetByteCount(StringBuilder sb, int start = 0, int end = -1) { char[] _byteCount = new char[1]; diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/WebServiceProxy.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/WebServiceProxy.cs index 602b41c07..1fc8ea3c5 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/WebServiceProxy.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/WebServiceProxy.cs @@ -276,7 +276,7 @@ namespace Microsoft.PowerShell.Commands /// /// Generates a random name /// - /// string + /// String. private string GenerateRandomName() { string rndname = null; diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/WriteContentCommandBase.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/WriteContentCommandBase.cs index 41e3dd703..315e60841 100644 --- a/src/Microsoft.PowerShell.Commands.Management/commands/management/WriteContentCommandBase.cs +++ b/src/Microsoft.PowerShell.Commands.Management/commands/management/WriteContentCommandBase.cs @@ -327,7 +327,7 @@ namespace Microsoft.PowerShell.Commands /// /// The list of unfiltered paths /// The current context - /// The list of paths accepted by the user + /// The list of paths accepted by the user. private string[] GetAcceptedPaths(string[] unfilteredPaths, CmdletProviderContext currentContext) { Collection pathInfos = ResolvePaths(unfilteredPaths, true, false, currentContext); diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CSVCommands.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CSVCommands.cs index 77f9c7d30..3a550e0ec 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CSVCommands.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CSVCommands.cs @@ -1365,7 +1365,7 @@ namespace Microsoft.PowerShell.Commands /// /// Read the type information, if present. /// - /// Type string if present else null + /// Type string if present else null. private string ReadTypeInformation() { diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CustomSerialization.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CustomSerialization.cs index ea0a69afa..b5dba74b1 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CustomSerialization.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/CustomSerialization.cs @@ -997,7 +997,7 @@ namespace System.Management.Automation /// and returns true if this object should be serialized as string. /// /// PSObject to be serialized. - /// true if the object needs to be serialized as a string. + /// True if the object needs to be serialized as a string. private static bool SerializeAsString(PSObject source) { return source.GetSerializationMethod(null) == SerializationMethod.String; diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/EnableDisableRunspaceDebugCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/EnableDisableRunspaceDebugCommand.cs index 0d54331da..b3c644a87 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/EnableDisableRunspaceDebugCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/EnableDisableRunspaceDebugCommand.cs @@ -213,7 +213,7 @@ namespace Microsoft.PowerShell.Commands /// /// Returns a list of valid runspaces based on current parameter set. /// - /// IReadOnlyList + /// IReadOnlyList. protected IReadOnlyList GetRunspaces() { IReadOnlyList results = null; @@ -251,7 +251,7 @@ namespace Microsoft.PowerShell.Commands /// Returns Runspace Debugger. /// /// Runspace - /// Debugger + /// Debugger. protected System.Management.Automation.Debugger GetDebuggerFromRunspace(Runspace runspace) { System.Management.Automation.Debugger debugger = null; 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 9e36c5ee5..7efa87267 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 @@ -45,7 +45,7 @@ namespace Microsoft.PowerShell.Commands /// Auxiliar used in GetValue methods since the list does not deal well with unlimited sized lines. /// /// source string - /// the source string limited in the number of lines + /// The source string limited in the number of lines. internal static object LimitString(object src) { string srcString = src as string; diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetRandomCommand.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetRandomCommand.cs index 7e40757dd..d54110f26 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetRandomCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetRandomCommand.cs @@ -572,7 +572,7 @@ namespace Microsoft.PowerShell.Commands /// /// Generates a random floating-point number that is greater than or equal to 0.0, and less than 1.0. /// - /// A random floating-point number that is greater than or equal to 0.0, and less than 1.0 + /// A random floating-point number that is greater than or equal to 0.0, and less than 1.0. internal double NextDouble() { // According to the CLR source: @@ -666,7 +666,7 @@ namespace Microsoft.PowerShell.Commands /// /// Samples a random integer. /// - /// A random integer, using the full range of Int32 + /// A random integer, using the full range of Int32. private int InternalSample() { int result; diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs index 82b77a0a4..d57562859 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs @@ -1103,7 +1103,7 @@ namespace Microsoft.PowerShell.Commands /// (i.e. it can't be used for code injection attacks). /// /// name to validate - /// true if the name is safe; false otherwise + /// true if the name is safe; false otherwise. private static bool IsSafeNameOrIdentifier(string name) { // '.' is needed for stuff like net.exe @@ -1121,7 +1121,7 @@ namespace Microsoft.PowerShell.Commands /// (i.e. it can't be used for code injection attacks). /// /// parameter name to validate - /// true if the name is safe; false otherwise + /// true if the name is safe; false otherwise. private static bool IsSafeParameterName(string parameterName) { return IsSafeNameOrIdentifier(parameterName) && !parameterName.Contains(":"); @@ -1132,7 +1132,7 @@ namespace Microsoft.PowerShell.Commands /// (i.e. it doesn't introduce any side effects on the client). /// /// type to validate - /// true if the type is safe; false otherwise + /// true if the type is safe; false otherwise. private static bool IsSafeTypeConstraint(Type type) { if (type == null) @@ -1175,7 +1175,7 @@ namespace Microsoft.PowerShell.Commands /// Writes error messages if necessary. Modifies command metadata to make it safe if necessary. /// /// command metadata to verify - /// true if the command metadata is safe; false otherwise + /// true if the command metadata is safe; false otherwise. private bool IsSafeCommandMetadata(CommandMetadata commandMetadata) { if (!IsCommandNameMatchingParameters(commandMetadata.Name)) @@ -1395,7 +1395,7 @@ namespace Microsoft.PowerShell.Commands /// Dictionary where rehydrated CommandMetadata are going to be stored /// Dictionary mapping alias names to resolved command names /// Remote (deserialized) CommandInfo object - /// CommandMetadata equivalents + /// CommandMetadata equivalents. private void AddRemoteCommandMetadata( Dictionary name2commandMetadata, Dictionary alias2resolvedCommandName, @@ -1592,7 +1592,7 @@ namespace Microsoft.PowerShell.Commands /// /// Gets CommandMetadata objects from remote runspace. /// - /// (rehydrated) CommandMetadata objects + /// (rehydrated) CommandMetadata objects. internal List GetRemoteFormatData() { if ((this.FormatTypeName == null) || (this.FormatTypeName.Length == 0) || @@ -1695,7 +1695,7 @@ namespace Microsoft.PowerShell.Commands /// /// Gets CommandMetadata objects from remote runspace. /// - /// (rehydrated) CommandMetadata objects + /// (rehydrated) CommandMetadata objects. internal List GetRemoteCommandMetadata(out Dictionary alias2resolvedCommandName) { bool isReleaseCandidateBackcompatibilityMode = @@ -1866,7 +1866,7 @@ namespace Microsoft.PowerShell.Commands /// 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 + /// Paths to generated files. internal List GenerateProxyModule( DirectoryInfo moduleRootDirectory, String moduleNamePrefix, @@ -1941,7 +1941,7 @@ namespace Microsoft.PowerShell.Commands /// /// Gets a connection URI associated with the remote runspace. /// - /// Connection URI associated with the remote runspace + /// Connection URI associated with the remote runspace. private string GetConnectionString() { WSManConnectionInfo connectionInfo = _remoteRunspaceInfo.Runspace.ConnectionInfo as WSManConnectionInfo; @@ -3020,7 +3020,7 @@ function Get-PSImplicitRemotingClientSideParameters /// 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 + /// Path to the created files. internal List GenerateProxyModule( DirectoryInfo moduleRootDirectory, String fileNamePrefix, diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs index c6ffc9535..39b034f24 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs @@ -1510,7 +1510,7 @@ namespace Microsoft.PowerShell.Commands /// The result of converting operand to a string. /// The input object in filter mode. /// The match info object - this will be null if this.quiet is set. - /// true if the input object matched. + /// True if the input object matched. private bool DoMatchWorker(string operandString, MatchInfo matchInfo, out MatchInfo matchResult) { bool gotMatch = false; 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 09d97dd7f..4024dc4dd 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Measure-Object.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Measure-Object.cs @@ -652,7 +652,7 @@ namespace Microsoft.PowerShell.Commands /// /// string whose chars are counted /// true to discount white space - /// number of chars in inStr + /// Number of chars in inStr. internal static int CountChar(string inStr, bool ignoreWhiteSpace) { if (String.IsNullOrEmpty(inStr)) @@ -681,7 +681,7 @@ namespace Microsoft.PowerShell.Commands /// Count words in inStr. /// /// string whose words are counted - /// number of words in inStr + /// Number of words in inStr. internal static int CountWord(string inStr) { if (String.IsNullOrEmpty(inStr)) @@ -715,7 +715,7 @@ namespace Microsoft.PowerShell.Commands /// Count lines in inStr. /// /// string whose lines are counted - /// number of lines in inStr + /// Number of lines in inStr. internal static int CountLine(string inStr) { if (String.IsNullOrEmpty(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 56f2d7c3e..a6b2cff16 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ShowCommand/ShowCommand.cs @@ -366,7 +366,7 @@ namespace Microsoft.PowerShell.Commands /// /// ProcessRecord when a command name is specified. /// - /// true if there was no exception processing this record + /// True if there was no exception processing this record. private bool CanProcessRecordForOneCommand() { CommandInfo commandInfo; @@ -390,7 +390,7 @@ namespace Microsoft.PowerShell.Commands /// /// ProcessRecord when a command name is not specified. /// - /// true if there was no exception processing this record + /// True if there was no exception processing this record. private bool CanProcessRecordForAllCommands() { Collection rawCommands = this.InvokeCommand.InvokeScript(_showCommandProxy.GetShowAllModulesCommand()); @@ -505,7 +505,7 @@ namespace Microsoft.PowerShell.Commands /// /// 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 + /// True if it was successful in adding all characters to console input buffer. internal static bool AddToConsoleInputBuffer(string str, bool newLine) { IntPtr handle = ConsoleInputWithNativeMethods.GetStdHandle(ConsoleInputWithNativeMethods.STD_INPUT_HANDLE); @@ -556,7 +556,7 @@ namespace Microsoft.PowerShell.Commands /// Gets the console handle. /// /// which console handle to get - /// the console handle + /// The console handle. [DllImport("kernel32.dll", SetLastError = true)] internal static extern IntPtr GetStdHandle(int nStdHandle); @@ -567,7 +567,7 @@ namespace Microsoft.PowerShell.Commands /// inputs to be written /// number of inputs to be written /// returned number of inputs actually written - /// 0 if the function fails + /// 0 if the function fails. [DllImport("kernel32.dll", SetLastError = true)] [return: MarshalAs(UnmanagedType.Bool)] internal static extern bool WriteConsoleInput( diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Update-TypeData.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Update-TypeData.cs index 4d013301a..b97d4fd8e 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Update-TypeData.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Update-TypeData.cs @@ -626,7 +626,7 @@ namespace Microsoft.PowerShell.Commands /// Check if the TypeData instance contains no members. /// /// - /// false if empty, true if not + /// False if empty, true if not. private bool EnsureTypeDataIsNotEmpty(TypeData typeData) { if (typeData.Members.Count == 0 && typeData.StandardMembers.Count == 0 diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs index d80be3416..91986a9e8 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs @@ -1635,7 +1635,7 @@ namespace Microsoft.PowerShell.Commands /// /// The WebRequest who's content is to be set /// A byte array containing the content data. - /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property + /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property. /// /// Because this function sets the request's ContentLength property and writes content data into the requests's stream, /// it should be called one time maximum on a given request. @@ -1658,7 +1658,7 @@ namespace Microsoft.PowerShell.Commands /// /// The WebRequest who's content is to be set /// A String object containing the content data. - /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property + /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property. /// /// Because this function sets the request's ContentLength property and writes content data into the requests's stream, /// it should be called one time maximum on a given request. @@ -1744,7 +1744,7 @@ namespace Microsoft.PowerShell.Commands /// /// The WebRequest who's content is to be set /// A Stream object containing the content data. - /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property + /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property. /// /// Because this function sets the request's ContentLength property and writes content data into the requests's stream, /// it should be called one time maximum on a given request. @@ -1767,7 +1767,7 @@ namespace Microsoft.PowerShell.Commands /// /// The WebRequest who's content is to be set /// A MultipartFormDataContent object containing multipart/form-data content. - /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property + /// The number of bytes written to the requests RequestStream (and the new value of the request's ContentLength property. /// /// Because this function sets the request's ContentLength property and writes content data into the requests's stream, /// it should be called one time maximum on a given request. 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 cf2fab65d..a8dca7cee 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs @@ -165,7 +165,7 @@ namespace Microsoft.PowerShell.Commands /// /// The object to be processed /// The current depth into the object graph - /// An object suitable for serializing to JSON + /// An object suitable for serializing to JSON. private object ProcessValue(object obj, int depth) { if (Stopping) 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 2cd62fdc4..3a2811cb4 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/select-object.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/select-object.cs @@ -39,7 +39,7 @@ namespace Microsoft.PowerShell.Commands /// The first match shortcircuits the search. /// /// PSPropertyExpression to test against - /// true if there is a match, else false + /// True if there is a match, else false. internal bool IsMatch(PSPropertyExpression expression) { for (int k = 0; k < _wildcardPatterns.Length; k++) 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 931550792..ff5efc1b8 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/trace/TraceExpressionCommand.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/trace/TraceExpressionCommand.cs @@ -470,7 +470,7 @@ namespace Microsoft.PowerShell.Commands /// written separately. Otherwise, /// will be written as a single object. /// - /// The number of objects written + /// The number of objects written. /// /// The underlying stream is closed. /// diff --git a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs index b2ec27cc6..e23c53b40 100644 --- a/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs +++ b/src/Microsoft.PowerShell.Commands.Utility/commands/utility/write.cs @@ -436,7 +436,7 @@ namespace Microsoft.PowerShell.Commands /// /// Constructor for class WriteErrorException. /// - /// constructed object + /// Constructed object. public WriteErrorException() : base(StringUtil.Format(WriteErrorStrings.WriteErrorException)) { @@ -446,7 +446,7 @@ namespace Microsoft.PowerShell.Commands /// Constructor for class WriteErrorException. /// /// - /// constructed object + /// Constructed object. public WriteErrorException(string message) : base(message) { @@ -457,7 +457,7 @@ namespace Microsoft.PowerShell.Commands /// /// /// - /// constructed object + /// Constructed object. public WriteErrorException(string message, Exception innerException) : base(message, innerException) @@ -471,7 +471,7 @@ namespace Microsoft.PowerShell.Commands /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected WriteErrorException(SerializationInfo info, StreamingContext context) : base(info, context) diff --git a/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs b/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs index c02603f10..1a56a5e83 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropertyKey.cs @@ -87,7 +87,7 @@ namespace Microsoft.PowerShell /// /// First property key to compare. /// Second property key to compare. - /// true if object a equals object b. false otherwise. + /// True if object a equals object b. false otherwise. public static bool operator ==(PropertyKey propKey1, PropertyKey propKey2) { return propKey1.Equals(propKey2); @@ -98,7 +98,7 @@ namespace Microsoft.PowerShell /// /// First property key to compare /// Second property key to compare. - /// true if object a does not equal object b. false otherwise. + /// True if object a does not equal object b. false otherwise. public static bool operator !=(PropertyKey propKey1, PropertyKey propKey2) { return !propKey1.Equals(propKey2); @@ -107,7 +107,7 @@ namespace Microsoft.PowerShell /// /// Override ToString() to provide a user friendly string representation /// - /// String representing the property key + /// String representing the property key. public override string ToString() { return string.Format(System.Globalization.CultureInfo.InvariantCulture, diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs index 8787639ed..c8702a689 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs @@ -447,7 +447,7 @@ namespace Microsoft.PowerShell /// /// The window to show... /// The command to do - /// true it it was successful + /// True it it was successful. [DllImport("user32.dll")] internal static extern bool ShowWindow(IntPtr hWnd, Int32 nCmdShow); diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs index 6cbefb9a3..0b3f8d30a 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfacePrompt.cs @@ -340,7 +340,7 @@ namespace Microsoft.PowerShell /// 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 + /// 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) { @@ -403,7 +403,7 @@ namespace Microsoft.PowerShell /// 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 + /// An object of type fieldType that inputString represents. private PromptCommonInputErrors PromptTryConvertTo(Type fieldType, bool isFromRemoteHost, string inputString, out object convertedObj) { Dbg.Assert(fieldType != null, "fieldType should never be null when PromptTryConvertTo is called"); diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfaceSecurity.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfaceSecurity.cs index aee9db4a1..8250eca7c 100644 --- a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfaceSecurity.cs +++ b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterfaceSecurity.cs @@ -27,7 +27,7 @@ namespace Microsoft.PowerShell /// name of the target for which creds are being collected /// message to be displayed. /// caption for the message. - /// PSCredential object + /// PSCredential object. public override PSCredential PromptForCredential( string caption, @@ -52,7 +52,7 @@ namespace Microsoft.PowerShell /// 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) + /// PSCredential object, or null if input was cancelled (or if reading from stdin and stdin at EOF). public override PSCredential PromptForCredential( string caption, diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs index 69e609615..6bce67fdf 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobDefinition.cs @@ -659,7 +659,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Handles known Task Scheduler COM error codes. /// /// COMException - /// Error message + /// Error message. private string ConvertCOMErrorCode(System.Runtime.InteropServices.COMException e) { string msg = null; @@ -1170,7 +1170,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// job is also added to the local job repository. Job results are /// not written to the job store. /// - /// ScheduledJob object for running job + /// ScheduledJob object for running job. public ScheduledJob StartJob() { IsDisposed(); @@ -1426,7 +1426,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// List of trigger Ids /// List of not found trigger Ids - /// List of ScheduledJobTrigger objects + /// List of ScheduledJobTrigger objects. public List GetTriggers( IEnumerable triggerIds, out List notFoundIds) @@ -1477,7 +1477,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// the passed in trigger Id. /// /// Trigger Id - /// ScheduledJobTrigger object + /// ScheduledJobTrigger object. public ScheduledJobTrigger GetTrigger( Int32 triggerId) { @@ -1723,7 +1723,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Name of definition to load /// Path to definition file - /// ScheduledJobDefinition object + /// ScheduledJobDefinition object. internal static ScheduledJobDefinition LoadDefFromStore( string definitionName, string definitionPath) @@ -1947,7 +1947,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Create a Job2 job, runs it and waits for it to complete. /// Job status and results are written to the job store. /// - /// Job2 job object that was run + /// Job2 job object that was run. public Job2 Run() { Job2 job = null; @@ -2217,7 +2217,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// the provided definition name. /// /// Definition name - /// True if definition exists + /// True if definition exists. public bool Contains(string jobDefName) { lock (_syncObject) diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs index d8dd5f980..e31b561b3 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobSourceAdapter.cs @@ -69,7 +69,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Create a new Job2 results instance. /// /// Job specification - /// Job2 + /// Job2. public override Job2 NewJob(JobInvocationInfo specification) { if (specification == null) @@ -94,7 +94,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// ScheduledJob definition name /// ScheduledJob definition file path - /// Job2 object + /// Job2 object. public override Job2 NewJob(string definitionName, string definitionPath) { if (string.IsNullOrEmpty(definitionName)) @@ -125,7 +125,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Get the list of jobs that are currently available in this /// store /// - /// Collection of job objects + /// Collection of job objects. public override IList GetJobs() { RefreshRepository(); @@ -145,8 +145,8 @@ namespace Microsoft.PowerShell.ScheduledJob /// names to match, can support /// wildcard if the store supports /// - /// collection of jobs that match the specified - /// criteria + /// Collection of jobs that match the specified + /// criteria. public override IList GetJobsByName(string name, bool recurse) { if (string.IsNullOrEmpty(name)) @@ -174,8 +174,8 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// command to match /// - /// collection of jobs that match the specified - /// criteria + /// Collection of jobs that match the specified + /// criteria. public override IList GetJobsByCommand(string command, bool recurse) { if (string.IsNullOrEmpty(command)) @@ -203,7 +203,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Guid to match /// - /// job with the specified guid + /// Job with the specified guid. public override Job2 GetJobByInstanceId(Guid instanceId, bool recurse) { RefreshRepository(); @@ -224,7 +224,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Id to match /// - /// Job with the specified id + /// Job with the specified id. public override Job2 GetJobBySessionId(int id, bool recurse) { RefreshRepository(); @@ -245,8 +245,8 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// state to match /// - /// collection of jobs with the specified - /// state + /// Collection of jobs with the specified + /// state. public override IList GetJobsByState(JobState state, bool recurse) { RefreshRepository(); @@ -270,8 +270,8 @@ namespace Microsoft.PowerShell.ScheduledJob /// dictionary containing name value /// pairs for adapter specific filters /// - /// collection of jobs that match the - /// specified criteria + /// Collection of jobs that match the + /// specified criteria. public override IList GetJobsByFilter(Dictionary filter, bool recurse) { if (filter == null) @@ -478,7 +478,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// DateTime of job run to load /// ScheduledJobDefinition name - /// Job2 job loaded from store + /// Job2 job loaded from store. internal static Job2 LoadJobFromStore(string definitionName, DateTime jobRun) { FileStream fsResults = null; @@ -563,7 +563,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Loads the Job2 object from provided files stream. /// /// FileStream from which to read job object - /// Created Job2 from file stream + /// Created Job2 from file stream. private static Job2 LoadResultsFromFile(FileStream fs) { XmlObjectSerializer serializer = new System.Runtime.Serialization.NetDataContractSerializer(); @@ -996,7 +996,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Gets the latest job run Date/Time for the given definition name. /// /// ScheduledJobDefinition name - /// Job Run DateTime + /// Job Run DateTime. public DateTime GetLatestJobRun(string definitionName) { if (string.IsNullOrEmpty(definitionName)) @@ -1050,7 +1050,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Definition name /// Job run DateTime - /// Scheduled job if found + /// Scheduled job if found. public ScheduledJob GetJob(string definitionName, DateTime jobRun) { lock (_syncObject) diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs index 37f046f38..1d07a475b 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobStore.cs @@ -119,7 +119,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// for the current user. /// /// Path for scheduled job definitions - /// True if paths are equal + /// True if paths are equal. public static bool IsDefaultUserPath(string definitionPath) { return definitionPath.Equals(GetJobDefinitionLocation(), StringComparison.OrdinalIgnoreCase); @@ -406,7 +406,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// scheduled job definition. /// /// Definition name - /// Directory Path + /// Directory Path. public static string GetJobRunOutputDirectory( string definitionName) { @@ -421,7 +421,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Gets the directory path for a Scheduled Job Definition. /// - /// Directory Path + /// Directory Path. public static string GetJobDefinitionLocation() { #if UNIX @@ -444,7 +444,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Gets the directory path for Scheduled Jobs. Will create the directory if /// it does not exist. /// - /// Directory Path + /// Directory Path. private static string GetDirectoryPath() { string pathName; @@ -469,7 +469,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Definition name /// File name - /// File path/name + /// File path/name. private static string CreateFilePathName(string definitionName, string fileName) { string filePath = GetJobDefinitionPath(definitionName); @@ -491,7 +491,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Definition name /// File name - /// File path/name + /// File path/name. private static string GetFilePathName(string definitionName, string fileName) { string filePath = GetJobDefinitionPath(definitionName); @@ -502,7 +502,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Gets the directory path for a Scheduled Job Definition. /// /// Scheduled job definition name - /// Directory Path + /// Directory Path. private static string GetJobDefinitionPath(string definitionName) { #if UNIX @@ -519,7 +519,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Definition name /// File name - /// Directory Path + /// Directory Path. private static string GetRunDirectory( string definitionName, DateTime runStart) @@ -535,7 +535,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Output directory path /// File name - /// Directory Path + /// Directory Path. private static string GetRunDirectoryFromPath( string definitionOutputPath, DateTime runStart) @@ -551,7 +551,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Definition name /// Result type /// Run date - /// File path/name + /// File path/name. private static string GetRunFilePathName( string definitionName, JobRunItem runItem, diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs index da4e62652..24ad7d858 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobTrigger.cs @@ -480,7 +480,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Repetition duration /// Trigger Id /// Trigger enabled state - /// ScheduledJobTrigger + /// ScheduledJobTrigger. public static ScheduledJobTrigger CreateOnceTrigger( DateTime time, TimeSpan delay, @@ -510,7 +510,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Random delay /// Trigger Id /// Trigger enabled state - /// ScheduledJobTrigger + /// ScheduledJobTrigger. public static ScheduledJobTrigger CreateDailyTrigger( DateTime time, Int32 interval, @@ -540,7 +540,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Random delay /// Trigger Id /// Trigger enabled state - /// ScheduledJobTrigger + /// ScheduledJobTrigger. public static ScheduledJobTrigger CreateWeeklyTrigger( DateTime time, Int32 interval, @@ -571,7 +571,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Random delay /// Trigger Id /// Trigger enabled state - /// ScheduledJobTrigger + /// ScheduledJobTrigger. public static ScheduledJobTrigger CreateAtLogOnTrigger( string user, TimeSpan delay, @@ -597,7 +597,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Random delay /// Trigger Id /// Trigger enabled state - /// ScheduledJobTrigger + /// ScheduledJobTrigger. public static ScheduledJobTrigger CreateAtStartupTrigger( TimeSpan delay, Int32 id, @@ -725,7 +725,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// The type to convert to /// The format provider to use like in IFormattable's ToString /// true if case should be ignored - /// the parameter converted to the parameter using formatProvider and ignoreCase + /// The parameter converted to the parameter using formatProvider and ignoreCase. /// if no conversion was possible public override object ConvertFrom(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { @@ -782,7 +782,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// The type to convert to /// The format provider to use like in IFormattable's ToString /// true if case should be ignored - /// sourceValue converted to the parameter using formatProvider and ignoreCase + /// SourceValue converted to the parameter using formatProvider and ignoreCase. /// if no conversion was possible public override object ConvertTo(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { diff --git a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobWTS.cs b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobWTS.cs index 6ae77f380..36684189a 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobWTS.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/ScheduledJobWTS.cs @@ -67,7 +67,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Task Id /// Task not found. - /// ScheduledJobTriggers + /// ScheduledJobTriggers. public Collection GetJobTriggers( string taskId) { @@ -103,7 +103,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Task Id /// Task not found. - /// ScheduledJobOptions + /// ScheduledJobOptions. public ScheduledJobOptions GetJobOptions( string taskId) { @@ -467,7 +467,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Creates a ScheduledJobTrigger object based on a provided WTS ITrigger. /// /// ITrigger - /// ScheduledJobTrigger + /// ScheduledJobTrigger. private ScheduledJobTrigger CreateJobTrigger( ITrigger iTrigger) { @@ -588,7 +588,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// PSCredential object. /// /// PSCredential - /// Unsecured password string + /// Unsecured password string. private string GetCredentialPassword(PSCredential credential) { if (credential == null) @@ -649,7 +649,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// a ITaskDefinition object. /// /// Task Id - /// ITaskDefinition + /// ITaskDefinition. private ITaskDefinition FindTask(string taskId) { try @@ -697,7 +697,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// "nS" - second value. /// /// Formatted time string - /// TimeSpan + /// TimeSpan. private TimeSpan ParseWTSTime(string wtsTime) { if (string.IsNullOrEmpty(wtsTime)) @@ -793,7 +793,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Creates WTS formatted time string based on TimeSpan parameter. /// /// TimeSpan - /// WTS time string + /// WTS time string. internal static string ConvertTimeSpanToWTSString(TimeSpan time) { return string.Format( @@ -809,7 +809,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Converts DateTime to string for WTS. /// /// DateTime - /// DateTime string + /// DateTime string. internal static string ConvertDateTimeToString(DateTime? dt) { if (dt == null) @@ -827,7 +827,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// required by Windows Task Scheduler API. /// /// Array of DayOfWeek - /// WTS days of week mask + /// WTS days of week mask. internal static short ConvertDaysOfWeekToMask(IEnumerable daysOfWeek) { short rtnValue = 0; @@ -872,7 +872,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// Converts WTS days of week mask to an array of DayOfWeek type. /// /// WTS days of week mask - /// Days of week as List + /// Days of week as List. private List ConvertMaskToDaysOfWeekArray(short mask) { List daysOfWeek = new List(); diff --git a/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs b/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs index eddeb1997..907e33ae6 100644 --- a/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs +++ b/src/Microsoft.PowerShell.ScheduledJob/commands/SchedJobCmdletBase.cs @@ -47,7 +47,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Local repository scheduled job definition id /// Errors/warnings are written to host - /// ScheduledJobDefinition object + /// ScheduledJobDefinition object. internal ScheduledJobDefinition GetJobDefinitionById( Int32 id, bool writeErrorsAndWarnings = true) @@ -78,7 +78,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Local repository scheduled job definition ids /// Errors/warnings are written to host - /// List of ScheduledJobDefinition objects + /// List of ScheduledJobDefinition objects. internal List GetJobDefinitionsById( Int32[] ids, bool writeErrorsAndWarnings = true) @@ -148,7 +148,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Scheduled job definition name /// Errors/warnings are written to host - /// ScheduledJobDefinition object + /// ScheduledJobDefinition object. internal ScheduledJobDefinition GetJobDefinitionByName( string name, bool writeErrorsAndWarnings = true) @@ -189,7 +189,7 @@ namespace Microsoft.PowerShell.ScheduledJob /// /// Scheduled job definition names /// Errors/warnings are written to host - /// List of ScheduledJobDefinition objects + /// List of ScheduledJobDefinition objects. internal List GetJobDefinitionsByName( string[] names, bool writeErrorsAndWarnings = true) diff --git a/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs b/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs index 0dc198003..f54291542 100644 --- a/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs +++ b/src/Microsoft.PowerShell.Security/security/CertificateProvider.cs @@ -1559,7 +1559,7 @@ namespace Microsoft.PowerShell.Commands /// Delete private key /// /// key prov info - /// no return + /// No return. [SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults", MessageId = "System.Management.Automation.Security.NativeMethods.NCryptSetProperty(System.IntPtr,System.String,System.Void*,System.Int32,System.Int32)")] [SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults", MessageId = "System.Management.Automation.Security.NativeMethods.NCryptFreeObject(System.IntPtr)")] @@ -1688,7 +1688,7 @@ namespace Microsoft.PowerShell.Commands /// the store name /// boolean to specify whether or not to delete private key /// source path - /// no return + /// No return. private void RemoveCertStore(string storeName, bool fDeleteKey, string sourcePath) { @@ -1751,7 +1751,7 @@ namespace Microsoft.PowerShell.Commands /// boolean to specify whether or not to delete private key /// machine context or user /// source path - /// no return + /// No return. private void RemoveCertItem(X509Certificate2 cert, bool fDeleteKey, bool fMachine, string sourcePath) { if (cert != null) @@ -1786,7 +1786,7 @@ namespace Microsoft.PowerShell.Commands /// boolean to specify whether or not to delete private key /// machine context or user /// source path - /// no return + /// No return. [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults")] private void DoRemove(X509Certificate2 cert, bool fDeleteKey, bool fMachine, string sourcePath) @@ -1865,7 +1865,7 @@ namespace Microsoft.PowerShell.Commands /// Commit store for UserDS store /// /// an IntPtr for store handle - /// no return + /// No return. private void CommitUserDS(IntPtr storeHandle) { if (!Security.NativeMethods.CertControlStore( @@ -1885,7 +1885,7 @@ namespace Microsoft.PowerShell.Commands /// an X509Certificate2 /// an X509NativeStore /// source path - /// no return + /// No return. [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults")] private void DoMove(string destination, X509Certificate2 cert, X509NativeStore store, string sourcePath) { @@ -1945,7 +1945,7 @@ namespace Microsoft.PowerShell.Commands /// 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 - /// item at the path + /// Item at the path. private object GetItemAtPath(string path, bool test, out bool isContainer) { Utils.CheckArgForNull(path, "path"); @@ -2251,7 +2251,7 @@ namespace Microsoft.PowerShell.Commands /// /// whether we only need the names /// filter info - /// Does not return a value + /// Does not return a value. /// private void GetChildItemsOrNames( string path, @@ -2361,7 +2361,7 @@ namespace Microsoft.PowerShell.Commands /// get the name of the specified certificate /// /// - /// cert name + /// Cert name . /// we use Thumbprint as the name private static string GetCertName(X509Certificate2 cert) { @@ -2375,7 +2375,7 @@ namespace Microsoft.PowerShell.Commands /// path elements /// whether we should return only the names (instead of objects) /// filter info - /// Does not return a value + /// Does not return a value. private void GetCertificatesOrNames(string path, string[] pathElements, bool returnNames, @@ -2427,7 +2427,7 @@ namespace Microsoft.PowerShell.Commands /// get X509StoreLocation object at path /// /// - /// X509StoreLocation object + /// X509StoreLocation object. private X509StoreLocation GetStoreLocation(string path) { // @@ -2451,7 +2451,7 @@ namespace Microsoft.PowerShell.Commands /// path to store /// True if this should be a test for path existence. Returns True or False /// path elements - /// X509NativeStore object + /// X509NativeStore object. private X509NativeStore GetStore(string path, bool test, string[] pathElements) { X509StoreLocation location = GetStoreLocation(pathElements[0]); @@ -2479,7 +2479,7 @@ namespace Microsoft.PowerShell.Commands /// path to the store /// name of store (path leaf element) /// location of store (CurrentUser or LocalMachine) - /// X509NativeStore object + /// X509NativeStore object. private X509NativeStore GetStore(string storePath, string storeName, X509StoreLocation storeLocation) @@ -2516,7 +2516,7 @@ namespace Microsoft.PowerShell.Commands /// recursively return all items if true /// /// filter info - /// Does not return a value + /// 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 745aebe15..570bbcd74 100644 --- a/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs +++ b/src/Microsoft.PowerShell.Security/security/SignatureCommands.cs @@ -616,7 +616,7 @@ namespace Microsoft.PowerShell.Commands /// get SigningOption value corresponding to a string name /// /// name of option - /// SigningOption + /// SigningOption. private static SigningOption GetSigningOption(string optionName) { foreach (SigningOptionInfo si in s_sigOptionInfo) diff --git a/src/Microsoft.PowerShell.Security/security/Utils.cs b/src/Microsoft.PowerShell.Security/security/Utils.cs index 555ff8ed7..d17e425b7 100644 --- a/src/Microsoft.PowerShell.Security/security/Utils.cs +++ b/src/Microsoft.PowerShell.Security/security/Utils.cs @@ -16,7 +16,7 @@ namespace Microsoft.PowerShell /// gets the size of a file /// /// path to file - /// file size + /// File size . /// internal static long GetFileSize(string filePath) { @@ -35,7 +35,7 @@ namespace Microsoft.PowerShell /// /// ref to host ui interface /// prompt text - /// user input as secure string + /// User input as secure string. /// internal static SecureString PromptForSecureString(PSHostUserInterface hostUI, string prompt) @@ -54,7 +54,7 @@ namespace Microsoft.PowerShell /// resource string /// error identifier /// replacement params for resource string formatting - /// + /// /// internal static ErrorRecord CreateFileNotFoundErrorRecord(string resourceStr, @@ -83,7 +83,7 @@ namespace Microsoft.PowerShell /// /// path that was not found /// error identifier - /// ErrorRecord instance + /// ErrorRecord instance. /// internal static ErrorRecord CreatePathNotFoundErrorRecord(string path, @@ -107,7 +107,7 @@ namespace Microsoft.PowerShell /// resource string /// error identifier /// replacement params for resource string formatting - /// + /// /// internal static ErrorRecord CreateNotSupportedErrorRecord(string resourceStr, @@ -133,7 +133,7 @@ namespace Microsoft.PowerShell /// /// exception to include in ErrorRecord /// error identifier - /// + /// /// internal static ErrorRecord CreateInvalidArgumentErrorRecord(Exception e, diff --git a/src/System.Management.Automation/DscSupport/CimDSCParser.cs b/src/System.Management.Automation/DscSupport/CimDSCParser.cs index ee831a132..c28a065e7 100644 --- a/src/System.Management.Automation/DscSupport/CimDSCParser.cs +++ b/src/System.Management.Automation/DscSupport/CimDSCParser.cs @@ -988,7 +988,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal /// get text from SecureString /// /// value of SecureString - /// decoded string + /// Decoded string. public static string GetStringFromSecureString(SecureString value) { string passwordValueToAdd = String.Empty; @@ -1057,7 +1057,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal /// Find cached cim classes defined under specified module /// /// - /// List of cached cim classes + /// List of cached cim classes. public static List GetCachedClassesForModule(PSModuleInfo module) { List cachedClasses = new List(); diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs index 80658c30c..a89f3ffa2 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs @@ -69,7 +69,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// send an object to the pipeline /// /// object to process - /// Array of objects out of the success pipeline + /// Array of objects out of the success pipeline. internal Array Process(object o) { if (_pp == null) @@ -85,7 +85,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// shut down the pipeline /// - /// Array of objects out of the success pipeline + /// Array of objects out of the success pipeline. internal Array ShutDown() { if (_pp == null) @@ -197,7 +197,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// callback for the implementation to obtain a reference to the Cmdlet object /// - /// Cmdlet reference + /// Cmdlet reference. protected virtual PSCmdlet OuterCmdletCall() { return this; @@ -206,7 +206,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// callback for the implementation to get the current pipeline object /// - /// current object from the pipeline + /// Current object from the pipeline. protected virtual PSObject InputObjectCall() { // just bind to the input object parameter diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs index c968efe90..2d0867a71 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs @@ -429,7 +429,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// compute the group transition, given an input object /// /// object received from the input pipeline - /// GroupTransition enumeration + /// GroupTransition enumeration. private GroupTransition ComputeGroupTransition(PSObject so) { // check if we have to start a group @@ -667,7 +667,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// FormattingCommandLineParameters instance, ready to pass to the /// inner format command /// - /// parameters collected in unified manner + /// Parameters collected in unified manner. internal virtual FormattingCommandLineParameters GetCommandLineParameters() { return null; diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs index f559767b2..a9ec81a5a 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/BaseOutputtingCommand.cs @@ -259,7 +259,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// preprocessed by the default formatter /// /// object to examine for formatting - /// whether the object needs to be shunted to preprocessing + /// Whether the object needs to be shunted to preprocessing. private bool NeedsPreprocessing(object o) { FormatEntryData fed = o as FormatEntryData; @@ -365,7 +365,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// shunt object to the formatting pipeline for preprocessing /// /// object to be preprocessed - /// array of objects returned by the preprocessing step + /// Array of objects returned by the preprocessing step. private Array ApplyFormatting(object o) { if (_command == null) diff --git a/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs b/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs index 87e415f94..24bdf0af0 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ColumnWidthManager.cs @@ -48,7 +48,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// (meaning unassigned) /// /// columns to process - /// true if there was a fit, false if there is need for trimming + /// True if there was a fit, false if there is need for trimming. private bool AssignColumnWidths(Span columnWidths) { // run a quick check to see if all the columns have a specified width, @@ -189,7 +189,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// get the last visible column (i.e. with a width >= 0) /// /// column widths array - /// index of the last visible column, -1 if none + /// Index of the last visible column, -1 if none. private static int GetLastVisibleColumn(Span columnWidths) { for (int k = 0; k < columnWidths.Length; k++) diff --git a/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs b/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs index df6dbf761..1c0fb54e9 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs @@ -349,7 +349,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// so that we do not break paths etc. /// /// input string - /// a collection of words + /// A collection of words. private static IEnumerable GetWords(string s) { StringBuilder sb = new StringBuilder(); @@ -660,7 +660,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// by honoring both \n and \r\n /// /// string to split - /// string array with the values + /// String array with the values. internal static string[] SplitLines(string s) { if (string.IsNullOrEmpty(s)) diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs index 3ad868c74..ffe378510 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/XmlLoaderBase.cs @@ -266,7 +266,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// The returned IDisposable should be used in a using(){...} block /// /// node to push on the stack - /// object to dispose when exiting the frame + /// Object to dispose when exiting the frame. protected IDisposable StackFrame(XmlNode n) { return StackFrame(n, -1); @@ -278,7 +278,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// node to push on the stack /// index of the node of the same name in a collection - /// object to dispose when exiting the frame + /// Object to dispose when exiting the frame. protected IDisposable StackFrame(XmlNode n, int index) { XmlLoaderStackFrame sf = new XmlLoaderStackFrame(this, n, index); @@ -363,7 +363,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// XmlNode whose name is to compare /// string to compare the node name to /// if true, accept the presence of attributes on the node - /// true if there is a match + /// True if there is a match. private bool MatchNodeNameHelper(XmlNode n, string s, bool allowAttributes) { bool match = false; diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Table.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Table.cs index eb80ba95c..71a936e1e 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Table.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Table.cs @@ -229,7 +229,7 @@ namespace System.Management.Automation /// /// Determines if this object is safe to be written /// - /// true if safe, false otherwise + /// True if safe, false otherwise. internal override bool SafeForExport() { if (!base.SafeForExport()) diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Wide.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Wide.cs index 7898e725e..85e3579a8 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Wide.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/displayDescriptionData_Wide.cs @@ -90,7 +90,7 @@ namespace System.Management.Automation /// Indicates if this control does not have /// any script blocks and is safe to export /// - /// true if exportable, false otherwise + /// True if exportable, false otherwise. internal override bool SafeForExport() { if (!base.SafeForExport()) @@ -316,4 +316,4 @@ namespace System.Management.Automation return _control; } } -} \ No newline at end of file +} diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs index de5243f78..a33c15d7a 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs @@ -273,7 +273,7 @@ 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. /// - /// database instance + /// Database instance. internal void UpdateDataBase( Collection mshsnapins, AuthorizationManager authorizationManager, @@ -314,7 +314,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// skipped at runtime. /// /// Trace and error logs from loading the format Xml files. - /// true if we had a successful load + /// True if we had a successful load. internal bool LoadFromFile( Collection files, PSPropertyExpressionFactory expressionFactory, @@ -376,7 +376,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// list of logger entries (errors, etc.) to return to the caller /// true if no error occurred - /// a database instance loaded from file(s) + /// A database instance loaded from file(s). private static TypeInfoDataBase LoadFromFileHelper( Collection files, PSPropertyExpressionFactory expressionFactory, diff --git a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs index 54b4fd347..d8495715b 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataXmlLoader.cs @@ -183,7 +183,7 @@ 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. /// - /// true if successful + /// True if successful. internal bool LoadXmlFile( XmlFileLoadInfo info, TypeInfoDataBase db, @@ -1919,7 +1919,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// log an error if an exception is thrown /// /// script block string to verify - /// true if parsed correctly, false if failed + /// True if parsed correctly, false if failed. internal bool VerifyScriptBlock(string scriptBlockText) { try diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs index f9df3c979..cf09e5488 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatGroupManager.cs @@ -45,7 +45,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// compute the string value of the grouping property /// /// object to use to compute the property value - /// true if there was an update + /// True if there was an update. internal bool UpdateGroupingKeyValue(PSObject so) { if (_groupingKeyExpression == null) diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs index 49e34d7b4..c4adcd5fa 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs @@ -275,7 +275,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// update the current value of the grouping key /// /// object to use for the update - /// true if the value of the key changed + /// True if the value of the key changed. internal bool UpdateGroupingKeyValue(PSObject so) { if (_groupingManager == null) diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs index c3d918b7b..8a27b0cde 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs @@ -434,7 +434,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// object to process /// parameters from the command line - /// complex view entry to send to the output command + /// Complex view entry to send to the output command. internal ComplexViewEntry GenerateView(PSObject so, FormattingCommandLineParameters inputParameters) { _complexSpecificParameters = (ComplexSpecificParameters)inputParameters.shapeParameters; @@ -697,7 +697,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// treat as scalar check /// /// name of the type to check - /// true if it has to be treated as a scalar + /// True if it has to be treated as a scalar. private static bool TreatAsScalarType(Collection typeNames) { return DefaultScalarTypes.IsTypeInList(typeNames); diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs b/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs index e4eeed93f..11994457b 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormatViewManager.cs @@ -665,7 +665,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// to be written to the error pipeline and clear the list of pending /// errors /// - /// list of ErrorRecord objects + /// List of ErrorRecord objects. internal List DrainFailedResultList() { if (!_formatErrorPolicy.ShowErrorsAsMessages) @@ -687,7 +687,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// Conversion between an error internal representation and ErrorRecord /// /// internal error object - /// corresponding ErrorRecord instance + /// Corresponding ErrorRecord instance. private static ErrorRecord GenerateErrorRecord(FormattingError error) { ErrorRecord errorRecord = null; diff --git a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs index 76d33b1ac..adc51faff 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/FormattingObjectsDeserializer.cs @@ -85,7 +85,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// it just returns the object unchanged /// /// object to deserialize - /// deserialized object or null + /// Deserialized object or null. internal object Deserialize(PSObject so) { var fid = PSObject.Base(so) as FormatInfoData; @@ -166,7 +166,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// object to process /// property to look up - /// string[] representation of the property + /// String[] representation of the property. private static string[] ReadStringArrayHelper (object rawObject, string propertyName) { // throw if the property is not there @@ -264,7 +264,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// object whose the property belongs to /// name of the string property - /// string out of the MsObject + /// String out of the MsObject. internal string DeserializeStringMemberVariableRaw(PSObject so, string property) { return (string)DeserializeMemberVariable(so, property, typeof(string), false /* cannotBeNull */); @@ -275,7 +275,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// object whose the property belongs to /// name of the string property - /// string out of the MsObject + /// String out of the MsObject. internal string DeserializeStringMemberVariable(PSObject so, string property) { string val = (string)DeserializeMemberVariable(so, property, typeof(string), false /* cannotBeNull */); diff --git a/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs b/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs index f925ae9ad..a4da0936f 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs @@ -66,7 +66,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// 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 + /// Number of characters that would fit. protected int GetSplitLengthInternalHelper(string str, int offset, int displayCells, bool head) { int filledDisplayCellsCount = 0; // number of cells that are filled in diff --git a/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs b/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs index b0e1ddbb6..d40f39d37 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/OutputManager.cs @@ -158,7 +158,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// /// ETS type name of the object to process - /// true if there is a match + /// True if there is a match. internal bool AppliesToType(string typeName) { foreach (string s in _applicableTypes) @@ -303,7 +303,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// to process the current pipeline object /// /// pipeline object to be processed - /// applicable command entry + /// Applicable command entry. private CommandEntry GetActiveCommandEntry(PSObject so) { string typeName = PSObjectHelper.PSObjectIsOfExactType(so.InternalTypeNames); diff --git a/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs b/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs index a501e518b..af79ad135 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/OutputQueue.cs @@ -40,7 +40,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// add an object to the cache /// /// object to add - /// objects the cache needs to return. It can be null + /// Objects the cache needs to return. It can be null. internal List Add(PacketInfoData o) { FormatStartData fsd = o as FormatStartData; @@ -152,7 +152,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// remove a single object from the queue /// - /// object retrieved, null if queue is empty + /// Object retrieved, null if queue is empty. internal PacketInfoData Dequeue() { if (_queue.Count == 0) @@ -252,7 +252,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// objects already in the cache and the cache settings /// /// object to add - /// list of objects the cache is flushing + /// List of objects the cache is flushing. internal List Add(PacketInfoData o) { // if neither there, pass thru @@ -277,7 +277,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// remove all the objects from the cache /// - /// all the objects that were in the cache + /// All the objects that were in the cache. internal List Drain() { // if neither there,we did not cache at all diff --git a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs index 91674a58c..10f883877 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshObjectUtil.cs @@ -116,7 +116,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// shell object to process /// expression factory to create PSPropertyExpression - /// resolved PSPropertyExpression; null if no match was found + /// Resolved PSPropertyExpression; null if no match was found. internal static PSPropertyExpression GetDisplayNameExpression(PSObject target, PSPropertyExpressionFactory expressionFactory) { // first try to get the expression from the object (types.ps1xml data) @@ -163,7 +163,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// shell object to process /// expression factory to create PSPropertyExpression - /// PSPropertyExpressionResult if successful; null otherwise + /// PSPropertyExpressionResult if successful; null otherwise. internal static PSPropertyExpressionResult GetDisplayName(PSObject target, PSPropertyExpressionFactory expressionFactory) { // get the expression to evaluate @@ -276,7 +276,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// expression factory to create PSPropertyExpression /// limit on IEnumerable enumeration /// stores errors during string conversion - /// string representation + /// String representation. internal static string SmartToString(PSObject so, PSPropertyExpressionFactory expressionFactory, int enumerationLimit, StringFormatError formatErrorObject) { if (so == null) @@ -394,7 +394,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// limit on IEnumerable enumeration /// formatting error object, if present /// expression factory to create PSPropertyExpression - /// string representation + /// String representation. internal static string FormatField(FieldFormattingDirective directive, object val, int enumerationLimit, StringFormatError formatErrorObject, PSPropertyExpressionFactory expressionFactory) { @@ -486,7 +486,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// helper to retrieve the default property set of a shell object /// /// shell object to process - /// resolved expression; empty list if not found + /// Resolved expression; empty list if not found. internal static List GetDefaultPropertySet(PSObject so) { List retVal = GetDefaultPropertySet(so.PSStandardMembers); @@ -539,7 +539,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// expression factory to create PSPropertyExpression /// not null if an error condition arose - /// formatted string + /// Formatted string. internal static string GetExpressionDisplayValue( PSObject so, int enumerationLimit, @@ -637,7 +637,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// create an expression from an expression token /// /// expression token to use - /// constructed expression + /// Constructed expression. /// internal PSPropertyExpression CreateFromExpressionToken(ExpressionToken et) { @@ -649,7 +649,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// expression token to use /// The context from which the file was loaded - /// constructed expression + /// Constructed expression. /// internal PSPropertyExpression CreateFromExpressionToken(ExpressionToken et, DatabaseLoadingInfo loadingInfo) { diff --git a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs index e675dd25f..4a21946e5 100644 --- a/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs +++ b/src/System.Management.Automation/FormatAndOutput/common/Utilities/MshParameter.cs @@ -135,7 +135,7 @@ namespace Microsoft.PowerShell.Commands.Internal.Format /// /// key to verify /// invocation context for error reporting - /// matching hash table entry + /// Matching hash table entry. /// internal HashtableEntryDefinition MatchEntry(string keyName, TerminatingErrorContext invocationContext) { diff --git a/src/System.Management.Automation/cimSupport/cmdletization/ObjectModelWrapper.cs b/src/System.Management.Automation/cimSupport/cmdletization/ObjectModelWrapper.cs index f5a1400a2..1296c25df 100644 --- a/src/System.Management.Automation/cimSupport/cmdletization/ObjectModelWrapper.cs +++ b/src/System.Management.Automation/cimSupport/cmdletization/ObjectModelWrapper.cs @@ -76,7 +76,7 @@ namespace Microsoft.PowerShell.Cmdletization /// /// When overridden in the derived class, creates a query builder for a given object model /// - /// Query builder for a given object model + /// Query builder for a given object model. public virtual QueryBuilder GetQueryBuilder() { throw new NotImplementedException(); @@ -86,7 +86,7 @@ namespace Microsoft.PowerShell.Cmdletization /// Queries for object instances in the object model. /// /// Query parameters - /// A lazy evaluated collection of object instances + /// A lazy evaluated collection of object instances. public virtual void ProcessRecord(QueryBuilder query) { throw new NotImplementedException(); diff --git a/src/System.Management.Automation/engine/Attributes.cs b/src/System.Management.Automation/engine/Attributes.cs index 784ab42ff..5e0c9d149 100644 --- a/src/System.Management.Automation/engine/Attributes.cs +++ b/src/System.Management.Automation/engine/Attributes.cs @@ -142,7 +142,7 @@ namespace System.Management.Automation /// The engine APIs for the context under which the prerequisite is being /// evaluated. /// - /// bool true if the validate succeeded + /// Bool true if the validate succeeded. /// /// Whenever any exception occurs during data validate. /// All the system exceptions are wrapped in ValidationMetadataException @@ -2200,7 +2200,7 @@ namespace System.Management.Automation /// made. /// /// parameter argument to mutate - /// mutated object(s) + /// Mutated object(s). /// /// Return the transformed value of . /// Throw diff --git a/src/System.Management.Automation/engine/COM/ComAdapter.cs b/src/System.Management.Automation/engine/COM/ComAdapter.cs index f0918c85c..edfc1526e 100644 --- a/src/System.Management.Automation/engine/COM/ComAdapter.cs +++ b/src/System.Management.Automation/engine/COM/ComAdapter.cs @@ -54,7 +54,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSMemberInfo from /// name of the member to be retrieved - /// The PSMemberInfo corresponding to memberName from obj + /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { ComProperty prop; @@ -95,7 +95,7 @@ namespace System.Management.Automation /// to the properties available in it. /// /// object to get all the member information from - /// all members in obj + /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { PSMemberInfoInternalCollection collection = new PSMemberInfoInternalCollection(); @@ -141,7 +141,7 @@ namespace System.Management.Automation /// Returns an array with the property attributes /// /// property we want the attributes from - /// an array with the property attributes + /// An array with the property attributes. protected override AttributeCollection PropertyAttributes(PSProperty property) { return new AttributeCollection(); @@ -151,7 +151,7 @@ namespace System.Management.Automation /// Returns the value from a property coming from a previous call to DoGetProperty /// /// PSProperty coming from a previous call to DoGetProperty - /// The value of the property + /// The value of the property. protected override object PropertyGet(PSProperty property) { ComProperty prop = (ComProperty)property.adapterData; @@ -174,7 +174,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { ComProperty prop = (ComProperty)property.adapterData; @@ -185,7 +185,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { ComProperty prop = (ComProperty)property.adapterData; @@ -197,7 +197,7 @@ namespace System.Management.Automation /// /// PSProperty obtained in a previous DoGetProperty /// True if the result is for display purposes only - /// the name of the type corresponding to the property + /// The name of the type corresponding to the property. protected override string PropertyType(PSProperty property, bool forDisplay) { ComProperty prop = (ComProperty)property.adapterData; @@ -208,7 +208,7 @@ namespace System.Management.Automation /// get the property signature. /// /// property object whose signature we want - /// string representing the signature of the property + /// String representing the signature of the property. protected override string PropertyToString(PSProperty property) { ComProperty prop = (ComProperty)property.adapterData; @@ -223,7 +223,7 @@ namespace System.Management.Automation /// /// the non empty return from GetMethods /// the arguments to use - /// the return value for the method + /// The return value for the method. protected override object MethodInvoke(PSMethod method, object[] arguments) { ComMethod commethod = (ComMethod)method.adapterData; @@ -248,7 +248,7 @@ namespace System.Management.Automation /// Returns the name of the type corresponding to the property's value /// /// property obtained in a previous GetMember - /// the name of the type corresponding to the member + /// The name of the type corresponding to the member. protected override string ParameterizedPropertyType(PSParameterizedProperty property) { ComProperty prop = (ComProperty)property.adapterData; @@ -259,7 +259,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected override bool ParameterizedPropertyIsSettable(PSParameterizedProperty property) { ComProperty prop = (ComProperty)property.adapterData; @@ -270,7 +270,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected override bool ParameterizedPropertyIsGettable(PSParameterizedProperty property) { ComProperty prop = (ComProperty)property.adapterData; @@ -282,7 +282,7 @@ namespace System.Management.Automation /// /// the non empty return from GetMember /// the arguments to use - /// the return value for the property + /// The return value for the property. protected override object ParameterizedPropertyGet(PSParameterizedProperty property, object[] arguments) { ComProperty prop = (ComProperty)property.adapterData; @@ -305,7 +305,7 @@ namespace System.Management.Automation /// Returns the string representation of the property in the object /// /// property obtained in a previous GetMember - /// the string representation of the property in the object + /// The string representation of the property in the object. protected override string ParameterizedPropertyToString(PSParameterizedProperty property) { ComProperty prop = (ComProperty)property.adapterData; diff --git a/src/System.Management.Automation/engine/COM/ComInvoker.cs b/src/System.Management.Automation/engine/COM/ComInvoker.cs index a3d326e4b..c8733713c 100644 --- a/src/System.Management.Automation/engine/COM/ComInvoker.cs +++ b/src/System.Management.Automation/engine/COM/ComInvoker.cs @@ -74,7 +74,7 @@ namespace System.Management.Automation /// Also initialize the VARIANT elements to be the type 'VT_EMPTY'. /// /// Array length - /// Pointer to the array + /// Pointer to the array. private static unsafe IntPtr NewVariantArray(int length) { IntPtr variantArray = Marshal.AllocCoTaskMem(s_variantSize * length); diff --git a/src/System.Management.Automation/engine/COM/ComMethod.cs b/src/System.Management.Automation/engine/COM/ComMethod.cs index ea2c61dc6..d202304ff 100644 --- a/src/System.Management.Automation/engine/COM/ComMethod.cs +++ b/src/System.Management.Automation/engine/COM/ComMethod.cs @@ -84,7 +84,7 @@ namespace System.Management.Automation /// /// represents the instance of the method we want to invoke /// parameters to be passed to the method - /// returns the value of method call + /// Returns the value of method call. internal object InvokeMethod(PSMethod method, object[] arguments) { try diff --git a/src/System.Management.Automation/engine/COM/ComProperty.cs b/src/System.Management.Automation/engine/COM/ComProperty.cs index 4fbdf01b1..be7264daa 100644 --- a/src/System.Management.Automation/engine/COM/ComProperty.cs +++ b/src/System.Management.Automation/engine/COM/ComProperty.cs @@ -142,7 +142,7 @@ namespace System.Management.Automation /// Get value of this property /// /// instance of the object from which to get the property value - /// value of the property + /// Value of the property. internal object GetValue(Object target) { try @@ -173,7 +173,7 @@ namespace System.Management.Automation /// /// instance of the object from which to get the property value /// parameters to get the property value - /// value of the property + /// Value of the property internal object GetValue(Object target, object[] arguments) { try @@ -360,7 +360,7 @@ namespace System.Management.Automation /// /// Returns the property signature string /// - /// property signature + /// Property signature. public override string ToString() { StringBuilder builder = new StringBuilder(); diff --git a/src/System.Management.Automation/engine/COM/ComTypeInfo.cs b/src/System.Management.Automation/engine/COM/ComTypeInfo.cs index a2a56bfcf..710727f4c 100644 --- a/src/System.Management.Automation/engine/COM/ComTypeInfo.cs +++ b/src/System.Management.Automation/engine/COM/ComTypeInfo.cs @@ -140,7 +140,7 @@ namespace System.Management.Automation /// Get the typeinfo interface for the given comobject. /// /// reference to com object for which we are getting type information. - /// ComTypeInfo object which wraps the ITypeInfo interface of the given COM object + /// 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) { @@ -266,7 +266,7 @@ namespace System.Management.Automation /// Get the IDispatch Typeinfo from CoClass typeinfo. /// /// Reference to the type info to which the type descriptor belongs - /// ITypeInfo reference to the Dispatch interface + /// ITypeInfo reference to the Dispatch interface. internal static COM.ITypeInfo GetDispatchTypeInfoFromCoClassTypeInfo(COM.ITypeInfo typeinfo) { //Get the number of interfaces implemented by this CoClass. diff --git a/src/System.Management.Automation/engine/COM/ComUtil.cs b/src/System.Management.Automation/engine/COM/ComUtil.cs index ff8fed0c2..7b980e3b5 100644 --- a/src/System.Management.Automation/engine/COM/ComUtil.cs +++ b/src/System.Management.Automation/engine/COM/ComUtil.cs @@ -31,7 +31,7 @@ namespace System.Management.Automation /// ITypeInfo interface of the object /// FuncDesc which defines the method /// True if this is a property put; these properties take their return type from their first parameter - /// signature of the method + /// Signature of the method. internal static string GetMethodSignatureFromFuncDesc(COM.ITypeInfo typeinfo, COM.FUNCDESC funcdesc, bool isPropertyPut) { StringBuilder builder = new StringBuilder(); @@ -102,7 +102,7 @@ namespace System.Management.Automation /// /// ITypeInfo interface of the type /// FuncDesc of property of method - /// name of the method or property + /// Name of the method or property. internal static string GetNameFromFuncDesc(COM.ITypeInfo typeinfo, COM.FUNCDESC funcdesc) { //Get the method or property name. @@ -117,7 +117,7 @@ namespace System.Management.Automation /// /// ITypeInfo interface of the type /// reference to the custom type - /// name of the custom type + /// Name of the custom type. private static string GetStringFromCustomType(COM.ITypeInfo typeinfo, IntPtr refptr) { COM.ITypeInfo custtypeinfo; @@ -145,7 +145,7 @@ namespace System.Management.Automation /// /// Reference to the type info to which the type descriptor belongs /// reference to type descriptor which is being converted to string from - /// string representation of the type descriptor + /// String representation of the type descriptor. private static string GetStringFromTypeDesc(COM.ITypeInfo typeinfo, COM.TYPEDESC typedesc) { if ((VarEnum)typedesc.vt == VarEnum.VT_PTR) @@ -247,7 +247,7 @@ namespace System.Management.Automation /// Determine .net type for the given type descriptor /// /// COM type descriptor to convert - /// type represented by the typedesc + /// Type represented by the typedesc. internal static Type GetTypeFromTypeDesc(COM.TYPEDESC typedesc) { VarEnum vt = (VarEnum)typedesc.vt; @@ -340,7 +340,7 @@ namespace System.Management.Automation /// /// Converts a MethodBase[] into a MethodInformation[] /// - /// the ComMethodInformation[] corresponding to methods + /// The ComMethodInformation[] corresponding to methods. internal static ComMethodInformation[] GetMethodInformationArray(COM.ITypeInfo typeInfo, Collection methods, bool skipLastParameters) { int methodCount = methods.Count; diff --git a/src/System.Management.Automation/engine/CmdletParameterBinderController.cs b/src/System.Management.Automation/engine/CmdletParameterBinderController.cs index 97798378b..ad4f89eda 100644 --- a/src/System.Management.Automation/engine/CmdletParameterBinderController.cs +++ b/src/System.Management.Automation/engine/CmdletParameterBinderController.cs @@ -509,7 +509,7 @@ namespace System.Management.Automation /// /// /// - /// null if no qualified pair found + /// Null if no qualified pair found. private Dictionary GetQualifiedParameterValuePairs( uint currentParameterSetFlag, Dictionary availableParameterValuePairs) @@ -597,7 +597,7 @@ namespace System.Management.Automation /// /// Get all available default parameter value pairs /// - /// return the available parameter value pairs. Otherwise return null + /// Return the available parameter value pairs. Otherwise return null. private Dictionary GetDefaultParameterValuePairs(bool needToGetAlias) { if (DefaultParameterValues == null) @@ -4378,7 +4378,7 @@ namespace System.Management.Automation /// /// check to see if the hashtable has been changed since last check /// - /// true for changed; false for not changed + /// True for changed; false for not changed. public bool ChangeSinceLastCheck() { bool ret = _isChanged; @@ -4609,7 +4609,7 @@ namespace System.Management.Automation /// /// /// - /// Return true if the key is valid, false if not + /// Return true if the key is valid, false if not. internal static bool CheckKeyIsValid(string key, ref string cmdletName, ref string parameterName) { if (key == String.Empty) diff --git a/src/System.Management.Automation/engine/ComInterop/BoundDispEvent.cs b/src/System.Management.Automation/engine/ComInterop/BoundDispEvent.cs index 35cfacd07..86fdfa82f 100644 --- a/src/System.Management.Automation/engine/ComInterop/BoundDispEvent.cs +++ b/src/System.Management.Automation/engine/ComInterop/BoundDispEvent.cs @@ -32,7 +32,7 @@ namespace System.Management.Automation.ComInterop /// The binder provided by the call site. /// The handler for the operation. /// The result of the operation. - /// true if the operation is complete, false if the call site should determine behavior. + /// True if the operation is complete, false if the call site should determine behavior. public override bool TryBinaryOperation(BinaryOperationBinder binder, object handler, out object result) { if (binder.Operation == ExpressionType.AddAssign) diff --git a/src/System.Management.Automation/engine/ComInterop/ComBinder.cs b/src/System.Management.Automation/engine/ComInterop/ComBinder.cs index cb8fc8e89..cf2139fab 100644 --- a/src/System.Management.Automation/engine/ComInterop/ComBinder.cs +++ b/src/System.Management.Automation/engine/ComInterop/ComBinder.cs @@ -27,7 +27,7 @@ namespace System.Management.Automation.ComInterop /// Determines if an object is a COM object. /// /// The object to test. - /// true if the object is a COM object, false otherwise. + /// True if the object is a COM object, false otherwise. public static bool IsComObject(object value) { return @@ -48,7 +48,7 @@ namespace System.Management.Automation.ComInterop /// The target of the dynamic operation. /// The new representing the result of the binding. /// true if member evaluation may be delayed. - /// true if operation was bound successfully; otherwise, false. + /// True if operation was bound successfully; otherwise, false. public static bool TryBindGetMember(GetMemberBinder binder, DynamicMetaObject instance, out DynamicMetaObject result, bool delayInvocation) { if (TryGetMetaObject(ref instance)) @@ -78,7 +78,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 operation was bound successfully; otherwise, false. + /// True if operation was bound successfully; otherwise, false. public static bool TryBindGetMember(GetMemberBinder binder, DynamicMetaObject instance, out DynamicMetaObject result) { return TryBindGetMember(binder, instance, out result, false); @@ -91,7 +91,7 @@ namespace System.Management.Automation.ComInterop /// The target of the dynamic operation. /// The representing the value for the set member operation. /// The new representing the result of the binding. - /// true if operation was bound successfully; otherwise, false. + /// True if operation was bound successfully; otherwise, false. public static bool TryBindSetMember(SetMemberBinder binder, DynamicMetaObject instance, DynamicMetaObject value, out DynamicMetaObject result) { if (TryGetMetaObject(ref instance)) @@ -114,7 +114,7 @@ namespace System.Management.Automation.ComInterop /// The target of the dynamic operation. /// An array of instances - arguments to the invoke member operation. /// The new representing the result of the binding. - /// true if operation was bound successfully; otherwise, false. + /// True if operation was bound successfully; otherwise, false. public static bool TryBindInvoke(InvokeBinder binder, DynamicMetaObject instance, DynamicMetaObject[] args, out DynamicMetaObject result) { if (TryGetMetaObjectInvoke(ref instance)) @@ -137,7 +137,7 @@ namespace System.Management.Automation.ComInterop /// The target of the dynamic operation. /// An array of instances - arguments to the invoke member operation. /// The new representing the result of the binding. - /// true if operation was bound successfully; otherwise, false. + /// True if operation was bound successfully; otherwise, false. public static bool TryBindInvokeMember(InvokeMemberBinder binder, bool isSetProperty, DynamicMetaObject instance, DynamicMetaObject[] args, out DynamicMetaObject result) { if (TryGetMetaObject(ref instance)) @@ -177,7 +177,7 @@ namespace System.Management.Automation.ComInterop /// The target of the dynamic operation. /// An array of instances - arguments to the invoke member operation. /// The new representing the result of the binding. - /// true if operation was bound successfully; otherwise, false. + /// True if operation was bound successfully; otherwise, false. public static bool TryBindGetIndex(GetIndexBinder binder, DynamicMetaObject instance, DynamicMetaObject[] args, out DynamicMetaObject result) { if (TryGetMetaObjectInvoke(ref instance)) @@ -200,7 +200,7 @@ namespace System.Management.Automation.ComInterop /// An array of instances - arguments to the invoke member operation. /// The representing the value for the set index operation. /// The new representing the result of the binding. - /// true if operation was bound successfully; otherwise, false. + /// True if operation was bound successfully; otherwise, false. public static bool TryBindSetIndex(SetIndexBinder binder, DynamicMetaObject instance, DynamicMetaObject[] args, DynamicMetaObject value, out DynamicMetaObject result) { if (TryGetMetaObjectInvoke(ref instance)) @@ -223,7 +223,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 operation was bound successfully; otherwise, false. + /// True if operation was bound successfully; otherwise, false. public static bool TryConvert(ConvertBinder binder, DynamicMetaObject instance, out DynamicMetaObject result) { if (IsComObject(instance.Value)) diff --git a/src/System.Management.Automation/engine/ComInterop/ComTypeLibDesc.cs b/src/System.Management.Automation/engine/ComInterop/ComTypeLibDesc.cs index e5e400fc6..9550c4448 100644 --- a/src/System.Management.Automation/engine/ComInterop/ComTypeLibDesc.cs +++ b/src/System.Management.Automation/engine/ComInterop/ComTypeLibDesc.cs @@ -63,7 +63,7 @@ namespace System.Management.Automation.ComInterop /// and get actual values for the enums. /// /// Type Library Guid - /// ComTypeLibDesc object + /// ComTypeLibDesc object. [System.Runtime.Versioning.ResourceExposure(System.Runtime.Versioning.ResourceScope.Machine)] [System.Runtime.Versioning.ResourceConsumption(System.Runtime.Versioning.ResourceScope.Machine, System.Runtime.Versioning.ResourceScope.Machine)] public static ComTypeLibInfo CreateFromGuid(Guid typeLibGuid) @@ -82,7 +82,7 @@ namespace System.Management.Automation.ComInterop /// and get actual values for the enums. /// /// OLE automation compatible RCW - /// ComTypeLibDesc object + /// ComTypeLibDesc object. public static ComTypeLibInfo CreateFromObject(object rcw) { if (Marshal.IsComObject(rcw) == false) diff --git a/src/System.Management.Automation/engine/CommandCompletion/CommandCompletion.cs b/src/System.Management.Automation/engine/CommandCompletion/CommandCompletion.cs index c19e34fa6..19c3b42b9 100644 --- a/src/System.Management.Automation/engine/CommandCompletion/CommandCompletion.cs +++ b/src/System.Management.Automation/engine/CommandCompletion/CommandCompletion.cs @@ -358,7 +358,7 @@ namespace System.Management.Automation /// /// Optional options to configure how completion is performed /// Current debugger - /// Command completion + /// Command completion. internal static CommandCompletion CompleteInputInDebugger(Ast ast, Token[] tokens, IScriptPosition cursorPosition, Hashtable options, Debugger debugger) { if (ast == null) diff --git a/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs b/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs index 141eaf259..49e088ce5 100644 --- a/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs +++ b/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs @@ -784,7 +784,7 @@ namespace System.Management.Automation /// Get completion results for operators that start with /// /// The starting text of the operator to complete - /// A list of completion results + /// A list of completion results. public static List CompleteOperator(string wordToComplete) { if (wordToComplete.StartsWith("-", StringComparison.Ordinal)) diff --git a/src/System.Management.Automation/engine/CommandCompletion/PseudoParameterBinder.cs b/src/System.Management.Automation/engine/CommandCompletion/PseudoParameterBinder.cs index e2d21f6ef..35d7879d9 100644 --- a/src/System.Management.Automation/engine/CommandCompletion/PseudoParameterBinder.cs +++ b/src/System.Management.Automation/engine/CommandCompletion/PseudoParameterBinder.cs @@ -944,7 +944,7 @@ namespace System.Management.Automation.Language /// Indicate the type of the piped-in argument /// The CommandParameterAst the cursor is pointing at /// Indicates whether pseudo binding is for argument binding, argument completion, or parameter completion. - /// PseudoBindingInfo + /// PseudoBindingInfo. internal PseudoBindingInfo DoPseudoParameterBinding(CommandAst command, Type pipeArgumentType, CommandParameterAst paramAstAtCursor, BindingType bindingType) { if (command == null) diff --git a/src/System.Management.Automation/engine/CommandInfo.cs b/src/System.Management.Automation/engine/CommandInfo.cs index 4959a5b98..375abc320 100644 --- a/src/System.Management.Automation/engine/CommandInfo.cs +++ b/src/System.Management.Automation/engine/CommandInfo.cs @@ -597,7 +597,7 @@ namespace System.Management.Automation /// algorithm. /// /// The name of the parameter to resolve. - /// The parameter that matches this name + /// The parameter that matches this name. public ParameterMetadata ResolveParameter(string name) { MergedCommandParameterMetadata merged = GetMergedCommandParameterMetadataSafely(); @@ -897,7 +897,7 @@ namespace System.Management.Automation /// /// Returns a String that represents the current PSTypeName. /// - /// String that represents the current PSTypeName. + /// String that represents the current PSTypeName. public override string ToString() { return Name ?? string.Empty; diff --git a/src/System.Management.Automation/engine/CommandProcessor.cs b/src/System.Management.Automation/engine/CommandProcessor.cs index 933ae9063..f02674978 100644 --- a/src/System.Management.Automation/engine/CommandProcessor.cs +++ b/src/System.Management.Automation/engine/CommandProcessor.cs @@ -822,7 +822,7 @@ namespace System.Management.Automation /// /// help target to request /// help category to request - /// true if user requested help; false otherwise + /// true if user requested help; false otherwise. internal override bool IsHelpRequested(out string helpTarget, out HelpCategory helpCategory) { if (this.arguments != null) diff --git a/src/System.Management.Automation/engine/CommandProcessorBase.cs b/src/System.Management.Automation/engine/CommandProcessorBase.cs index 985df26c5..5135fbe81 100644 --- a/src/System.Management.Automation/engine/CommandProcessorBase.cs +++ b/src/System.Management.Automation/engine/CommandProcessorBase.cs @@ -253,7 +253,7 @@ namespace System.Management.Automation /// /// help target to request /// help category to request - /// true if user requested help; false otherwise + /// true if user requested help; false otherwise. internal virtual bool IsHelpRequested(out string helpTarget, out HelpCategory helpCategory) { // by default we don't handle "-?" parameter at all @@ -269,7 +269,7 @@ namespace System.Management.Automation /// context for the command processor /// help target /// help category - /// command processor for "get-help [helpTarget]" + /// Command processor for "get-help [helpTarget]". internal static CommandProcessorBase CreateGetHelpCommandProcessor( ExecutionContext context, string helpTarget, diff --git a/src/System.Management.Automation/engine/CoreAdapter.cs b/src/System.Management.Automation/engine/CoreAdapter.cs index 6f07a1e3a..8785813ed 100644 --- a/src/System.Management.Automation/engine/CoreAdapter.cs +++ b/src/System.Management.Automation/engine/CoreAdapter.cs @@ -86,7 +86,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSMemberInfo from /// name of the member to be retrieved - /// The PSMemberInfo corresponding to memberName from obj + /// The PSMemberInfo corresponding to memberName from obj. protected abstract T GetMember(object obj, string memberName) where T : PSMemberInfo; /// @@ -100,7 +100,7 @@ namespace System.Management.Automation /// to the properties available in it. /// /// object to get all the member information from - /// all members in obj + /// All members in obj. protected abstract PSMemberInfoInternalCollection GetMembers(object obj) where T : PSMemberInfo; #endregion member @@ -111,7 +111,7 @@ namespace System.Management.Automation /// Returns the value from a property coming from a previous call to GetMember /// /// PSProperty coming from a previous call to GetMember - /// The value of the property + /// The value of the property. protected abstract object PropertyGet(PSProperty property); /// @@ -126,14 +126,14 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected abstract bool PropertyIsSettable(PSProperty property); /// /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected abstract bool PropertyIsGettable(PSProperty property); /// @@ -141,21 +141,21 @@ namespace System.Management.Automation /// /// PSProperty obtained in a previous GetMember /// True if the result is for display purposes only - /// the name of the type corresponding to the member + /// The name of the type corresponding to the member. protected abstract string PropertyType(PSProperty property, bool forDisplay); /// /// Returns the string representation of the property in the object /// /// property obtained in a previous GetMember - /// the string representation of the property in the object + /// 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 - /// an array with the property attributes + /// An array with the property attributes. protected abstract AttributeCollection PropertyAttributes(PSProperty property); #endregion property @@ -169,7 +169,7 @@ namespace System.Management.Automation /// the non empty return from GetMethods /// invocation constraints /// the arguments to use - /// the return value for the method + /// The return value for the method. protected virtual object MethodInvoke(PSMethod method, PSMethodInvocationConstraints invocationConstraints, object[] arguments) { return this.MethodInvoke(method, arguments); @@ -181,7 +181,7 @@ namespace System.Management.Automation /// /// the non empty return from GetMethods /// the arguments to use - /// the return value for the method + /// The return value for the method. protected abstract object MethodInvoke(PSMethod method, object[] arguments); /// @@ -194,7 +194,7 @@ namespace System.Management.Automation /// /// Returns the string representation of the method in the object /// - /// the string representation of the method in the object + /// The string representation of the method in the object. protected virtual string MethodToString(PSMethod method) { StringBuilder returnValue = new StringBuilder(); @@ -216,7 +216,7 @@ namespace System.Management.Automation /// Returns the name of the type corresponding to the property's value /// /// property obtained in a previous GetMember - /// the name of the type corresponding to the member + /// The name of the type corresponding to the member. /// /// It is not necessary for derived methods to override this. /// This method is called only if ParameterizedProperties are present. @@ -231,7 +231,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. /// /// It is not necessary for derived methods to override this. /// This method is called only if ParameterizedProperties are present. @@ -246,7 +246,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. /// /// It is not necessary for derived methods to override this. /// This method is called only if ParameterizedProperties are present. @@ -276,7 +276,7 @@ namespace System.Management.Automation /// /// the non empty return from GetMember /// the arguments to use - /// the return value for the property + /// The return value for the property. /// /// It is not necessary for derived methods to override this. /// This method is called only if ParameterizedProperties are present. @@ -307,7 +307,7 @@ namespace System.Management.Automation /// Returns the string representation of the property in the object /// /// property obtained in a previous GetMember - /// the string representation of the property in the object + /// The string representation of the property in the object. /// /// It is not necessary for derived methods to override this. /// This method is called only if ParameterizedProperties are present. @@ -3421,7 +3421,7 @@ namespace System.Management.Automation /// Returns true if a parameterized property should be in a PSMemberInfoCollection of type t /// /// Type of a PSMemberInfoCollection like the type of T in PSMemberInfoCollection of T - /// true if a parameterized property should be in a collection + /// True if a parameterized property should be in a collection. /// /// Usually typeof(T).IsAssignableFrom(typeof(PSParameterizedProperty)) would work like it does /// for PSMethod and PSProperty, but since PSParameterizedProperty derives from PSMethodInfo and @@ -3691,7 +3691,7 @@ namespace System.Management.Automation /// 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 - /// all members in obj + /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { PSMemberInfoInternalCollection returnValue = new PSMemberInfoInternalCollection(); @@ -3711,7 +3711,7 @@ namespace System.Management.Automation /// Returns an array with the property attributes /// /// property we want the attributes from - /// an array with the property attributes + /// An array with the property attributes. protected override AttributeCollection PropertyAttributes(PSProperty property) { PropertyCacheEntry adapterData = (PropertyCacheEntry)property.adapterData; @@ -3722,7 +3722,7 @@ namespace System.Management.Automation /// Returns the string representation of the property in the object /// /// property obtained in a previous GetMember - /// the string representation of the property in the object + /// The string representation of the property in the object. protected override string PropertyToString(PSProperty property) { StringBuilder returnValue = new StringBuilder(); @@ -3753,7 +3753,7 @@ namespace System.Management.Automation /// Returns the value from a property coming from a previous call to GetMember /// /// PSProperty coming from a previous call to GetMember - /// The value of the property + /// The value of the property. protected override object PropertyGet(PSProperty property) { PropertyCacheEntry adapterData = (PropertyCacheEntry)property.adapterData; @@ -3870,7 +3870,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { return !((PropertyCacheEntry)property.adapterData).readOnly; @@ -3880,7 +3880,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { return !((PropertyCacheEntry)property.adapterData).writeOnly; @@ -3891,7 +3891,7 @@ namespace System.Management.Automation /// /// PSProperty obtained in a previous GetMember /// True if the result is for display purposes only - /// the name of the type corresponding to the member + /// The name of the type corresponding to the member. protected override string PropertyType(PSProperty property, bool forDisplay) { var propertyType = ((PropertyCacheEntry)property.adapterData).propertyType; @@ -3908,7 +3908,7 @@ namespace System.Management.Automation /// Calls constructor using the arguments and catching the appropriate exception /// /// final arguments to the constructor - /// the return of 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 @@ -3950,7 +3950,7 @@ namespace System.Management.Automation /// 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 + /// The return of the method. /// if the method throws an exception internal static object AuxiliaryMethodInvoke(object target, object[] arguments, MethodInformation methodInformation, object[] originalArguments) { @@ -4021,7 +4021,7 @@ namespace System.Management.Automation /// Converts a MethodBase[] into a MethodInformation[] /// /// the methods to be converted - /// the MethodInformation[] corresponding to methods + /// The MethodInformation[] corresponding to methods. internal static MethodInformation[] GetMethodInformationArray(MethodBase[] methods) { int methodCount = methods.Length; @@ -4042,7 +4042,7 @@ namespace System.Management.Automation /// method information corresponding to methods /// invocation constraints /// arguments of the call - /// the return of the method + /// The return of the method. /// if the method throws an exception /// if we could not find a method for the given arguments internal static object MethodInvokeDotNet( @@ -4071,7 +4071,7 @@ namespace System.Management.Automation /// the type being constructed, used for diagnostics and caching /// all overloads for the constructors /// arguments of the call - /// the return of the method + /// The return of the method. /// 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) @@ -4236,7 +4236,7 @@ namespace System.Management.Automation /// /// the non empty return from GetMethods /// the arguments to use - /// the return value for the method + /// The return value for the method. protected override object MethodInvoke(PSMethod method, object[] arguments) { return this.MethodInvoke(method, null, arguments); @@ -4249,7 +4249,7 @@ namespace System.Management.Automation /// the non empty return from GetMethods /// invocation constraints /// the arguments to use - /// the return value for the method + /// The return value for the method. protected override object MethodInvoke(PSMethod method, PSMethodInvocationConstraints invocationConstraints, object[] arguments) { MethodCacheEntry methodEntry = (MethodCacheEntry)method.adapterData; @@ -4285,7 +4285,7 @@ namespace System.Management.Automation /// Returns the name of the type corresponding to the property's value /// /// property obtained in a previous GetMember - /// the name of the type corresponding to the member + /// The name of the type corresponding to the member. protected override string ParameterizedPropertyType(PSParameterizedProperty property) { var adapterData = (ParameterizedPropertyCacheEntry)property.adapterData; @@ -4296,7 +4296,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected override bool ParameterizedPropertyIsSettable(PSParameterizedProperty property) { return !((ParameterizedPropertyCacheEntry)property.adapterData).readOnly; @@ -4306,7 +4306,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected override bool ParameterizedPropertyIsGettable(PSParameterizedProperty property) { return !((ParameterizedPropertyCacheEntry)property.adapterData).writeOnly; @@ -4317,7 +4317,7 @@ namespace System.Management.Automation /// /// the non empty return from GetMember /// the arguments to use - /// the return value for the property + /// The return value for the property. protected override object ParameterizedPropertyGet(PSParameterizedProperty property, object[] arguments) { var adapterData = (ParameterizedPropertyCacheEntry)property.adapterData; @@ -4357,7 +4357,7 @@ namespace System.Management.Automation /// Returns the string representation of the property in the object /// /// property obtained in a previous GetMember - /// the string representation of the property in the object + /// The string representation of the property in the object. protected override string ParameterizedPropertyToString(PSParameterizedProperty property) { StringBuilder returnValue = new StringBuilder(); @@ -4494,7 +4494,7 @@ namespace System.Management.Automation /// Returns an array with the property attributes /// /// property we want the attributes from - /// an array with the property attributes + /// An array with the property attributes. protected override AttributeCollection PropertyAttributes(PSProperty property) { return new AttributeCollection(); @@ -4504,7 +4504,7 @@ namespace System.Management.Automation /// Returns the value from a property coming from a previous call to GetMember /// /// PSProperty coming from a previous call to GetMember - /// The value of the property + /// The value of the property. protected override object PropertyGet(PSProperty property) { Diagnostics.Assert(false, "redirection adapter is not called for properties"); @@ -4527,7 +4527,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { Diagnostics.Assert(false, "redirection adapter is not called for properties"); @@ -4538,7 +4538,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { Diagnostics.Assert(false, "redirection adapter is not called for properties"); @@ -4550,7 +4550,7 @@ namespace System.Management.Automation /// /// PSProperty obtained in a previous GetMember /// True if the result is for display purposes only - /// the name of the type corresponding to the member + /// The name of the type corresponding to the member. protected override string PropertyType(PSProperty property, bool forDisplay) { Diagnostics.Assert(false, "redirection adapter is not called for properties"); @@ -4561,7 +4561,7 @@ namespace System.Management.Automation /// Returns the string representation of the property in the object /// /// property obtained in a previous GetMember - /// the string representation of the property in the object + /// The string representation of the property in the object. protected override string PropertyToString(PSProperty property) { Diagnostics.Assert(false, "redirection adapter is not called for properties"); @@ -4578,7 +4578,7 @@ namespace System.Management.Automation /// /// the non empty return from GetMethods /// the arguments to use - /// the return value for the method + /// The return value for the method. protected override object MethodInvoke(PSMethod method, object[] arguments) { Diagnostics.Assert(false, "redirection adapter is not called for methods"); @@ -4622,7 +4622,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSMemberInfo from /// name of the member to be retrieved - /// The PSMemberInfo corresponding to memberName from obj + /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { return ((PSObject)obj).Members[memberName] as T; @@ -4639,7 +4639,7 @@ namespace System.Management.Automation /// to the properties available in it. /// /// object to get all the member information from - /// all members in obj + /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { var returnValue = new PSMemberInfoInternalCollection(); @@ -4681,7 +4681,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSMemberInfo from /// name of the member to be retrieved - /// The PSMemberInfo corresponding to memberName from obj + /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { return ((PSMemberSet)obj).Members[memberName] as T; @@ -4698,7 +4698,7 @@ namespace System.Management.Automation /// to the properties available in it. /// /// object to get all the member information from - /// all members in obj + /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { var returnValue = new PSMemberInfoInternalCollection(); @@ -4753,7 +4753,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSProperty from /// name of the property to be retrieved - /// The PSProperty corresponding to propertyName from obj + /// The PSProperty corresponding to propertyName from obj. protected abstract PSProperty DoGetProperty(object obj, string propertyName); /// @@ -4769,7 +4769,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSMemberInfo from /// name of the member to be retrieved - /// The PSMemberInfo corresponding to memberName from obj + /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { PSProperty property = DoGetProperty(obj, memberName); @@ -4815,7 +4815,7 @@ namespace System.Management.Automation /// to the properties available in it. /// /// object to get all the member information from - /// all members in obj + /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { var returnValue = new PSMemberInfoInternalCollection(); @@ -4947,7 +4947,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSProperty from /// name of the property to be retrieved - /// The PSProperty corresponding to propertyName from obj + /// The PSProperty corresponding to propertyName from obj. protected override PSProperty DoGetProperty(object obj, string propertyName) { XmlNode[] nodes = FindNodes(obj, propertyName, StringComparison.OrdinalIgnoreCase); @@ -4963,7 +4963,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { XmlNode[] nodes = (XmlNode[])property.adapterData; @@ -5008,7 +5008,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { return true; @@ -5056,7 +5056,7 @@ namespace System.Management.Automation /// Returns the value from a property coming from a previous call to DoGetProperty /// /// PSProperty coming from a previous call to DoGetProperty - /// The value of the property + /// The value of the property. protected override object PropertyGet(PSProperty property) { XmlNode[] nodes = (XmlNode[])property.adapterData; @@ -5143,7 +5143,7 @@ namespace System.Management.Automation /// /// PSProperty obtained in a previous DoGetProperty /// True if the result is for display purposes only - /// the name of the type corresponding to the property + /// The name of the type corresponding to the property. protected override string PropertyType(PSProperty property, bool forDisplay) { object value = null; @@ -5167,7 +5167,7 @@ namespace System.Management.Automation /// XmlNode to extract property from /// property to look for /// type pf comparison to perform - /// the corresponding XmlNode or null if not present + /// The corresponding XmlNode or null if not present. private static XmlNode[] FindNodes(object obj, string propertyName, StringComparison comparisonType) { List retValue = new List(); @@ -5235,7 +5235,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSProperty from /// name of the property to be retrieved - /// The PSProperty corresponding to propertyName from obj + /// The PSProperty corresponding to propertyName from obj. protected override PSProperty DoGetProperty(object obj, string propertyName) { DataRow dataRow = (DataRow)obj; @@ -5254,7 +5254,7 @@ namespace System.Management.Automation /// /// PSProperty obtained in a previous DoGetProperty /// True if the result is for display purposes only - /// the name of the type corresponding to the property + /// The name of the type corresponding to the property. protected override string PropertyType(PSProperty property, bool forDisplay) { string columnName = (string)property.adapterData; @@ -5267,7 +5267,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { string columnName = (string)property.adapterData; @@ -5279,7 +5279,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { return true; @@ -5289,7 +5289,7 @@ namespace System.Management.Automation /// Returns the value from a property coming from a previous call to DoGetProperty /// /// PSProperty coming from a previous call to DoGetProperty - /// The value of the property + /// The value of the property. protected override object PropertyGet(PSProperty property) { DataRow dataRow = (DataRow)property.baseObject; @@ -5342,7 +5342,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSProperty from /// name of the property to be retrieved - /// The PSProperty corresponding to propertyName from obj + /// The PSProperty corresponding to propertyName from obj. protected override PSProperty DoGetProperty(object obj, string propertyName) { DataRowView dataRowView = (DataRowView)obj; @@ -5361,7 +5361,7 @@ namespace System.Management.Automation /// /// PSProperty obtained in a previous DoGetProperty /// True if the result is for display purposes only - /// the name of the type corresponding to the property + /// The name of the type corresponding to the property. protected override string PropertyType(PSProperty property, bool forDisplay) { string columnName = (string)property.adapterData; @@ -5374,7 +5374,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { string columnName = (string)property.adapterData; @@ -5386,7 +5386,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { return true; @@ -5396,7 +5396,7 @@ namespace System.Management.Automation /// Returns the value from a property coming from a previous call to DoGetProperty /// /// PSProperty coming from a previous call to DoGetProperty - /// The value of the property + /// The value of the property. protected override object PropertyGet(PSProperty property) { DataRowView dataRowView = (DataRowView)property.baseObject; diff --git a/src/System.Management.Automation/engine/DataStoreAdapter.cs b/src/System.Management.Automation/engine/DataStoreAdapter.cs index 46fd4a7ec..909077efd 100644 --- a/src/System.Management.Automation/engine/DataStoreAdapter.cs +++ b/src/System.Management.Automation/engine/DataStoreAdapter.cs @@ -808,7 +808,7 @@ namespace System.Management.Automation /// /// Gets the hash code for this instance. /// - /// The result of base.GetHashCode() + /// The result of base.GetHashCode(). /// public override int GetHashCode() diff --git a/src/System.Management.Automation/engine/DefaultCommandRuntime.cs b/src/System.Management.Automation/engine/DefaultCommandRuntime.cs index bcbca6e2d..09e7fd21b 100644 --- a/src/System.Management.Automation/engine/DefaultCommandRuntime.cs +++ b/src/System.Management.Automation/engine/DefaultCommandRuntime.cs @@ -137,7 +137,7 @@ namespace System.Management.Automation /// Default implementation - always returns true. /// /// ignored - /// true + /// True. public bool ShouldProcess(string target) { return true; } /// @@ -145,7 +145,7 @@ namespace System.Management.Automation /// /// ignored /// ignored - /// true + /// True. public bool ShouldProcess(string target, string action) { return true; } /// @@ -154,7 +154,7 @@ namespace System.Management.Automation /// ignored /// ignored /// ignored - /// true + /// True. public bool ShouldProcess(string verboseDescription, string verboseWarning, string caption) { return true; } /// @@ -164,7 +164,7 @@ namespace System.Management.Automation /// ignored /// ignored /// ignored - /// true + /// True. public bool ShouldProcess(string verboseDescription, string verboseWarning, string caption, out ShouldProcessReason shouldProcessReason) { shouldProcessReason = ShouldProcessReason.None; return true; } /// @@ -172,7 +172,7 @@ namespace System.Management.Automation /// /// ignored /// ignored - /// true + /// True. public bool ShouldContinue(string query, string caption) { return true; } /// @@ -182,7 +182,7 @@ namespace System.Management.Automation /// ignored /// ignored /// ignored - /// true + /// True. public bool ShouldContinue(string query, string caption, ref bool yesToAll, ref bool noToAll) { return true; } /// @@ -193,7 +193,7 @@ namespace System.Management.Automation /// ignored /// ignored /// ignored - /// true + /// True. public bool ShouldContinue(string query, string caption, bool hasSecurityImpact, ref bool yesToAll, ref bool noToAll) { return true; } #endregion Should diff --git a/src/System.Management.Automation/engine/EnumMinimumDisambiguation.cs b/src/System.Management.Automation/engine/EnumMinimumDisambiguation.cs index b2d308f61..ed92e15f9 100644 --- a/src/System.Management.Automation/engine/EnumMinimumDisambiguation.cs +++ b/src/System.Management.Automation/engine/EnumMinimumDisambiguation.cs @@ -32,7 +32,7 @@ namespace System.Management.Automation /// /// Perform disambiguation on enum names /// - /// complete enum name after disambiguation + /// Complete enum name after disambiguation. internal static string EnumDisambiguate(string text, Type enumType) { // Get all enum names in the given enum type diff --git a/src/System.Management.Automation/engine/ErrorPackage.cs b/src/System.Management.Automation/engine/ErrorPackage.cs index d90fe000d..d0819d9e9 100644 --- a/src/System.Management.Automation/engine/ErrorPackage.cs +++ b/src/System.Management.Automation/engine/ErrorPackage.cs @@ -353,7 +353,7 @@ namespace System.Management.Automation /// concise text description based on /// /// - /// concise text description + /// Concise text description. /// /// GetMessage returns a concise string which categorizes the error, /// based on @@ -384,7 +384,7 @@ namespace System.Management.Automation /// /// /// Culture in which to display message - /// concise text description + /// Concise text description. /// /// GetMessage returns a concise string which categorizes the error, /// based on @@ -455,7 +455,7 @@ namespace System.Management.Automation /// Same as /// /// - /// developer-readable identifier + /// Developer-readable identifier. public override string ToString() { return GetMessage(CultureInfo.CurrentUICulture); @@ -476,7 +476,7 @@ namespace System.Management.Automation /// /// culture to retrieve template if needed /// original string - /// Ellipsized version of string + /// Ellipsized version of string. /// /// "Please do not make this public as ellipsize is not a word." /// @@ -693,7 +693,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected ErrorDetails(SerializationInfo info, StreamingContext context) { @@ -785,7 +785,7 @@ namespace System.Management.Automation /// /// As /// - /// developer-readable identifier + /// Developer-readable identifier. public override string ToString() { return Message; @@ -1027,7 +1027,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. /// /// ErrorRecord instances which are serialized using /// @@ -1689,7 +1689,7 @@ namespace System.Management.Automation /// /// As /// - /// developer-readable identifier + /// Developer-readable identifier. public override string ToString() { if (ErrorDetails != null @@ -1843,7 +1843,7 @@ namespace System.Management.Automation /// /// the base resource name /// the resource id - /// the error message template string corresponding to baseName and resourceId + /// The error message template string corresponding to baseName and resourceId. string GetResourceString(string baseName, string resourceId); } } diff --git a/src/System.Management.Automation/engine/ExecutionContext.cs b/src/System.Management.Automation/engine/ExecutionContext.cs index edd510cee..eb0f0d9a1 100644 --- a/src/System.Management.Automation/engine/ExecutionContext.cs +++ b/src/System.Management.Automation/engine/ExecutionContext.cs @@ -679,7 +679,7 @@ namespace System.Management.Automation /// /// The name of the command to lookup /// - /// The command processor object + /// The command processor object. internal CommandProcessorBase CreateCommand(string command, bool dotSource) { CommandOrigin commandOrigin = this.EngineSessionState.CurrentScope.ScopeOrigin; @@ -1642,7 +1642,7 @@ namespace System.Management.Automation /// /// The event sender /// The event args - /// The resolve assembly or null if not found + /// The resolve assembly or null if not found. private static Assembly PowerShellAssemblyResolveHandler(object sender, ResolveEventArgs args) { ExecutionContext ecFromTLS = Runspaces.LocalPipeline.GetExecutionContextFromTLS(); diff --git a/src/System.Management.Automation/engine/ExtraAdapter.cs b/src/System.Management.Automation/engine/ExtraAdapter.cs index bbb894371..3209d3315 100644 --- a/src/System.Management.Automation/engine/ExtraAdapter.cs +++ b/src/System.Management.Automation/engine/ExtraAdapter.cs @@ -41,7 +41,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSMemberInfo from /// name of the member to be retrieved - /// The PSMemberInfo corresponding to memberName from obj + /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { PSProperty property; @@ -133,7 +133,7 @@ namespace System.Management.Automation /// to the properties available in it. /// /// object to get all the member information from - /// all members in obj + /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { DirectoryEntry entry = (DirectoryEntry)obj; @@ -176,7 +176,7 @@ namespace System.Management.Automation /// Returns the value from a property coming from a previous call to GetMember /// /// PSProperty coming from a previous call to GetMember - /// The value of the property + /// The value of the property. protected override object PropertyGet(PSProperty property) { return property.adapterData; @@ -254,7 +254,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { return true; @@ -264,7 +264,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { return true; @@ -275,7 +275,7 @@ namespace System.Management.Automation /// /// PSProperty obtained in a previous GetMember /// True if the result is for display purposes only - /// the name of the type corresponding to the member + /// The name of the type corresponding to the member. protected override string PropertyType(PSProperty property, bool forDisplay) { object value = null; @@ -306,7 +306,7 @@ namespace System.Management.Automation /// /// the non empty return from GetMethods /// the arguments to use - /// the return value for the method + /// The return value for the method. protected override object MethodInvoke(PSMethod method, object[] arguments) { ParameterInformation[] parameters = new ParameterInformation[arguments.Length]; @@ -365,7 +365,7 @@ namespace System.Management.Automation /// /// Returns the string representation of the method in the object /// - /// the string representation of the method in the object + /// The string representation of the method in the object. protected override string MethodToString(PSMethod method) { StringBuilder returnValue = new StringBuilder(); diff --git a/src/System.Management.Automation/engine/ICommandRuntime.cs b/src/System.Management.Automation/engine/ICommandRuntime.cs index cd792a2da..cbec49958 100644 --- a/src/System.Management.Automation/engine/ICommandRuntime.cs +++ b/src/System.Management.Automation/engine/ICommandRuntime.cs @@ -616,4 +616,4 @@ namespace System.Management.Automation [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference")] bool ShouldContinue(string query, string caption, bool hasSecurityImpact, ref bool yesToAll, ref bool noToAll); } -} \ No newline at end of file +} diff --git a/src/System.Management.Automation/engine/InformationRecord.cs b/src/System.Management.Automation/engine/InformationRecord.cs index faee9257a..4c41e29fb 100644 --- a/src/System.Management.Automation/engine/InformationRecord.cs +++ b/src/System.Management.Automation/engine/InformationRecord.cs @@ -204,7 +204,7 @@ namespace System.Management.Automation /// Returns this object as a PSObject property bag /// that can be used in a remoting protocol data object. /// - /// This object as a PSObject property bag + /// This object as a PSObject property bag. internal PSObject ToPSObjectForRemoting() { PSObject informationAsPSObject = RemotingEncoder.CreateEmptyPSObject(); diff --git a/src/System.Management.Automation/engine/InitialSessionState.cs b/src/System.Management.Automation/engine/InitialSessionState.cs index d84d96a69..b2304d169 100644 --- a/src/System.Management.Automation/engine/InitialSessionState.cs +++ b/src/System.Management.Automation/engine/InitialSessionState.cs @@ -227,7 +227,7 @@ namespace System.Management.Automation.Runspaces /// /// Shallow-clone this object. /// - /// The cloned object + /// The cloned object. public override InitialSessionStateEntry Clone() { SessionStateTypeEntry entry; @@ -408,7 +408,7 @@ namespace System.Management.Automation.Runspaces /// /// Shallow-clone this object. /// - /// The cloned object + /// The cloned object. public override InitialSessionStateEntry Clone() { SessionStateAssemblyEntry entry = new SessionStateAssemblyEntry(Name, FileName); @@ -550,7 +550,7 @@ namespace System.Management.Automation.Runspaces /// /// Shallow-clone this object... /// - /// The cloned object + /// The cloned object. public override InitialSessionStateEntry Clone() { SessionStateScriptEntry entry = new SessionStateScriptEntry(Path, Visibility); @@ -629,7 +629,7 @@ namespace System.Management.Automation.Runspaces /// /// Shallow-clone this object... /// - /// The cloned object + /// The cloned object. public override InitialSessionStateEntry Clone() { SessionStateAliasEntry entry = new SessionStateAliasEntry(Name, Definition, Description, Options, Visibility); @@ -685,7 +685,7 @@ namespace System.Management.Automation.Runspaces /// /// Shallow-clone this object... /// - /// The cloned object + /// The cloned object. public override InitialSessionStateEntry Clone() { SessionStateApplicationEntry entry = new SessionStateApplicationEntry(Path, Visibility); @@ -923,7 +923,7 @@ namespace System.Management.Automation.Runspaces /// /// Shallow-clone this object... /// - /// The cloned object + /// The cloned object. public override InitialSessionStateEntry Clone() { // Copy the attribute collection if necessary... diff --git a/src/System.Management.Automation/engine/InternalCommands.cs b/src/System.Management.Automation/engine/InternalCommands.cs index 180b6f5c2..3b920a83e 100644 --- a/src/System.Management.Automation/engine/InternalCommands.cs +++ b/src/System.Management.Automation/engine/InternalCommands.cs @@ -1708,7 +1708,7 @@ namespace Microsoft.PowerShell.Commands /// /// Get the value based on the given property name /// - /// the value of the property + /// The value of the property. private object GetValue(ref bool error) { if (LanguagePrimitives.IsNull(InputObject)) diff --git a/src/System.Management.Automation/engine/LanguagePrimitives.cs b/src/System.Management.Automation/engine/LanguagePrimitives.cs index 3002c04a2..683bfcade 100644 --- a/src/System.Management.Automation/engine/LanguagePrimitives.cs +++ b/src/System.Management.Automation/engine/LanguagePrimitives.cs @@ -95,7 +95,7 @@ namespace System.Management.Automation /// one of the types supported by this converter to which the parameter should be converted to /// The format provider to use like in IFormattable's ToString /// true if case should be ignored - /// the parameter converted to the parameter using formatProvider and ignoreCase + /// The parameter converted to the parameter using formatProvider and ignoreCase. /// if no conversion was possible public abstract object ConvertFrom(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase); @@ -106,7 +106,7 @@ namespace System.Management.Automation /// one of the types supported by this converter to which the parameter should be converted to /// The format provider to use like in IFormattable's ToString /// true if case should be ignored - /// the parameter converted to the parameter using formatProvider and ignoreCase + /// The parameter converted to the parameter using formatProvider and ignoreCase. /// if no conversion was possible public virtual object ConvertFrom(PSObject sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { @@ -139,7 +139,7 @@ namespace System.Management.Automation /// type to convert the parameter, supposedly not one of the types supported by the converter /// The format provider to use like in IFormattable's ToString /// true if case should be ignored - /// sourceValue converted to the parameter using formatProvider and ignoreCase + /// SourceValue converted to the parameter using formatProvider and ignoreCase. /// if no conversion was possible public abstract object ConvertTo(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase); @@ -150,7 +150,7 @@ namespace System.Management.Automation /// type to convert the parameter, supposedly not one of the types supported by the converter /// The format provider to use like in IFormattable's ToString /// true if case should be ignored - /// sourceValue converted to the parameter using formatProvider and ignoreCase + /// SourceValue converted to the parameter using formatProvider and ignoreCase. /// if no conversion was possible public virtual object ConvertTo(PSObject sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { @@ -173,7 +173,7 @@ namespace System.Management.Automation /// /// value to convert from /// ignored - /// false only if sourceValue is string + /// False only if sourceValue is string. public override bool CanConvertFrom(object sourceValue, Type destinationType) { // This if avoids infinite recursion. @@ -193,7 +193,7 @@ namespace System.Management.Automation /// The type this converter is associated with /// The IFormatProvider to use /// true if case should be ignored - /// sourceValue converted to destinationType + /// SourceValue converted to destinationType. /// When no conversion was possible public override object ConvertFrom(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { @@ -207,7 +207,7 @@ namespace System.Management.Automation /// /// The value to convert from /// The value to convert from - /// false + /// False. public override bool CanConvertTo(object sourceValue, Type destinationType) { return false; @@ -588,7 +588,7 @@ namespace System.Management.Automation /// /// first object /// object to compare first to - /// true if first is equal to the second + /// True if first is equal to the second. public static new bool Equals(object first, object second) { return Equals(first, second, false, CultureInfo.InvariantCulture); @@ -601,7 +601,7 @@ namespace System.Management.Automation /// 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 + /// True if first is equal to the second. public static bool Equals(object first, object second, bool ignoreCase) { return Equals(first, second, ignoreCase, CultureInfo.InvariantCulture); @@ -617,7 +617,7 @@ namespace System.Management.Automation /// the format/culture to be used. If this parameter is null, /// CultureInfo.InvariantCulture will be used. /// - /// true if first is equal to the second + /// True if first is equal to the second. public static bool Equals(object first, object second, bool ignoreCase, IFormatProvider formatProvider) { // If both first and second are null it returns true. @@ -731,8 +731,8 @@ namespace System.Management.Automation /// /// 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 + /// Less than zero if first is smaller than second, more than + /// zero if it is greater or zero if they are the same. /// /// does not implement IComparable or cannot be converted /// to the type of . @@ -749,8 +749,8 @@ namespace System.Management.Automation /// 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 + /// Less than zero if first is smaller than second, more than + /// zero if it is greater or zero if they are the same. /// /// does not implement IComparable or cannot be converted /// to the type of . @@ -768,8 +768,8 @@ namespace System.Management.Automation /// second comparison value /// Used if both values are strings /// Used in type conversions and if both values are strings - /// less than zero if first is smaller than second, more than - /// zero if it is greater or zero if they are the same + /// Less than zero if first is smaller than second, more than + /// zero if it is greater or zero if they are the same. /// /// does not implement IComparable or cannot be converted /// to the type of . @@ -980,7 +980,7 @@ namespace System.Management.Automation /// Returns true if the language considers obj to be true /// /// obj to verify if it is true - /// true if obj 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) { @@ -1062,7 +1062,7 @@ namespace System.Management.Automation /// Internal routine that determines if an object meets any of our criteria for null. /// /// The object to test - /// true if the object is null + /// True if the object is null. internal static bool IsNull(object obj) { return (obj == null || obj == AutomationNull.Value); @@ -1264,7 +1264,7 @@ namespace System.Management.Automation /// Verifies if type is a signed integer /// /// type code to check - /// true if type is a signed integer, false otherwise + /// True if type is a signed integer, false otherwise. internal static bool IsSignedInteger(TypeCode typeCode) { return (s_typeCodeTraits[(int)typeCode] & TypeCodeTraits.SignedInteger) != 0; @@ -1274,7 +1274,7 @@ namespace System.Management.Automation /// Verifies if type is an unsigned integer /// /// type code to check - /// true if type is an unsigned integer, false otherwise + /// True if type is an unsigned integer, false otherwise. internal static bool IsUnsignedInteger(TypeCode typeCode) { return (s_typeCodeTraits[(int)typeCode] & TypeCodeTraits.UnsignedInteger) != 0; @@ -1284,7 +1284,7 @@ namespace System.Management.Automation /// Verifies if type is integer /// /// type code to check - /// true if type is integer, false otherwise + /// True if type is integer, false otherwise. internal static bool IsInteger(TypeCode typeCode) { return (s_typeCodeTraits[(int)typeCode] & TypeCodeTraits.Integer) != 0; @@ -1294,7 +1294,7 @@ namespace System.Management.Automation /// Verifies if type is a floating point number /// /// type code to check - /// true if type is floating point, false otherwise + /// True if type is floating point, false otherwise. internal static bool IsFloating(TypeCode typeCode) { return (s_typeCodeTraits[(int)typeCode] & TypeCodeTraits.Floating) != 0; @@ -1304,7 +1304,7 @@ namespace System.Management.Automation /// Verifies if type is an integer or floating point number /// /// type code to check - /// true if type is integer or floating point, false otherwise + /// True if type is integer or floating point, false otherwise. internal static bool IsNumeric(TypeCode typeCode) { return (s_typeCodeTraits[(int)typeCode] & TypeCodeTraits.Numeric) != 0; @@ -1314,7 +1314,7 @@ namespace System.Management.Automation /// Verifies if type is a CIM intrinsic type /// /// type code to check - /// true if type is CIM intrinsic type, false otherwise + /// True if type is CIM intrinsic type, false otherwise. internal static bool IsCimIntrinsicScalarType(TypeCode typeCode) { return (s_typeCodeTraits[(int)typeCode] & TypeCodeTraits.CimIntrinsicType) != 0; @@ -1346,7 +1346,7 @@ namespace System.Management.Automation /// Verifies if type is one of the boolean types /// /// type to check - /// true if type is one of boolean types, false otherwise + /// True if type is one of boolean types, false otherwise. internal static bool IsBooleanType(Type type) { if (type == typeof(bool) || @@ -1360,7 +1360,7 @@ namespace System.Management.Automation /// Verifies if type is one of switch parameter types /// /// type to check - /// true if type is one of switch parameter types, false otherwise + /// True if type is one of switch parameter types, false otherwise. internal static bool IsSwitchParameterType(Type type) { if (type == typeof(SwitchParameter) || type == typeof(SwitchParameter?)) @@ -1373,8 +1373,8 @@ namespace System.Management.Automation /// Verifies if type is one of boolean or switch parameter types /// /// type to check - /// true if type if one of boolean or switch parameter types, - /// false otherwise + /// True if type if one of boolean or switch parameter types, + /// false otherwise. internal static bool IsBoolOrSwitchParameterType(Type type) { if (IsBooleanType(type) || IsSwitchParameterType(type)) @@ -1680,7 +1680,7 @@ namespace System.Management.Automation /// /// value to be converted and returned /// type to convert valueToConvert - /// converted value + /// Converted value. /// if resultType is null /// if the conversion failed public static object ConvertTo(object valueToConvert, Type resultType) @@ -1736,7 +1736,7 @@ namespace System.Management.Automation /// 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 + /// Converted value. /// if resultType is null /// if the conversion failed public static object ConvertTo(object valueToConvert, Type resultType, IFormatProvider formatProvider) @@ -1752,7 +1752,7 @@ namespace System.Management.Automation /// 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. - /// converted value. + /// Converted value. public static object ConvertPSObjectToType(PSObject valueToConvert, Type resultType, bool recursion, IFormatProvider formatProvider, bool ignoreUnknownMembers) { if (valueToConvert != null) @@ -1789,7 +1789,7 @@ namespace System.Management.Automation /// /// 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 + /// False for conversion failure, true for success. public static bool TryConvertTo(object valueToConvert, out T result) { if (valueToConvert is T value) @@ -1810,7 +1810,7 @@ namespace System.Management.Automation /// 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 + /// False for conversion failure, true for success. public static bool TryConvertTo(object valueToConvert, IFormatProvider formatProvider, out T result) { result = default(T); @@ -1833,7 +1833,7 @@ namespace System.Management.Automation /// 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 + /// False for conversion failure, true for success. public static bool TryConvertTo(object valueToConvert, Type resultType, out object result) { return TryConvertTo(valueToConvert, resultType, CultureInfo.InvariantCulture, out result); @@ -1850,7 +1850,7 @@ namespace System.Management.Automation /// 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. + /// False for conversion failure, true for success. public static bool TryConvertTo(object valueToConvert, Type resultType, IFormatProvider formatProvider, out object result) { result = null; @@ -2255,7 +2255,7 @@ namespace System.Management.Automation /// 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 + /// A cast operator method, or null if not found. private static MethodInfo FindCastOperator(string methodName, Type targetType, Type originalType, Type resultType) { using (typeConversion.TraceScope("Looking for \"{0}\" cast operator.", methodName)) @@ -4719,7 +4719,7 @@ namespace System.Management.Automation /// LocalPipeline.ExecutionContextFromTLS() might return null..In which case this /// TypeTable will be used to do the conversion. /// - /// the value converted + /// The value converted. /// if resultType is null /// if the conversion failed internal static object ConvertTo(object valueToConvert, diff --git a/src/System.Management.Automation/engine/ManagementObjectAdapter.cs b/src/System.Management.Automation/engine/ManagementObjectAdapter.cs index d77a315bc..ecaf177aa 100644 --- a/src/System.Management.Automation/engine/ManagementObjectAdapter.cs +++ b/src/System.Management.Automation/engine/ManagementObjectAdapter.cs @@ -165,7 +165,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSMemberInfo from /// name of the member to be retrieved - /// The PSMemberInfo corresponding to memberName from obj + /// The PSMemberInfo corresponding to memberName from obj. protected override T GetMember(object obj, string memberName) { tracer.WriteLine("Getting member with name {0}", memberName); @@ -209,7 +209,7 @@ namespace System.Management.Automation /// to the properties available in it. /// /// object to get all the member information from - /// all members in obj + /// All members in obj. protected override PSMemberInfoInternalCollection GetMembers(object obj) { // obj should never be null @@ -228,7 +228,7 @@ namespace System.Management.Automation /// /// the non empty return from GetMethods /// the arguments to use - /// the return value for the method + /// The return value for the method. protected override object MethodInvoke(PSMethod method, object[] arguments) { ManagementObject mgmtObject = method.baseObject as ManagementObject; @@ -258,7 +258,7 @@ namespace System.Management.Automation /// Returns true if the property is settable /// /// property to check - /// true if the property is settable + /// True if the property is settable. protected override bool PropertyIsSettable(PSProperty property) { ManagementBaseObject mObj = property.baseObject as ManagementBaseObject; @@ -294,7 +294,7 @@ namespace System.Management.Automation /// Returns true if the property is gettable /// /// property to check - /// true if the property is gettable + /// True if the property is gettable. protected override bool PropertyIsGettable(PSProperty property) { return true; @@ -305,7 +305,7 @@ namespace System.Management.Automation /// /// PSProperty obtained in a previous DoGetProperty /// True if the result is for display purposes only - /// the name of the type corresponding to the property + /// The name of the type corresponding to the property. protected override string PropertyType(PSProperty property, bool forDisplay) { PropertyData pd = property.adapterData as PropertyData; @@ -337,7 +337,7 @@ namespace System.Management.Automation /// Returns the value from a property coming from a previous call to DoGetProperty /// /// PSProperty coming from a previous call to DoGetProperty - /// The value of the property + /// The value of the property. protected override object PropertyGet(PSProperty property) { PropertyData pd = property.adapterData as PropertyData; @@ -389,7 +389,7 @@ namespace System.Management.Automation /// Returns the string representation of the property in the object /// /// property obtained in a previous GetMember - /// the string representation of the property in the object + /// The string representation of the property in the object. protected override string PropertyToString(PSProperty property) { StringBuilder returnValue = new StringBuilder(); @@ -420,7 +420,7 @@ namespace System.Management.Automation /// Returns an array with the property attributes /// /// property we want the attributes from - /// an array with the property attributes + /// An array with the property attributes. protected override AttributeCollection PropertyAttributes(PSProperty property) { return null; @@ -914,7 +914,7 @@ namespace System.Management.Automation /// /// object to retrieve the PSProperty from /// name of the property to be retrieved - /// The PSProperty corresponding to propertyName from obj + /// 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 dc69c4cd4..e2984a137 100644 --- a/src/System.Management.Automation/engine/MinishellParameterBinderController.cs +++ b/src/System.Management.Automation/engine/MinishellParameterBinderController.cs @@ -297,7 +297,7 @@ namespace System.Management.Automation /// /// Name of the parameter for error messages. Value should be -inputFormat or -outputFormat /// value to process - /// Processed value + /// 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 dad909793..9ed56d70d 100644 --- a/src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs +++ b/src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs @@ -1379,7 +1379,7 @@ namespace Microsoft.PowerShell.Commands /// Helper function to generate fake PSModuleInfo objects from ModuleSpecification objects. /// /// Collection of ModuleSpecification objects - /// Collection of fake PSModuleInfo objects + /// Collection of fake PSModuleInfo objects. private IEnumerable CreateFakeModuleObject(IEnumerable moduleSpecs) { foreach (ModuleSpecification moduleSpec in moduleSpecs) @@ -2979,7 +2979,7 @@ namespace Microsoft.PowerShell.Commands ImportModuleOptions nestedModuleOptions = new ImportModuleOptions(); // If the nested manifest explicitly (no wildcards) specifies functions to be exported then allow all functions to be exported - // into the session state function table (regardless of language boundaries), because the manifest will filter them later to the + // into the session state function table (regardless of language boundaries), because the manifest will filter them later to the // specified function list. nestedModuleOptions.AllowNestedModuleFunctionsToExport = ((exportedFunctions != null) && !exportedFunctionsContainsWildcards); @@ -3094,13 +3094,13 @@ namespace Microsoft.PowerShell.Commands { bool found; newManifestInfo = LoadModuleNamedInManifest( - parentModule: null, + parentModule: null, moduleSpecification: new ModuleSpecification(actualRootModule), - moduleBase: moduleBase, + moduleBase: moduleBase, searchModulePath: false, - prefix: resolvedCommandPrefix, - ss: ss, - options: options, + prefix: resolvedCommandPrefix, + ss: ss, + options: options, manifestProcessingFlags: manifestProcessingFlags, loadTypesFiles: (exportedTypeFiles == null || 0 == exportedTypeFiles.Count), // If types files already loaded, don't load snapin files loadFormatFiles: (exportedFormatFiles == null || 0 == exportedFormatFiles.Count), // if format files already loaded, don't load snapin files @@ -3437,7 +3437,7 @@ namespace Microsoft.PowerShell.Commands // implicitly export functions and cmdlets. if ((ss != null) && (!ss.Internal.UseExportList)) { - // For cross language boundaries, implicitly import all functions only if + // For cross language boundaries, implicitly import all functions only if // this manifest *does* exort functions explicitly. List fnMatchPattern = ( (manifestScriptInfo.DefiningLanguageMode == PSLanguageMode.FullLanguage) && @@ -3744,7 +3744,7 @@ namespace Microsoft.PowerShell.Commands /// Either a string or a hash of ModuleName, optional Guid, and ModuleVersion. /// The reason the module failed to load, or null on success. /// Sets if the module/snapin is already present. - /// null if the module is not loaded or loadElements is false, the loaded module otherwise. + /// Null if the module is not loaded or loadElements is false, the loaded module otherwise. internal static object IsModuleLoaded(ExecutionContext context, ModuleSpecification requiredModule, out ModuleMatchFailure matchFailureReason, out bool loaded) { loaded = false; @@ -3791,7 +3791,7 @@ namespace Microsoft.PowerShell.Commands /// Specifies how to treat errors and whether to load elements /// Set if any errors are found. /// Contains error record information. - /// null if the module is not loaded or loadElements is false, the loaded module otherwise. + /// Null if the module is not loaded or loadElements is false, the loaded module otherwise. internal PSModuleInfo LoadRequiredModule(PSModuleInfo currentModule, ModuleSpecification requiredModule, string moduleManifestPath, ManifestProcessingFlags manifestProcessingFlags, bool containedErrors, out ErrorRecord error) { Dbg.Assert(moduleManifestPath != null, "Caller should verify moduleManifestPath != null"); @@ -3815,7 +3815,7 @@ namespace Microsoft.PowerShell.Commands /// Used for error messages. /// Specifies how to treat errors and whether to load elements /// Contains error record information. - /// null if the module is not loaded or loadElements is false, the loaded module otherwise. + /// Null if the module is not loaded or loadElements is false, the loaded module otherwise. internal static PSModuleInfo LoadRequiredModule(ExecutionContext context, PSModuleInfo currentModule, ModuleSpecification requiredModuleSpecification, @@ -5334,7 +5334,7 @@ namespace Microsoft.PowerShell.Commands if (!BaseForce && importingModule && DoesAlreadyLoadedModuleSatisfyConstraints(module)) { moduleFileFound = true; - + // If the module has already been loaded, then while loading it the second time, we should load it with the DefaultCommandPrefix specified in the module manifest. (If there is no Prefix from command line) if (string.IsNullOrEmpty(prefix)) { @@ -5513,7 +5513,7 @@ namespace Microsoft.PowerShell.Commands /// The manifest processing flags to use when processing the module /// True if a module was found /// True if a module file was found - /// True if the module was successfully loaded + /// True if the module was successfully loaded. internal PSModuleInfo LoadModule(PSModuleInfo parentModule, string fileName, string moduleBase, string prefix, SessionState ss, object privateData, ref ImportModuleOptions options, ManifestProcessingFlags manifestProcessingFlags, out bool found, out bool moduleFileFound) @@ -5997,7 +5997,7 @@ namespace Microsoft.PowerShell.Commands // If system is in lock down mode, we disallow trusted modules that use the dotsource operator while simultaneously using // wild cards for exporting module functions, unless there is an overriding manifest that explicitly exports functions // without wild cards. - // This is because dotsourcing brings functions into module scope and it is too easy to inadvertently or maliciously + // This is because dotsourcing brings functions into module scope and it is too easy to inadvertently or maliciously // expose harmful private functions that run in trusted (FullLanguage) mode. if (!manifestWithExplicitFunctionExport && ss.Internal.FunctionsExportedWithWildcard && (SystemPolicy.GetSystemLockdownPolicy() == SystemEnforcementMode.Enforce) && @@ -7551,13 +7551,13 @@ namespace Microsoft.PowerShell.Commands /// /// Returns the context cached ModuleTable module for import only if found and has safe language boundaries while /// exporting all functions by default. - /// + /// /// This protects cached trusted modules that exported all functions in a trusted context, from being re-used /// in an untrusted context and thus exposing functions that were meant to be private in that context. - /// + /// /// Returning false forces module import to re-import the module from file with the current context and prevent /// all module functions from being exported by default. - /// + /// /// Note that module loading order is important with this check when the system is *locked down with DeviceGuard*. /// If a submodule that does not explicitly export any functions is imported from the command line, its useless /// because no functions are exported (default fn export is explictly disallowed on locked down systems). @@ -7575,7 +7575,7 @@ namespace Microsoft.PowerShell.Commands /// Key /// PSModuleInfo /// True if module item is to be removed - /// True if module found in table and is safe to use + /// True if module found in table and is safe to use. internal bool TryGetFromModuleTable(string key, out PSModuleInfo moduleInfo, bool toRemove = false) { var foundModule = Context.Modules.ModuleTable.TryGetValue(key, out moduleInfo); diff --git a/src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs b/src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs index 39cd3b69c..bedfc04bc 100644 --- a/src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs +++ b/src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs @@ -93,7 +93,7 @@ namespace System.Management.Automation /// /// The session state instance to use for this module - may be null /// The results produced from evaluating the scriptblock - /// The newly created module info object + /// The newly created module info object. internal PSModuleInfo CreateModule(string name, string path, ScriptBlock scriptBlock, SessionState ss, out List results, params object[] arguments) { return CreateModuleImplementation(name, path, scriptBlock, null, ss, null, out results, arguments); @@ -108,7 +108,7 @@ namespace System.Management.Automation /// Optional arguments to pass to the script while executing /// The session state instance to use for this module - may be null /// The private data to use for this module - may be null - /// The constructed module object + /// The constructed module object. internal PSModuleInfo CreateModule(string path, ExternalScriptInfo scriptInfo, IScriptExtent scriptPosition, SessionState ss, object privateData, params object[] arguments) { List result; @@ -136,7 +136,7 @@ namespace System.Management.Automation /// /// The session state instance to use for this module - may be null /// The private data to use for this module - may be null - /// The created module + /// The created module. private PSModuleInfo CreateModuleImplementation(string name, string path, object moduleCode, IScriptExtent scriptPosition, SessionState ss, object privateData, out List result, params object[] arguments) { ScriptBlock sb; @@ -262,7 +262,7 @@ namespace System.Management.Automation /// Context to use to create bounded script. /// The scriptblock to bind /// Whether it should be linked to the global session state or not - /// A new scriptblock + /// A new scriptblock. internal ScriptBlock CreateBoundScriptBlock(ExecutionContext context, ScriptBlock sb, bool linkToGlobal) { PSModuleInfo module = new PSModuleInfo(context, linkToGlobal); @@ -921,7 +921,7 @@ namespace System.Management.Automation /// Gets the module name from module path. /// /// The path to the module - /// The module name + /// The module name. internal static string GetModuleName(string path) { string fileName = path == null ? string.Empty : Path.GetFileName(path); @@ -948,7 +948,7 @@ namespace System.Management.Automation /// /// Gets the personal module path /// - /// personal module path + /// Personal module path. internal static string GetPersonalModulePath() { #if UNIX @@ -961,7 +961,7 @@ namespace System.Management.Automation /// /// Gets the PSHome module path, as known as the "system wide module path" in windows powershell. /// - /// The PSHome module path + /// The PSHome module path. internal static string GetPSHomeModulePath() { if (s_psHomeModulePath != null) @@ -1371,7 +1371,7 @@ namespace System.Management.Automation /// modules long term - e.g. when open sourcing a module and installing from the gallery. /// /// - /// The module path as an array of strings + /// The module path as an array of strings. internal static IEnumerable GetModulePath(bool includeSystemModulePath, ExecutionContext context) { string modulePathString = Environment.GetEnvironmentVariable(Constants.PSModulePathEnvVar) ?? SetModulePath(); @@ -1697,7 +1697,7 @@ namespace System.Management.Automation /// Checks pattern list for wildcard characters. /// /// Pattern list - /// True if pattern contains '*' + /// True if pattern contains '*'. internal static bool PatternContainsWildcard(List list) { if (list != null) diff --git a/src/System.Management.Automation/engine/Modules/ModuleUtils.cs b/src/System.Management.Automation/engine/Modules/ModuleUtils.cs index d2db08ae6..098c9f534 100644 --- a/src/System.Management.Automation/engine/Modules/ModuleUtils.cs +++ b/src/System.Management.Automation/engine/Modules/ModuleUtils.cs @@ -69,7 +69,7 @@ namespace System.Management.Automation.Internal internal static IEnumerable GetAllAvailableModuleFiles(string topDirectoryToCheck) { if (!Directory.Exists(topDirectoryToCheck)) { yield break; } - + var options = Utils.PathIsUnc(topDirectoryToCheck) ? s_uncPathEnumerationOptions : s_defaultEnumerationOptions; Queue directoriesToCheck = new Queue(); directoriesToCheck.Enqueue(topDirectoryToCheck); @@ -324,7 +324,7 @@ namespace System.Management.Automation.Internal /// Gets the list of versions under the specified module base path in descending sorted order /// /// module base path - /// sorted list of versions + /// Sorted list of versions. internal static List GetModuleVersionSubfolders(string moduleBase) { var versionFolders = new List(); diff --git a/src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs b/src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs index 12e1b2ddf..1331a0161 100644 --- a/src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs +++ b/src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs @@ -542,7 +542,7 @@ namespace Microsoft.PowerShell.Commands /// Return a single-quoted string. Any embedded single quotes will be doubled. /// /// The string to quote - /// The quoted string + /// The quoted string. private string QuoteName(string name) { if (name == null) @@ -554,7 +554,7 @@ namespace Microsoft.PowerShell.Commands /// Return a single-quoted string using the AbsoluteUri member to ensure it is escaped correctly /// /// The Uri to quote - /// The quoted AbsoluteUri + /// The quoted AbsoluteUri. private string QuoteName(Uri name) { if (name == null) @@ -566,7 +566,7 @@ namespace Microsoft.PowerShell.Commands /// Return a single-quoted string from a Version object /// /// The Version object to quote - /// The quoted Version string + /// The quoted Version string. private string QuoteName(Version name) { if (name == null) @@ -580,7 +580,7 @@ namespace Microsoft.PowerShell.Commands /// /// The list to quote /// Streamwriter to get end of line character from - /// The quoted list + /// The quoted list. private string QuoteNames(IEnumerable names, StreamWriter streamWriter) { if (names == null) @@ -655,7 +655,7 @@ namespace Microsoft.PowerShell.Commands /// /// The list to quote /// Streamwriter to get end of line character from - /// The quoted list + /// The quoted list. private string QuoteModules(IEnumerable moduleSpecs, StreamWriter streamWriter) { StringBuilder result = new StringBuilder(); @@ -741,7 +741,7 @@ namespace Microsoft.PowerShell.Commands /// /// The list to quote /// Streamwriter to get end of line character from - /// The quoted list + /// The quoted list. private string QuoteFiles(IEnumerable names, StreamWriter streamWriter) { List resolvedPaths = new List(); @@ -774,7 +774,7 @@ namespace Microsoft.PowerShell.Commands ///// This is the allowed file extension, any other extension will give an error. ///// Streamwriter to get end of line character from ///// The item of the manifest file for which names are being resolved. - ///// The quoted list + ///// The quoted list. //private string QuoteFilesWithWildcard(string basePath, IEnumerable names, string allowedExtension, StreamWriter streamWriter, string item) //{ // if (names != null) diff --git a/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs b/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs index e6123531c..531198de8 100644 --- a/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs +++ b/src/System.Management.Automation/engine/Modules/PSModuleInfo.cs @@ -204,7 +204,7 @@ namespace System.Management.Automation /// /// ToString() implementation which returns the name of the module. /// - /// The name of the module + /// The name of the module. public override string ToString() { return this.Name; @@ -1237,7 +1237,7 @@ namespace System.Management.Automation /// Returns a new scriptblock bound to this module instance. /// /// The original scriptblock - /// The new bound scriptblock + /// The new bound scriptblock. public ScriptBlock NewBoundScriptBlock(ScriptBlock scriptBlockToBind) { var context = LocalPipeline.GetExecutionContextFromTLS(); @@ -1278,7 +1278,7 @@ namespace System.Management.Automation /// /// The scriptblock to invoke /// Arguments to the scriptblock - /// The result of the invocation + /// The result of the invocation. public object Invoke(ScriptBlock sb, params object[] args) { if (sb == null) @@ -1385,7 +1385,7 @@ namespace System.Management.Automation /// /// Build a custom object out of this module... /// - /// A custom object + /// A custom object. public PSObject AsCustomObject() { if (SessionState == null) @@ -1445,7 +1445,7 @@ namespace System.Management.Automation /// /// Implements deep copy of a PSModuleInfo instance. - /// A new PSModuleInfo instance + /// A new PSModuleInfo instance. /// public PSModuleInfo Clone() { @@ -1510,7 +1510,7 @@ namespace System.Management.Automation /// Look up a module in the appdomain wide module path cache. /// /// Module name to look up. - /// The path to the matched module + /// The path to the matched module. internal static string ResolveUsingAppDomainLevelModuleCache(string moduleName) { string path; diff --git a/src/System.Management.Automation/engine/MshCmdlet.cs b/src/System.Management.Automation/engine/MshCmdlet.cs index 353f085b5..0b4313a66 100644 --- a/src/System.Management.Automation/engine/MshCmdlet.cs +++ b/src/System.Management.Automation/engine/MshCmdlet.cs @@ -101,7 +101,7 @@ namespace System.Management.Automation /// /// Explicit method to convert a SwitchParameter to a boolean value. /// - /// The boolean equivalent of the SwitchParameter + /// The boolean equivalent of the SwitchParameter. public bool ToBool() { return _isPresent; @@ -161,7 +161,7 @@ namespace System.Management.Automation /// /// first object to compare /// second object to compare - /// True if they are the same + /// True if they are the same. public static bool operator ==(SwitchParameter first, SwitchParameter second) { return first.Equals(second); @@ -171,7 +171,7 @@ namespace System.Management.Automation /// /// first object to compare /// second object to compare - /// True if they are different + /// True if they are different. public static bool operator !=(SwitchParameter first, SwitchParameter second) { return !first.Equals(second); @@ -181,7 +181,7 @@ namespace System.Management.Automation /// /// first object to compare /// second object to compare - /// True if they are the same + /// True if they are the same. public static bool operator ==(SwitchParameter first, bool second) { return first.Equals(second); @@ -191,7 +191,7 @@ namespace System.Management.Automation /// /// first object to compare /// second object to compare - /// True if they are different + /// True if they are different. public static bool operator !=(SwitchParameter first, bool second) { return !first.Equals(second); @@ -201,7 +201,7 @@ namespace System.Management.Automation /// /// first object to compare /// second object to compare - /// True if they are the same + /// True if they are the same. public static bool operator ==(bool first, SwitchParameter second) { return first.Equals(second); @@ -211,7 +211,7 @@ namespace System.Management.Automation /// /// first object to compare /// second object to compare - /// True if they are different + /// True if they are different. public static bool operator !=(bool first, SwitchParameter second) { return !first.Equals(second); @@ -300,7 +300,7 @@ namespace System.Management.Automation /// The command name to search for /// The command type to search for /// The command arguments used to resolve dynamic parameters - /// A CommandInfo result that represents the resolved command + /// A CommandInfo result that represents the resolved command. public CommandInfo GetCommand(string commandName, CommandTypes type, object[] arguments) { CommandInfo result = null; @@ -366,7 +366,7 @@ namespace System.Management.Automation /// Returns the CmdletInfo object that corresponds to the name argument /// /// The name of the cmdlet to look for - /// The cmdletInfo object if found, null otherwise + /// The cmdletInfo object if found, null otherwise. public CmdletInfo GetCmdlet(string commandName) { return GetCmdlet(commandName, _context); @@ -377,7 +377,7 @@ namespace System.Management.Automation /// /// The name of the cmdlet to look for /// The execution context instance to use for lookup - /// The cmdletInfo object if found, null otherwise + /// The cmdletInfo object if found, null otherwise. internal static CmdletInfo GetCmdlet(string commandName, ExecutionContext context) { CmdletInfo current = null; @@ -429,7 +429,7 @@ namespace System.Management.Automation /// info will both be null on returned object. /// /// the type name of the class implementing this cmdlet - /// CmdletInfo for the cmdlet if found, null otherwise + /// CmdletInfo for the cmdlet if found, null otherwise. public CmdletInfo GetCmdletByTypeName(string cmdletTypeName) { if (string.IsNullOrEmpty(cmdletTypeName)) @@ -738,7 +738,7 @@ namespace System.Management.Automation /// The scriptblock to execute /// Optionall input to the command /// Arguments to pass to the scriptblock - /// The result of the evaluation + /// The result of the evaluation. public Collection InvokeScript( bool useLocalScope, ScriptBlock scriptBlock, IList input, params object[] args) { @@ -882,7 +882,7 @@ namespace System.Management.Automation /// Compile a string into a script block. /// /// The source text to compile - /// The compiled script block + /// The compiled script block. /// public ScriptBlock NewScriptBlock(string scriptText) { diff --git a/src/System.Management.Automation/engine/MshCommandRuntime.cs b/src/System.Management.Automation/engine/MshCommandRuntime.cs index 5feafaef0..9157e4715 100644 --- a/src/System.Management.Automation/engine/MshCommandRuntime.cs +++ b/src/System.Management.Automation/engine/MshCommandRuntime.cs @@ -2273,7 +2273,7 @@ namespace System.Management.Automation /// Be sure to use this object only in "using" so that it is reliably /// disposed and follows stack semantics. /// - /// IDisposable + /// IDisposable. internal IDisposable AllowThisCommandToWrite(bool permittedToWriteToPipeline) { return new AllowWrite(_thisCommand, permittedToWriteToPipeline); @@ -2333,7 +2333,7 @@ namespace System.Management.Automation /// throw ManageException(e); /// /// the exception - /// PipelineStoppedException + /// PipelineStoppedException. public Exception ManageException(Exception e) { if (e == null) @@ -2936,7 +2936,7 @@ namespace System.Management.Automation { return _debugPreference; } - + if (IsDebugFlagSet) { return Debug ? ActionPreference.Continue : ActionPreference.SilentlyContinue; @@ -2957,7 +2957,7 @@ namespace System.Management.Automation _isDebugPreferenceCached = true; } - + return _debugPreference; } @@ -3394,7 +3394,7 @@ namespace System.Management.Automation /// /// /// - /// Did Inquire return YesToAll? + /// Did Inquire return YesToAll?. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. @@ -3469,7 +3469,7 @@ namespace System.Management.Automation /// /// /// - /// user's selection + /// User's selection. /// /// The pipeline has already been terminated, or was terminated /// during the execution of this method. diff --git a/src/System.Management.Automation/engine/MshMemberInfo.cs b/src/System.Management.Automation/engine/MshMemberInfo.cs index 729383a14..f97272aca 100644 --- a/src/System.Management.Automation/engine/MshMemberInfo.cs +++ b/src/System.Management.Automation/engine/MshMemberInfo.cs @@ -277,7 +277,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public abstract PSMemberInfo Copy(); internal bool MatchesOptions(MshMemberMatchOptions options) @@ -347,7 +347,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this property /// - /// This property as a string + /// This property as a string. public override string ToString() { StringBuilder returnValue = new StringBuilder(); @@ -435,7 +435,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { PSAliasProperty alias = new PSAliasProperty(name, ReferencedMemberName) {ConversionType = ConversionType}; @@ -610,7 +610,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this property /// - /// This property as a string + /// This property as a string. public override string ToString() { StringBuilder returnValue = new StringBuilder(); @@ -846,7 +846,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { PSCodeProperty property = new PSCodeProperty(name, GetterCodeReference, SetterCodeReference); @@ -1019,7 +1019,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this property /// - /// This property as a string + /// This property as a string. public override string ToString() { if (this.isDeserialized) @@ -1089,7 +1089,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { PSProperty property = new PSProperty(this.name, this.adapter, this.baseObject, this.adapterData); @@ -1267,7 +1267,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this property /// - /// This property as a string + /// This property as a string. public override string ToString() { StringBuilder returnValue = new StringBuilder(); @@ -1305,7 +1305,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { PSNoteProperty property = new PSNoteProperty(this.name, this.noteValue); @@ -1415,7 +1415,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this property /// - /// This property as a string + /// This property as a string. public override string ToString() { StringBuilder returnValue = new StringBuilder(); @@ -1448,7 +1448,7 @@ namespace System.Management.Automation /// Note that it returns another reference to the variable, not a reference /// to a new variable... /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { PSNoteProperty property = new PSVariableProperty(_variable); @@ -1535,7 +1535,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this property /// - /// This property as a string + /// This property as a string. public override string ToString() { StringBuilder returnValue = new StringBuilder(); @@ -1754,7 +1754,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { var property = new PSScriptProperty(name, this.GetterScript, this.SetterScript) {_shouldCloneOnAccess = _shouldCloneOnAccess}; @@ -2051,7 +2051,7 @@ namespace System.Management.Automation /// Invokes the appropriate method overload for the given arguments and returns its result. /// /// arguments to the method - /// return value from the method + /// Return value from the method. /// if arguments is null /// For problems finding an appropriate method for the arguments /// For exceptions invoking the method. @@ -2097,7 +2097,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this member /// - /// This property as a string + /// This property as a string. public override string ToString() { StringBuilder returnValue = new StringBuilder(); @@ -2200,7 +2200,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { PSCodeMethod member = new PSCodeMethod(name, CodeReference); @@ -2217,7 +2217,7 @@ namespace System.Management.Automation /// Invokes CodeReference method and returns its results. /// /// arguments to the method - /// return value from the method + /// Return value from the method. /// if arguments is null /// /// When @@ -2277,7 +2277,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this member /// - /// This property as a string + /// This property as a string. public override string ToString() { StringBuilder returnValue = new StringBuilder(); @@ -2357,7 +2357,7 @@ namespace System.Management.Automation /// Invokes Script method and returns its results. /// /// arguments to the method - /// return value from the method + /// Return value from the method. /// 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) @@ -2428,7 +2428,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { var method = new PSScriptMethod(this.name, _script) {_shouldCloneOnAccess = _shouldCloneOnAccess}; @@ -2467,7 +2467,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this member /// - /// This property as a string + /// This property as a string. public override string ToString() { return _adapter.BaseMethodToString(this); @@ -2520,7 +2520,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { PSMethod member = new PSMethod(this.name, _adapter, this.baseObject, this.adapterData, this.IsSpecial, this.IsHidden); @@ -2537,7 +2537,7 @@ namespace System.Management.Automation /// Invokes the appropriate method overload for the given arguments and returns its result. /// /// arguments to the method - /// return value from the method + /// Return value from the method. /// if arguments is null /// For problems finding an appropriate method for the arguments /// For exceptions invoking the method @@ -2551,7 +2551,7 @@ namespace System.Management.Automation /// /// constraints /// arguments to the method - /// return value from the method + /// Return value from the method. /// if arguments is null /// For problems finding an appropriate method for the arguments /// For exceptions invoking the method @@ -2885,7 +2885,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this member /// - /// This property as a string + /// This property as a string. public override string ToString() { Diagnostics.Assert((this.baseObject != null) && (this.adapter != null) && (this.adapterData != null), "it should have all these properties set"); @@ -2943,7 +2943,7 @@ namespace System.Management.Automation /// Invokes the getter method and returns its result /// /// arguments to the method - /// return value from the method + /// Return value from the method. /// if arguments is null /// When getting the value of a property throws an exception public override object Invoke(params object[] arguments) @@ -2986,7 +2986,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { PSParameterizedProperty property = new PSParameterizedProperty(this.name, this.adapter, this.baseObject, this.adapterData); @@ -3019,7 +3019,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this member /// - /// This property as a string + /// This property as a string. public override string ToString() { StringBuilder returnValue = new StringBuilder(); @@ -3198,7 +3198,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { if (_constructorPSObject == null) @@ -3400,7 +3400,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this member /// - /// This property as a string + /// This property as a string. public override string ToString() { StringBuilder returnValue = new StringBuilder(); @@ -3462,7 +3462,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { PSPropertySet member = new PSPropertySet(name, ReferencedPropertyNames); @@ -3506,7 +3506,7 @@ namespace System.Management.Automation /// /// Returns the string representation of this member /// - /// This property as a string + /// This property as a string. public override string ToString() { StringBuilder eventDefinition = new StringBuilder(); @@ -3548,7 +3548,7 @@ namespace System.Management.Automation /// /// returns a new PSMemberInfo that is a copy of this PSMemberInfo /// - /// a new PSMemberInfo that is a copy of this PSMemberInfo + /// A new PSMemberInfo that is a copy of this PSMemberInfo. public override PSMemberInfo Copy() { PSEvent member = new PSEvent(this.baseEvent); @@ -3748,7 +3748,7 @@ namespace System.Management.Automation /// Gets the member in this collection matching name. If the member does not exist, null is returned. /// /// name of the member to look for - /// the member matching name + /// The member matching name. /// for invalid arguments public abstract T this[string name] { get; } @@ -3760,7 +3760,7 @@ namespace System.Management.Automation /// Returns all members in the collection matching name /// /// name of the members to be return. May contain wildcard characters. - /// all members in the collection matching name + /// All members in the collection matching name. /// for invalid arguments public abstract ReadOnlyPSMemberInfoCollection Match(string name); @@ -3769,7 +3769,7 @@ namespace System.Management.Automation /// /// 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 + /// All members in the collection matching name and types. /// for invalid arguments public abstract ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes); @@ -3779,7 +3779,7 @@ namespace System.Management.Automation /// 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 + /// All members in the collection matching name and types. /// for invalid arguments internal abstract ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes, MshMemberMatchOptions matchOptions); @@ -3799,7 +3799,7 @@ namespace System.Management.Automation /// /// Gets the general enumerator for this collection /// - /// the enumerator for this collection + /// The enumerator for this collection. IEnumerator IEnumerable.GetEnumerator() { return GetEnumerator(); @@ -3808,7 +3808,7 @@ namespace System.Management.Automation /// /// Gets the specific enumerator for this collection. /// - /// the enumerator for this collection + /// The enumerator for this collection. public abstract IEnumerator GetEnumerator(); #endregion IEnumerable @@ -3844,7 +3844,7 @@ 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 - /// the member matching name + /// The member matching name. /// for invalid arguments public T this[string name] { @@ -3863,7 +3863,7 @@ namespace System.Management.Automation /// Returns all members in the collection matching name /// /// name of the members to be return. May contain wildcard characters. - /// all members in the collection matching name + /// All members in the collection matching name. /// for invalid arguments public ReadOnlyPSMemberInfoCollection Match(string name) { @@ -3880,7 +3880,7 @@ namespace System.Management.Automation /// /// 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 + /// All members in the collection matching name and types. /// for invalid arguments public ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes) { @@ -3895,7 +3895,7 @@ namespace System.Management.Automation /// /// Gets the general enumerator for this collection /// - /// the enumerator for this collection + /// The enumerator for this collection. IEnumerator IEnumerable.GetEnumerator() { return GetEnumerator(); @@ -3904,7 +3904,7 @@ namespace System.Management.Automation /// /// Gets the specific enumerator for this collection. /// - /// the enumerator for this collection + /// The enumerator for this collection. public virtual IEnumerator GetEnumerator() { return _members.GetEnumerator(); @@ -4085,7 +4085,7 @@ namespace System.Management.Automation /// Returns the member in this collection matching name /// /// name of the member to look for - /// the member matching name + /// The member matching name. /// for invalid arguments public override T this[string name] { @@ -4112,7 +4112,7 @@ namespace System.Management.Automation /// Returns all members in the collection matching name /// /// name of the members to be return. May contain wildcard characters. - /// all members in the collection matching name + /// All members in the collection matching name. /// for invalid arguments public override ReadOnlyPSMemberInfoCollection Match(string name) { @@ -4129,7 +4129,7 @@ namespace System.Management.Automation /// /// 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 + /// All members in the collection matching name and types. /// for invalid arguments public override ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes) { @@ -4147,7 +4147,7 @@ namespace System.Management.Automation /// 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 + /// All members in the collection matching name and types. /// for invalid arguments internal override ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes, MshMemberMatchOptions matchOptions) { @@ -4247,7 +4247,7 @@ namespace System.Management.Automation /// This virtual works around the difficulty of implementing /// interfaces virtually. /// - /// the enumerator for this collection + /// The enumerator for this collection. public override IEnumerator GetEnumerator() { if (_members == null) @@ -4832,7 +4832,7 @@ namespace System.Management.Automation /// Returns all members in the collection matching name /// /// name of the members to be return. May contain wildcard characters. - /// all members in the collection matching name + /// All members in the collection matching name. /// for invalid arguments public override ReadOnlyPSMemberInfoCollection Match(string name) { @@ -4849,7 +4849,7 @@ namespace System.Management.Automation /// /// 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 + /// All members in the collection matching name and types. /// for invalid arguments public override ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes) { @@ -4867,7 +4867,7 @@ namespace System.Management.Automation /// 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 + /// All members in the collection matching name and types. /// for invalid arguments internal override ReadOnlyPSMemberInfoCollection Match(string name, PSMemberTypes memberTypes, MshMemberMatchOptions matchOptions) { @@ -4896,7 +4896,7 @@ namespace System.Management.Automation /// This virtual works around the difficulty of implementing /// interfaces virtually. /// - /// the enumerator for this collection + /// The enumerator for this collection. public override IEnumerator GetEnumerator() { return new Enumerator(this); diff --git a/src/System.Management.Automation/engine/MshObject.cs b/src/System.Management.Automation/engine/MshObject.cs index 792a08294..bc56400d9 100644 --- a/src/System.Management.Automation/engine/MshObject.cs +++ b/src/System.Management.Automation/engine/MshObject.cs @@ -428,7 +428,7 @@ namespace System.Management.Automation /// /// Returns the adapter corresponding to obj.GetType() /// - /// the adapter set corresponding to obj.GetType() + /// The adapter set corresponding to obj.GetType(). internal static AdapterSet GetMappedAdapter(object obj, TypeTable typeTable) { Type objectType = obj.GetType(); @@ -1187,7 +1187,7 @@ namespace System.Management.Automation /// If it is not present, and the BaseObject is null we try listing the properties. /// If the BaseObject is not null we try enumerating. If that fails we try the BaseObject's ToString. /// - /// A string representation of the object + /// A string representation of the object. /// /// When there is a brokered ToString but it failed, or when the ToString on obj throws an exception. /// @@ -1248,7 +1248,7 @@ namespace System.Management.Automation /// If recurse is false, this parameter is not considered. If it is true /// this parameter will determine how enumerators are going to be treated. /// - /// A string representation of the object + /// A string representation of the object. /// /// When there is a brokered ToString but it failed, or when the ToString on obj throws an exception. /// @@ -1489,7 +1489,7 @@ namespace System.Management.Automation /// CodeMethod or ScriptMethod will be used, if available. Enumerations items are /// concatenated using $ofs. /// - /// the string representation for baseObject + /// The string representation for baseObject. /// if an exception was thrown by the BaseObject's ToString public override string ToString() { @@ -1510,7 +1510,7 @@ namespace System.Management.Automation /// /// repassed to baseObject's IFormattable if present /// repassed to baseObject's IFormattable if present - /// the string representation for baseObject + /// The string representation for baseObject. /// if an exception was thrown by the BaseObject's ToString public string ToString(string format, IFormatProvider formatProvider) { @@ -1547,7 +1547,7 @@ namespace System.Management.Automation /// it is a value type, and use BaseObject.Clone() for the new PSObject, /// if the BaseObject is ICloneable. /// - /// a copy of this object + /// A copy of this object. public virtual PSObject Copy() { PSObject returnValue = (PSObject)this.MemberwiseClone(); @@ -1665,7 +1665,7 @@ namespace System.Management.Automation /// Determines whether the specified Object is equal to the current Object. /// /// The Object to compare with the current Object. - /// true if the specified Object is equal to the current Object; otherwise, false. + /// True if the specified Object is equal to the current Object; otherwise, false. public override bool Equals(object obj) { // There is a slight difference between BaseObject and PSObject.Base. @@ -1694,7 +1694,7 @@ namespace System.Management.Automation /// /// Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. /// - /// A hash code for the current Object + /// A hash code for the current Object. public override int GetHashCode() { return this.BaseObject.GetHashCode(); @@ -1959,7 +1959,7 @@ namespace System.Management.Automation /// in the remoting scenario on the client side (where a LocalRunspace may not be /// present). /// - /// A collection with only the specific properties to serialize + /// A collection with only the specific properties to serialize. internal Collection GetSpecificPropertiesToSerialize(TypeTable backupTypeTable) { TypeTable typeTable = backupTypeTable ?? this.GetTypeTable(); @@ -2494,7 +2494,7 @@ namespace Microsoft.PowerShell if (nodes == null) { return string.Empty; - } + } if (nodes.Count == 1) { diff --git a/src/System.Management.Automation/engine/MshObjectTypeDescriptor.cs b/src/System.Management.Automation/engine/MshObjectTypeDescriptor.cs index 33bada71c..7e2484f17 100644 --- a/src/System.Management.Automation/engine/MshObjectTypeDescriptor.cs +++ b/src/System.Management.Automation/engine/MshObjectTypeDescriptor.cs @@ -123,14 +123,14 @@ namespace System.Management.Automation /// Returns false to indicate that ResetValue has no effect. /// /// The component to test for reset capability. - /// false + /// False. public override bool CanResetValue(object component) { return false; } /// /// Returns true to indicate that the value of this property needs to be persisted. /// /// The component with the property to be examined for persistence. - /// true + /// True. public override bool ShouldSerializeValue(object component) { return true; @@ -464,7 +464,7 @@ namespace System.Management.Automation /// Determines whether the Instance property of is equal to the current Instance. /// /// The Object to compare with the current Object. - /// true if the Instance property of is equal to the current Instance; otherwise, false. + /// True if the Instance property of is equal to the current Instance; otherwise, false. public override bool Equals(object obj) { PSObjectTypeDescriptor other = obj as PSObjectTypeDescriptor; @@ -484,7 +484,7 @@ namespace System.Management.Automation /// /// Provides a value for hashing algorithms. /// - /// A hash code for the current object + /// A hash code for the current object. public override int GetHashCode() { if (this.Instance == null) @@ -498,7 +498,7 @@ namespace System.Management.Automation /// /// Returns the default property for this object. /// - /// An that represents the default property for this object, or a null reference (Nothing in Visual Basic) if this object does not have properties + /// An that represents the default property for this object, or a null reference (Nothing in Visual Basic) if this object does not have properties. public override PropertyDescriptor GetDefaultProperty() { if (this.Instance == null) diff --git a/src/System.Management.Automation/engine/MshSecurityException.cs b/src/System.Management.Automation/engine/MshSecurityException.cs index baae51712..79681a3a3 100644 --- a/src/System.Management.Automation/engine/MshSecurityException.cs +++ b/src/System.Management.Automation/engine/MshSecurityException.cs @@ -15,7 +15,7 @@ namespace System.Management.Automation /// /// Recommended constructor for class PSSecurityException /// - /// constructed object + /// Constructed object. public PSSecurityException() : base() { @@ -33,7 +33,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PSSecurityException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -53,7 +53,7 @@ namespace System.Management.Automation /// Constructor for class PSSecurityException /// /// - /// constructed object + /// Constructed object. public PSSecurityException(string message) : base(message) { @@ -71,7 +71,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PSSecurityException(string message, Exception innerException) : base(message, innerException) diff --git a/src/System.Management.Automation/engine/NativeCommandProcessor.cs b/src/System.Management.Automation/engine/NativeCommandProcessor.cs index 01d0516a8..5b5e23bd5 100644 --- a/src/System.Management.Automation/engine/NativeCommandProcessor.cs +++ b/src/System.Management.Automation/engine/NativeCommandProcessor.cs @@ -1921,21 +1921,21 @@ namespace System.Management.Automation /// /// The window to show... /// The command to do - /// true it it was successful + /// True it it was successful. [DllImport("user32.dll")] internal static extern bool ShowWindow(IntPtr hWnd, int nCmdShow); /// /// Code to allocate a console... /// - /// true if a console was created... + /// True if a console was created... [DllImport("kernel32.dll", SetLastError = true)] internal static extern bool AllocConsole(); /// /// Called to save the foreground window before allocating a hidden console window /// - /// A handle to the foreground window + /// A handle to the foreground window. [DllImport("user32.dll")] private static extern IntPtr GetForegroundWindow(); @@ -1943,7 +1943,7 @@ namespace System.Management.Automation /// Called to restore the foreground window after allocating a hidden console window /// /// A handle to the window that should be activated and brought to the foreground. - /// true if the window was brought to the foreground + /// True if the window was brought to the foreground. [DllImport("user32.dll")] [return: MarshalAs(UnmanagedType.Bool)] private static extern bool SetForegroundWindow(IntPtr hWnd); diff --git a/src/System.Management.Automation/engine/Pipe.cs b/src/System.Management.Automation/engine/Pipe.cs index c036dfa59..291674a61 100644 --- a/src/System.Management.Automation/engine/Pipe.cs +++ b/src/System.Management.Automation/engine/Pipe.cs @@ -597,7 +597,7 @@ namespace System.Management.Automation.Internal /// not block on ExternalInput, and it does not modify the contents of /// the pipe. /// - /// possibly empty array of objects, but not null + /// Possibly empty array of objects, but not null. internal object[] ToArray() { if (ObjectQueue == null || ObjectQueue.Count == 0) diff --git a/src/System.Management.Automation/engine/ProcessCodeMethods.cs b/src/System.Management.Automation/engine/ProcessCodeMethods.cs index a3f75f967..867aa0e6f 100644 --- a/src/System.Management.Automation/engine/ProcessCodeMethods.cs +++ b/src/System.Management.Automation/engine/ProcessCodeMethods.cs @@ -38,7 +38,7 @@ namespace Microsoft.PowerShell { /// CodeMethod for getting the parent process of a process /// /// - /// the parent process, or null if the parent is no longer running + /// The parent process, or null if the parent is no longer running. public static object GetParentProcess(PSObject obj) { var process = PSObject.Base(obj) as Process; @@ -49,7 +49,7 @@ namespace Microsoft.PowerShell { /// Returns the parent id of a process or -1 if it fails /// /// - /// the pid of the parent process + /// The pid of the parent process. #if UNIX internal static int GetParentPid(Process process) { diff --git a/src/System.Management.Automation/engine/ProgressRecord.cs b/src/System.Management.Automation/engine/ProgressRecord.cs index 0268397b9..c26254acf 100644 --- a/src/System.Management.Automation/engine/ProgressRecord.cs +++ b/src/System.Management.Automation/engine/ProgressRecord.cs @@ -356,7 +356,7 @@ namespace System.Management.Automation /// /// When did the operation start /// How long does the operation usually take - /// Estimated percentage complete of the operation (always between 0 and 99% - never returns 100%) + /// Estimated percentage complete of the operation (always between 0 and 99% - never returns 100%). /// /// Thrown when /// 1) is in the future @@ -495,7 +495,7 @@ namespace System.Management.Automation /// Returns this object as a PSObject property bag /// that can be used in a remoting protocol data object. /// - /// This object as a PSObject property bag + /// This object as a PSObject property bag. internal PSObject ToPSObjectForRemoting() { PSObject progressAsPSObject = RemotingEncoder.CreateEmptyPSObject(); diff --git a/src/System.Management.Automation/engine/ScriptCommandProcessor.cs b/src/System.Management.Automation/engine/ScriptCommandProcessor.cs index d2747f2d5..3afb8f46b 100644 --- a/src/System.Management.Automation/engine/ScriptCommandProcessor.cs +++ b/src/System.Management.Automation/engine/ScriptCommandProcessor.cs @@ -129,7 +129,7 @@ namespace System.Management.Automation /// /// help target to request /// help category to request - /// true if user requested help; false otherwise + /// true if user requested help; false otherwise. internal override bool IsHelpRequested(out string helpTarget, out HelpCategory helpCategory) { if (arguments != null && CommandInfo != null && !string.IsNullOrEmpty(CommandInfo.Name) && _scriptBlock != null) diff --git a/src/System.Management.Automation/engine/SecurityManagerBase.cs b/src/System.Management.Automation/engine/SecurityManagerBase.cs index 46497389f..45deaebe9 100644 --- a/src/System.Management.Automation/engine/SecurityManagerBase.cs +++ b/src/System.Management.Automation/engine/SecurityManagerBase.cs @@ -164,7 +164,7 @@ namespace System.Management.Automation /// The origin of the command /// The host running the command /// The reason for preventing execution, if applicable - /// True if the host should run the command. False otherwise + /// True if the host should run the command. False otherwise. protected internal virtual bool ShouldRun(CommandInfo commandInfo, CommandOrigin origin, PSHost host, diff --git a/src/System.Management.Automation/engine/SessionState.cs b/src/System.Management.Automation/engine/SessionState.cs index 880749d42..1520dc053 100644 --- a/src/System.Management.Automation/engine/SessionState.cs +++ b/src/System.Management.Automation/engine/SessionState.cs @@ -226,7 +226,7 @@ namespace System.Management.Automation /// See if a script is allowed to be run. /// /// Path to check - /// true if script is allowed + /// True if script is allowed. internal SessionStateEntryVisibility CheckScriptVisibility(string scriptPath) { return checkPathVisibility(Scripts, scriptPath); diff --git a/src/System.Management.Automation/engine/SessionStateContainer.cs b/src/System.Management.Automation/engine/SessionStateContainer.cs index cdc84f6b4..f2c7acf2d 100644 --- a/src/System.Management.Automation/engine/SessionStateContainer.cs +++ b/src/System.Management.Automation/engine/SessionStateContainer.cs @@ -1327,7 +1327,7 @@ namespace System.Management.Automation if (recurse) { string childName = GetChildName(path, context); - + // If -File or -Directory is specified and path is ended with '*', we should include the parent path as search path bool isFileOrDirectoryPresent = false; @@ -1504,7 +1504,7 @@ namespace System.Management.Automation } finally { - context.SuppressWildcardExpansion = true; + context.SuppressWildcardExpansion = true; } } else if (path != null && this.ItemExists(providerInstance, path, context)) diff --git a/src/System.Management.Automation/engine/SessionStateFunctionAPIs.cs b/src/System.Management.Automation/engine/SessionStateFunctionAPIs.cs index 511e37d89..64536f3a2 100644 --- a/src/System.Management.Automation/engine/SessionStateFunctionAPIs.cs +++ b/src/System.Management.Automation/engine/SessionStateFunctionAPIs.cs @@ -173,7 +173,7 @@ namespace System.Management.Automation private bool IsFunctionVisibleInDebugger(FunctionInfo fnInfo, CommandOrigin origin) { - // Ensure the returned function item is not exposed across language boundaries when in + // Ensure the returned function item is not exposed across language boundaries when in // a debugger breakpoint or nested prompt. // A debugger breakpoint/nested prompt has access to all current scoped functions. // This includes both running commands from the prompt or via a debugger Action scriptblock. diff --git a/src/System.Management.Automation/engine/SessionStatePublic.cs b/src/System.Management.Automation/engine/SessionStatePublic.cs index 5b6be707e..8b6446ca7 100644 --- a/src/System.Management.Automation/engine/SessionStatePublic.cs +++ b/src/System.Management.Automation/engine/SessionStatePublic.cs @@ -247,7 +247,7 @@ namespace System.Management.Automation /// /// The origin to check against /// The object to check - /// Returns true if the object is visible, false otherwise + /// Returns true if the object is visible, false otherwise. public static bool IsVisible(CommandOrigin origin, object valueToCheck) { if (origin == CommandOrigin.Internal) @@ -265,7 +265,7 @@ namespace System.Management.Automation /// /// The origin to check against /// The variable to check - /// Returns true if the object is visible, false otherwise + /// Returns true if the object is visible, false otherwise. public static bool IsVisible(CommandOrigin origin, PSVariable variable) { if (origin == CommandOrigin.Internal) @@ -282,7 +282,7 @@ namespace System.Management.Automation /// /// The origin to check against /// The command to check - /// Returns true if the object is visible, false otherwise + /// Returns true if the object is visible, false otherwise. public static bool IsVisible(CommandOrigin origin, CommandInfo commandInfo) { if (origin == CommandOrigin.Internal) diff --git a/src/System.Management.Automation/engine/TypeMetadata.cs b/src/System.Management.Automation/engine/TypeMetadata.cs index 8ff2a6017..4619d1109 100644 --- a/src/System.Management.Automation/engine/TypeMetadata.cs +++ b/src/System.Management.Automation/engine/TypeMetadata.cs @@ -1294,7 +1294,7 @@ namespace System.Management.Automation if (processingDynamicParameters) { // When processing dynamic parameters, parameter definitions come from the user, - // Invalid data could be passed in, or the parameter could be actually disabled. + // Invalid data could be passed in, or the parameter could be actually disabled. if (parameterDefinition == null || parameterDefinition.IsDisabled()) { continue; } } diff --git a/src/System.Management.Automation/engine/TypeTable.cs b/src/System.Management.Automation/engine/TypeTable.cs index 84ac917b1..2a9bb736f 100644 --- a/src/System.Management.Automation/engine/TypeTable.cs +++ b/src/System.Management.Automation/engine/TypeTable.cs @@ -3501,7 +3501,7 @@ namespace System.Management.Automation.Runspaces /// /// if caller doesn't have permission to read the PowerShell registry key /// - /// TypeTable + /// TypeTable. public static TypeTable LoadDefaultTypeFiles() { return new TypeTable(GetDefaultTypeFiles()); @@ -3510,7 +3510,7 @@ namespace System.Management.Automation.Runspaces /// /// Gets the default types files available in PowerShell /// - /// list of type files + /// List of type files. public static List GetDefaultTypeFiles() { string typesFilePath = string.Empty; @@ -3579,7 +3579,7 @@ namespace System.Management.Automation.Runspaces /// The first type in the type hierarchy is guaranteed to have SpecificProperties /// /// - /// null if this should not be serialized with SpecificProperties + /// Null if this should not be serialized with SpecificProperties. internal Collection GetSpecificProperties(ConsolidatedString types) { if (types == null || string.IsNullOrEmpty(types.Key)) @@ -3703,7 +3703,7 @@ namespace System.Management.Automation.Runspaces /// Gets the type converter for the typeName /// /// type name with the converter - /// the type converter for the typeName or null, if there is no type converter + /// The type converter for the typeName or null, if there is no type converter. internal object GetTypeConverter(string typeName) { if (string.IsNullOrEmpty(typeName)) @@ -3719,7 +3719,7 @@ namespace System.Management.Automation.Runspaces /// /// Gets the type adapter for the given type /// - /// the type adapter or null, if there is no adapter + /// The type adapter or null, if there is no adapter. internal PSObject.AdapterSet GetTypeAdapter(Type type) { if (type == null) diff --git a/src/System.Management.Automation/engine/UserFeedbackParameters.cs b/src/System.Management.Automation/engine/UserFeedbackParameters.cs index 3c2bce27c..a024e1e2b 100644 --- a/src/System.Management.Automation/engine/UserFeedbackParameters.cs +++ b/src/System.Management.Automation/engine/UserFeedbackParameters.cs @@ -64,7 +64,7 @@ namespace System.Management.Automation /// 0.0 means that total count is unknown; /// anything in-between means that total count is estimated /// - /// An object that represents a total count of objects that the cmdlet would return without paging + /// An object that represents a total count of objects that the cmdlet would return without paging. public PSObject NewTotalCount(UInt64 totalCount, double accuracy) { PSObject result = new PSObject(totalCount); diff --git a/src/System.Management.Automation/engine/Utils.cs b/src/System.Management.Automation/engine/Utils.cs index d70682a9d..58ee8336e 100644 --- a/src/System.Management.Automation/engine/Utils.cs +++ b/src/System.Management.Automation/engine/Utils.cs @@ -84,7 +84,7 @@ namespace System.Management.Automation /// /// arg to check /// name of the arg - /// Does not return a value + /// Does not return a value. internal static void CheckKeyArg(byte[] arg, string argName) { if (arg == null) @@ -111,7 +111,7 @@ namespace System.Management.Automation /// /// arg to check /// name of the arg - /// Does not return a value + /// Does not return a value. internal static void CheckArgForNullOrEmpty(string arg, string argName) { if (arg == null) @@ -130,7 +130,7 @@ namespace System.Management.Automation /// /// arg to check /// name of the arg - /// Does not return a value + /// Does not return a value. internal static void CheckArgForNull(object arg, string argName) { if (arg == null) @@ -144,7 +144,7 @@ namespace System.Management.Automation /// /// arg to check /// name of the arg - /// Does not return a value + /// Does not return a value. internal static void CheckSecureStringArg(SecureString arg, string argName) { if (arg == null) @@ -237,7 +237,7 @@ namespace System.Management.Automation /// /// Specifies the per-user configuration settings directory in a platform agnostic manner. /// - /// The current user's configuration settings directory + /// The current user's configuration settings directory. internal static string GetUserConfigurationDirectory() { #if UNIX @@ -344,7 +344,7 @@ namespace System.Management.Automation /// returns current major version of monad ( that is running ) in a string /// format. /// - /// string + /// String. /// /// Cannot return a Version object as minor number is a requirement for /// version object. @@ -403,7 +403,7 @@ namespace System.Management.Automation /// by ver. /// /// Version to check - /// true if supported, false otherwise + /// True if supported, false otherwise. internal static bool IsPSVersionSupported(string ver) { // Convert version to supported format ie., x.x @@ -416,7 +416,7 @@ namespace System.Management.Automation /// by checkVersion. /// /// Version to check - /// true if supported, false otherwise + /// True if supported, false otherwise. internal static bool IsPSVersionSupported(Version checkVersion) { if (checkVersion == null) @@ -438,7 +438,7 @@ namespace System.Management.Automation /// by checkEdition. /// /// Edition to check - /// true if supported, false otherwise + /// True if supported, false otherwise. internal static bool IsPSEditionSupported(string checkEdition) { return PSVersionInfo.PSEdition.Equals(checkEdition, StringComparison.OrdinalIgnoreCase); @@ -467,7 +467,7 @@ namespace System.Management.Automation /// Checks whether the specified edition value is allowed. /// /// Edition value to check - /// true if allowed, false otherwise + /// True if allowed, false otherwise. internal static bool IsValidPSEditionValue(string editionValue) { return AllowedEditionValues.Contains(editionValue, StringComparer.OrdinalIgnoreCase); @@ -896,7 +896,7 @@ namespace System.Management.Automation /// Gets the current impersonating Windows identity, if any /// /// Current impersonated Windows identity or null - /// True if current identity is impersonated + /// True if current identity is impersonated. internal static bool TryGetWindowsImpersonatedIdentity(out WindowsIdentity impersonatedIdentity) { WindowsIdentity currentIdentity; @@ -1094,7 +1094,7 @@ namespace System.Management.Automation /// /// The mutex to wait on. If it is null, a new one will be created /// The initializer to use to recreate the mutex. - /// A working mutex. If the mutex was abandoned, a new one is created to replace it + /// A working mutex. If the mutex was abandoned, a new one is created to replace it. internal static Mutex SafeWaitMutex(Mutex mutex, MutexInitializer initializer) { try @@ -1261,7 +1261,7 @@ namespace System.Management.Automation /// /// /// - /// Command name and as appropriate Module name in out parameter + /// Command name and as appropriate Module name in out parameter. internal static string ParseCommandName(string commandName, out string moduleName) { var names = commandName.Split(Separators.Backslash, 2); @@ -1356,7 +1356,7 @@ namespace System.Management.Automation /// NoLanguage -> NoLanguage /// /// ExecutionContext - /// Previous language mode or null for no language mode change + /// Previous language mode or null for no language mode change. internal static PSLanguageMode? EnforceSystemLockDownLanguageMode(ExecutionContext context) { PSLanguageMode? oldMode = null; @@ -1840,7 +1840,7 @@ namespace System.Management.Automation.Internal /// /// Command pipeline to test /// Runspace with imported remote session - /// True if commandPipeline is batched successfully + /// True if commandPipeline is batched successfully. public static bool TestImplicitRemotingBatching(string commandPipeline, System.Management.Automation.Runspaces.Runspace runspace) { return Utils.TryRunAsImplicitBatch(commandPipeline, runspace); diff --git a/src/System.Management.Automation/engine/cmdlet.cs b/src/System.Management.Automation/engine/cmdlet.cs index 94059e171..0c1b7f26b 100644 --- a/src/System.Management.Automation/engine/cmdlet.cs +++ b/src/System.Management.Automation/engine/cmdlet.cs @@ -232,7 +232,7 @@ namespace System.Management.Automation /// /// the base resource name /// the resource id - /// the resource string corresponding to baseName and resourceId + /// The resource string corresponding to baseName and resourceId. /// /// Invalid or , or /// string not found in resources @@ -1611,7 +1611,7 @@ namespace System.Management.Automation /// /// Invoke this cmdlet object returning a collection of results. /// - /// The results that were produced by this class + /// The results that were produced by this class. public IEnumerable Invoke() { using (PSTransactionManager.GetEngineProtectionScope()) @@ -1626,7 +1626,7 @@ namespace System.Management.Automation /// Returns a strongly-typed enumerator for the results of this cmdlet. /// /// The type returned by the enumerator - /// An instance of the appropriate enumerator + /// An instance of the appropriate enumerator. /// Thrown when the object returned by the cmdlet cannot be converted to the target type public IEnumerable Invoke() { diff --git a/src/System.Management.Automation/engine/debugger/Breakpoint.cs b/src/System.Management.Automation/engine/debugger/Breakpoint.cs index db4eb9338..77cb8bbc6 100644 --- a/src/System.Management.Automation/engine/debugger/Breakpoint.cs +++ b/src/System.Management.Automation/engine/debugger/Breakpoint.cs @@ -159,7 +159,7 @@ namespace System.Management.Automation /// /// Gets a string representation of this breakpoint. /// - /// A string representation of this breakpoint + /// A string representation of this breakpoint. public override string ToString() { return IsScriptBreakpoint @@ -265,7 +265,7 @@ namespace System.Management.Automation /// /// Gets the string representation of this breakpoint /// - /// The string representation of this breakpoint + /// The string representation of this breakpoint. public override string ToString() { return IsScriptBreakpoint @@ -340,7 +340,7 @@ namespace System.Management.Automation /// /// Gets a string representation of this breakpoint. /// - /// A string representation of this breakpoint + /// A string representation of this breakpoint. public override string ToString() { return Column == 0 diff --git a/src/System.Management.Automation/engine/debugger/debugger.cs b/src/System.Management.Automation/engine/debugger/debugger.cs index 0ad182a9d..90d3b7092 100644 --- a/src/System.Management.Automation/engine/debugger/debugger.cs +++ b/src/System.Management.Automation/engine/debugger/debugger.cs @@ -494,7 +494,7 @@ namespace System.Management.Automation /// /// IsDebuggerStopEventSubscribed /// - /// True if event subscription exists + /// True if event subscription exists. protected bool IsDebuggerStopEventSubscribed() { return (DebuggerStop != null); @@ -513,7 +513,7 @@ namespace System.Management.Automation /// /// IsDebuggerBreakpointUpdatedEventSubscribed /// - /// True if event subscription exists + /// True if event subscription exists. protected bool IsDebuggerBreakpointUpdatedEventSubscribed() { return (BreakpointUpdated != null); @@ -561,7 +561,7 @@ namespace System.Management.Automation /// /// PowerShell command /// Output - /// DebuggerCommandResults + /// DebuggerCommandResults. public abstract DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output); /// @@ -579,7 +579,7 @@ namespace System.Management.Automation /// Returns current debugger stop event arguments if debugger is in /// debug stop state. Otherwise returns null. /// - /// DebuggerStopEventArgs + /// DebuggerStopEventArgs. public abstract DebuggerStopEventArgs GetDebuggerStopArgs(); /// @@ -667,7 +667,7 @@ namespace System.Management.Automation /// /// Current source line /// Output collection - /// True if source listed successfully + /// True if source listed successfully. internal virtual bool InternalProcessListCommand(int lineNum, IList output) { throw new PSNotImplementedException(); @@ -698,7 +698,7 @@ namespace System.Management.Automation /// /// GetActiveDebuggerCallStack. /// - /// Array of stack frame objects of active debugger + /// Array of stack frame objects of active debugger. internal virtual CallStackFrame[] GetActiveDebuggerCallStack() { throw new PSNotImplementedException(); @@ -2158,7 +2158,7 @@ namespace System.Management.Automation /// /// GetDebuggerStopped /// - /// DebuggerStopEventArgs + /// DebuggerStopEventArgs. public override DebuggerStopEventArgs GetDebuggerStopArgs() { DebuggerStopEventArgs rtnArgs; @@ -2175,7 +2175,7 @@ namespace System.Management.Automation /// /// PowerShell command /// Output - /// DebuggerCommandResults + /// DebuggerCommandResults. public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output) { if (command == null) @@ -2314,7 +2314,7 @@ namespace System.Management.Automation /// /// Returns current call stack. /// - /// IEnumerable of CallStackFrame objects + /// IEnumerable of CallStackFrame objects. public override IEnumerable GetCallStack() { CallStackInfo[] callStack = _callStack.ToArray(); @@ -2444,7 +2444,7 @@ namespace System.Management.Automation /// /// Current source line /// Output collection - /// True if source listed successfully + /// True if source listed successfully. internal override bool InternalProcessListCommand(int lineNum, IList output) { if (!DebuggerStopped || (_currentInvocationInfo == null)) { return false; } @@ -2497,7 +2497,7 @@ namespace System.Management.Automation /// Array of stack frame objects of active debugger if any, /// otherwise null. /// - /// CallStackFrame[] + /// CallStackFrame[]. internal override CallStackFrame[] GetActiveDebuggerCallStack() { Debugger activeDebugger; @@ -3957,7 +3957,7 @@ namespace System.Management.Automation /// /// PowerShell command /// Output collection - /// DebuggerCommandResults + /// DebuggerCommandResults. public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output) { if (_isDisposed) { return new DebuggerCommandResults(null, false); } @@ -4009,7 +4009,7 @@ namespace System.Management.Automation /// Returns current debugger stop event arguments if debugger is in /// debug stop state. Otherwise returns null. /// - /// DebuggerStopEventArgs + /// DebuggerStopEventArgs. public override DebuggerStopEventArgs GetDebuggerStopArgs() { return _wrappedDebugger.GetDebuggerStopArgs(); @@ -4143,7 +4143,7 @@ namespace System.Management.Automation /// such as with Workflow InlineScripts and script Invoke-Command cases. /// /// - /// InvocationInfo + /// InvocationInfo. internal virtual InvocationInfo FixupInvocationInfo(InvocationInfo debugStopInvocationInfo) { // Default is no fix up. @@ -4419,7 +4419,7 @@ namespace System.Management.Automation /// such as with Workflow InlineScripts and script Invoke-Command cases. /// /// Invocation information from debugger stop - /// InvocationInfo + /// InvocationInfo. internal override InvocationInfo FixupInvocationInfo(InvocationInfo debugStopInvocationInfo) { if (debugStopInvocationInfo == null) { return null; } @@ -5340,7 +5340,7 @@ namespace System.Management.Automation.Internal /// history. /// /// Command string - /// True if command can be added to history + /// True if command can be added to history. public static bool ShouldAddCommandToHistory(string command) { if (command == null) @@ -5495,7 +5495,7 @@ namespace System.Management.Automation.Internal /// Creates an instance of a NestedRunspaceDebugger. /// /// Root debugger or null. - /// NestedRunspaceDebugger + /// NestedRunspaceDebugger. internal abstract NestedRunspaceDebugger CreateDebugger(Debugger rootDebugger); #endregion @@ -5535,7 +5535,7 @@ namespace System.Management.Automation.Internal /// Creates an instance of a NestedRunspaceDebugger. /// /// Root debugger or null - /// NestedRunspaceDebugger wrapper + /// NestedRunspaceDebugger wrapper. internal override NestedRunspaceDebugger CreateDebugger(Debugger rootDebugger) { return new StandaloneRunspaceDebugger(Runspace); @@ -5606,7 +5606,7 @@ namespace System.Management.Automation.Internal /// Creates an instance of a NestedRunspaceDebugger. /// /// Root debugger or null - /// NestedRunspaceDebugger wrapper + /// NestedRunspaceDebugger wrapper. internal override NestedRunspaceDebugger CreateDebugger(Debugger rootDebugger) { return new EmbeddedRunspaceDebugger( diff --git a/src/System.Management.Automation/engine/hostifaces/Command.cs b/src/System.Management.Automation/engine/hostifaces/Command.cs index 6e6f31b90..4f34af59d 100644 --- a/src/System.Management.Automation/engine/hostifaces/Command.cs +++ b/src/System.Management.Automation/engine/hostifaces/Command.cs @@ -635,7 +635,7 @@ namespace System.Management.Automation.Runspaces /// that can be used in a remoting protocol data object. /// /// PowerShell remoting protocol version - /// This object as a PSObject property bag + /// This object as a PSObject property bag. internal PSObject ToPSObjectForRemoting(Version psRPVersion) { PSObject commandAsPSObject = RemotingEncoder.CreateEmptyPSObject(); diff --git a/src/System.Management.Automation/engine/hostifaces/Connection.cs b/src/System.Management.Automation/engine/hostifaces/Connection.cs index f234bd62a..6b9d7e287 100644 --- a/src/System.Management.Automation/engine/hostifaces/Connection.cs +++ b/src/System.Management.Automation/engine/hostifaces/Connection.cs @@ -302,7 +302,7 @@ namespace System.Management.Automation.Runspaces /// /// Clones current object /// - /// Cloned object + /// Cloned object. internal RunspaceStateInfo Clone() { return new RunspaceStateInfo(this); @@ -1354,7 +1354,7 @@ namespace System.Management.Automation.Runspaces /// /// Returns Runspace capabilities. /// - /// RunspaceCapability + /// RunspaceCapability. public abstract RunspaceCapability GetCapabilities(); #endregion @@ -1403,7 +1403,7 @@ namespace System.Management.Automation.Runspaces /// /// Create an empty pipeline /// - /// An empty pipeline + /// An empty pipeline. public abstract Pipeline CreatePipeline(); /// @@ -1500,7 +1500,7 @@ namespace System.Management.Automation.Runspaces /// /// Pop the currently running PowerShell from stack. /// - /// PowerShell + /// PowerShell. internal PowerShell PopRunningPowerShell() { lock (_syncObject) diff --git a/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs b/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs index db8005987..d6ad04706 100644 --- a/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs +++ b/src/System.Management.Automation/engine/hostifaces/ConnectionBase.cs @@ -482,7 +482,7 @@ namespace System.Management.Automation.Runspaces /// /// Creates a pipeline object in the Disconnected state. /// - /// Pipeline + /// Pipeline. public override Pipeline CreateDisconnectedPipeline() { // @@ -495,7 +495,7 @@ namespace System.Management.Automation.Runspaces /// /// Creates a powershell object in the Disconnected state. /// - /// PowerShell + /// PowerShell. public override PowerShell CreateDisconnectedPowerShell() { // @@ -508,7 +508,7 @@ namespace System.Management.Automation.Runspaces /// /// Returns Runspace capabilities. /// - /// RunspaceCapability + /// RunspaceCapability. public override RunspaceCapability GetCapabilities() { return RunspaceCapability.Default; @@ -521,7 +521,7 @@ namespace System.Management.Automation.Runspaces /// /// Create an empty pipeline /// - /// An empty pipeline + /// An empty pipeline. public override Pipeline CreatePipeline() { return CoreCreatePipeline(null, false, false); diff --git a/src/System.Management.Automation/engine/hostifaces/History.cs b/src/System.Management.Automation/engine/hostifaces/History.cs index 0a593e6a3..de882a33b 100644 --- a/src/System.Management.Automation/engine/hostifaces/History.cs +++ b/src/System.Management.Automation/engine/hostifaces/History.cs @@ -196,8 +196,8 @@ namespace Microsoft.PowerShell.Commands /// /// /// If true, the entry will not be added when the history is locked - /// id for the new created entry. Use this id to fetch the - /// entry. Returns -1 if the entry is not added + /// Id for the new created entry. Use this id to fetch the + /// entry. Returns -1 if the entry is not added. /// This function is thread safe internal long AddEntry(long pipelineId, string cmdline, PipelineState status, DateTime startTime, DateTime endTime, bool skipIfLocked) { @@ -254,7 +254,7 @@ namespace Microsoft.PowerShell.Commands /// id returned by Add method. /// /// Id of the entry to be fetched - /// entry corresponding to id if it is present else null + /// Entry corresponding to id if it is present else null /// internal HistoryInfo GetEntry(long id) { @@ -277,7 +277,7 @@ namespace Microsoft.PowerShell.Commands /// /// /// - /// history entries + /// History entries. internal HistoryInfo[] GetEntries(long id, long count, SwitchParameter newest) { ReallocateBufferIfNeeded(); @@ -552,7 +552,7 @@ namespace Microsoft.PowerShell.Commands /// Clears the history entry from buffer for a given id. /// /// Id of the entry to be Cleared - /// nothing + /// Nothing. internal void ClearEntry(long id) { lock (_syncRoot) @@ -585,7 +585,7 @@ namespace Microsoft.PowerShell.Commands /// /// gets the total number of entries added /// - ///count of total entries added + ///count of total entries added. internal int Buffercapacity() { @@ -602,7 +602,7 @@ namespace Microsoft.PowerShell.Commands /// /// /// Returns id for the entry. This id should be used to fetch - /// the entry from the buffer + /// the entry from the buffer. /// Id starts from 1 and is incremented by 1 for each new entry private long Add(HistoryInfo entry) @@ -631,7 +631,7 @@ namespace Microsoft.PowerShell.Commands /// id returned by Add method. /// /// Id of the entry to be fetched - /// entry corresponding to id if it is present else null + /// Entry corresponding to id if it is present else null /// private HistoryInfo CoreGetEntry(long id) { @@ -719,7 +719,7 @@ namespace Microsoft.PowerShell.Commands /// /// Get the index for new entry /// - /// Index for new entry + /// Index for new entry. private int GetIndexForNewEntry() { return (int)(_countEntriesAdded % _capacity); @@ -1722,7 +1722,7 @@ namespace Microsoft.PowerShell.Commands /// /// Clears the session history based on the id parameter /// takes no parameters - /// nothing + /// Nothing. /// private void ClearHistoryByID() { @@ -1830,7 +1830,7 @@ namespace Microsoft.PowerShell.Commands /// /// Clears the session history based on the Commandline parameter /// takes no parameters - /// nothing + /// Nothing. /// private void ClearHistoryByCmdLine() { @@ -1897,7 +1897,7 @@ namespace Microsoft.PowerShell.Commands /// count of entries to be cleared /// cmdline string to be cleared /// order of the entries - /// nothing + /// Nothing. /// private void ClearHistoryEntries(long id, int count, string cmdline, SwitchParameter newest) diff --git a/src/System.Management.Automation/engine/hostifaces/HostUtilities.cs b/src/System.Management.Automation/engine/hostifaces/HostUtilities.cs index 8e9655e1b..643478b4b 100644 --- a/src/System.Management.Automation/engine/hostifaces/HostUtilities.cs +++ b/src/System.Management.Automation/engine/hostifaces/HostUtilities.cs @@ -208,7 +208,7 @@ namespace System.Management.Automation /// Used internally in GetFullProfileFileName to get the base path for all users profiles. /// /// The shellId to use. - /// the base path for all users profiles. + /// The base path for all users profiles. private static string GetAllUsersFolderPath(string shellId) { string folderPath = string.Empty; @@ -882,7 +882,7 @@ namespace System.Management.Automation /// /// Runspace to invoke the command on /// Command to invoke - /// Collection of command output result objects + /// Collection of command output result objects. public static Collection InvokeOnRunspace(PSCommand command, Runspace runspace) { if (command == null) diff --git a/src/System.Management.Automation/engine/hostifaces/InternalHost.cs b/src/System.Management.Automation/engine/hostifaces/InternalHost.cs index 341522405..4807857bf 100644 --- a/src/System.Management.Automation/engine/hostifaces/InternalHost.cs +++ b/src/System.Management.Automation/engine/hostifaces/InternalHost.cs @@ -504,8 +504,8 @@ namespace System.Management.Automation.Internal.Host /// /// Checks if the host is in a nested prompt /// - /// true, if host in nested prompt - /// false, otherwise + /// True, if host in nested prompt + /// false, otherwise. internal bool HostInNestedPrompt() { if (NestedPromptCount > 0) diff --git a/src/System.Management.Automation/engine/hostifaces/InternalHostUserInterface.cs b/src/System.Management.Automation/engine/hostifaces/InternalHostUserInterface.cs index d31d483de..e81e5b38f 100644 --- a/src/System.Management.Automation/engine/hostifaces/InternalHostUserInterface.cs +++ b/src/System.Management.Automation/engine/hostifaces/InternalHostUserInterface.cs @@ -439,7 +439,7 @@ namespace System.Management.Automation.Internal.Host /// /// Gets the informational message buffers of the host /// - /// informational message buffers + /// Informational message buffers. internal PSInformationalBuffers GetInformationalMessageBuffers() { return _informationalBuffers; diff --git a/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs b/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs index a1afc3fa3..732501f1c 100644 --- a/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs +++ b/src/System.Management.Automation/engine/hostifaces/LocalConnection.cs @@ -366,7 +366,7 @@ namespace System.Management.Automation.Runspaces /// CreateDebugPerfStruct is a helper method to populate DebugPreference /// /// App Domain Names - /// DebugPreference + /// DebugPreference. private static DebugPreference CreateDebugPreference(string[] AppDomainNames) { DebugPreference DebugPreference = new DebugPreference(); diff --git a/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs b/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs index 4f79d146b..fa32c72bc 100644 --- a/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs +++ b/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs @@ -175,7 +175,7 @@ namespace System.Management.Automation.Runspaces case PSThreadOptions.Default: case PSThreadOptions.UseNewThread: { - // Start execution of pipeline in another thread, + // Start execution of pipeline in another thread, // and support impersonation flow as needed (Windows only). Thread invokeThread = new Thread(new ThreadStart(invokeThreadProcDelegate), DefaultPipelineStackSize); SetupInvokeThread(invokeThread, true); @@ -533,7 +533,7 @@ namespace System.Management.Automation.Runspaces #if !UNIX /// - /// Invokes the InvokeThreadProc() method on new thread, and flows calling thread + /// Invokes the InvokeThreadProc() method on new thread, and flows calling thread /// impersonation as needed. /// private void InvokeThreadProcImpersonate() @@ -826,7 +826,7 @@ namespace System.Management.Automation.Runspaces /// /// Creates a PipelineProcessor object from LocalPipeline object. /// - /// Created PipelineProcessor object + /// Created PipelineProcessor object. private PipelineProcessor CreatePipelineProcessor() { CommandCollection commands = Commands; diff --git a/src/System.Management.Automation/engine/hostifaces/NativeCultureResolver.cs b/src/System.Management.Automation/engine/hostifaces/NativeCultureResolver.cs index 0a10284ac..f08d2f480 100644 --- a/src/System.Management.Automation/engine/hostifaces/NativeCultureResolver.cs +++ b/src/System.Management.Automation/engine/hostifaces/NativeCultureResolver.cs @@ -155,7 +155,7 @@ namespace Microsoft.PowerShell /// /// Clones the custom CultureInfo retaining the fallbacks. /// - /// Cloned custom CultureInfo + /// Cloned custom CultureInfo. public override object Clone() { return new VistaCultureInfo(base.Name, _fallbacks); @@ -314,7 +314,7 @@ namespace Microsoft.PowerShell /// Constructs CultureInfo object without considering any Vista and later /// custom culture fallback logic. /// - /// A CultureInfo object + /// A CultureInfo object. [System.Diagnostics.CodeAnalysis.SuppressMessage("GoldMan", "#pw17903:UseOfLCID", Justification = "This is only called In XP and below where GetUserDefaultLocaleName is not available, or as a fallback when GetThreadPreferredUILanguages fails")] private static CultureInfo EmulateDownLevel() { diff --git a/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs b/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs index cf61707a4..b8c1ba8b3 100644 --- a/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs +++ b/src/System.Management.Automation/engine/hostifaces/PSDataCollection.cs @@ -198,7 +198,7 @@ namespace System.Management.Automation /// Wrap the argument in a PSDataCollection /// /// The value to convert - /// New collection of value, marked as Complete + /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] public static implicit operator PSDataCollection(bool valueToConvert) @@ -210,7 +210,7 @@ namespace System.Management.Automation /// Wrap the argument in a PSDataCollection /// /// The value to convert - /// New collection of value, marked as Complete + /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] public static implicit operator PSDataCollection(string valueToConvert) @@ -222,7 +222,7 @@ namespace System.Management.Automation /// Wrap the argument in a PSDataCollection /// /// The value to convert - /// New collection of value, marked as Complete + /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] public static implicit operator PSDataCollection(int valueToConvert) @@ -234,7 +234,7 @@ namespace System.Management.Automation /// Wrap the argument in a PSDataCollection /// /// The value to convert - /// New collection of value, marked as Complete + /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] public static implicit operator PSDataCollection(byte valueToConvert) @@ -254,7 +254,7 @@ namespace System.Management.Automation /// Wrap the argument in a PSDataCollection /// /// The value to convert - /// New collection of value, marked as Complete + /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] public static implicit operator PSDataCollection(Hashtable valueToConvert) @@ -269,7 +269,7 @@ namespace System.Management.Automation /// Wrap the argument in a PSDataCollection /// /// The value to convert - /// New collection of value, marked as Complete + /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] public static implicit operator PSDataCollection(T valueToConvert) @@ -284,7 +284,7 @@ namespace System.Management.Automation /// Wrap the argument in a PSDataCollection /// /// The value to convert - /// New collection of value, marked as Complete + /// New collection of value, marked as Complete. [SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification = "There are already alternates to the implicit casts, ToXXX and FromXXX methods are unnecessary and redundant")] public static implicit operator PSDataCollection(object[] arrayToConvert) diff --git a/src/System.Management.Automation/engine/hostifaces/Parameter.cs b/src/System.Management.Automation/engine/hostifaces/Parameter.cs index e5adfb377..7e236cb05 100644 --- a/src/System.Management.Automation/engine/hostifaces/Parameter.cs +++ b/src/System.Management.Automation/engine/hostifaces/Parameter.cs @@ -222,7 +222,7 @@ namespace System.Management.Automation.Runspaces /// Returns this object as a PSObject property bag /// that can be used in a remoting protocol data object. /// - /// This object as a PSObject property bag + /// This object as a PSObject property bag. internal PSObject ToPSObjectForRemoting() { PSObject parameterAsPSObject = RemotingEncoder.CreateEmptyPSObject(); diff --git a/src/System.Management.Automation/engine/hostifaces/Pipeline.cs b/src/System.Management.Automation/engine/hostifaces/Pipeline.cs index ae541b9d7..5fa477c62 100644 --- a/src/System.Management.Automation/engine/hostifaces/Pipeline.cs +++ b/src/System.Management.Automation/engine/hostifaces/Pipeline.cs @@ -232,7 +232,7 @@ namespace System.Management.Automation.Runspaces /// /// Clones this object /// - /// Cloned object + /// Cloned object. internal PipelineStateInfo Clone() { return new PipelineStateInfo(this); @@ -535,7 +535,7 @@ namespace System.Management.Automation.Runspaces /// /// an array of input objects to pass to the pipeline. /// Array may be empty but may not be null - /// An array of zero or more result objects + /// An array of zero or more result objects. /// If using synchronous exectute, do not close /// input objectWriter. Synchronous invoke will always close the input /// objectWriter. diff --git a/src/System.Management.Automation/engine/hostifaces/PowerShell.cs b/src/System.Management.Automation/engine/hostifaces/PowerShell.cs index 1f4aaffab..de52475fa 100644 --- a/src/System.Management.Automation/engine/hostifaces/PowerShell.cs +++ b/src/System.Management.Automation/engine/hostifaces/PowerShell.cs @@ -1952,7 +1952,7 @@ namespace System.Management.Automation /// The output buffer to return from EndInvoke. /// An AsyncCallback to be called once the previous invocation has completed. /// A user supplied state to call the with. - /// IAsyncResult + /// IAsyncResult. public IAsyncResult ConnectAsync( PSDataCollection output, AsyncCallback invocationCallback, @@ -2127,7 +2127,7 @@ namespace System.Management.Automation /// True if PowerShell Invoke must run regardless /// of whether debugger handles the command. /// - /// DebuggerCommandResults + /// DebuggerCommandResults. internal void InvokeWithDebugger( IEnumerable input, IList output, @@ -3620,7 +3620,7 @@ namespace System.Management.Automation /// /// Get a steppable pipeline object. /// - /// A steppable pipeline object + /// A steppable pipeline object. /// An attempt was made to use the scriptblock outside of the engine. internal SteppablePipeline GetSteppablePipeline() { @@ -3668,7 +3668,7 @@ namespace System.Management.Automation /// /// engine execution context /// command origin - /// steppable pipeline object + /// Steppable pipeline object. private SteppablePipeline GetSteppablePipeline(ExecutionContext context, CommandOrigin commandOrigin) { // Check for an empty pipeline @@ -5526,7 +5526,7 @@ namespace System.Management.Automation /// Returns this object as a PSObject property bag /// that can be used in a remoting protocol data object. /// - /// This object as a PSObject property bag + /// This object as a PSObject property bag. internal PSObject ToPSObjectForRemoting() { PSObject powerShellAsPSObject = RemotingEncoder.CreateEmptyPSObject(); @@ -5640,7 +5640,7 @@ namespace System.Management.Automation /// control the invocation of the command with /// AsJob Parameter /// - /// Job object + /// Job object. public PSJobProxy AsJobProxy() { // if there are no commands added diff --git a/src/System.Management.Automation/engine/hostifaces/RunspaceInit.cs b/src/System.Management.Automation/engine/hostifaces/RunspaceInit.cs index 7f54c80ab..1e7052d56 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspaceInit.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspaceInit.cs @@ -16,7 +16,7 @@ namespace System.Management.Automation.Runspaces /// /// initialize default values of preference vars /// - /// Does not return a value + /// Does not return a value. /// private void InitializeDefaults() diff --git a/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs b/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs index 4cc0cd3fd..df618a25f 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspaceInvoke.cs @@ -62,7 +62,7 @@ namespace System.Management.Automation /// Invoke the specified script /// /// msh script to invoke - /// Output of invocation + /// Output of invocation. public Collection Invoke(string script) { return Invoke(script, null); @@ -73,7 +73,7 @@ namespace System.Management.Automation /// /// msh script to invoke /// input to script - /// Output of invocation + /// Output of invocation. public Collection Invoke(string script, IEnumerable input) { if (_disposed == true) @@ -96,7 +96,7 @@ namespace System.Management.Automation /// msh script to invoke /// input to script /// this gets errors from script - /// output of invocation + /// Output of invocation. /// /// is the non-terminating error stream /// from the command. diff --git a/src/System.Management.Automation/engine/hostifaces/RunspacePool.cs b/src/System.Management.Automation/engine/hostifaces/RunspacePool.cs index 7961c3db3..2005abc13 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspacePool.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspacePool.cs @@ -1009,7 +1009,7 @@ namespace System.Management.Automation.Runspaces /// /// Returns RunspacePool capabilities. /// - /// RunspacePoolCapability + /// RunspacePoolCapability. public RunspacePoolCapability GetCapabilities() { return _internalPool.GetCapabilities(); diff --git a/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs b/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs index 8d77a72c3..b0ada3278 100644 --- a/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs +++ b/src/System.Management.Automation/engine/hostifaces/RunspacePoolInternal.cs @@ -394,7 +394,7 @@ namespace System.Management.Automation.Runspaces.Internal /// /// Returns RunspacePool capabilities. /// - /// RunspacePoolCapability + /// RunspacePoolCapability. public virtual RunspacePoolCapability GetCapabilities() { return RunspacePoolCapability.Default; @@ -409,7 +409,7 @@ namespace System.Management.Automation.Runspaces.Internal /// runspace. /// This is currently supported *only* for remote runspaces. /// - /// True if successful + /// True if successful. internal virtual bool ResetRunspaceState() { throw new PSNotSupportedException(); diff --git a/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs b/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs index 16b7c69b8..35464dbb2 100644 --- a/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs +++ b/src/System.Management.Automation/engine/hostifaces/pipelinebase.cs @@ -366,7 +366,7 @@ namespace System.Management.Automation.Runspaces /// /// an array of input objects to pass to the pipeline. /// Array may be empty but may not be null - /// An array of zero or more result objects + /// An array of zero or more result objects. /// Caller of synchronous exectute should not close /// input objectWriter. Synchronous invoke will always close the input /// objectWriter. diff --git a/src/System.Management.Automation/engine/lang/interface/PSParser.cs b/src/System.Management.Automation/engine/lang/interface/PSParser.cs index 2e44c6227..3ae02a7cb 100644 --- a/src/System.Management.Automation/engine/lang/interface/PSParser.cs +++ b/src/System.Management.Automation/engine/lang/interface/PSParser.cs @@ -135,7 +135,7 @@ namespace System.Management.Automation /// /// script to parse /// errors happened during parsing - /// collection of tokens generated during parsing + /// Collection of tokens generated during parsing. /// /// Although this API returns most parse-time exceptions in the errors /// collection, there are some scenarios where resource limits will result @@ -162,7 +162,7 @@ namespace System.Management.Automation /// /// script to parse, as an array of lines /// errors happened during parsing - /// collection of tokens generated during parsing + /// Collection of tokens generated during parsing. /// /// Although this API returns most parse-time exceptions in the errors /// collection, there are some scenarios where resource limits will result diff --git a/src/System.Management.Automation/engine/lang/interface/PSToken.cs b/src/System.Management.Automation/engine/lang/interface/PSToken.cs index 2f90d6205..4de53f3bc 100644 --- a/src/System.Management.Automation/engine/lang/interface/PSToken.cs +++ b/src/System.Management.Automation/engine/lang/interface/PSToken.cs @@ -76,7 +76,7 @@ namespace System.Management.Automation /// Map a V3 token to a V2 PSTokenType /// /// The V3 token - /// The V2 PSTokenType + /// The V2 PSTokenType. public static PSTokenType GetPSTokenType(Token token) { if ((token.TokenFlags & TokenFlags.CommandName) != 0) diff --git a/src/System.Management.Automation/engine/lang/parserutils.cs b/src/System.Management.Automation/engine/lang/parserutils.cs index 58220b47c..d5869f035 100644 --- a/src/System.Management.Automation/engine/lang/parserutils.cs +++ b/src/System.Management.Automation/engine/lang/parserutils.cs @@ -365,7 +365,7 @@ namespace System.Management.Automation /// Convert an object into an int, avoiding boxing small integers... /// /// The int to convert - /// The reference equivalent + /// The reference equivalent. internal static object IntToObject(int value) { if (value < _MaxCache && value >= _MinCache) @@ -434,7 +434,7 @@ namespace System.Management.Automation /// 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 result of the operation + /// 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) { @@ -776,7 +776,7 @@ namespace System.Management.Automation /// The execution context to use /// The position to use for error reporting. /// left operand - /// The result of the operator + /// The result of the operator. internal static object UnaryJoinOperator(ExecutionContext context, IScriptExtent errorPosition, object lval) { return JoinOperator(context, errorPosition, lval, string.Empty); @@ -789,7 +789,7 @@ namespace System.Management.Automation /// The position to use for error reporting. /// left operand /// right operand - /// The result of the operator + /// The result of the operator. internal static object JoinOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval) { string separator = PSObject.ToStringParser(context, rval); @@ -901,7 +901,7 @@ namespace System.Management.Automation /// The object on which to replace the values /// The replacement description. /// True for -ireplace/-replace, false for -creplace - /// The result of the operator + /// The result of the operator. internal static object ReplaceOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, bool ignoreCase) { object pattern = string.Empty; @@ -982,7 +982,7 @@ namespace System.Management.Automation /// The input string /// A Regex instance. /// The substitute value - /// The result of the regex.Replace operation + /// The result of the regex.Replace operation. private static object ReplaceOperatorImpl(ExecutionContext context, string input, Regex regex, object substitute) { switch (substitute) @@ -1020,7 +1020,7 @@ namespace System.Management.Automation /// The position to use for error reporting. /// left operand /// right operand - /// The result of the operator + /// The result of the operator. internal static object IsOperator(ExecutionContext context, IScriptExtent errorPosition, object left, object right) { object lval = PSObject.Base(left); @@ -1061,7 +1061,7 @@ namespace System.Management.Automation /// The position to use for error reporting. /// left operand /// right operand - /// The result of the operator + /// The result of the operator. internal static object IsNotOperator(ExecutionContext context, IScriptExtent errorPosition, object left, object right) { object lval = PSObject.Base(left); @@ -1103,7 +1103,7 @@ namespace System.Management.Automation /// left operand /// right operand /// the operator - /// The result of the operator + /// The result of the operator. internal static object LikeOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, TokenKind @operator) { var wcp = rval as WildcardPattern; @@ -1149,7 +1149,7 @@ namespace System.Management.Automation /// right operand /// ignore case? /// true for -notmatch, false for -match - /// The result of the operator + /// The result of the operator. internal static object MatchOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, bool notMatch, bool ignoreCase) { RegexOptions reOptions = ignoreCase ? RegexOptions.IgnoreCase : RegexOptions.None; @@ -1285,7 +1285,7 @@ namespace System.Management.Automation /// right operand /// ignore case? /// true for -contains, false for -notcontains - /// The result of the operator + /// The result of the operator. internal static object ContainsOperator(ExecutionContext context, IScriptExtent errorPosition, object left, object right, bool contains, bool ignoreCase) { IEnumerator list = LanguagePrimitives.GetEnumerator(left); @@ -1373,7 +1373,7 @@ namespace System.Management.Automation /// The position to use for error reporting. /// THe enumerator to advance. /// An error occurred moving to the next element in the enumeration - /// True if the move succeeded + /// True if the move succeeded. internal static bool MoveNext(ExecutionContext context, IScriptExtent errorPosition, IEnumerator enumerator) { try @@ -1438,7 +1438,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 obj's type full name + /// The obj's type full name. internal static string GetTypeFullName(object obj) { if (obj == null) @@ -1760,7 +1760,7 @@ namespace System.Management.Automation /// Resource string that holds the error message /// /// Insertion parameters to message - /// A new instance of the specified exception type + /// A new instance of the specified exception type. internal static RuntimeException NewInterpreterException(object targetObject, Type exceptionType, IScriptExtent errorPosition, string resourceIdAndErrorId, string resourceString, params object[] args) { @@ -1781,7 +1781,7 @@ namespace System.Management.Automation /// /// inner exception /// Insertion parameters to message - /// New instance of an interpreter exception + /// New instance of an interpreter exception. internal static RuntimeException NewInterpreterExceptionWithInnerException(object targetObject, Type exceptionType, IScriptExtent errorPosition, string resourceIdAndErrorId, string resourceString, Exception innerException, params object[] args) { @@ -1856,7 +1856,7 @@ namespace System.Management.Automation /// Message /// ErrorID /// inner exception - /// New instance of ParseException + /// 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 9aa81841b..38bc67b9a 100644 --- a/src/System.Management.Automation/engine/lang/scriptblock.cs +++ b/src/System.Management.Automation/engine/lang/scriptblock.cs @@ -336,7 +336,7 @@ namespace System.Management.Automation /// /// Get a steppable pipeline object. /// - /// A steppable pipeline object + /// A steppable pipeline object. [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Steppable", Justification = "Review this during API naming")] public SteppablePipeline GetSteppablePipeline() { @@ -346,7 +346,7 @@ namespace System.Management.Automation /// /// Get a steppable pipeline object. /// - /// A steppable pipeline object + /// A steppable pipeline object. [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Steppable", Justification = "Review this during API naming")] public SteppablePipeline GetSteppablePipeline(CommandOrigin commandOrigin) { @@ -356,7 +356,7 @@ namespace System.Management.Automation /// /// Get a steppable pipeline object. /// - /// A steppable pipeline object + /// A steppable pipeline object. [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Steppable", Justification = "Review this during API naming")] public SteppablePipeline GetSteppablePipeline(CommandOrigin commandOrigin, object[] args) { @@ -369,7 +369,7 @@ namespace System.Management.Automation /// /// The arguments to this script. /// The object(s) generated during the execution of - /// the script block returned as a collection of PSObjects + /// the script block returned as a collection of PSObjects. /// Thrown if a script runtime exceptionexception occurred /// An internal (non-public) exception from a flow control statement public Collection Invoke(params object[] args) @@ -523,7 +523,7 @@ namespace System.Management.Automation // method returns [object]. If the argument to 'return' // is a pipeline that emits nothing then result.Count will // be zero so we catch that and "convert" it to null. Note that - // the return statement is still required in the method, it + // the return statement is still required in the method, it // just recieves nothing from it's argument. if (result.Count == 0) { @@ -836,7 +836,7 @@ namespace System.Management.Automation /// /// The arguments to this script. /// The object(s) generated during the execution of - /// the script block returned as a collection of PSObjects + /// the script block returned as a collection of PSObjects. /// A script exception occurred /// Internal exception from a flow control statement internal Collection DoInvoke(object dollarUnder, object input, object[] args) @@ -893,7 +893,7 @@ namespace System.Management.Automation /// /// The arguments to this script. /// The object(s) generated during the execution of - /// the script block returned as a collection of PSObjects + /// the script block returned as a collection of PSObjects. /// A script exception occurred /// Internal exception from a flow control statement internal object DoInvokeReturnAsIs(bool useLocalScope, @@ -1131,7 +1131,7 @@ namespace System.Management.Automation /// Process a single input object. /// /// The object to process - /// a collection of 0 or more result objects + /// A collection of 0 or more result objects. public Array Process(object input) { try @@ -1185,7 +1185,7 @@ namespace System.Management.Automation /// Begin() was called with $false so we won't send any /// input to be processed. /// - /// The result of the execution + /// The result of the execution. public Array Process() { try diff --git a/src/System.Management.Automation/engine/parser/Compiler.cs b/src/System.Management.Automation/engine/parser/Compiler.cs index d4184de36..8254d1978 100644 --- a/src/System.Management.Automation/engine/parser/Compiler.cs +++ b/src/System.Management.Automation/engine/parser/Compiler.cs @@ -2396,7 +2396,7 @@ namespace System.Management.Automation.Language /// /// /// non-empty array of TypeDefinitionAst - /// Assembly with defined types + /// Assembly with defined types. internal static Assembly DefinePowerShellTypes(Ast rootForDefiningTypes, TypeDefinitionAst[] typeAsts) { // TODO(sevoroby): this Diagnostic is conceptually right. @@ -2540,7 +2540,7 @@ namespace System.Management.Automation.Language /// Take module info of module that can be already loaded or not and loads it. /// /// - /// module info of the same module, but loaded + /// Module info of the same module, but loaded. private static PSModuleInfo LoadModule(PSModuleInfo originalModuleInfo) { // originalModuleInfo is created during parse time and may not contain [System.Type] types exported from the module. diff --git a/src/System.Management.Automation/engine/parser/Parser.cs b/src/System.Management.Automation/engine/parser/Parser.cs index 457bfb3b5..71ac331da 100644 --- a/src/System.Management.Automation/engine/parser/Parser.cs +++ b/src/System.Management.Automation/engine/parser/Parser.cs @@ -6978,7 +6978,7 @@ namespace System.Management.Automation.Language // ErrorRecovery: pretend we saw a statement and keep parsing. IScriptExtent errorExtent = After(equals); - + string errorId; string errorMsg; if (parsingSchemaElement) diff --git a/src/System.Management.Automation/engine/parser/SymbolResolver.cs b/src/System.Management.Automation/engine/parser/SymbolResolver.cs index 05276084a..67b32efe2 100644 --- a/src/System.Management.Automation/engine/parser/SymbolResolver.cs +++ b/src/System.Management.Automation/engine/parser/SymbolResolver.cs @@ -252,7 +252,7 @@ namespace System.Management.Automation.Language /// /// Return the most deep typeDefinitionAst in the current context. /// - /// typeDefinitionAst or null, if currently not in type definition + /// TypeDefinitionAst or null, if currently not in type definition. public TypeDefinitionAst GetCurrentTypeDefinitionAst() { for (int i = _scopes.Count - 1; i >= 0; i--) diff --git a/src/System.Management.Automation/engine/parser/ast.cs b/src/System.Management.Automation/engine/parser/ast.cs index 892f4b12d..1d1267a7a 100644 --- a/src/System.Management.Automation/engine/parser/ast.cs +++ b/src/System.Management.Automation/engine/parser/ast.cs @@ -188,7 +188,7 @@ namespace System.Management.Automation.Language /// /// Constructs the resultant object from the AST and returns it if it is safe. /// - /// The object represented by the AST as a safe object + /// The object represented by the AST as a safe object. /// /// If is deemed unsafe /// @@ -2932,7 +2932,7 @@ namespace System.Management.Automation.Language /// Define imported module and all type definitions imported by this using statement. /// /// - /// return ExportedTypeTable for this module + /// Return ExportedTypeTable for this module. internal ReadOnlyDictionary DefineImportedModule(PSModuleInfo moduleInfo) { var types = moduleInfo.GetExportedTypeDefinitions(); @@ -2943,7 +2943,7 @@ namespace System.Management.Automation.Language /// /// Is UsingStatementKind Module or Assembly. /// - /// true, if it is. + /// True, if it is. internal bool IsUsingModuleOrAssembly() { return UsingStatementKind == UsingStatementKind.Assembly || UsingStatementKind == UsingStatementKind.Module; diff --git a/src/System.Management.Automation/engine/parser/tokenizer.cs b/src/System.Management.Automation/engine/parser/tokenizer.cs index 9c837612d..f9eb0a3d2 100644 --- a/src/System.Management.Automation/engine/parser/tokenizer.cs +++ b/src/System.Management.Automation/engine/parser/tokenizer.cs @@ -226,7 +226,7 @@ namespace System.Management.Automation.Language /// /// Duplicates the DynamicKeyword /// - /// A copy of the DynamicKeyword + /// A copy of the DynamicKeyword. public DynamicKeyword Copy() { DynamicKeyword keyword = new DynamicKeyword() diff --git a/src/System.Management.Automation/engine/pipeline.cs b/src/System.Management.Automation/engine/pipeline.cs index 29c84db0b..3c9cbd788 100644 --- a/src/System.Management.Automation/engine/pipeline.cs +++ b/src/System.Management.Automation/engine/pipeline.cs @@ -270,7 +270,7 @@ namespace System.Management.Automation.Internal /// /// Add a single InternalCommand to the end of the pipeline /// - /// Results from last pipeline stage + /// Results from last pipeline stage. /// /// see AddCommand /// @@ -298,7 +298,7 @@ namespace System.Management.Automation.Internal /// /// 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 + /// Reference number of this command for use in readFromCommand. /// /// /// FirstCommandCannotHaveInput: must be zero @@ -675,7 +675,7 @@ namespace System.Management.Automation.Internal /// Implements DoComplete as a stand-alone function for completing /// the execution of a steppable pipeline. /// - /// The results of the execution + /// The results of the execution. internal Array DoComplete() { if (Stopping) @@ -1384,7 +1384,7 @@ namespace System.Management.Automation.Internal /// /// error which terminated the pipeline /// command against which to log SecondFailure - /// true iff the pipeline was not already stopped + /// True iff the pipeline was not already stopped. internal bool RecordFailure(Exception e, InternalCommand command) { bool wasStopping = false; diff --git a/src/System.Management.Automation/engine/regex.cs b/src/System.Management.Automation/engine/regex.cs index cd4196f57..1626b176c 100644 --- a/src/System.Management.Automation/engine/regex.cs +++ b/src/System.Management.Automation/engine/regex.cs @@ -86,7 +86,7 @@ namespace System.Management.Automation /// for the specified wildcard pattern. /// /// The wildcard pattern to match - /// The constructed WildcardPattern object + /// The constructed WildcardPattern object. /// if wildCardType == None, the pattern does not have wild cards public WildcardPattern(string pattern) { @@ -105,7 +105,7 @@ namespace System.Management.Automation /// /// The wildcard pattern to match. /// Wildcard options - /// The constructed WildcardPattern object + /// The constructed WildcardPattern object. /// if wildCardType == None, the pattern does not have wild cards public WildcardPattern(string pattern, WildcardOptions options) @@ -141,7 +141,7 @@ namespace System.Management.Automation /// /// Instantiate internal regex member if not already done. /// - /// true on success, false otherwise + /// True on success, false otherwise. /// private void Init() { @@ -164,7 +164,7 @@ namespace System.Management.Automation /// constructor finds a match in the input string. /// /// The string to search for a match. - /// true if the wildcard pattern finds a match; otherwise, false + /// True if the wildcard pattern finds a match; otherwise, false. public bool IsMatch(string input) { Init(); @@ -245,7 +245,7 @@ namespace System.Management.Automation /// /// String which needs to be checked for the presence of wildcard chars /// - /// true if the string has wild card chars, false otherwise. + /// True if the string has wild card chars, false otherwise.. /// /// Currently { '*', '?', '[' } are considered wild card chars and /// '`' is the escape character. @@ -402,7 +402,7 @@ namespace System.Management.Automation /// /// ErrorRecord object containing additional information about the error condition. /// - /// constructed object + /// Constructed object. internal WildcardPatternException(ErrorRecord errorRecord) : base(RetrieveMessage(errorRecord)) { diff --git a/src/System.Management.Automation/engine/remoting/client/Job.cs b/src/System.Management.Automation/engine/remoting/client/Job.cs index 6b96c98f8..223985655 100644 --- a/src/System.Management.Automation/engine/remoting/client/Job.cs +++ b/src/System.Management.Automation/engine/remoting/client/Job.cs @@ -294,7 +294,7 @@ namespace System.Management.Automation /// /// Clones this object /// - /// Cloned object + /// Cloned object. internal JobStateInfo Clone() { return new JobStateInfo(this); @@ -1335,7 +1335,7 @@ namespace System.Management.Automation /// Returns runspaces associated with the Job, including /// child jobs. /// - /// IEnumerable of RemoteRunspaces + /// IEnumerable of RemoteRunspaces. internal virtual IEnumerable GetRunspaces() { return null; @@ -1474,7 +1474,7 @@ namespace System.Management.Automation /// after clearing up all the internal /// structures /// - /// collection of stream objects + /// Collection of stream objects. internal Collection ReadAll() { Output.Clear(); @@ -1536,7 +1536,7 @@ namespace System.Management.Automation /// Automatically generate a job name if the user /// does not supply one /// - /// auto generated job name + /// Auto generated job name. /// Since the user can script/program against the /// job name, the auto generated name will not be /// localizable @@ -1597,7 +1597,7 @@ namespace System.Management.Automation /// Gets the job for the specified location /// /// location to filter on - /// collection of jobs + /// Collection of jobs. internal List GetJobsForLocation(string location) { List returnJobList = new List(); @@ -1900,7 +1900,7 @@ namespace System.Management.Automation /// /// computername for which entity /// result is required - /// entity result + /// Entity result. internal List GetJobsForComputer(string computerName) { List returnJobList = new List(); @@ -1924,7 +1924,7 @@ namespace System.Management.Automation /// /// runspace for which entity /// result is required - /// entity result + /// Entity result. internal List GetJobsForRunspace(PSSession runspace) { List returnJobList = new List(); @@ -1947,7 +1947,7 @@ namespace System.Management.Automation /// /// helper for which entity /// result is required - /// entity result + /// Entity result. internal List GetJobsForOperation(IThrottleOperation operation) { List returnJobList = new List(); @@ -2622,7 +2622,7 @@ namespace System.Management.Automation /// Returns runspaces associated with the Job, including /// child jobs. /// - /// IEnumerable of RemoteRunspaces + /// IEnumerable of RemoteRunspaces. internal override IEnumerable GetRunspaces() { List runspaces = new List(); @@ -3528,7 +3528,7 @@ namespace System.Management.Automation /// /// remote pipeline /// instance as described in event args - /// PowerShell instance + /// PowerShell instance. private PowerShell GetPipelinePowerShell(RemotePipeline pipeline, Guid instanceId) { if (pipeline != null) @@ -3764,7 +3764,7 @@ namespace System.Management.Automation /// Returns the PowerShell for the specified instance id /// /// instance id of powershell - /// powershell instance + /// Powershell instance. internal virtual PowerShell GetPowerShell(Guid instanceId) { // this should be called only in the derived implementation @@ -3895,7 +3895,7 @@ namespace System.Management.Automation /// /// PowerShell command /// Output - /// DebuggerCommandResults + /// DebuggerCommandResults. public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output) { // Special handling for the prompt command. @@ -3928,7 +3928,7 @@ namespace System.Management.Automation /// Returns current debugger stop event arguments if debugger is in /// debug stop state. Otherwise returns null. /// - /// DebuggerStopEventArgs + /// DebuggerStopEventArgs. public override DebuggerStopEventArgs GetDebuggerStopArgs() { return _wrappedDebugger.GetDebuggerStopArgs(); @@ -4313,7 +4313,7 @@ namespace System.Management.Automation /// Returns the PowerShell instance for the specified id /// /// instance id of PowerShell - /// PowerShell instance + /// PowerShell instance. internal override PowerShell GetPowerShell(Guid instanceId) { PowerShell powershell = null; @@ -4368,8 +4368,8 @@ namespace System.Management.Automation /// /// Determines if the job is in a terminal state /// - /// true, if job in terminal state - /// false otherwise + /// True, if job in terminal state + /// false otherwise. internal bool IsTerminalState() { return (IsFinishedState(this.JobStateInfo.State) || diff --git a/src/System.Management.Automation/engine/remoting/client/Job2.cs b/src/System.Management.Automation/engine/remoting/client/Job2.cs index b069d8066..5de8b13d4 100644 --- a/src/System.Management.Automation/engine/remoting/client/Job2.cs +++ b/src/System.Management.Automation/engine/remoting/client/Job2.cs @@ -1814,7 +1814,7 @@ namespace System.Management.Automation /// /// /// - /// true if the job state needs to be modified, false otherwise + /// True if the job state needs to be modified, false otherwise. internal static bool ComputeJobStateFromChildJobStates(string traceClassName, JobStateEventArgs e, ref int blockedChildJobsCount, ref int suspendedChildJobsCount, ref int suspendingChildJobsCount, ref int finishedChildJobsCount, ref int failedChildJobsCount, ref int stoppedChildJobsCount, int childJobsCount, diff --git a/src/System.Management.Automation/engine/remoting/client/JobManager.cs b/src/System.Management.Automation/engine/remoting/client/JobManager.cs index a1a711366..216819b14 100644 --- a/src/System.Management.Automation/engine/remoting/client/JobManager.cs +++ b/src/System.Management.Automation/engine/remoting/client/JobManager.cs @@ -326,7 +326,7 @@ namespace System.Management.Automation /// otherwise load the associated module and the requested source adapter. /// /// JobDefinition supplies the JobSourceAdapter information. - /// JobSourceAdapter + /// JobSourceAdapter. private JobSourceAdapter GetJobSourceAdapter(JobDefinition definition) { string adapterTypeName; @@ -793,7 +793,7 @@ namespace System.Management.Automation /// JobSourceAdapter type that contains the job definition. /// Cmdlet making call. /// Whether to write jobsourceadapter errors. - /// List of matching Job2 objects + /// List of matching Job2 objects. internal List GetJobToStart( string definitionName, string definitionPath, @@ -879,7 +879,7 @@ namespace System.Management.Automation /// Returns a List of adapter names currently loaded. /// /// Adapter names to filter on - /// List of names + /// List of names. internal List GetLoadedAdapterNames(string[] adapterTypeNames) { List adapterNames = new List(); diff --git a/src/System.Management.Automation/engine/remoting/client/JobSourceAdapter.cs b/src/System.Management.Automation/engine/remoting/client/JobSourceAdapter.cs index d34a26a01..6f58b27c5 100644 --- a/src/System.Management.Automation/engine/remoting/client/JobSourceAdapter.cs +++ b/src/System.Management.Automation/engine/remoting/client/JobSourceAdapter.cs @@ -354,7 +354,7 @@ namespace System.Management.Automation /// Utility function to turn a dictionary of name/value pairs into a parameter collection /// /// The dictionary to convert - /// The converted collection + /// The converted collection. private static CommandParameterCollection ConvertDictionaryToParameterCollection(IEnumerable> parameters) { if (parameters == null) @@ -388,7 +388,7 @@ namespace System.Management.Automation /// The original job must have been saved using "SaveJobIdForReconstruction" /// /// Instance Id of the job to recreate - /// JobIdentifier to be used in job construction + /// JobIdentifier to be used in job construction. protected JobIdentifier RetrieveJobIdForReuse(Guid instanceId) { return JobManager.GetJobIdentifier(instanceId, this.GetType().Name); @@ -442,7 +442,7 @@ namespace System.Management.Automation /// Create a new job with the specified definition /// /// job definition to use - /// job object + /// Job object. public Job2 NewJob(JobDefinition definition) { return NewJob(new JobInvocationInfo(definition, new Dictionary())); @@ -456,7 +456,7 @@ namespace System.Management.Automation /// /// Job definition name /// Job definition file path - /// Job2 object + /// Job2 object. public virtual Job2 NewJob(string definitionName, string definitionPath) { return null; @@ -466,14 +466,14 @@ namespace System.Management.Automation /// Create a new job with the specified JobSpecification /// /// specification - /// job object + /// Job object. public abstract Job2 NewJob(JobInvocationInfo specification); /// /// Get the list of jobs that are currently available in this /// store /// - /// collection of job objects + /// Collection of job objects. public abstract IList GetJobs(); /// @@ -482,8 +482,8 @@ namespace System.Management.Automation /// names to match, can support /// wildcard if the store supports /// - /// collection of jobs that match the specified - /// criteria + /// Collection of jobs that match the specified + /// criteria. public abstract IList GetJobsByName(string name, bool recurse); /// @@ -491,8 +491,8 @@ namespace System.Management.Automation /// /// command to match /// - /// collection of jobs that match the specified - /// criteria + /// Collection of jobs that match the specified + /// criteria. public abstract IList GetJobsByCommand(string command, bool recurse); /// @@ -500,7 +500,7 @@ namespace System.Management.Automation /// /// Guid to match /// - /// job with the specified guid + /// Job with the specified guid. public abstract Job2 GetJobByInstanceId(Guid instanceId, bool recurse); /// @@ -508,7 +508,7 @@ namespace System.Management.Automation /// /// Id to match /// - /// Job with the specified id + /// Job with the specified id. public abstract Job2 GetJobBySessionId(int id, bool recurse); /// @@ -516,8 +516,8 @@ namespace System.Management.Automation /// /// state to match /// - /// collection of jobs with the specified - /// state + /// Collection of jobs with the specified + /// state. public abstract IList GetJobsByState(JobState state, bool recurse); /// @@ -527,8 +527,8 @@ namespace System.Management.Automation /// dictionary containing name value /// pairs for adapter specific filters /// - /// collection of jobs that match the - /// specified criteria + /// Collection of jobs that match the + /// specified criteria. public abstract IList GetJobsByFilter(Dictionary filter, bool recurse); /// diff --git a/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs b/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs index 3ca1d2c20..0f4652073 100644 --- a/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs +++ b/src/System.Management.Automation/engine/remoting/client/PSProxyJob.cs @@ -1165,7 +1165,7 @@ namespace System.Management.Automation /// /// Type of the collection /// collection to check - /// true if the collection has more data + /// True if the collection has more data. private static bool CollectionHasMoreData(PSDataCollection collection) { return (collection.IsOpen || collection.Count > 0); diff --git a/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs b/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs index 73597347c..e7ebd86d9 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemoteRunspacePoolInternal.cs @@ -295,7 +295,7 @@ namespace System.Management.Automation.Runspaces.Internal /// runspace. /// This is currently supported *only* for remote runspaces. /// - /// True if successful + /// True if successful. internal override bool ResetRunspaceState() { // Version check. Reset Runspace is supported only on PSRP protocol @@ -450,7 +450,7 @@ namespace System.Management.Automation.Runspaces.Internal /// Retrieves the number of runspaces available at the time of calling /// this method from the remote server /// - /// The number of runspaces available in the pool + /// The number of runspaces available in the pool. internal override int GetAvailableRunspaces() { int availableRunspaces = 0; @@ -789,7 +789,7 @@ namespace System.Management.Automation.Runspaces.Internal /// /// Pop the currently running PowerShell from stack. /// - /// PowerShell + /// PowerShell. internal PowerShell PopRunningPowerShell() { PowerShell powershell; @@ -804,7 +804,7 @@ namespace System.Management.Automation.Runspaces.Internal /// /// Return the current running PowerShell. /// - /// PowerShell + /// PowerShell. internal PowerShell GetCurrentRunningPowerShell() { PowerShell powershell; @@ -1012,7 +1012,7 @@ namespace System.Management.Automation.Runspaces.Internal /// /// AsyncCallback object. /// state object. - /// IAsyncResult + /// IAsyncResult. public override IAsyncResult BeginDisconnect(AsyncCallback callback, object state) { if (!CanDisconnect) @@ -1103,7 +1103,7 @@ namespace System.Management.Automation.Runspaces.Internal /// /// ASyncCallback object. /// state Object. - /// IAsyncResult + /// IAsyncResult. public override IAsyncResult BeginConnect(AsyncCallback callback, object state) { if (!AvailableForConnection) @@ -1227,7 +1227,7 @@ namespace System.Management.Automation.Runspaces.Internal /// /// Returns RunspacePool capabilities. /// - /// RunspacePoolCapability + /// RunspacePoolCapability. public override RunspacePoolCapability GetCapabilities() { RunspacePoolCapability returnCaps = RunspacePoolCapability.Default; @@ -2102,7 +2102,7 @@ namespace System.Management.Automation.Runspaces.Internal /// object used for Get-WSManInstance queries. /// /// WSManConnectionInfo - /// WSMan session options object + /// WSMan session options object. private static object GetSessionOptions(WSManConnectionInfo wsmanConnectionInfo) { Collection result; diff --git a/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs b/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs index 0f385b219..9bce80c35 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemotingErrorRecord.cs @@ -367,7 +367,7 @@ namespace System.Management.Automation.Remoting /// /// Overridden ToString() method /// - /// returns the computername + /// Returns the computername. public override string ToString() { return PSComputerName; diff --git a/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs b/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs index ba0e734d9..c5fe3cf96 100644 --- a/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs +++ b/src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs @@ -210,7 +210,7 @@ namespace System.Management.Automation.Internal /// with this runspace pool data structure handler /// /// associated powershell - /// PowerShell data structure handler object + /// PowerShell data structure handler object. internal ClientPowerShellDataStructureHandler CreatePowerShellDataStructureHandler( ClientRemotePowerShell shell) { @@ -668,7 +668,7 @@ namespace System.Management.Automation.Internal /// Gets the ClientPowerShellDataStructureHandler instance for the specified id /// /// id of the client remote powershell - /// ClientPowerShellDataStructureHandler object + /// ClientPowerShellDataStructureHandler object. private ClientPowerShellDataStructureHandler GetAssociatedPowerShellDataStructureHandler (Guid clientPowerShellId) { diff --git a/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs b/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs index dd07a56fc..6531b06d9 100644 --- a/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs +++ b/src/System.Management.Automation/engine/remoting/client/remotepipeline.cs @@ -414,7 +414,7 @@ namespace System.Management.Automation /// /// an array of input objects to pass to the pipeline. /// Array may be empty but may not be null - /// An array of zero or more result objects + /// An array of zero or more result objects. /// Caller of synchronous exectute should not close /// input objectWriter. Synchronous invoke will always close the input /// objectWriter. diff --git a/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs b/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs index d8305db30..bbeed2c30 100644 --- a/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs +++ b/src/System.Management.Automation/engine/remoting/client/remoterunspace.cs @@ -772,7 +772,7 @@ namespace System.Management.Automation /// Optional command Id to connect to /// Optional PSHost /// Optional TypeTable - /// Disconnect remote Runspace object + /// Disconnect remote Runspace object. internal static Runspace GetRemoteRunspace(RunspaceConnectionInfo connectionInfo, Guid sessionId, Guid? commandId, PSHost host, TypeTable typeTable) { RunspacePool runspacePool = RemoteRunspacePoolInternal.GetRemoteRunspacePool( @@ -950,7 +950,7 @@ namespace System.Management.Automation /// /// Returns Runspace capabilities. /// - /// RunspaceCapability + /// RunspaceCapability. public override RunspaceCapability GetCapabilities() { RunspaceCapability returnCaps = RunspaceCapability.Default; @@ -1023,7 +1023,7 @@ namespace System.Management.Automation /// /// Create an empty pipeline /// - /// An empty pipeline + /// An empty pipeline. public override Pipeline CreatePipeline() { return CoreCreatePipeline(null, false, false); @@ -1397,7 +1397,7 @@ namespace System.Management.Automation /// An exception indicating the state change is the /// result of an error, otherwise; null. /// - /// Previous runspace state + /// Previous runspace state. /// /// Sets the internal runspace state information member variable. It also /// adds RunspaceStateInfo to a queue. @@ -1666,8 +1666,8 @@ namespace System.Management.Automation /// current invoke-command /// instance /// local pipeline id - /// true, if another invoke-command is running - /// before, false otherwise + /// True, if another invoke-command is running + /// before, false otherwise. internal bool IsAnotherInvokeCommandExecuting(InvokeCommandCommand invokeCommand, long localPipelineId) { @@ -1875,7 +1875,7 @@ namespace System.Management.Automation /// /// Debugger PSCommand /// Output - /// DebuggerCommandResults + /// DebuggerCommandResults. public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output) { CheckForValidateState(); @@ -2034,7 +2034,7 @@ namespace System.Management.Automation /// /// GetDebuggerStopped /// - /// DebuggerStopEventArgs + /// DebuggerStopEventArgs. public override DebuggerStopEventArgs GetDebuggerStopArgs() { CheckForValidateState(); diff --git a/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs b/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs index 8a4bfbda1..d9f47e929 100644 --- a/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs +++ b/src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs @@ -203,7 +203,7 @@ namespace System.Management.Automation.Runspaces /// /// ToString method override /// - /// string + /// String. public override string ToString() { // PSSession is a PowerShell type name and so should not be localized. @@ -322,7 +322,7 @@ namespace System.Management.Automation.Runspaces /// /// Generates and returns the runspace name /// - /// auto generated name + /// Auto generated name. private string GetTransportName() { if (_remoteRunspace.ConnectionInfo is WSManConnectionInfo) @@ -359,7 +359,7 @@ namespace System.Management.Automation.Runspaces /// Returns shell configuration name with shell prefix removed. /// /// shell configuration name - /// display shell name + /// Display shell name. private string GetDisplayShellName(string shell) { string shellPrefix = System.Management.Automation.Remoting.Client.WSManNativeApi.ResourceURIPrefix; @@ -376,7 +376,7 @@ namespace System.Management.Automation.Runspaces /// Generates a unique runspace id. /// /// Returned Id - /// Returned name + /// Returned name. internal static string GenerateRunspaceName(out int rtnId) { int id = GenerateRunspaceId(); @@ -387,7 +387,7 @@ namespace System.Management.Automation.Runspaces /// /// Increments and returns a session unique runspace Id. /// - /// Id + /// Id. internal static int GenerateRunspaceId() { return System.Threading.Interlocked.Increment(ref s_seed); diff --git a/src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs b/src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs index 677127f72..e90b7c622 100644 --- a/src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs +++ b/src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs @@ -1420,7 +1420,7 @@ else /// Creates a Grouped Managed Service Account credential based on the passed in account name /// /// Group Managed Service Account name - /// PSCredential for GMS account + /// PSCredential for GMS account. /// /// Invalid account name. Must be of form 'Domain\UserName'. /// @@ -1554,7 +1554,7 @@ else /// /// /// - /// SDDL + /// SDDL. internal static string ComputeSDDLFromConfiguration( Hashtable configTable, PSSessionConfigurationAccessMode accessMode, diff --git a/src/System.Management.Automation/engine/remoting/commands/EnterPSHostProcessCommand.cs b/src/System.Management.Automation/engine/remoting/commands/EnterPSHostProcessCommand.cs index 45b5ba5ba..a95a6e958 100644 --- a/src/System.Management.Automation/engine/remoting/commands/EnterPSHostProcessCommand.cs +++ b/src/System.Management.Automation/engine/remoting/commands/EnterPSHostProcessCommand.cs @@ -527,7 +527,7 @@ namespace Microsoft.PowerShell.Commands /// PSHost.130566795082911445.8224.DefaultAppDomain.powershell /// /// Process Ids or null - /// Collection of process AppDomain info + /// Collection of process AppDomain info. internal static IReadOnlyCollection GetAppDomainNamesFromProcessId(int[] procIds) { var procAppDomainInfo = new List(); diff --git a/src/System.Management.Automation/engine/remoting/commands/GetJob.cs b/src/System.Management.Automation/engine/remoting/commands/GetJob.cs index 0d686f4d4..6c13b19ed 100644 --- a/src/System.Management.Automation/engine/remoting/commands/GetJob.cs +++ b/src/System.Management.Automation/engine/remoting/commands/GetJob.cs @@ -121,7 +121,7 @@ namespace Microsoft.PowerShell.Commands /// /// Helper method to find jobs based on parameter set. /// - /// Matching jobs + /// Matching jobs. protected List FindJobs() { List jobList = new List(); @@ -198,7 +198,7 @@ namespace Microsoft.PowerShell.Commands /// Filter jobs based on HasMoreData /// /// - /// return the list of jobs after applying HasMoreData filter + /// Return the list of jobs after applying HasMoreData filter. private List ApplyHasMoreDataFiltering(List jobList) { bool hasMoreDataParameter = MyInvocation.BoundParameters.ContainsKey(nameof(HasMoreData)); @@ -225,7 +225,7 @@ namespace Microsoft.PowerShell.Commands /// Find the all child jobs with specified ChildJobState in the job list /// /// - /// returns job list including all child jobs with ChildJobState or all if IncludeChildJob is specified + /// Returns job list including all child jobs with ChildJobState or all if IncludeChildJob is specified. private List FindChildJobs(List jobList) { bool childJobStateParameter = MyInvocation.BoundParameters.ContainsKey(nameof(ChildJobState)); diff --git a/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs b/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs index 4a5141d10..e0ad7d64d 100644 --- a/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs +++ b/src/System.Management.Automation/engine/remoting/commands/JobRepository.cs @@ -80,7 +80,7 @@ namespace System.Management.Automation /// Get a key for the specified item /// /// item for which the key is required - /// returns a key + /// Returns a key. protected abstract Guid GetKey(T item); /// @@ -179,7 +179,7 @@ namespace System.Management.Automation /// Returns the instance id of the job as key /// /// job for which a key is required - /// returns jobs guid + /// Returns jobs guid. protected override Guid GetKey(Job item) { if (item != null) diff --git a/src/System.Management.Automation/engine/remoting/commands/NewPSSessionConfigurationFile.cs b/src/System.Management.Automation/engine/remoting/commands/NewPSSessionConfigurationFile.cs index c7348a690..1530d932b 100644 --- a/src/System.Management.Automation/engine/remoting/commands/NewPSSessionConfigurationFile.cs +++ b/src/System.Management.Automation/engine/remoting/commands/NewPSSessionConfigurationFile.cs @@ -1880,7 +1880,7 @@ namespace Microsoft.PowerShell.Commands /// Return a single-quoted string. Any embedded single quotes will be doubled. /// /// The string to quote - /// The quoted string + /// The quoted string. internal static string QuoteName(object name) { if (name == null) @@ -1892,7 +1892,7 @@ namespace Microsoft.PowerShell.Commands /// Return a script block string wrapped in curly braces. /// /// The string to wrap - /// The wrapped string + /// The wrapped string. internal static string WrapScriptBlock(object sb) { if (sb == null) @@ -2080,7 +2080,7 @@ namespace Microsoft.PowerShell.Commands /// Combines an array of strings into a single string block /// /// string values - /// string block + /// String block. internal static string CombineStringArray(string[] values) { StringBuilder sb = new StringBuilder(); diff --git a/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs b/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs index f1cbacdef..1c4826dd3 100644 --- a/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs +++ b/src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs @@ -88,7 +88,7 @@ namespace Microsoft.PowerShell.Commands /// its assumed to be localhost /// /// computer name to resolve - /// resolved computer name + /// Resolved computer name. protected string ResolveComputerName(string computerName) { Diagnostics.Assert(computerName != null, "Null ComputerName"); @@ -112,7 +112,7 @@ namespace Microsoft.PowerShell.Commands /// /// resource String which holds the message /// - /// Error message loaded from appropriate resource cache + /// Error message loaded from appropriate resource cache. internal string GetMessage(string resourceString) { string message = GetMessage(resourceString, null); @@ -222,7 +222,7 @@ namespace Microsoft.PowerShell.Commands /// 2. DEFAULTREMOTESHELLNAME variable set /// 3. PowerShell /// - /// The shell to launch in the remote machine + /// The shell to launch in the remote machine. protected string ResolveShell(string shell) { string resolvedShell; @@ -247,7 +247,7 @@ namespace Microsoft.PowerShell.Commands /// 3. WSMan /// /// application name to resolve - /// resolved appname + /// Resolved appname. protected string ResolveAppName(string appName) { string resolvedAppName; @@ -886,7 +886,7 @@ namespace Microsoft.PowerShell.Commands /// /// Parse the Connection parameter HashTable array. /// - /// Array of SSHConnection objects + /// Array of SSHConnection objects. internal SSHConnection[] ParseSSHConnectionHashTable() { List connections = new List(); @@ -1056,7 +1056,7 @@ namespace Microsoft.PowerShell.Commands /// Validates parameter value and returns as string /// /// Parameter value to be validated - /// Parameter value as string + /// Parameter value as string. private static string GetSSHConnectionStringParameter(object param) { if (param is string paramValue && !string.IsNullOrEmpty(paramValue)) @@ -1071,7 +1071,7 @@ namespace Microsoft.PowerShell.Commands /// Validates parameter value and returns as integer /// /// Parameter value to be validated - /// Parameter value as integer + /// Parameter value as integer. private static int GetSSHConnectionIntParameter(object param) { if (param is int paramValue) @@ -1826,7 +1826,7 @@ namespace Microsoft.PowerShell.Commands /// Creates a pipeline from the powershell /// /// runspace on which to create the pipeline - /// a pipeline + /// A pipeline. internal Pipeline CreatePipeline(RemoteRunspace remoteRunspace) { // The fix to WinBlue#475223 changed how UsingExpression is handled on the client/server sides, if the remote end is PSv5 @@ -2402,7 +2402,7 @@ namespace Microsoft.PowerShell.Commands /// Get all Using expressions that we care about /// /// - /// a list of UsingExpressionAsts ordered by the StartOffset + /// A list of UsingExpressionAsts ordered by the StartOffset. private List GetUsingVariables(ScriptBlock localScriptBlock) { if (localScriptBlock == null) @@ -2578,7 +2578,7 @@ namespace Microsoft.PowerShell.Commands /// no matches are found /// if true write the object down /// the pipeline - /// list of matching runspaces + /// List of matching runspaces. [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Runspaces")] protected Dictionary GetMatchingRunspaces(bool writeobject, bool writeErrorOnNoMatch) @@ -2595,7 +2595,7 @@ namespace Microsoft.PowerShell.Commands /// the pipeline /// Runspace state filter value. /// Runspace configuration name filter value. - /// list of matching runspaces + /// List of matching runspaces. [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Runspaces")] protected Dictionary GetMatchingRunspaces(bool writeobject, bool writeErrorOnNoMatch, @@ -2697,7 +2697,7 @@ namespace Microsoft.PowerShell.Commands /// no matches are found /// if true write the object down /// the pipeline - /// list of matching runspaces + /// List of matching runspaces. private Dictionary GetMatchingRunspacesByComputerName(bool writeobject, bool writeErrorOnNoMatch) { @@ -2759,7 +2759,7 @@ namespace Microsoft.PowerShell.Commands /// no matches are found /// if true write the object down /// the pipeline - /// list of matching runspaces + /// List of matching runspaces. [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Runspaces")] [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "writeobject")] protected Dictionary GetMatchingRunspacesByName(bool writeobject, @@ -2818,7 +2818,7 @@ namespace Microsoft.PowerShell.Commands /// no matches are found /// if true write the object down /// the pipeline - /// list of matching runspaces + /// List of matching runspaces. [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Runspaces")] [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "writeobject")] protected Dictionary GetMatchingRunspacesByRunspaceId(bool writeobject, @@ -2876,7 +2876,7 @@ namespace Microsoft.PowerShell.Commands /// no matches are found /// if true write the object down /// the pipeline - /// list of matching runspaces + /// List of matching runspaces. private Dictionary GetMatchingRunspacesBySessionId(bool writeobject, bool writeErrorOnNoMatch) { @@ -2931,7 +2931,7 @@ namespace Microsoft.PowerShell.Commands /// Runspace state filter value. /// Runspace configuration name filter value. /// if true the target is a container instead of virtual machine - /// list of matching runspaces + /// List of matching runspaces. private Dictionary GetMatchingRunspacesByVMNameContainerId(bool writeobject, SessionFilterState filterState, string configurationName, @@ -2999,7 +2999,7 @@ namespace Microsoft.PowerShell.Commands /// Runspace state filter value. /// Runspace configuration name filter value. /// if true the target is a container instead of virtual machine - /// list of matching runspaces + /// List of matching runspaces. private Dictionary GetMatchingRunspacesByVMNameContainerIdSessionInstanceId(bool writeobject, SessionFilterState filterState, string configurationName, @@ -3056,7 +3056,7 @@ namespace Microsoft.PowerShell.Commands /// if true write the object down the pipeline /// Runspace state filter value. /// Runspace configuration name filter value. - /// list of matching runspaces + /// List of matching runspaces. private Dictionary GetMatchingRunspacesByVMId(bool writeobject, SessionFilterState filterState, string configurationName) @@ -3101,7 +3101,7 @@ namespace Microsoft.PowerShell.Commands /// if true write the object down the pipeline /// Runspace state filter value. /// Runspace configuration name filter value. - /// list of matching runspaces + /// List of matching runspaces. private Dictionary GetMatchingRunspacesByVMIdSessionInstanceId(bool writeobject, SessionFilterState filterState, string configurationName) @@ -4056,7 +4056,7 @@ namespace Microsoft.PowerShell.Commands /// /// Exception /// Returned WSMan error code - /// WSMan message + /// WSMan message. internal static string ExtractMessage( Exception e, out int errorCode) diff --git a/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs b/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs index 0c6fef6d8..31f54a818 100644 --- a/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs +++ b/src/System.Management.Automation/engine/remoting/commands/ReceiveJob.cs @@ -919,7 +919,7 @@ namespace Microsoft.PowerShell.Commands /// Returns all the results from supplied PSDataCollection. /// /// data collection to read from - /// collection with copy of data + /// Collection with copy of data. private Collection ReadAll(PSDataCollection psDataCollection) { if (_flush) diff --git a/src/System.Management.Automation/engine/remoting/commands/ReceivePSSession.cs b/src/System.Management.Automation/engine/remoting/commands/ReceivePSSession.cs index f107aacbe..f4685b3ab 100644 --- a/src/System.Management.Automation/engine/remoting/commands/ReceivePSSession.cs +++ b/src/System.Management.Automation/engine/remoting/commands/ReceivePSSession.cs @@ -1153,7 +1153,7 @@ namespace Microsoft.PowerShell.Commands /// from the server, based on the provided session object. /// /// PSSession - /// PSSession + /// PSSession. private PSSession TryGetSessionFromServer(PSSession session) { RemoteRunspace remoteRunspace = session.Runspace as RemoteRunspace; diff --git a/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs b/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs index bfab391aa..6e9829ce9 100644 --- a/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs +++ b/src/System.Management.Automation/engine/remoting/commands/RemoveJob.cs @@ -50,7 +50,7 @@ namespace Microsoft.PowerShell.Commands /// write error if no match is found /// check if this job can be removed /// recurse and check in child jobs - /// list of matching jobs + /// List of matching jobs. internal List FindJobsMatchingByName( bool recurse, bool writeobject, @@ -183,7 +183,7 @@ namespace Microsoft.PowerShell.Commands /// write error if no match is found /// check if this job can be removed /// look in all child jobs - /// list of matching jobs + /// List of matching jobs. internal List FindJobsMatchingByInstanceId(bool recurse, bool writeobject, bool writeErrorOnNoMatch, bool checkIfJobCanBeRemoved) { List matches = new List(); @@ -300,7 +300,7 @@ namespace Microsoft.PowerShell.Commands /// write error if no match is found /// check if this job can be removed /// look in child jobs as well - /// list of matching jobs + /// List of matching jobs. internal List FindJobsMatchingBySessionId(bool recurse, bool writeobject, bool writeErrorOnNoMatch, bool checkIfJobCanBeRemoved) { List matches = new List(); @@ -401,7 +401,7 @@ namespace Microsoft.PowerShell.Commands /// /// if true, method writes the object instead of returning it /// in list (an empty list is returned). - /// list of matching jobs + /// List of matching jobs. internal List FindJobsMatchingByCommand( bool writeobject) { @@ -454,7 +454,7 @@ namespace Microsoft.PowerShell.Commands /// /// if true, method writes the object instead of returning it /// in list (an empty list is returned). - /// list of matching jobs + /// List of matching jobs. internal List FindJobsMatchingByState( bool writeobject) { @@ -585,7 +585,7 @@ namespace Microsoft.PowerShell.Commands /// /// Resource String in case of error /// Parameters for resource message - /// true if object should be removed, else false + /// True if object should be removed, else false. private bool CheckJobCanBeRemoved(Job job, string parameterName, string resourceString, params object[] list) { if (job.IsFinishedState(job.JobStateInfo.State)) diff --git a/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs b/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs index bff7723bb..41e53b4bb 100644 --- a/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs +++ b/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs @@ -47,7 +47,7 @@ namespace System.Management.Automation.Remoting /// E.g., "PSHost.ProcessStartTime.ProcessId.DefaultAppDomain.ProcessName" /// /// Process Id - /// Pipe name + /// Pipe name. internal static string CreateProcessPipeName( int procId) { @@ -60,7 +60,7 @@ namespace System.Management.Automation.Remoting /// E.g., "PSHost.ProcessStartTime.ProcessId.DefaultAppDomain.ProcessName" /// /// Process object - /// Pipe name + /// Pipe name. internal static string CreateProcessPipeName( System.Diagnostics.Process proc) { @@ -73,7 +73,7 @@ namespace System.Management.Automation.Remoting /// /// Process Id /// Name of process app domain to connect to. - /// Pipe name + /// Pipe name. internal static string CreateProcessPipeName( int procId, string appDomainName) @@ -87,7 +87,7 @@ namespace System.Management.Automation.Remoting /// /// Process object /// Name of process app domain to connect to. - /// Pipe name + /// Pipe name. internal static string CreateProcessPipeName( System.Diagnostics.Process proc, string appDomainName) @@ -142,7 +142,7 @@ namespace System.Management.Automation.Remoting /// /// Returns the current process AppDomain name. /// - /// AppDomain Name string + /// AppDomain Name string. internal static string GetCurrentAppDomainName() { #if CORECLR // There is only one AppDomain per application in CoreCLR, which would be the default @@ -428,7 +428,7 @@ namespace System.Management.Automation.Remoting /// /// Creates a RemoteSessionNamedPipeServer with the current process and AppDomain information. /// - /// RemoteSessionNamedPipeServer + /// RemoteSessionNamedPipeServer. public static RemoteSessionNamedPipeServer CreateRemoteSessionNamedPipeServer() { string appDomainName = NamedPipeUtils.GetCurrentAppDomainName(); @@ -467,7 +467,7 @@ namespace System.Management.Automation.Remoting /// Named pipe namespace name. /// Named pipe core name. /// - /// NamedPipeServerStream + /// NamedPipeServerStream. private NamedPipeServerStream CreateNamedPipe( string serverName, string namespaceName, diff --git a/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs b/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs index aa5922ad5..2c3a1e39f 100644 --- a/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs +++ b/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs @@ -1029,7 +1029,7 @@ namespace System.Management.Automation.Runspaces /// /// Shallow copy of the current instance. /// - /// RunspaceConnectionInfo + /// RunspaceConnectionInfo. internal override RunspaceConnectionInfo InternalCopy() { return Copy(); @@ -1833,7 +1833,7 @@ namespace System.Management.Automation.Runspaces /// /// Shallow copy of current instance. /// - /// NamedPipeConnectionInfo + /// NamedPipeConnectionInfo. internal override RunspaceConnectionInfo InternalCopy() { NamedPipeConnectionInfo newCopy = new NamedPipeConnectionInfo(); @@ -2017,7 +2017,7 @@ namespace System.Management.Automation.Runspaces /// /// Shallow copy of current instance. /// - /// NamedPipeConnectionInfo + /// NamedPipeConnectionInfo. internal override RunspaceConnectionInfo InternalCopy() { SSHConnectionInfo newCopy = new SSHConnectionInfo(); @@ -2272,7 +2272,7 @@ namespace System.Management.Automation.Runspaces /// Copies environment variables from ProcessStartInfo /// ProcessStartInfo - /// String array of environment key/value pairs + /// String array of environment key/value pairs. private static string[] CopyEnvVariables(ProcessStartInfo psi) { var envp = new string[psi.Environment.Count]; @@ -3185,7 +3185,7 @@ namespace System.Management.Automation.Runspaces // other errors caught without exception default: throw new PSInvalidOperationException(StringUtil.Format(RemotingErrorIdStrings.CannotCreateProcessInContainer, - ContainerId, + ContainerId, Executable, ErrorCode)); } @@ -3369,7 +3369,7 @@ namespace System.Management.Automation.Runspaces return string.Format( System.Globalization.CultureInfo.InvariantCulture, @"{{""CommandLine"": ""{0} {1} -NoLogo {2}"",""RestrictedToken"": {3}}}", - Executable, + Executable, (RuntimeId != Guid.Empty) ? "-SocketServerMode -NoProfile" : "-NamedPipeServerMode", string.IsNullOrEmpty(ConfigurationName) ? string.Empty : string.Concat("-Config ", ConfigurationName), RunAsAdmin ? "false" : "true"); 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 7cc0df7b6..8f6b90014 100644 --- a/src/System.Management.Automation/engine/remoting/common/WireDataFormat/EncodeAndDecode.cs +++ b/src/System.Management.Automation/engine/remoting/common/WireDataFormat/EncodeAndDecode.cs @@ -649,7 +649,7 @@ namespace System.Management.Automation /// /// Application arguments the server can see in /// - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -704,7 +704,7 @@ namespace System.Management.Automation /// to be created at the server /// maxRunspaces for the RunspacePool /// to be created at the server - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -761,7 +761,7 @@ namespace System.Management.Automation /// to be created at the server /// maxRunspaces for the RunspacePool /// to be created at the server - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -795,7 +795,7 @@ namespace System.Management.Automation /// new value of maxRunspaces for the /// specified RunspacePool /// call id of the call at client - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -826,7 +826,7 @@ namespace System.Management.Automation /// new value of minRunspaces for the /// specified RunspacePool /// call id of the call at client - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -856,7 +856,7 @@ namespace System.Management.Automation /// id of the clientRunspacePool /// call id of the call at client /// response to the call - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -886,7 +886,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 - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------- /// | D | TI | RPID | PID | Data | Type | @@ -915,7 +915,7 @@ namespace System.Management.Automation /// public key to send across /// destination that this message is /// targeted to - /// data structure message + /// Data structure message. /// The message format is as under for this message /// -------------------------------------------------------------------------- /// | D | TI | RPID | PID | Data | Type | @@ -941,7 +941,7 @@ namespace System.Management.Automation /// requesting a public key from the client to the server /// /// runspace pool id - /// data structure message + /// Data structure message. /// The message format is as under for this message /// -------------------------------------------------------------------------- /// | D | TI | RPID | PID | Data | Type | @@ -964,7 +964,7 @@ namespace System.Management.Automation /// /// runspace pool id /// encrypted session key - /// data structure message + /// Data structure message. /// The message format is as under for this message /// -------------------------------------------------------------------------- /// | D | TI | RPID | PID | Data | Type | @@ -994,7 +994,7 @@ namespace System.Management.Automation /// message needs to be generated. /// The data is extracted from parameters of the first command named "Get-Command". /// - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// ------------------------------------------------------------------------- /// | D | TI | RPID | PID | Data | Type | @@ -1073,7 +1073,7 @@ namespace System.Management.Automation /// /// The client remote powershell from which the /// create powershell message needs to be generated - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// ------------------------------------------------------------------------- /// | D | TI | RPID | PID | Data | Type | @@ -1154,7 +1154,7 @@ namespace System.Management.Automation /// /// id of the client RunspacePool /// application private data - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1183,7 +1183,7 @@ namespace System.Management.Automation /// /// id of the client RunspacePool /// State information object - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1227,7 +1227,7 @@ namespace System.Management.Automation /// /// id of the client RunspacePool /// PowerShell event - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1261,7 +1261,7 @@ namespace System.Management.Automation /// /// /// Caller Id - /// Data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1285,7 +1285,7 @@ namespace System.Management.Automation /// Returns the PS remoting protocol version associated with the provided /// /// RunspacePool - /// PS remoting protocol version + /// PS remoting protocol version. internal static Version GetPSRemotingProtocolVersion(RunspacePool rsPool) { return (rsPool != null && rsPool.RemoteRunspacePoolInternal != null) ? @@ -1303,7 +1303,7 @@ namespace System.Management.Automation /// input data to send /// client runspace pool id /// client powershell id - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1327,7 +1327,7 @@ namespace System.Management.Automation /// /// client runspace pool id /// client powershell id - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1354,7 +1354,7 @@ namespace System.Management.Automation /// to which this information need to be delivered /// id of client runspacepool /// associated with this powershell - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1384,7 +1384,7 @@ namespace System.Management.Automation /// associated with this powershell /// data type of this informational /// message - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1412,7 +1412,7 @@ namespace System.Management.Automation /// to which this information need to be delivered /// id of client runspacepool /// associated with this powershell - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1445,7 +1445,7 @@ namespace System.Management.Automation /// to which this information need to be delivered /// id of client runspacepool /// associated with this powershell - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// ----------------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1477,7 +1477,7 @@ namespace System.Management.Automation /// to which this information need to be delivered /// id of client runspacepool /// associated with this powershell - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1504,7 +1504,7 @@ namespace System.Management.Automation /// to which this information need to be delivered /// id of client runspacepool /// associated with this powershell - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1597,7 +1597,7 @@ namespace System.Management.Automation /// /// RemoteSession capability object to encode /// - /// data structure handler message encoded as RemoteDataObject + /// Data structure handler message encoded as RemoteDataObject. /// The message format is as under for this message /// -------------------------------------------------------------------------------------- /// | D | TI | RPID | PID | Action | Data | Type | @@ -1842,7 +1842,7 @@ namespace System.Management.Automation /// data object specified /// /// data object to decode - /// RunspacePoolStateInfo + /// RunspacePoolStateInfo. internal static RunspacePoolStateInfo GetRunspacePoolStateInfo(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -1861,7 +1861,7 @@ namespace System.Management.Automation /// data object specified /// /// data object to decode - /// application private data + /// Application private data. internal static PSPrimitiveDictionary GetApplicationPrivateData(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -1876,7 +1876,7 @@ namespace System.Management.Automation /// Gets the public key from the encoded message /// /// data object to decode - /// public key as string + /// Public key as string. internal static string GetPublicKey(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -1891,7 +1891,7 @@ namespace System.Management.Automation /// Gets the encrypted session key from the encoded message /// /// data object to decode - /// encrypted session key as string + /// Encrypted session key as string. internal static string GetEncryptedSessionKey(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -1907,7 +1907,7 @@ namespace System.Management.Automation /// data object specified /// /// data object to decode - /// RunspacePoolStateInfo + /// RunspacePoolStateInfo. internal static PSEventArgs GetPSEventArgs(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -1947,7 +1947,7 @@ namespace System.Management.Automation /// runspace pool from the data object specified /// /// data object to decode - /// minimum runspaces + /// Minimum runspaces. internal static int GetMinRunspaces(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -1963,7 +1963,7 @@ namespace System.Management.Automation /// runspace pool from the data object specified /// /// data object to decode - /// maximum runspaces + /// Maximum runspaces. internal static int GetMaxRunspaces(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -1979,7 +1979,7 @@ namespace System.Management.Automation /// runspace pool from the data object specified /// /// data object to decode - /// thread options + /// Thread options. internal static PSPrimitiveDictionary GetApplicationArguments(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -1996,7 +1996,7 @@ namespace System.Management.Automation /// Generates RunspacePoolInitInfo object from a received PSObject /// /// data object to decode - /// RunspacePoolInitInfo generated + /// RunspacePoolInitInfo generated. internal static RunspacePoolInitInfo GetRunspacePoolInitInfo(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -2015,7 +2015,7 @@ namespace System.Management.Automation /// runspace pool from the data object specified /// /// data object to decode - /// thread options + /// Thread options. internal static PSThreadOptions GetThreadOptions(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -2031,7 +2031,7 @@ namespace System.Management.Automation /// associated with the runspace pool /// /// dataAsPSObject object to decode - /// host information + /// Host information. internal static HostInfo GetHostInfo(PSObject dataAsPSObject) { if (dataAsPSObject == null) @@ -2083,7 +2083,7 @@ namespace System.Management.Automation /// Gets the output from the message /// /// object to decode - /// output object + /// Output object. /// the current implementation does nothing, /// however this method is there in place as the /// packaging of output data may change in the future @@ -2096,7 +2096,7 @@ namespace System.Management.Automation /// Gets the PSInvocationStateInfo from the data /// /// object to decode - /// PSInvocationInfo + /// PSInvocationInfo. internal static PSInvocationStateInfo GetPowerShellStateInfo(object data) { PSObject dataAsPSObject = data as PSObject; @@ -2115,7 +2115,7 @@ namespace System.Management.Automation /// Gets the ErrorRecord from the message /// /// data to decode - /// error record + /// Error record. internal static ErrorRecord GetPowerShellError(object data) { if (data == null) @@ -2201,7 +2201,7 @@ namespace System.Management.Automation /// Gets the PowerShell object from the specified data /// /// data to decode - /// Deserialized PowerShell object + /// Deserialized PowerShell object. internal static PowerShell GetPowerShell(object data) { PSObject dataAsPSObject = PSObject.AsPSObject(data); @@ -2218,7 +2218,7 @@ namespace System.Management.Automation /// Gets the PowerShell object from the specified data /// /// data to decode - /// Deserialized PowerShell object + /// Deserialized PowerShell object. internal static PowerShell GetCommandDiscoveryPipeline(object data) { PSObject dataAsPSObject = PSObject.AsPSObject(data); @@ -2292,7 +2292,7 @@ namespace System.Management.Automation /// Gets the NoInput setting from the specified data /// /// data to decode - /// true if there is no pipeline input; false otherwise + /// true if there is no pipeline input; false otherwise. internal static bool GetNoInput(object data) { PSObject dataAsPSObject = PSObject.AsPSObject(data); @@ -2309,7 +2309,7 @@ namespace System.Management.Automation /// Gets the AddToHistory setting from the specified data /// /// data to decode - /// true if there is addToHistory data; false otherwise + /// true if there is addToHistory data; false otherwise. internal static bool GetAddToHistory(object data) { PSObject dataAsPSObject = PSObject.AsPSObject(data); @@ -2326,7 +2326,7 @@ namespace System.Management.Automation /// Gets the IsNested setting from the specified data /// /// data to decode - /// true if there is IsNested data; false otherwise + /// true if there is IsNested data; false otherwise. internal static bool GetIsNested(object data) { PSObject dataAsPSObject = PSObject.AsPSObject(data); @@ -2366,7 +2366,7 @@ namespace System.Management.Automation /// Decodes a RemoteSessionCapability object /// /// data to decode - /// RemoteSessionCapability object + /// RemoteSessionCapability object. internal static RemoteSessionCapability GetSessionCapability(object data) { PSObject dataAsPSObject = data as PSObject; @@ -2411,7 +2411,7 @@ namespace System.Management.Automation /// Checks if the server supports batch invocation /// /// runspace instance - /// true if batch invocation is supported, false if not + /// True if batch invocation is supported, false if not. internal static bool ServerSupportsBatchInvocation(Runspace runspace) { if (runspace == null || runspace.RunspaceStateInfo.State == RunspaceState.BeforeOpen) 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 19e0ceec4..db8aed0f1 100644 --- a/src/System.Management.Automation/engine/remoting/common/WireDataFormat/RemoteHost.cs +++ b/src/System.Management.Automation/engine/remoting/common/WireDataFormat/RemoteHost.cs @@ -329,9 +329,9 @@ namespace System.Management.Automation.Remoting /// /// computer name to use in /// warning messages - /// a collection of remote host calls which will + /// A collection of remote host calls which will /// have to be executed before this host call can be - /// executed + /// executed. internal Collection PerformSecurityChecksOnHostMessage(string computerName) { Dbg.Assert(!String.IsNullOrEmpty(computerName), @@ -438,7 +438,7 @@ namespace System.Management.Automation.Remoting /// tagged with "Windows PowerShell Credential Request" /// /// caption to modify - /// new modified caption + /// New modified caption. private string ModifyCaption(string caption) { string pscaption = CredUI.PromptForCredential_DefaultCaption; @@ -463,7 +463,7 @@ namespace System.Management.Automation.Remoting /// original message to modify /// computername to include in the /// message - /// message which contains a warning as well + /// Message which contains a warning as well. private string ModifyMessage(string message, string computerName) { string modifiedMessage = PSRemotingErrorInvariants.FormatResourceString( @@ -482,8 +482,8 @@ namespace System.Management.Automation.Remoting /// computer name to include /// in warning /// resource string to use - /// a constructed remote host call message - /// which will display the warning + /// A constructed remote host call message + /// which will display the warning. private RemoteHostCall ConstructWarningMessageForSecureString(string computerName, string resourceString) { @@ -503,8 +503,8 @@ namespace System.Management.Automation.Remoting /// /// computer name to include /// in warning - /// a constructed remote host call message - /// which will display the warning + /// A constructed remote host call message + /// which will display the warning. private RemoteHostCall ConstructWarningMessageForGetBufferContents(string computerName) { string warning = PSRemotingErrorInvariants.FormatResourceString( diff --git a/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs b/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs index 7187247aa..88284e882 100644 --- a/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs +++ b/src/System.Management.Automation/engine/remoting/common/throttlemanager.cs @@ -291,8 +291,8 @@ namespace System.Management.Automation.Remoting /// Calling this method will also affect other cmdlets which /// could have potentially submitComplete operations for processing /// - /// number of objects cleared from queue without being - /// stopped + /// Number of objects cleared from queue without being + /// stopped. internal void StopAllOperations() { // if stopping is already in progress, make it a no op diff --git a/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs b/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs index e4560258d..94365ebe2 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs @@ -756,7 +756,7 @@ namespace System.Management.Automation.Remoting.Client /// interaction. /// /// Remote data object - /// True if remote data object requires a user response + /// True if remote data object requires a user response. private bool CheckForInteractiveHostCall(RemoteDataObject remoteObject) { bool interactiveHostCall = false; diff --git a/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs b/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs index a0c5f9a7b..10c2cbbba 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/InitialSessionStateProvider.cs @@ -1435,7 +1435,7 @@ namespace System.Management.Automation.Remoting /// /// execution context /// the ExternalScriptInfo object - /// configuration hashtable + /// Configuration hashtable. internal static Hashtable LoadConfigFile(ExecutionContext context, ExternalScriptInfo scriptInfo) { object result; @@ -1465,7 +1465,7 @@ namespace System.Management.Automation.Remoting /// configuration hashtable /// /// - /// true if valid, false otherwise + /// True if valid, false otherwise. internal static bool VerifyConfigTable(Hashtable table, PSCmdlet cmdlet, string path) { bool hasSchemaVersion = false; diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs index 83458d91d..1993c9890 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs @@ -172,7 +172,7 @@ namespace System.Management.Automation.Remoting.Client /// Must be a value type. /// /// - /// MarshalledObject + /// MarshalledObject. internal static MarshalledObject Create(T obj) { IntPtr ptr = Marshal.AllocHGlobal(Marshal.SizeOf()); diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs index 086a7623c..988d60892 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManPlugin.cs @@ -535,7 +535,7 @@ namespace System.Management.Automation.Remoting /// Retrieves a WSManPluginShellSession if matched. /// /// Shell context (WSManPluginRequest.unmanagedHandle) - /// null WSManPluginShellSession if not matched. The object if matched. + /// Null WSManPluginShellSession if not matched. The object if matched. private WSManPluginShellSession GetFromActiveShellSessions( IntPtr key) { @@ -1002,7 +1002,7 @@ namespace System.Management.Automation.Remoting /// Helper method to retrieve the WSMan client token from the __WINRM_RUNAS_CLIENT_TOKEN__ /// environment variable, which is set in the WSMan layer for Virtual or RunAs accounts. /// - /// ClientToken IntPtr + /// ClientToken IntPtr. private IntPtr GetRunAsClientToken() { string clientTokenStr = System.Environment.GetEnvironmentVariable(WSManRunAsClientTokenName); diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs index f1c28cae9..3ea560769 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs @@ -427,7 +427,7 @@ namespace System.Management.Automation.Remoting /// various initializations. /// /// IntPtr to WSManPluginEntryDelegates.WSManPluginEntryDelegatesInternal - /// 0 = Success, 1 = Failure + /// 0 = Success, 1 = Failure. public static int InitPlugin( IntPtr wkrPtrs) { diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs index 8613e688c..1b8780afb 100644 --- a/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs +++ b/src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs @@ -253,7 +253,7 @@ namespace System.Management.Automation.Remoting.Client /// /// transport error code /// Default FQEID - /// Fully qualified error Id string + /// Fully qualified error Id string. internal static string GetFQEIDFromTransportError( int transportErrorCode, string defaultFQEID) diff --git a/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs b/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs index 9420ba007..eca809d49 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerRemotingProtocol2.cs @@ -202,7 +202,7 @@ namespace System.Management.Automation /// runspace pool id /// remote stream options /// local PowerShell object - /// ServerPowerShellDataStructureHandler + /// ServerPowerShellDataStructureHandler. internal ServerPowerShellDataStructureHandler CreatePowerShellDataStructureHandler( Guid instanceId, Guid runspacePoolId, RemoteStreamOptions remoteStreamOptions, PowerShell localPowerShell) { @@ -364,7 +364,7 @@ namespace System.Management.Automation /// /// powershell id for the /// powershell data structure handler - /// ServerPowerShellDataStructureHandler + /// ServerPowerShellDataStructureHandler. internal ServerPowerShellDataStructureHandler GetAssociatedPowerShellDataStructureHandler (Guid clientPowerShellId) { diff --git a/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs b/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs index c7222cbf5..a952bb294 100644 --- a/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs +++ b/src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs @@ -1785,7 +1785,7 @@ namespace System.Management.Automation /// /// Returns debugger stop event args if in debugger stop state. /// - /// DebuggerStopEventArgs + /// DebuggerStopEventArgs. public override DebuggerStopEventArgs GetDebuggerStopArgs() { return _wrappedDebugger.Value.GetDebuggerStopArgs(); diff --git a/src/System.Management.Automation/engine/runtime/CompiledScriptBlock.cs b/src/System.Management.Automation/engine/runtime/CompiledScriptBlock.cs index 4624e09d1..1b3b6c698 100644 --- a/src/System.Management.Automation/engine/runtime/CompiledScriptBlock.cs +++ b/src/System.Management.Automation/engine/runtime/CompiledScriptBlock.cs @@ -1991,20 +1991,20 @@ namespace System.Management.Automation } /// - /// Returns a script block that corresponds to the version deserialized + /// Returns a script block that corresponds to the version deserialized. /// - /// The streaming context for this instance - /// A script block that corresponds to the version deserialized + /// The streaming context for this instance. + /// A script block that corresponds to the version deserialized. public object GetRealObject(StreamingContext context) { return ScriptBlock.Create(_scriptText); } /// - /// Implements the ISerializable contract for serializing a scriptblock + /// Implements the ISerializable contract for serializing a scriptblock. /// - /// Serialization information for this instance - /// The streaming context for this instance + /// Serialization information for this instance. + /// The streaming context for this instance. public virtual void GetObjectData(SerializationInfo info, StreamingContext context) { throw new NotSupportedException(); diff --git a/src/System.Management.Automation/engine/runtime/Operations/ArrayOps.cs b/src/System.Management.Automation/engine/runtime/Operations/ArrayOps.cs index 4ee9df048..d6a9bcad1 100644 --- a/src/System.Management.Automation/engine/runtime/Operations/ArrayOps.cs +++ b/src/System.Management.Automation/engine/runtime/Operations/ArrayOps.cs @@ -40,7 +40,7 @@ namespace System.Management.Automation /// /// collection to multiply /// number of times the collection is to be multiplied/copied - /// collection multiplied by integer + /// Collection multiplied by integer. internal static T[] Multiply(T[] array, uint times) { Diagnostics.Assert(array != null, "Caller should verify the arguments for array multiplication"); @@ -287,4 +287,4 @@ namespace System.Management.Automation ParserStrings.CannotIndex, target.GetType()); } } -} \ No newline at end of file +} diff --git a/src/System.Management.Automation/engine/runtime/Operations/ClassOps.cs b/src/System.Management.Automation/engine/runtime/Operations/ClassOps.cs index b2e220bca..c07058843 100644 --- a/src/System.Management.Automation/engine/runtime/Operations/ClassOps.cs +++ b/src/System.Management.Automation/engine/runtime/Operations/ClassOps.cs @@ -77,7 +77,7 @@ namespace System.Management.Automation.Internal /// However, if the instantiation happens in a different Runspace where the class is not defined, or it happens on /// a thread without a default Runspace, then the created instance won't be bound to any session state. /// - /// SessionStateInternal + /// SessionStateInternal. public object GetSessionState() { SessionStateInternal ss = null; diff --git a/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs b/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs index d1b11e9ce..07dd912f1 100644 --- a/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs +++ b/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs @@ -1756,7 +1756,7 @@ namespace System.Management.Automation /// The RuntimeException which was reported /// The message to display /// The execution context - /// The preference the user selected + /// The preference the user selected. /// /// Error action is decided by error action preference. If preference is inquire, we will /// prompt user for their preference. @@ -1876,7 +1876,7 @@ namespace System.Management.Automation /// /// The runtime error to report /// The execution context - /// True if it was able to report the error + /// True if it was able to report the error. internal static bool ReportErrorRecord(IScriptExtent extent, RuntimeException rte, ExecutionContext context) { if (context.ShellFunctionErrorOutputPipe == null) @@ -3271,7 +3271,7 @@ namespace System.Management.Automation /// The execution context used to see if the pipeline is stopping /// THe enumerator to advance. /// An error occurred moving to the next element in the enumeration - /// True if the move succeeded + /// True if the move succeeded. internal static bool MoveNext(ExecutionContext context, IEnumerator enumerator) { try diff --git a/src/System.Management.Automation/engine/serialization.cs b/src/System.Management.Automation/engine/serialization.cs index 9cbc3b85b..8753a0ba2 100644 --- a/src/System.Management.Automation/engine/serialization.cs +++ b/src/System.Management.Automation/engine/serialization.cs @@ -88,7 +88,7 @@ namespace System.Management.Automation /// Serializes an object into PowerShell CliXml /// /// The input object to serialize. Serializes to a default depth of 1 - /// The serialized object, as CliXml + /// The serialized object, as CliXml. public static string Serialize(Object source) { return Serialize(source, s_mshDefaultSerializationDepth); @@ -99,7 +99,7 @@ namespace System.Management.Automation /// /// The input object to serialize /// The depth of the members to serialize - /// The serialized object, as CliXml + /// The serialized object, as CliXml. public static string Serialize(Object source, int depth) { // Create an xml writer @@ -125,7 +125,7 @@ namespace System.Management.Automation /// Deserializes PowerShell CliXml into an object. /// /// The CliXml the represents the object to deserialize. - /// An object that represents the serialized content + /// An object that represents the serialized content. public static object Deserialize(string source) { object[] results = DeserializeAsList(source); @@ -149,7 +149,7 @@ namespace System.Management.Automation /// Deserializes PowerShell CliXml into a list of objects. /// /// The CliXml the represents the object to deserialize. - /// An object array represents the serialized content + /// An object array represents the serialized content. public static object[] DeserializeAsList(string source) { List results = new List(); @@ -659,7 +659,7 @@ namespace System.Management.Automation /// /// /// - /// true if is either a live or deserialized instance of class or one of its subclasses; false otherwise + /// true if is either a live or deserialized instance of class or one of its subclasses; false otherwise. internal static bool IsInstanceOfType(object o, Type type) { if (type == null) @@ -680,7 +680,7 @@ namespace System.Management.Automation /// /// /// - /// true if is a deserialized instance of class or one of its subclasses; false otherwise + /// true if is a deserialized instance of class or one of its subclasses; false otherwise. internal static bool IsDeserializedInstanceOfType(object o, Type type) { if (type == null) @@ -2252,7 +2252,7 @@ namespace System.Management.Automation /// string /// /// PSObject to be serialized - /// true if the object needs to be serialized as a string + /// True if the object needs to be serialized as a string. private bool SerializeAsString(PSObject source) { SerializationMethod method = source.GetSerializationMethod(_typeTable); @@ -2784,7 +2784,7 @@ namespace System.Management.Automation /// Encodes the string to escape characters which would make XmlWriter.WriteString throw an exception. /// /// string to encode - /// encoded string + /// Encoded string. /// /// Output from this method can be reverted using XmlConvert.DecodeName method /// (or InternalDeserializer.DecodeString). @@ -2832,7 +2832,7 @@ namespace System.Management.Automation /// /// string to encode /// indexOfFirstEncodableCharacter - /// encoded string + /// Encoded string. private static string EncodeString(string s, int indexOfFirstEncodableCharacter) { Dbg.Assert(s != null, "Caller should validate the 's' parameter"); @@ -3717,7 +3717,7 @@ namespace System.Management.Automation /// This function reads the refId attribute and creates a /// mshObject for that attribute /// - /// mshObject which is created for refId + /// MshObject which is created for refId. private PSObject ReadAttributeAndCreatePSObject() { string refId = _reader.GetAttribute(SerializationStrings.ReferenceIdAttribute); @@ -4749,7 +4749,7 @@ namespace System.Management.Automation /// Read start element in monad namespace /// /// element tag to read - /// true if not an empty element else false + /// True if not an empty element else false. internal bool ReadStartElementAndHandleEmpty(string element) { Dbg.Assert(!string.IsNullOrEmpty(element), "Caller should validate the parameter"); @@ -4932,7 +4932,7 @@ namespace System.Management.Automation /// /// Get new reference id. /// - /// New reference id + /// New reference id. private UInt64 GetNewReferenceId() { UInt64 refId = _seed++; @@ -4958,7 +4958,7 @@ namespace System.Management.Automation /// Assigns a RefId to the given object /// /// object to assign a RefId to - /// RefId assigned to the object + /// RefId assigned to the object. internal string SetRefId(T t) { if (_object2refId != null) @@ -5111,7 +5111,7 @@ namespace System.Management.Automation /// Gets the type serialization information about a type /// /// Type for which information is retrieved - /// TypeSerializationInfo for the type, null if it doesn't exist + /// TypeSerializationInfo for the type, null if it doesn't exist. internal static TypeSerializationInfo GetTypeSerializationInfo(Type type) { TypeSerializationInfo temp; @@ -5127,7 +5127,7 @@ namespace System.Management.Automation /// Get TypeSerializationInfo using ItemTag as key /// /// ItemTag for which TypeSerializationInfo is to be fetched - /// TypeSerializationInfo entry, null if no entry exist for the tag + /// TypeSerializationInfo entry, null if no entry exist for the tag. internal static TypeSerializationInfo GetTypeSerializationInfoFromItemTag(string itemTag) { TypeSerializationInfo temp; @@ -6538,7 +6538,7 @@ namespace System.Management.Automation /// The root dictionary /// /// A chain of keys leading from the root dictionary () to the value - /// true if the value was found and was of the correct type; false otherwise + /// true if the value was found and was of the correct type; false otherwise. internal static bool TryPathGet(IDictionary data, out T result, params string[] keys) { Dbg.Assert(keys != null, "Caller should verify that keys != null"); @@ -6686,7 +6686,7 @@ namespace Microsoft.PowerShell /// The type to convert to /// The format provider to use like in IFormattable's ToString /// true if case should be ignored - /// the parameter converted to the parameter using formatProvider and ignoreCase + /// The parameter converted to the parameter using formatProvider and ignoreCase. /// if no conversion was possible public override object ConvertFrom(PSObject sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { @@ -6774,7 +6774,7 @@ namespace Microsoft.PowerShell /// The type to convert to /// The format provider to use like in IFormattable's ToString /// true if case should be ignored - /// sourceValue converted to the parameter using formatProvider and ignoreCase + /// SourceValue converted to the parameter using formatProvider and ignoreCase. /// if no conversion was possible public override object ConvertTo(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase) { diff --git a/src/System.Management.Automation/help/AliasHelpProvider.cs b/src/System.Management.Automation/help/AliasHelpProvider.cs index d82110a75..059aa803a 100644 --- a/src/System.Management.Automation/help/AliasHelpProvider.cs +++ b/src/System.Management.Automation/help/AliasHelpProvider.cs @@ -91,7 +91,7 @@ namespace System.Management.Automation /// b. Create AliasHelpInfo object based on AliasInfo object /// /// help request object - /// help info found + /// Help info found. internal override IEnumerable ExactMatchHelp(HelpRequest helpRequest) { CommandInfo commandInfo = null; @@ -133,7 +133,7 @@ namespace System.Management.Automation /// /// If false, searches for pattern in the command names. /// - /// a IEnumerable of helpinfo object + /// A IEnumerable of helpinfo object. internal override IEnumerable SearchHelp(HelpRequest helpRequest, bool searchOnlyContent) { // aliases do not have help content...so doing nothing in that case diff --git a/src/System.Management.Automation/help/BaseCommandHelpInfo.cs b/src/System.Management.Automation/help/BaseCommandHelpInfo.cs index c3fd71f21..ed28836e1 100644 --- a/src/System.Management.Automation/help/BaseCommandHelpInfo.cs +++ b/src/System.Management.Automation/help/BaseCommandHelpInfo.cs @@ -373,7 +373,7 @@ namespace System.Management.Automation /// Returns help information for a parameter(s) identified by pattern /// /// pattern to search for parameters - /// A collection of parameters that match pattern + /// A collection of parameters that match pattern. internal override PSObject[] GetParameter(string pattern) { // this object knows Maml format... diff --git a/src/System.Management.Automation/help/CabinetAPI.cs b/src/System.Management.Automation/help/CabinetAPI.cs index 994b704c9..150ff94ce 100644 --- a/src/System.Management.Automation/help/CabinetAPI.cs +++ b/src/System.Management.Automation/help/CabinetAPI.cs @@ -95,7 +95,7 @@ namespace System.Management.Automation.Internal /// /// Provider a CabinetExtractor instance /// - /// Tracer instance + /// Tracer instance. internal static ICabinetExtractor GetCabinetExtractor() { if (s_cabinetLoader != null) diff --git a/src/System.Management.Automation/help/CommandHelpProvider.cs b/src/System.Management.Automation/help/CommandHelpProvider.cs index cd94d68cf..1d921e20d 100644 --- a/src/System.Management.Automation/help/CommandHelpProvider.cs +++ b/src/System.Management.Automation/help/CommandHelpProvider.cs @@ -1249,7 +1249,7 @@ namespace System.Management.Automation /// /// HelpInfo that is forwarded over /// Help request object - /// The result helpInfo objects after processing + /// The result helpInfo objects after processing. internal override IEnumerable ProcessForwardedHelp(HelpInfo helpInfo, HelpRequest helpRequest) { HelpCategory categoriesHandled = (HelpCategory.Alias diff --git a/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs b/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs index 47e84f689..56c1dfc36 100644 --- a/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs +++ b/src/System.Management.Automation/help/DefaultCommandHelpObjectBuilder.cs @@ -47,7 +47,7 @@ namespace System.Management.Automation.Help /// Generates a HelpInfo PSObject from a CmdletInfo object /// /// command info - /// HelpInfo PSObject + /// HelpInfo PSObject. internal static PSObject GetPSObjectFromCmdletInfo(CommandInfo input) { // Create a copy of commandInfo for GetCommandCommand so that we can generate parameter @@ -779,7 +779,7 @@ namespace System.Management.Automation.Help /// Gets the parameter attribute from parameter metadata /// /// parameter attributes - /// parameter attributes + /// Parameter attributes. private static Collection GetParameterAttribute(Collection attributes) { Collection paramAttributes = new Collection(); @@ -801,7 +801,7 @@ namespace System.Management.Automation.Help /// Gets the validate set attribute from parameter metadata /// /// parameter attributes - /// parameter attributes + /// Parameter attributes. private static Collection GetValidateSetAttribute(Collection attributes) { Collection validateSetAttributes = new Collection(); @@ -823,7 +823,7 @@ namespace System.Management.Automation.Help /// Gets the pipeline input type /// /// parameter attribute - /// pipeline input type + /// Pipeline input type. private static string GetPipelineInputString(ParameterAttribute paramAttrib) { Debug.Assert(paramAttrib != null); @@ -874,7 +874,7 @@ namespace System.Management.Automation.Help /// Checks if a set of parameters contains any of the common parameters /// /// parameters to check - /// true if it contains common parameters, false otherwise + /// True if it contains common parameters, false otherwise. internal static bool HasCommonParameters(Dictionary parameters) { Collection commonParams = new Collection(); diff --git a/src/System.Management.Automation/help/HelpCommands.cs b/src/System.Management.Automation/help/HelpCommands.cs index 125501745..e22b3efd4 100644 --- a/src/System.Management.Automation/help/HelpCommands.cs +++ b/src/System.Management.Automation/help/HelpCommands.cs @@ -176,7 +176,7 @@ namespace Microsoft.PowerShell.Commands /// [Parameter] public string[] Role { get; set; } - + /// /// This parameter,if true, will direct get-help cmdlet to /// navigate to a URL (stored in the command MAML file under diff --git a/src/System.Management.Automation/help/HelpCommentsParser.cs b/src/System.Management.Automation/help/HelpCommentsParser.cs index 649bd9f44..de6d43db9 100644 --- a/src/System.Management.Automation/help/HelpCommentsParser.cs +++ b/src/System.Management.Automation/help/HelpCommentsParser.cs @@ -202,7 +202,7 @@ namespace System.Management.Automation /// /// Create the maml xml after a successful analysis of the comments. /// - /// The xml node for the command constructed + /// The xml node for the command constructed. internal XmlDocument BuildXmlFromComments() { Diagnostics.Assert(!string.IsNullOrEmpty(_commandName), "Name can never be null"); @@ -955,7 +955,7 @@ namespace System.Management.Automation /// Analyze a block of comments to determine if it is a special help block. /// /// The block of comments to analyze. - /// true if the block is our special comment block for help, false otherwise. + /// True if the block is our special comment block for help, false otherwise. internal static bool IsCommentHelpText(List commentBlock) { if ((commentBlock == null) || (commentBlock.Count == 0)) diff --git a/src/System.Management.Automation/help/HelpFileHelpInfo.cs b/src/System.Management.Automation/help/HelpFileHelpInfo.cs index 1788c1a5f..af7ba0fd6 100644 --- a/src/System.Management.Automation/help/HelpFileHelpInfo.cs +++ b/src/System.Management.Automation/help/HelpFileHelpInfo.cs @@ -88,7 +88,7 @@ namespace System.Management.Automation /// help topic name /// help text /// file name that contains the help text - /// HelpFileHelpInfo object created based on information provided + /// HelpFileHelpInfo object created based on information provided. internal static HelpFileHelpInfo GetHelpInfo(string name, string text, string filename) { if (String.IsNullOrEmpty(name)) @@ -109,7 +109,7 @@ namespace System.Management.Automation /// /// text to get the line for /// line number - /// the part of string in text that is in specified line + /// The part of string in text that is in specified line. private static string GetLine(string text, int line) { StringReader reader = new StringReader(text); diff --git a/src/System.Management.Automation/help/HelpFileHelpProvider.cs b/src/System.Management.Automation/help/HelpFileHelpProvider.cs index a13d9623f..731327a54 100644 --- a/src/System.Management.Automation/help/HelpFileHelpProvider.cs +++ b/src/System.Management.Automation/help/HelpFileHelpProvider.cs @@ -292,7 +292,7 @@ namespace System.Management.Automation /// Load help file based on the file path. /// /// file path to load help from - /// Help info object loaded from the file + /// Help info object loaded from the file. private HelpInfo LoadHelpFile(string path) { string fileName = Path.GetFileName(path); @@ -336,7 +336,7 @@ namespace System.Management.Automation /// Gets the extended search paths for about_topics help. To be able to get about_topics help from unloaded modules, /// we will add $pshome and the folders under PS module paths to the collection of paths to search. /// - /// a collection of string representing locations + /// A collection of string representing locations. internal Collection GetExtendedSearchPaths() { Collection searchPaths = GetSearchPaths(); diff --git a/src/System.Management.Automation/help/HelpInfo.cs b/src/System.Management.Automation/help/HelpInfo.cs index 53c186ce7..6c3d91848 100644 --- a/src/System.Management.Automation/help/HelpInfo.cs +++ b/src/System.Management.Automation/help/HelpInfo.cs @@ -140,7 +140,7 @@ namespace System.Management.Automation /// Returns help information for a parameter(s) identified by pattern /// /// pattern to search for parameters - /// A collection of parameters that match pattern + /// 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 ffd6803e6..2f68100b0 100644 --- a/src/System.Management.Automation/help/HelpProvider.cs +++ b/src/System.Management.Automation/help/HelpProvider.cs @@ -140,7 +140,7 @@ namespace System.Management.Automation /// Retrieve help info that exactly match the target. /// /// help request object - /// List of HelpInfo objects retrieved + /// List of HelpInfo objects retrieved. internal abstract IEnumerable ExactMatchHelp(HelpRequest helpRequest); /// @@ -153,7 +153,7 @@ namespace System.Management.Automation /// /// If false, searches for pattern in the command names. /// - /// a collection of help info objects + /// A collection of help info objects. internal abstract IEnumerable SearchHelp(HelpRequest helpRequest, bool searchOnlyContent); /// @@ -220,7 +220,7 @@ namespace System.Management.Automation /// Each Shell ( minishell ) will have its own path specified by the /// application base folder, which should be the same as $pshome /// - /// string representing base directory of the executing shell. + /// String representing base directory of the executing shell. internal string GetDefaultShellSearchPath() { string shellID = this.HelpSystem.ExecutionContext.ShellID; @@ -240,7 +240,7 @@ namespace System.Management.Automation /// Gets the search paths. If the current shell is single-shell based, then the returned /// search path contains all the directories of currently active PSSnapIns /// - /// a collection of string representing locations + /// A collection of string representing locations. internal Collection GetSearchPaths() { Collection searchPaths = this.HelpSystem.GetSearchPaths(); diff --git a/src/System.Management.Automation/help/HelpProviderWithCache.cs b/src/System.Management.Automation/help/HelpProviderWithCache.cs index 2893a94d9..fa5280291 100644 --- a/src/System.Management.Automation/help/HelpProviderWithCache.cs +++ b/src/System.Management.Automation/help/HelpProviderWithCache.cs @@ -34,7 +34,7 @@ namespace System.Management.Automation /// Exact match help for a target. /// /// Help request object - /// The HelpInfo found. Null if nothing is found + /// The HelpInfo found. Null if nothing is found. internal override IEnumerable ExactMatchHelp(HelpRequest helpRequest) { string target = helpRequest.Target; @@ -109,7 +109,7 @@ namespace System.Management.Automation /// /// If false, searches for pattern in the command names. /// - /// a collection of help info objects + /// A collection of help info objects. internal override IEnumerable SearchHelp(HelpRequest helpRequest, bool searchOnlyContent) { string target = helpRequest.Target; @@ -160,7 +160,7 @@ namespace System.Management.Automation /// Child class of this one may choose to override this function. /// /// target string - /// wild card pattern created + /// Wild card pattern created. internal virtual string GetWildCardPattern(string target) { if (WildcardPattern.ContainsWildcardCharacters(target)) @@ -177,7 +177,7 @@ namespace System.Management.Automation /// whether it want to reuse the logic in SearchHelp for this class. /// /// help request object - /// a collection of help info objects + /// A collection of help info objects. internal virtual IEnumerable DoSearchHelp(HelpRequest helpRequest) { yield break; @@ -197,7 +197,7 @@ namespace System.Management.Automation /// Get help entry from cache /// /// the key for the help entry to retrieve - /// the HelpInfo in cache corresponding the key specified + /// The HelpInfo in cache corresponding the key specified. internal HelpInfo GetCache(string target) { return (HelpInfo)_helpCache[target]; diff --git a/src/System.Management.Automation/help/HelpProviderWithFullCache.cs b/src/System.Management.Automation/help/HelpProviderWithFullCache.cs index cafcf268c..88deda817 100644 --- a/src/System.Management.Automation/help/HelpProviderWithFullCache.cs +++ b/src/System.Management.Automation/help/HelpProviderWithFullCache.cs @@ -28,7 +28,7 @@ namespace System.Management.Automation /// since this is no need for children class to override this member. /// /// help request object - /// The HelpInfo found. Null if nothing is found + /// The HelpInfo found. Null if nothing is found. internal sealed override IEnumerable ExactMatchHelp(HelpRequest helpRequest) { if (!this.CacheFullyLoaded) @@ -61,7 +61,7 @@ namespace System.Management.Automation /// /// If false, searches for pattern in the command names. /// - /// a collection of help info objects + /// A collection of help info objects. internal sealed override IEnumerable SearchHelp(HelpRequest helpRequest, bool searchOnlyContent) { if (!this.CacheFullyLoaded) @@ -79,7 +79,7 @@ namespace System.Management.Automation /// since this is no need for children class to override this member. /// /// help request object - /// a collection of help info objects + /// A collection of help info objects. internal sealed override IEnumerable DoSearchHelp(HelpRequest helpRequest) { return null; diff --git a/src/System.Management.Automation/help/HelpSystem.cs b/src/System.Management.Automation/help/HelpSystem.cs index 04ddcaa9f..c537a78d8 100644 --- a/src/System.Management.Automation/help/HelpSystem.cs +++ b/src/System.Management.Automation/help/HelpSystem.cs @@ -155,7 +155,7 @@ namespace System.Management.Automation /// object on fly. /// /// helpRequest object - /// An array of HelpInfo object + /// An array of HelpInfo object. internal IEnumerable GetHelp(HelpRequest helpRequest) { if (helpRequest == null) @@ -242,7 +242,7 @@ namespace System.Management.Automation /// If the current shell is single-shell based, then the returned /// search path contains all the directories of currently active PSSnapIns/modules. /// - /// a collection of strings representing locations + /// A collection of strings representing locations. internal Collection GetSearchPaths() { // return the cache if already present. @@ -280,7 +280,7 @@ namespace System.Management.Automation /// 4. if step 3 returns exact one helpInfo object, try to retrieve exact help. /// /// Help request object - /// An array of HelpInfo object + /// An array of HelpInfo object. private IEnumerable DoGetHelp(HelpRequest helpRequest) { _lastErrors.Clear(); @@ -456,7 +456,7 @@ namespace System.Management.Automation /// Get help that exactly match the target /// /// help request object - /// An IEnumerable of HelpInfo object + /// An IEnumerable of HelpInfo object. private IEnumerable SearchHelp(HelpRequest helpRequest) { int countOfHelpInfosFound = 0; diff --git a/src/System.Management.Automation/help/MamlClassHelpInfo.cs b/src/System.Management.Automation/help/MamlClassHelpInfo.cs index 7637e58a7..82d6a4719 100644 --- a/src/System.Management.Automation/help/MamlClassHelpInfo.cs +++ b/src/System.Management.Automation/help/MamlClassHelpInfo.cs @@ -51,7 +51,7 @@ namespace System.Management.Automation /// /// xmlNode that contains help info /// help category this maml object fits into - /// MamlCommandHelpInfo object created + /// MamlCommandHelpInfo object created. internal static MamlClassHelpInfo Load(XmlNode xmlNode, HelpCategory helpCategory) { MamlClassHelpInfo mamlClassHelpInfo = new MamlClassHelpInfo(xmlNode, helpCategory); @@ -82,7 +82,7 @@ namespace System.Management.Automation /// Clone the help object with a new category. /// /// - /// MamlClassHelpInfo + /// MamlClassHelpInfo. internal MamlClassHelpInfo Copy(HelpCategory newCategoryToUse) { MamlClassHelpInfo result = new MamlClassHelpInfo(_fullHelpObject.Copy(), newCategoryToUse); diff --git a/src/System.Management.Automation/help/MamlCommandHelpInfo.cs b/src/System.Management.Automation/help/MamlCommandHelpInfo.cs index 1b64f333a..d9d8f5c08 100644 --- a/src/System.Management.Automation/help/MamlCommandHelpInfo.cs +++ b/src/System.Management.Automation/help/MamlCommandHelpInfo.cs @@ -253,7 +253,7 @@ namespace System.Management.Automation /// /// xmlNode that contains help info /// help category this maml object fits into - /// MamlCommandHelpInfo object created + /// MamlCommandHelpInfo object created. internal static MamlCommandHelpInfo Load(XmlNode xmlNode, HelpCategory helpCategory) { MamlCommandHelpInfo mamlCommandHelpInfo = new MamlCommandHelpInfo(xmlNode, helpCategory); @@ -281,7 +281,7 @@ namespace System.Management.Automation /// /// 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 + /// Merged command help info object. internal MamlCommandHelpInfo MergeProviderSpecificHelp(PSObject cmdletHelp, PSObject[] dynamicParameterHelp) { if (this._fullHelpObject == null) diff --git a/src/System.Management.Automation/help/MamlNode.cs b/src/System.Management.Automation/help/MamlNode.cs index c5f0927d1..4c7d41ef5 100644 --- a/src/System.Management.Automation/help/MamlNode.cs +++ b/src/System.Management.Automation/help/MamlNode.cs @@ -1143,7 +1143,7 @@ namespace System.Management.Automation /// Trim empty lines from the either end of an string array. /// /// lines to trim - /// an string array with empty lines trimed on either end + /// An string array with empty lines trimed on either end. private static string[] TrimLines(string[] lines) { if (lines == null || lines.Length == 0) diff --git a/src/System.Management.Automation/help/ProviderHelpInfo.cs b/src/System.Management.Automation/help/ProviderHelpInfo.cs index 6bbdb35a5..cf3b70dc9 100644 --- a/src/System.Management.Automation/help/ProviderHelpInfo.cs +++ b/src/System.Management.Automation/help/ProviderHelpInfo.cs @@ -191,7 +191,7 @@ namespace System.Management.Automation /// Return the provider-specific cmdlet help based on input cmdletName /// /// cmdletName on which to get provider-specific help - /// An mshObject that contains provider-specific commandlet help + /// An mshObject that contains provider-specific commandlet help. internal PSObject GetCmdletHelp(string cmdletName) { if (String.IsNullOrEmpty(cmdletName)) @@ -262,7 +262,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 mshObject that contains the parameter help + /// An array of mshObject that contains the parameter help. internal PSObject[] GetDynamicParameterHelp(string[] parameters) { if (parameters == null || parameters.Length == 0) @@ -346,7 +346,7 @@ namespace System.Management.Automation /// Create providerHelpInfo from an xmlNode /// /// xml node that contains the provider help info - /// the providerHelpInfo object created + /// The providerHelpInfo object created. internal static ProviderHelpInfo Load(XmlNode xmlNode) { ProviderHelpInfo providerHelpInfo = new ProviderHelpInfo(xmlNode); diff --git a/src/System.Management.Automation/help/ProviderHelpProvider.cs b/src/System.Management.Automation/help/ProviderHelpProvider.cs index 9c8b208a4..721d0df23 100644 --- a/src/System.Management.Automation/help/ProviderHelpProvider.cs +++ b/src/System.Management.Automation/help/ProviderHelpProvider.cs @@ -374,7 +374,7 @@ namespace System.Management.Automation /// /// helpInfo forwarded in /// help request object - /// The help info object after processing + /// The help info object after processing. override internal HelpInfo ProcessForwardedHelp(HelpInfo helpInfo, HelpRequest helpRequest) { if (helpInfo == null) diff --git a/src/System.Management.Automation/help/SaveHelpCommand.cs b/src/System.Management.Automation/help/SaveHelpCommand.cs index fda6d8bec..e3703806d 100644 --- a/src/System.Management.Automation/help/SaveHelpCommand.cs +++ b/src/System.Management.Automation/help/SaveHelpCommand.cs @@ -165,7 +165,7 @@ namespace Microsoft.PowerShell.Commands /// /// module to process /// culture to use - /// true if the module has been processed, false if not + /// True if the module has been processed, false if not. internal override bool ProcessModuleWithCulture(UpdatableHelpModuleInfo module, string culture) { Collection resolvedPaths = new Collection(); diff --git a/src/System.Management.Automation/help/SyntaxHelpInfo.cs b/src/System.Management.Automation/help/SyntaxHelpInfo.cs index 22ec78a60..9d7c435e5 100644 --- a/src/System.Management.Automation/help/SyntaxHelpInfo.cs +++ b/src/System.Management.Automation/help/SyntaxHelpInfo.cs @@ -44,7 +44,7 @@ namespace System.Management.Automation /// help topic name /// help text /// help category - /// SyntaxHelpInfo object created based on information provided + /// SyntaxHelpInfo object created based on information provided. internal static SyntaxHelpInfo GetHelpInfo(string name, string text, HelpCategory category) { if (String.IsNullOrEmpty(name)) diff --git a/src/System.Management.Automation/help/UpdatableHelpCommandBase.cs b/src/System.Management.Automation/help/UpdatableHelpCommandBase.cs index a7e56a4b4..4e082e185 100644 --- a/src/System.Management.Automation/help/UpdatableHelpCommandBase.cs +++ b/src/System.Management.Automation/help/UpdatableHelpCommandBase.cs @@ -189,7 +189,7 @@ namespace Microsoft.PowerShell.Commands /// if it exists in the metadata cache. /// /// module name - /// true if system module, false if not + /// True if system module, false if not. internal static bool IsSystemModule(string module) { return s_metadataCache.ContainsKey(module); @@ -273,7 +273,7 @@ namespace Microsoft.PowerShell.Commands /// pattern to search /// Module Specification /// do not generate errors for modules without HelpInfoUri - /// a list of modules + /// A list of modules. private Dictionary, UpdatableHelpModuleInfo> GetModuleInfo(ExecutionContext context, string pattern, ModuleSpecification fullyQualifiedName, bool noErrors) { List modules = null; @@ -595,7 +595,7 @@ namespace Microsoft.PowerShell.Commands /// /// module to process /// culture to use - /// true if the module has been processed, false if not + /// True if the module has been processed, false if not. internal virtual bool ProcessModuleWithCulture(UpdatableHelpModuleInfo module, string culture) { return false; @@ -611,7 +611,7 @@ namespace Microsoft.PowerShell.Commands /// pattern to match /// ModuleSpecification /// skip errors - /// a list of modules + /// A list of modules. internal Dictionary, UpdatableHelpModuleInfo> GetModuleInfo(string pattern, ModuleSpecification fullyQualifiedName, bool noErrors) { Dictionary, UpdatableHelpModuleInfo> modules = GetModuleInfo(Context, pattern, fullyQualifiedName, noErrors); @@ -638,7 +638,7 @@ namespace Microsoft.PowerShell.Commands /// new HelpInfo.xml /// current culture /// force update - /// true if it is necessary to update help, false if not + /// True if it is necessary to update help, false if not. internal bool IsUpdateNecessary(UpdatableHelpModuleInfo module, UpdatableHelpInfo currentHelpInfo, UpdatableHelpInfo newHelpInfo, CultureInfo culture, bool force) { @@ -676,7 +676,7 @@ namespace Microsoft.PowerShell.Commands /// help info file name /// current time (UTC) /// if -Force is specified - /// true if we are okay to update, false if not + /// True if we are okay to update, false if not. internal bool CheckOncePerDayPerModule(string moduleName, string path, string filename, DateTime time, bool force) { // Update if -Force is specified @@ -719,7 +719,7 @@ namespace Microsoft.PowerShell.Commands /// path to resolve /// resolve recursively? /// Treat the path / start path as a literal path?/// - /// a list of directories + /// A list of directories. internal IEnumerable ResolvePath(string path, bool recurse, bool isLiteralPath) { List resolvedPaths = new List(); @@ -777,7 +777,7 @@ namespace Microsoft.PowerShell.Commands /// Resolves a given path to a list of directories recursively /// /// path to resolve - /// a list of directories + /// A list of directories. private IEnumerable RecursiveResolvePathHelper(string path) { if (System.IO.Directory.Exists(path)) diff --git a/src/System.Management.Automation/help/UpdatableHelpInfo.cs b/src/System.Management.Automation/help/UpdatableHelpInfo.cs index e49eb2b5c..2a6be8b01 100644 --- a/src/System.Management.Automation/help/UpdatableHelpInfo.cs +++ b/src/System.Management.Automation/help/UpdatableHelpInfo.cs @@ -78,7 +78,7 @@ namespace System.Management.Automation.Help /// /// HelpInfo object to check /// culture to check - /// true if the other HelpInfo is newer, false if not + /// True if the other HelpInfo is newer, false if not. internal bool IsNewerVersion(UpdatableHelpInfo helpInfo, CultureInfo culture) { Debug.Assert(helpInfo != null); @@ -100,7 +100,7 @@ namespace System.Management.Automation.Help /// Checks if a culture is supported /// /// culture to check - /// true if supported, false if not + /// True if supported, false if not. internal bool IsCultureSupported(CultureInfo culture) { Debug.Assert(culture != null); @@ -120,7 +120,7 @@ namespace System.Management.Automation.Help /// /// Gets a string representation of the supported cultures /// - /// supported cultures in string + /// Supported cultures in string. internal string GetSupportedCultures() { if (UpdatableHelpItems.Length == 0) @@ -147,7 +147,7 @@ namespace System.Management.Automation.Help /// Gets the culture version /// /// culture info - /// culture version + /// Culture version. internal Version GetCultureVersion(CultureInfo culture) { foreach (CultureSpecificUpdatableHelp updatableHelpItem in UpdatableHelpItems) diff --git a/src/System.Management.Automation/help/UpdatableHelpModuleInfo.cs b/src/System.Management.Automation/help/UpdatableHelpModuleInfo.cs index cdbf12013..d61c89f22 100644 --- a/src/System.Management.Automation/help/UpdatableHelpModuleInfo.cs +++ b/src/System.Management.Automation/help/UpdatableHelpModuleInfo.cs @@ -70,7 +70,7 @@ namespace System.Management.Automation.Help /// Gets the combined HelpContent.zip name /// /// current culture - /// HelpContent name + /// HelpContent name. internal string GetHelpContentName(CultureInfo culture) { Debug.Assert(culture != null); @@ -81,7 +81,7 @@ namespace System.Management.Automation.Help /// /// Gets the combined HelpInfo.xml name /// - /// HelpInfo name + /// HelpInfo name. internal string GetHelpInfoName() { return ModuleName + "_" + _moduleGuid.ToString() + "_" + HelpIntoXmlName; diff --git a/src/System.Management.Automation/help/UpdatableHelpSystem.cs b/src/System.Management.Automation/help/UpdatableHelpSystem.cs index 35e01dbb1..c93697e63 100644 --- a/src/System.Management.Automation/help/UpdatableHelpSystem.cs +++ b/src/System.Management.Automation/help/UpdatableHelpSystem.cs @@ -110,7 +110,7 @@ namespace System.Management.Automation.Help /// Creates an error record from this context /// /// command type - /// error record + /// Error record. internal ErrorRecord CreateErrorRecord(UpdatableHelpCommandType commandType) { Debug.Assert(Modules.Count != 0); @@ -287,7 +287,7 @@ namespace System.Management.Automation.Help /// /// Gets the current UIculture (includes the fallback chain) /// - /// a list of cultures + /// A list of cultures. internal IEnumerable GetCurrentUICulture() { CultureInfo culture = CultureInfo.CurrentUICulture; @@ -314,7 +314,7 @@ namespace System.Management.Automation.Help /// /// internal module information /// help content culture - /// internal help uri representation + /// Internal help uri representation. internal UpdatableHelpUri GetHelpInfoUri(UpdatableHelpModuleInfo module, CultureInfo culture) { return new UpdatableHelpUri(module.ModuleName, module.ModuleGuid, culture, ResolveUri(module.HelpInfoUri, false)); @@ -328,7 +328,7 @@ namespace System.Management.Automation.Help /// module name /// module GUID /// current UI culture - /// HelpInfo object + /// HelpInfo object. internal UpdatableHelpInfo GetHelpInfo(UpdatableHelpCommandType commandType, string uri, string moduleName, Guid moduleGuid, string culture) { try @@ -376,7 +376,7 @@ namespace System.Management.Automation.Help /// /// base URI /// - /// resolved URI + /// Resolved URI. private string ResolveUri(string baseUri, bool verbose) { Debug.Assert(!String.IsNullOrEmpty(baseUri)); @@ -527,7 +527,7 @@ namespace System.Management.Automation.Help /// to handle redirections if any. /// /// ignore the xsd validation exception and return null in such case - /// HelpInfo object + /// HelpInfo object. internal UpdatableHelpInfo CreateHelpInfo(string xml, string moduleName, Guid moduleGuid, string currentCulture, string pathOverride, bool verbose, bool shouldResolveUri, bool ignoreValidationException) { @@ -715,7 +715,7 @@ namespace System.Management.Automation.Help /// help content uri /// path of the maml XSDs /// files installed - /// true if the operation succeeded, false if not + /// 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) { @@ -746,7 +746,7 @@ namespace System.Management.Automation.Help /// help content uri /// combined file name /// culture name - /// true if the operation succeeded, false if not + /// True if the operation succeeded, false if not. internal bool DownloadHelpContent(UpdatableHelpCommandType commandType, string path, string helpContentUri, string fileName, string culture) { if (_stopping) @@ -1412,7 +1412,7 @@ namespace System.Management.Automation.Help /// cmdlet instance /// path to load /// credential - /// string loaded + /// String loaded. internal static string LoadStringFromPath(PSCmdlet cmdlet, string path, PSCredential credential) { Debug.Assert(path != null); diff --git a/src/System.Management.Automation/help/UpdateHelpCommand.cs b/src/System.Management.Automation/help/UpdateHelpCommand.cs index 27aa7990b..319369ef6 100644 --- a/src/System.Management.Automation/help/UpdateHelpCommand.cs +++ b/src/System.Management.Automation/help/UpdateHelpCommand.cs @@ -214,7 +214,7 @@ namespace Microsoft.PowerShell.Commands /// /// module to process /// culture to use - /// true if the module has been processed, false if not + /// True if the module has been processed, false if not. internal override bool ProcessModuleWithCulture(UpdatableHelpModuleInfo module, string culture) { UpdatableHelpInfo currentHelpInfo = null; diff --git a/src/System.Management.Automation/logging/LogProvider.cs b/src/System.Management.Automation/logging/LogProvider.cs index 0e253b55d..d88f5ef1c 100644 --- a/src/System.Management.Automation/logging/LogProvider.cs +++ b/src/System.Management.Automation/logging/LogProvider.cs @@ -234,7 +234,7 @@ namespace System.Management.Automation /// Converts log context to string /// /// log context - /// string representation + /// String representation. protected static string LogContextToString(LogContext context) { StringBuilder sb = new StringBuilder(LogContextInitialSize); diff --git a/src/System.Management.Automation/namespaces/EnvironmentProvider.cs b/src/System.Management.Automation/namespaces/EnvironmentProvider.cs index 5f1fe7174..88954238a 100644 --- a/src/System.Management.Automation/namespaces/EnvironmentProvider.cs +++ b/src/System.Management.Automation/namespaces/EnvironmentProvider.cs @@ -194,9 +194,9 @@ namespace Microsoft.PowerShell.Commands // see https://github.com/PowerShell/PowerShell/issues/6305. // However, because retrieval *by name* later is invariably // case-INsensitive, in effect only a *single* variable exists. - // We simply ask Environment.GetEnvironmentVariable() for the effective value + // We simply ask Environment.GetEnvironmentVariable() for the effective value // and use that as the only entry, because for a given key 'foo' (and all its case variations), - // that is guaranteed to match what $env:FOO and [environment]::GetEnvironmentVariable('foo') return. + // that is guaranteed to match what $env:FOO and [environment]::GetEnvironmentVariable('foo') return. // (If, by contrast, we just used `entry` as-is every time a duplicate is encountered, // it could - intermittently - represent a value *other* than the effective one.) string effectiveValue = Environment.GetEnvironmentVariable((string)entry.Key); @@ -204,7 +204,7 @@ namespace Microsoft.PowerShell.Commands // Note: We *recreate* the entry so that the specific name casing of the // effective definition is also reflected. However, if the case variants // define the same value, it is unspecified which name variant is reflected - // in Get-Item env: output; given the always case-insensitive nature of the retrieval, + // in Get-Item env: output; given the always case-insensitive nature of the retrieval, // that shouldn't matter. providerTable.Remove((string)entry.Key); providerTable.Add((string)entry.Key, entry); diff --git a/src/System.Management.Automation/namespaces/FileSystemContentStream.cs b/src/System.Management.Automation/namespaces/FileSystemContentStream.cs index a3a4dfa05..54e99e992 100644 --- a/src/System.Management.Automation/namespaces/FileSystemContentStream.cs +++ b/src/System.Management.Automation/namespaces/FileSystemContentStream.cs @@ -1241,7 +1241,7 @@ namespace Microsoft.PowerShell.Commands /// /// Peek the next character /// - /// Return -1 if we reach the head of the file + /// Return -1 if we reach the head of the file. public override int Peek() { if (_charCount == 0) @@ -1259,7 +1259,7 @@ namespace Microsoft.PowerShell.Commands /// /// Read the next character /// - /// Return -1 if we reach the head of the file + /// Return -1 if we reach the head of the file. public override int Read() { if (_charCount == 0) @@ -1280,8 +1280,8 @@ namespace Microsoft.PowerShell.Commands /// Output buffer. /// Start position to write with. /// Number of bytes to read. - /// Return the number of characters read, or -1 if we reach the head of the file - /// Return the number of characters read, or -1 if we reach the head of the file + /// Return the number of characters read, or -1 if we reach the head of the file. + /// Return the number of characters read, or -1 if we reach the head of the file. public override int Read(char[] buffer, int index, int count) { return ReadSpan(new Span(buffer, index, count)); @@ -1329,7 +1329,7 @@ namespace Microsoft.PowerShell.Commands /// /// Read a line from the current stream /// - /// Return null if we reach the head of the file + /// Return null if we reach the head of the file. public override string ReadLine() { if (_charCount == 0 && RefillCharBuffer() == -1) diff --git a/src/System.Management.Automation/namespaces/FileSystemProvider.cs b/src/System.Management.Automation/namespaces/FileSystemProvider.cs index a638e7b1b..4d9cea940 100644 --- a/src/System.Management.Automation/namespaces/FileSystemProvider.cs +++ b/src/System.Management.Automation/namespaces/FileSystemProvider.cs @@ -7668,7 +7668,7 @@ namespace Microsoft.PowerShell.Commands /// Gets the target of the specified reparse point. /// /// The object of FileInfo or DirectoryInfo type. - /// The target of the reparse point + /// The target of the reparse point. public static IEnumerable GetTarget(PSObject instance) { if (instance.BaseObject is FileSystemInfo fileSysInfo) @@ -8308,7 +8308,7 @@ namespace System.Management.Automation.Internal /// The FileAccess of the file. /// The FileShare of the file. /// A FileStream that can be used to interact with the file. - /// true if the stream was successfully created, otherwise false. + /// True if the stream was successfully created, otherwise false. internal static bool TryCreateFileStream(string path, string streamName, FileMode mode, FileAccess access, FileShare share, out FileStream stream) { if (path == null) diff --git a/src/System.Management.Automation/namespaces/RegistryProvider.cs b/src/System.Management.Automation/namespaces/RegistryProvider.cs index 0862faeda..c6e04f99a 100644 --- a/src/System.Management.Automation/namespaces/RegistryProvider.cs +++ b/src/System.Management.Automation/namespaces/RegistryProvider.cs @@ -3103,7 +3103,7 @@ namespace Microsoft.PowerShell.Commands /// /// Key whose value has to be reset /// name of the value to reset - /// default value the key was set to + /// Default value the key was set to. private object ResetRegistryKeyValue(IRegistryWrapper key, string valueName) { RegistryValueKind valueKind = key.GetValueKind(valueName); @@ -3208,7 +3208,7 @@ namespace Microsoft.PowerShell.Commands /// it throws an exception /// /// path to check - /// false if the operation is not allowed + /// False if the operation is not allowed. private bool CheckOperationNotAllowedOnHiveContainer(string path) { if (IsHiveContainer(path)) @@ -3882,7 +3882,7 @@ namespace Microsoft.PowerShell.Commands /// helper to infer the RegistryValueKind from an object /// /// object whose RegistryValueKind has to be determined - /// corresponding RegistryValueKind + /// Corresponding RegistryValueKind. private static RegistryValueKind GetValueKindFromObject(object value) { if (value == null) @@ -3925,7 +3925,7 @@ namespace Microsoft.PowerShell.Commands /// /// RegistryKey containing property /// Property for which RegistryValueKind is requested - /// RegistryValueKind of the property. If the property does not exit,returns RegistryValueKind.Unknown + /// RegistryValueKind of the property. If the property does not exit,returns RegistryValueKind.Unknown. private static RegistryValueKind GetValueKindForProperty(IRegistryWrapper key, string valueName) { try @@ -3954,7 +3954,7 @@ namespace Microsoft.PowerShell.Commands /// /// key to read the value from /// name of the value to read - /// value of the key, null if it could not retrieve + /// Value of the key, null if it could not retrieve /// it because known exceptions were thrown, else an exception is percolated up /// private static object ReadExistingKeyValue(IRegistryWrapper key, string valueName) diff --git a/src/System.Management.Automation/namespaces/SessionStateProviderBase.cs b/src/System.Management.Automation/namespaces/SessionStateProviderBase.cs index 099deee0c..680b3d2ef 100644 --- a/src/System.Management.Automation/namespaces/SessionStateProviderBase.cs +++ b/src/System.Management.Automation/namespaces/SessionStateProviderBase.cs @@ -1057,21 +1057,21 @@ namespace Microsoft.PowerShell.Commands /// Always returns null /// /// - /// null + /// Null. public object GetContentReaderDynamicParameters(string path) { return null; } /// /// Always returns null /// /// - /// null + /// Null. public object GetContentWriterDynamicParameters(string path) { return null; } /// /// Always returns null /// /// - /// null + /// Null. public object ClearContentDynamicParameters(string path) { return null; } #endregion diff --git a/src/System.Management.Automation/security/Authenticode.cs b/src/System.Management.Automation/security/Authenticode.cs index db94b8cf4..2c792cf88 100644 --- a/src/System.Management.Automation/security/Authenticode.cs +++ b/src/System.Management.Automation/security/Authenticode.cs @@ -66,7 +66,7 @@ namespace System.Management.Automation /// URL of time stamping server /// The name of the hash /// algorithm to use. - /// Does not return a value + /// Does not return a value. /// /// Thrown if argument fileName or certificate is null. /// @@ -259,7 +259,7 @@ namespace System.Management.Automation /// /// name of file to check /// content of file to check - /// Signature object + /// 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 ef8c609de..0f66f3bc8 100644 --- a/src/System.Management.Automation/security/CatalogHelper.cs +++ b/src/System.Management.Automation/security/CatalogHelper.cs @@ -87,7 +87,7 @@ namespace System.Management.Automation /// Find out the Version of Catalog by reading its Meta data. We can have either version 1 or version 2 catalog /// /// Handle to open catalog file - /// Version of the catalog + /// Version of the catalog. private static int GetCatalogVersion(IntPtr catalogHandle) { int catalogVersion = -1; @@ -124,7 +124,7 @@ namespace System.Management.Automation /// HashAlgorithm used by the Catalog. It is based on the version of Catalog. /// /// Path of the output catalog file - /// Version of the catalog + /// Version of the catalog. private static string GetCatalogHashAlgorithm(int catalogVersion) { string hashAlgorithm = string.Empty; @@ -159,7 +159,7 @@ namespace System.Management.Automation /// Path of the catalog definition file /// Version of catalog /// hash method used to generate hashes for the Catalog - /// HashSet for the relative Path for files in Catalog + /// HashSet for the relative Path for files in Catalog. internal static string GenerateCDFFile(Collection Path, string catalogFilePath, string cdfFilePath, int catalogVersion, string hashAlgorithm) { HashSet relativePaths = new HashSet(); @@ -210,7 +210,7 @@ namespace System.Management.Automation /// 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 + /// Void. internal static void ProcessFileToBeAddedInCatalogDefinitionFile(FileInfo fileToHash, DirectoryInfo dirInfo, ref HashSet relativePaths, ref string cdfHeaderContent, ref string cdfFilesContent, ref int catAttributeCount) { string relativePath = string.Empty; @@ -332,7 +332,7 @@ namespace System.Management.Automation /// Catalog File Path /// Catalog File Path /// Instance of cmdlet calling this method - /// true if able to generate .cat file or false + /// True if able to generate .cat file or false. internal static FileInfo GenerateCatalog(PSCmdlet cmdlet, Collection Path, string catalogFilePath, int catalogVersion) { _cmdlet = cmdlet; @@ -374,7 +374,7 @@ namespace System.Management.Automation /// Get file attribute (Relative path in our case) from catalog /// /// Pointer to current attribute of catalog member. - /// value of the attribute + /// Value of the attribute. internal static string ProcessFilePathAttributeInCatalog(IntPtr memberAttrInfo) { string relativePath = string.Empty; @@ -401,7 +401,7 @@ namespace System.Management.Automation /// /// Path of the file /// Used to calculate Hash - /// HashValue for the file + /// HashValue for the file. internal static string CalculateFileHash(string filePath, string hashAlgorithm) { string hashValue = string.Empty; @@ -479,7 +479,7 @@ namespace System.Management.Automation /// Path to the folder having catalog file /// /// The version of input catalog we read from catalog meta data after opening it. - /// Dictionary mapping files relative paths to HashValues + /// Dictionary mapping files relative paths to HashValues. internal static Dictionary GetHashesFromCatalog(string catalogFilePath, WildcardPattern[] excludedPatterns, out int catalogVersion) { IntPtr resultCatalog = NativeMethods.CryptCATOpen(catalogFilePath, 0, IntPtr.Zero, 1, 0); @@ -578,7 +578,7 @@ namespace System.Management.Automation /// hash of file found in catalog. /// skip file from validation if it matches these patterns /// collection of hashes of catalog - /// void + /// Void. internal static void ProcessCatalogFile(string relativePath, string fileHash, WildcardPattern[] excludedPatterns, ref Dictionary catalogHashes) { // Found the attribute we are looking for @@ -604,7 +604,7 @@ namespace System.Management.Automation /// Used to calculate Hash /// skip file if it matches these patterns /// collection of hashes of files - /// void + /// Void. internal static void ProcessPathFile(FileInfo fileToHash, DirectoryInfo dirInfo, string hashAlgorithm, WildcardPattern[] excludedPatterns, ref Dictionary fileHashes) { string relativePath = string.Empty; @@ -656,7 +656,7 @@ namespace System.Management.Automation /// catalog file path it should be skipped when calculating the hashes /// Used to calculate Hash /// - /// Dictionary mapping file relative paths to hashes. + /// Dictionary mapping file relative paths to hashes.. internal static Dictionary CalculateHashesFromPath(Collection folderPaths, string catalogFilePath, string hashAlgorithm, WildcardPattern[] excludedPatterns) { // Create a HashTable of file Hashes @@ -690,7 +690,7 @@ namespace System.Management.Automation /// /// Hashes extracted from Catalog /// Hashes created from folders path - /// True if both collections are same + /// True if both collections are same. internal static bool CompareDictionaries(Dictionary catalogItems, Dictionary pathItems) { bool Status = true; @@ -735,7 +735,7 @@ namespace System.Management.Automation /// File Name of the Catalog /// /// Instance of cmdlet calling this method - /// Information about Catalog + /// Information about Catalog. internal static CatalogInformation ValidateCatalog(PSCmdlet cmdlet, Collection catalogFolders, string catalogFilePath, WildcardPattern[] excludedPatterns) { _cmdlet = cmdlet; @@ -772,7 +772,7 @@ namespace System.Management.Automation /// /// /// - /// True if match is found else false + /// True if match is found else false. internal static bool CheckExcludedCriteria(string filename, WildcardPattern[] excludedPatterns) { if (excludedPatterns != null) diff --git a/src/System.Management.Automation/security/MshSignature.cs b/src/System.Management.Automation/security/MshSignature.cs index 8b5709741..98fdcc1ab 100644 --- a/src/System.Management.Automation/security/MshSignature.cs +++ b/src/System.Management.Automation/security/MshSignature.cs @@ -194,7 +194,7 @@ namespace System.Management.Automation /// win32 error code /// cert of the signer /// cert of the time stamper - /// constructed object + /// Constructed object. /// internal Signature(string filePath, DWORD error, @@ -215,7 +215,7 @@ namespace System.Management.Automation /// /// this signature is found in this file /// cert of the signer - /// constructed object + /// Constructed object. /// internal Signature(string filePath, X509Certificate2 signer) @@ -234,7 +234,7 @@ namespace System.Management.Automation /// this signature is found in this file /// win32 error code /// cert of the signer - /// constructed object + /// Constructed object. /// internal Signature(string filePath, DWORD error, @@ -253,7 +253,7 @@ namespace System.Management.Automation /// /// this signature is found in this file /// win32 error code - /// constructed object + /// 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 31152626c..ba60a70dd 100644 --- a/src/System.Management.Automation/security/SecureStringHelper.cs +++ b/src/System.Management.Automation/security/SecureStringHelper.cs @@ -29,7 +29,7 @@ namespace Microsoft.PowerShell /// otherwise the results are unpredictable. /// /// input data - /// a SecureString + /// A SecureString . private static SecureString New(byte[] data) { if ((data.Length % 2) != 0) @@ -66,7 +66,7 @@ namespace Microsoft.PowerShell /// get the contents of a SecureString as byte[] /// /// input string - /// contents of s (char[]) converted to byte[] + /// Contents of s (char[]) converted to byte[]. [ArchitectureSensitive] internal static byte[] GetData(SecureString s) { @@ -100,7 +100,7 @@ namespace Microsoft.PowerShell /// such as base64. /// /// binary data to encode - /// a string representing encoded data + /// A string representing encoded data. internal static string ByteArrayToString(byte[] data) { StringBuilder sb = new StringBuilder(); @@ -118,7 +118,7 @@ namespace Microsoft.PowerShell /// back to byte[] format. /// /// encoded input string - /// bin data as byte[] + /// Bin data as byte[]. internal static byte[] ByteArrayFromString(string s) { // @@ -145,7 +145,7 @@ namespace Microsoft.PowerShell /// using DPAPI and encoding the encrypted blob as a string /// /// SecureString to protect - /// a string (see summary) + /// A string (see summary) . internal static string Protect(SecureString input) { Utils.CheckSecureStringArg(input, "input"); @@ -174,7 +174,7 @@ namespace Microsoft.PowerShell /// The string must be obtained earlier by a call to Protect() /// /// encrypted string - /// SecureString + /// SecureString . internal static SecureString Unprotect(string input) { Utils.CheckArgForNullOrEmpty(input, "input"); @@ -203,7 +203,7 @@ namespace Microsoft.PowerShell /// /// input string to encrypt /// encryption key - /// a string (see summary) + /// A string (see summary) . /// internal static EncryptionResult Encrypt(SecureString input, SecureString key) { @@ -233,7 +233,7 @@ namespace Microsoft.PowerShell /// /// input string to encrypt /// encryption key - /// a string (see summary) + /// A string (see summary) . /// internal static EncryptionResult Encrypt(SecureString input, byte[] key) { @@ -299,7 +299,7 @@ namespace Microsoft.PowerShell /// encrypted string /// encryption key /// encryption initialization vector. If this is set to null, the method uses internally computed strong random number as IV - /// SecureString + /// SecureString . internal static SecureString Decrypt(string input, SecureString key, byte[] IV) { SecureString output = null; @@ -331,7 +331,7 @@ namespace Microsoft.PowerShell /// encrypted string /// encryption key /// encryption initialization vector. If this is set to null, the method uses internally computed strong random number as IV - /// SecureString + /// SecureString . internal static SecureString Decrypt(string input, byte[] key, byte[] IV) { Utils.CheckArgForNullOrEmpty(input, "input"); diff --git a/src/System.Management.Automation/security/SecuritySupport.cs b/src/System.Management.Automation/security/SecuritySupport.cs index 46a93d2b4..8002c2afe 100644 --- a/src/System.Management.Automation/security/SecuritySupport.cs +++ b/src/System.Management.Automation/security/SecuritySupport.cs @@ -375,7 +375,7 @@ namespace System.Management.Automation.Internal /// Returns true if file has product binary signature /// /// Name of file to check - /// True when file has product binary signature + /// True when file has product binary signature. public static bool IsProductBinary(string file) { if (String.IsNullOrEmpty(file) || (!IO.File.Exists(file))) @@ -422,7 +422,7 @@ namespace System.Management.Automation.Internal /// Returns the value of the Execution Policy as retrieved /// from group policy. /// - /// NULL if it is not defined at this level + /// NULL if it is not defined at this level. private static string GetGroupPolicyValue(string shellId, ExecutionPolicyScope scope) { ConfigScope[] scopeKey = null; @@ -460,7 +460,7 @@ namespace System.Management.Automation.Internal /// Returns the value of the Execution Policy as retrieved /// from the local preference. /// - /// NULL if it is not defined at this level + /// NULL if it is not defined at this level. private static string GetLocalPreferenceValue(string shellId, ExecutionPolicyScope scope) { switch (scope) @@ -581,7 +581,7 @@ namespace System.Management.Automation.Internal /// throw if file does not exist /// /// path to file - /// Does not return a value + /// Does not return a value. /// internal static void CheckIfFileExists(string filePath) { @@ -596,7 +596,7 @@ namespace System.Management.Automation.Internal /// used as a code signing cert /// /// certificate object - /// true on success, false otherwise + /// True on success, false otherwise. /// internal static bool CertIsGoodForSigning(X509Certificate2 c) { @@ -614,7 +614,7 @@ namespace System.Management.Automation.Internal /// that this cert doesn't require the private key. /// /// certificate object - /// true on success, false otherwise + /// True on success, false otherwise. /// internal static bool CertIsGoodForEncryption(X509Certificate2 c) { @@ -662,7 +662,7 @@ namespace System.Management.Automation.Internal /// check if the specified cert has a private key in it /// /// certificate object - /// true on success, false otherwise + /// True on success, false otherwise. /// internal static bool CertHasPrivatekey(X509Certificate2 cert) { @@ -673,7 +673,7 @@ namespace System.Management.Automation.Internal /// Get the EKUs of a cert /// /// certificate object - /// a collection of cert eku strings + /// A collection of cert eku strings. /// [ArchitectureSensitive] internal static Collection GetCertEKU(X509Certificate2 cert) @@ -732,7 +732,7 @@ namespace System.Management.Automation.Internal /// convert an int to a DWORD /// /// signed int number - /// DWORD + /// DWORD. /// internal static DWORD GetDWORDFromInt(int n) { @@ -744,7 +744,7 @@ namespace System.Management.Automation.Internal /// convert a DWORD to int /// /// number - /// int + /// Int. /// internal static int GetIntFromDWORD(DWORD n) { diff --git a/src/System.Management.Automation/security/wldpNativeMethods.cs b/src/System.Management.Automation/security/wldpNativeMethods.cs index c68907526..ebd33d5b7 100644 --- a/src/System.Management.Automation/security/wldpNativeMethods.cs +++ b/src/System.Management.Automation/security/wldpNativeMethods.cs @@ -45,7 +45,7 @@ namespace System.Management.Automation.Security /// /// Gets the system lockdown policy /// - /// An EnforcementMode that describes the system policy + /// An EnforcementMode that describes the system policy. public static SystemEnforcementMode GetSystemLockdownPolicy() { if (s_allowDebugOverridePolicy || (s_systemLockdownPolicy == null)) @@ -69,7 +69,7 @@ namespace System.Management.Automation.Security /// /// Gets lockdown policy as applied to a file /// - /// An EnforcementMode that describes policy + /// An EnforcementMode that describes policy. public static SystemEnforcementMode GetLockdownPolicy(string path, SafeHandle handle) { // Check the WLDP API diff --git a/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs b/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs index f0cf85fd8..39716d276 100644 --- a/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs +++ b/src/System.Management.Automation/singleshell/config/MshSnapinInfo.cs @@ -1138,7 +1138,7 @@ namespace System.Management.Automation /// /// Get the registry key to PSEngine. /// - /// RegistryKey + /// RegistryKey. /// Major version in string format. /// /// Monad registration information is not available. diff --git a/src/System.Management.Automation/utils/CommandProcessorExceptions.cs b/src/System.Management.Automation/utils/CommandProcessorExceptions.cs index 3d24b4b18..a17909d27 100644 --- a/src/System.Management.Automation/utils/CommandProcessorExceptions.cs +++ b/src/System.Management.Automation/utils/CommandProcessorExceptions.cs @@ -24,7 +24,7 @@ namespace System.Management.Automation /// /// The serialization information to use when initializing this object /// The streaming context to use when initializing this object - /// constructed object + /// Constructed object. protected ApplicationFailedException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -35,7 +35,7 @@ namespace System.Management.Automation /// /// Initializes a new instance of the class ApplicationFailedException. /// - /// constructed object + /// Constructed object. public ApplicationFailedException() : base() { base.SetErrorId(errorIdString); @@ -46,7 +46,7 @@ namespace System.Management.Automation /// Initializes a new instance of the ApplicationFailedException class and defines the error message. /// /// The error message to use when initializing this object - /// constructed object + /// Constructed object. public ApplicationFailedException(string message) : base(message) { base.SetErrorId(errorIdString); @@ -59,7 +59,7 @@ namespace System.Management.Automation /// /// The error message to use when initializing this object /// The errorId to use when initializing this object - /// constructed object + /// Constructed object. internal ApplicationFailedException(string message, string errorId) : base(message) { base.SetErrorId(errorId); @@ -73,7 +73,7 @@ namespace System.Management.Automation /// The error message to use when initializing this object /// The errorId to use when initializing this object /// The inner exception to use when initializing this object - /// constructed object + /// Constructed object. internal ApplicationFailedException(string message, string errorId, Exception innerException) : base(message, innerException) { @@ -87,7 +87,7 @@ namespace System.Management.Automation /// /// The error message to use when initializing this object /// The inner exception to use when initializing this object - /// constructed object + /// Constructed object. public ApplicationFailedException(string message, Exception innerException) : base(message, innerException) diff --git a/src/System.Management.Automation/utils/CryptoUtils.cs b/src/System.Management.Automation/utils/CryptoUtils.cs index 231604b96..bfca1c58e 100644 --- a/src/System.Management.Automation/utils/CryptoUtils.cs +++ b/src/System.Management.Automation/utils/CryptoUtils.cs @@ -33,7 +33,7 @@ namespace System.Management.Automation.Internal /// /// Release the crypto handle held by this instance /// - /// true on success, false otherwise + /// True on success, false otherwise. [ReliabilityContract(Consistency.WillNotCorruptState, Cer.MayFail)] protected override bool ReleaseHandle() { @@ -60,7 +60,7 @@ namespace System.Management.Automation.Internal /// /// Release the crypto handle held by this instance /// - /// true on success, false otherwise + /// True on success, false otherwise. [ReliabilityContract(Consistency.WillNotCorruptState, Cer.MayFail)] protected override bool ReleaseHandle() { @@ -466,7 +466,7 @@ namespace System.Management.Automation.Internal /// /// Get the public key as a base64 encoded string /// - /// public key as base64 encoded string + /// Public key as base64 encoded string. internal string GetPublicKeyAsBase64EncodedString() { uint publicKeyLength = 0; @@ -528,8 +528,8 @@ namespace System.Management.Automation.Internal /// RSA public key /// 3. Encode result above as base 64 string and export /// - /// session key encrypted with receivers public key - /// and encoded as a base 64 string + /// Session key encrypted with receivers public key + /// and encoded as a base 64 string. internal string SafeExportSessionKey() { //generate one if not already done. @@ -613,7 +613,7 @@ namespace System.Management.Automation.Internal /// Encrypt the specified byte array /// /// data to encrypt - /// encrypted byte array + /// Encrypted byte array. internal byte[] EncryptWithSessionKey(byte[] data) { // first make a copy of the original data.This is needed @@ -674,7 +674,7 @@ namespace System.Management.Automation.Internal /// Decrypt the specified buffer /// /// data to decrypt - /// decrypted buffer + /// Decrypted buffer. internal byte[] DecryptWithSessionKey(byte[] data) { // first make a copy of the original data.This is needed @@ -793,8 +793,8 @@ namespace System.Management.Automation.Internal /// client. This will reuse the key that has been /// generated /// - /// crypto service provider for - /// the client side + /// Crypto service provider for + /// the client side. internal static PSRSACryptoServiceProvider GetRSACryptoServiceProviderForClient() { PSRSACryptoServiceProvider cryptoProvider = new PSRSACryptoServiceProvider(false); @@ -810,8 +810,8 @@ namespace System.Management.Automation.Internal /// Returns a crypto service provider for use in the /// server. This will not generate a key pair /// - /// crypto service provider for - /// the server side + /// Crypto service provider for + /// the server side. internal static PSRSACryptoServiceProvider GetRSACryptoServiceProviderForServer() { PSRSACryptoServiceProvider cryptoProvider = new PSRSACryptoServiceProvider(true); @@ -1105,7 +1105,7 @@ namespace System.Management.Automation.Internal /// Encrypt a secure string /// /// secure string to encrypt - /// encrypted string + /// Encrypted string. /// This method zeroes out all interim buffers used internal abstract string EncryptSecureString(SecureString secureString); @@ -1114,7 +1114,7 @@ namespace System.Management.Automation.Internal /// contents /// /// encrypted string - /// secure string object + /// Secure string object. /// This method zeroes out any interim buffers used internal abstract SecureString DecryptSecureString(string encryptedString); @@ -1225,7 +1225,7 @@ namespace System.Management.Automation.Internal /// Imports a public key from its base64 encoded string representation /// /// public key in its string representation - /// true on success + /// True on success. internal bool ImportRemotePublicKey(string publicKeyAsString) { Dbg.Assert(!String.IsNullOrEmpty(publicKeyAsString), "public key passed in cannot be null"); @@ -1283,7 +1283,7 @@ namespace System.Management.Automation.Internal /// /// Gets a helper with a test session /// - /// helper for testing + /// Helper for testing. /// To be used only for testing internal static PSRemotingCryptoHelperServer GetTestRemotingCryptHelperServer() { @@ -1346,7 +1346,7 @@ namespace System.Management.Automation.Internal /// /// on execution will contain /// the public key as string - /// true on success + /// True on success. internal bool ExportLocalPublicKey(out string publicKeyAsString) { // generate keys - the method already takes of creating @@ -1405,7 +1405,7 @@ namespace System.Management.Automation.Internal /// /// Gets a helper with a test session /// - /// helper for testing + /// Helper for testing. /// To be used only for testing internal static PSRemotingCryptoHelperClient GetTestRemotingCryptHelperClient() { diff --git a/src/System.Management.Automation/utils/EncodingUtils.cs b/src/System.Management.Automation/utils/EncodingUtils.cs index 713ff1e31..f63e969f6 100644 --- a/src/System.Management.Automation/utils/EncodingUtils.cs +++ b/src/System.Management.Automation/utils/EncodingUtils.cs @@ -49,7 +49,7 @@ namespace System.Management.Automation /// retrieve the encoding parameter from the command line /// it throws if the encoding does not match the known ones /// - /// a System.Text.Encoding object (null if no encoding specified) + /// A System.Text.Encoding object (null if no encoding specified). internal static Encoding Convert(Cmdlet cmdlet, string encoding) { if (string.IsNullOrEmpty(encoding)) diff --git a/src/System.Management.Automation/utils/ExecutionExceptions.cs b/src/System.Management.Automation/utils/ExecutionExceptions.cs index 3bbc9153b..50ffa7d77 100644 --- a/src/System.Management.Automation/utils/ExecutionExceptions.cs +++ b/src/System.Management.Automation/utils/ExecutionExceptions.cs @@ -96,7 +96,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the CmdletInvocationException class /// /// - /// constructed object + /// Constructed object. public CmdletInvocationException(string message) : base(message) { @@ -107,7 +107,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public CmdletInvocationException(string message, Exception innerException) : base(message, innerException) @@ -122,7 +122,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected CmdletInvocationException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -200,7 +200,7 @@ namespace System.Management.Automation /// /// identity of cmdlet, null is unknown /// - /// constructed object + /// Constructed object. internal CmdletProviderInvocationException( ProviderInvocationException innerException, InvocationInfo myInvocation) @@ -217,7 +217,7 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the CmdletProviderInvocationException class /// - /// constructed object + /// Constructed object. public CmdletProviderInvocationException() : base() { @@ -230,7 +230,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected CmdletProviderInvocationException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -242,7 +242,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the CmdletProviderInvocationException class /// /// - /// constructed object + /// Constructed object. public CmdletProviderInvocationException(string message) : base(message) { @@ -253,7 +253,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public CmdletProviderInvocationException(string message, Exception innerException) : base(message, innerException) @@ -329,7 +329,7 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the PipelineStoppedException class /// - /// constructed object + /// Constructed object. public PipelineStoppedException() : base(GetErrorText.PipelineStoppedException) { @@ -344,7 +344,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PipelineStoppedException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -357,7 +357,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the PipelineStoppedException class /// /// - /// constructed object + /// Constructed object. public PipelineStoppedException(string message) : base(message) { @@ -368,7 +368,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PipelineStoppedException(string message, Exception innerException) : base(message, innerException) @@ -392,7 +392,7 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the PipelineClosedException class /// - /// constructed object + /// Constructed object. public PipelineClosedException() : base() { @@ -402,7 +402,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the PipelineClosedException class /// /// - /// constructed object + /// Constructed object. public PipelineClosedException(string message) : base(message) { @@ -413,7 +413,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PipelineClosedException(string message, Exception innerException) : base(message, innerException) @@ -429,7 +429,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PipelineClosedException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -455,7 +455,7 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the ActionPreferenceStopException class /// - /// constructed object + /// Constructed object. public ActionPreferenceStopException() : this(GetErrorText.ActionPreferenceStop) { @@ -467,7 +467,7 @@ namespace System.Management.Automation /// /// Non-terminating error which triggered the Stop /// - /// constructed object + /// Constructed object. internal ActionPreferenceStopException(ErrorRecord error) : this(RetrieveMessage(error)) { @@ -484,7 +484,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. internal ActionPreferenceStopException(InvocationInfo invocationInfo, string message) : this(message) { @@ -515,7 +515,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected ActionPreferenceStopException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -564,7 +564,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the ActionPreferenceStopException class /// /// - /// constructed object + /// Constructed object. public ActionPreferenceStopException(string message) : base(message) { @@ -584,7 +584,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public ActionPreferenceStopException(string message, Exception innerException) : base(message, innerException) @@ -640,7 +640,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the ParentContainsErrorRecordException class. /// Note that this sets the Message and not the InnerException. /// - /// constructed object + /// Constructed object. /// /// I leave this non-standard constructor form public. /// @@ -659,7 +659,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the ParentContainsErrorRecordException class /// /// - /// constructed object + /// Constructed object. public ParentContainsErrorRecordException(string message) { _message = message; @@ -668,7 +668,7 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the ParentContainsErrorRecordException class /// - /// constructed object + /// Constructed object. public ParentContainsErrorRecordException() : base() { @@ -679,7 +679,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public ParentContainsErrorRecordException(string message, Exception innerException) : base(message, innerException) @@ -696,7 +696,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// doesn't return + /// Doesn't return. /// always protected ParentContainsErrorRecordException( SerializationInfo info, StreamingContext context) @@ -757,7 +757,7 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the RedirectedException class /// - /// constructed object + /// Constructed object. public RedirectedException() : base() { @@ -769,7 +769,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the RedirectedException class /// /// - /// constructed object + /// Constructed object. public RedirectedException(string message) : base(message) { @@ -782,7 +782,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public RedirectedException(string message, Exception innerException) : base(message, innerException) @@ -798,7 +798,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected RedirectedException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -829,7 +829,7 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the ScriptCallDepthException class /// - /// constructed object + /// Constructed object. public ScriptCallDepthException() : base(GetErrorText.ScriptCallDepthException) { @@ -839,7 +839,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the ScriptCallDepthException class /// /// - /// constructed object + /// Constructed object. public ScriptCallDepthException(string message) : base(message) { @@ -850,7 +850,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public ScriptCallDepthException(string message, Exception innerException) : base(message, innerException) @@ -866,7 +866,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected ScriptCallDepthException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -938,7 +938,7 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the PipelineDepthException class /// - /// constructed object + /// Constructed object. public PipelineDepthException() : base(GetErrorText.PipelineDepthException) { @@ -948,7 +948,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the PipelineDepthException class /// /// - /// constructed object + /// Constructed object. public PipelineDepthException(string message) : base(message) { @@ -959,7 +959,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PipelineDepthException(string message, Exception innerException) : base(message, innerException) @@ -975,7 +975,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PipelineDepthException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -1055,7 +1055,7 @@ namespace System.Management.Automation /// /// Instantiates a new instance of the HaltCommandException class /// - /// constructed object + /// Constructed object. public HaltCommandException() : base(StringUtil.Format(AutomationExceptions.HaltCommandException)) { @@ -1065,7 +1065,7 @@ namespace System.Management.Automation /// Instantiates a new instance of the HaltCommandException class /// /// - /// constructed object + /// Constructed object. public HaltCommandException(string message) : base(message) { @@ -1076,7 +1076,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public HaltCommandException(string message, Exception innerException) : base(message, innerException) @@ -1092,7 +1092,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected HaltCommandException(SerializationInfo info, StreamingContext context) : base(info, context) diff --git a/src/System.Management.Automation/utils/ExtensionMethods.cs b/src/System.Management.Automation/utils/ExtensionMethods.cs index a8544af77..f633b24ba 100644 --- a/src/System.Management.Automation/utils/ExtensionMethods.cs +++ b/src/System.Management.Automation/utils/ExtensionMethods.cs @@ -79,7 +79,7 @@ namespace System.Management.Automation /// Check does the type have an instance default constructor with visibility that allows calling it from subclass. /// /// type - /// true when type has a default ctor. + /// True when type has a default ctor. internal static bool HasDefaultCtor(this Type type) { var ctor = type.GetConstructor(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic, null, Type.EmptyTypes, null); diff --git a/src/System.Management.Automation/utils/GraphicalHostReflectionWrapper.cs b/src/System.Management.Automation/utils/GraphicalHostReflectionWrapper.cs index e8bc19a18..49821d963 100644 --- a/src/System.Management.Automation/utils/GraphicalHostReflectionWrapper.cs +++ b/src/System.Management.Automation/utils/GraphicalHostReflectionWrapper.cs @@ -144,7 +144,7 @@ namespace System.Management.Automation.Internal /// Used to escape characters that are not friendly to WPF binding /// /// property name to be used in binding - /// string with escaped characters + /// String with escaped characters. internal static string EscapeBinding(string propertyName) { return propertyName.Replace("/", " ").Replace(".", " "); @@ -155,7 +155,7 @@ namespace System.Management.Automation.Internal /// /// name of the method to call /// arguments to call the method with - /// The method return value + /// The method return value. internal object CallMethod(string methodName, params object[] arguments) { Diagnostics.Assert(_graphicalHostHelperObject != null, "there should be a constructor in order to call an instance method"); @@ -169,7 +169,7 @@ namespace System.Management.Automation.Internal /// /// name of the method to call /// arguments to call the method with - /// The method return value + /// The method return value. internal object CallStaticMethod(string methodName, params object[] arguments) { MethodInfo method = _graphicalHostHelperType.GetMethod(methodName, BindingFlags.NonPublic | BindingFlags.Static); @@ -181,7 +181,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 - /// the value of an instance property with name + /// The value of an instance property with name internal object GetPropertyValue(string propertyName) { Diagnostics.Assert(_graphicalHostHelperObject != null, "there should be a constructor in order to get an instance property value"); @@ -194,7 +194,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 - /// the value of a static property with name + /// The value of a static property with name internal object GetStaticPropertyValue(string propertyName) { PropertyInfo property = _graphicalHostHelperType.GetProperty(propertyName, BindingFlags.NonPublic | BindingFlags.Static); @@ -206,7 +206,7 @@ namespace System.Management.Automation.Internal /// Returns true if the is being run remotely /// /// cmdlet we want to see if is running remotely - /// true if the is being run remotely + /// True if the is being run remotely. private static bool IsInputFromRemoting(PSCmdlet parentCmdlet) { Diagnostics.Assert(parentCmdlet.SessionState != null, "SessionState should always be available."); diff --git a/src/System.Management.Automation/utils/IObjectReader.cs b/src/System.Management.Automation/utils/IObjectReader.cs index 02616bda7..4646be9aa 100644 --- a/src/System.Management.Automation/utils/IObjectReader.cs +++ b/src/System.Management.Automation/utils/IObjectReader.cs @@ -97,7 +97,7 @@ namespace System.Management.Automation.Runspaces /// Read at most objects /// /// The maximum number of objects to read - /// The objects read + /// The objects read. /// /// This method blocks if the number of objects in the stream is less than /// and the stream is not closed. @@ -107,7 +107,7 @@ namespace System.Management.Automation.Runspaces /// /// Read a single object from the stream /// - /// the next object in the stream + /// The next object in the stream. /// This method blocks if the stream is empty public abstract T Read(); diff --git a/src/System.Management.Automation/utils/IObjectWriter.cs b/src/System.Management.Automation/utils/IObjectWriter.cs index 9f0770778..cde26beff 100644 --- a/src/System.Management.Automation/utils/IObjectWriter.cs +++ b/src/System.Management.Automation/utils/IObjectWriter.cs @@ -109,7 +109,7 @@ namespace System.Management.Automation.Runspaces /// written separately. Otherwise, /// will be written as a single object. /// - /// The number of objects written + /// The number of objects written. /// /// The underlying stream is already closed /// diff --git a/src/System.Management.Automation/utils/MshArgumentException.cs b/src/System.Management.Automation/utils/MshArgumentException.cs index bcc93d0c5..3fd1deb34 100644 --- a/src/System.Management.Automation/utils/MshArgumentException.cs +++ b/src/System.Management.Automation/utils/MshArgumentException.cs @@ -25,7 +25,7 @@ namespace System.Management.Automation /// /// Initializes a new instance of the PSArgumentException class. /// - /// constructed object + /// Constructed object. public PSArgumentException() : base() { @@ -35,7 +35,7 @@ namespace System.Management.Automation /// Initializes a new instance of the PSArgumentException class. /// /// - /// constructed object + /// Constructed object. /// /// Per MSDN, the parameter is message. /// I confirm this experimentally as well. @@ -50,7 +50,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. /// /// Note the unusual order of the construction parameters. /// ArgumentException has this ctor form and we imitate it here. @@ -69,7 +69,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PSArgumentException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -102,7 +102,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PSArgumentException(string message, Exception innerException) : base(message, innerException) diff --git a/src/System.Management.Automation/utils/MshArgumentNullException.cs b/src/System.Management.Automation/utils/MshArgumentNullException.cs index d89c2343b..139f7a483 100644 --- a/src/System.Management.Automation/utils/MshArgumentNullException.cs +++ b/src/System.Management.Automation/utils/MshArgumentNullException.cs @@ -25,7 +25,7 @@ namespace System.Management.Automation /// /// Initializes a new instance of the PSArgumentNullException class. /// - /// constructed object + /// Constructed object. public PSArgumentNullException() : base() { @@ -35,7 +35,7 @@ namespace System.Management.Automation /// Initializes a new instance of the PSArgumentNullException class. /// /// - /// constructed object + /// Constructed object. /// /// Per MSDN, the parameter is paramName and not message. /// I confirm this experimentally as well. @@ -50,7 +50,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PSArgumentNullException(string message, Exception innerException) : base(message, innerException) { @@ -62,7 +62,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. /// /// ArgumentNullException has this ctor form and we imitate it here. /// @@ -80,7 +80,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PSArgumentNullException(SerializationInfo info, StreamingContext context) : base(info, context) diff --git a/src/System.Management.Automation/utils/MshArgumentOutOfRangeException.cs b/src/System.Management.Automation/utils/MshArgumentOutOfRangeException.cs index cdbaf366a..b2f9fbf6b 100644 --- a/src/System.Management.Automation/utils/MshArgumentOutOfRangeException.cs +++ b/src/System.Management.Automation/utils/MshArgumentOutOfRangeException.cs @@ -25,7 +25,7 @@ namespace System.Management.Automation /// /// Constructor for class PSArgumentOutOfRangeException /// - /// constructed object + /// Constructed object. public PSArgumentOutOfRangeException() : base() { @@ -35,7 +35,7 @@ namespace System.Management.Automation /// Initializes a new instance of the PSArgumentOutOfRangeException class. /// /// - /// constructed object + /// Constructed object. /// /// Per MSDN, the parameter is paramName and not message. /// I confirm this experimentally as well. @@ -51,7 +51,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. /// /// ArgumentOutOfRangeException has this ctor form and we imitate it here. /// @@ -68,7 +68,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PSArgumentOutOfRangeException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -99,7 +99,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PSArgumentOutOfRangeException(string message, Exception innerException) : base(message, innerException) diff --git a/src/System.Management.Automation/utils/MshInvalidOperationException.cs b/src/System.Management.Automation/utils/MshInvalidOperationException.cs index 1e036f4c6..6c130afbd 100644 --- a/src/System.Management.Automation/utils/MshInvalidOperationException.cs +++ b/src/System.Management.Automation/utils/MshInvalidOperationException.cs @@ -25,7 +25,7 @@ namespace System.Management.Automation /// /// Initializes a new instance of the PSInvalidOperationException class. /// - /// constructed object + /// Constructed object. public PSInvalidOperationException() : base() { @@ -39,7 +39,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PSInvalidOperationException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -69,7 +69,7 @@ namespace System.Management.Automation /// Initializes a new instance of the PSInvalidOperationException class. /// /// - /// constructed object + /// Constructed object. public PSInvalidOperationException(string message) : base(message) { @@ -80,7 +80,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PSInvalidOperationException(string message, Exception innerException) : base(message, innerException) @@ -95,7 +95,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. internal PSInvalidOperationException(string message, Exception innerException, string errorId, ErrorCategory errorCategory, object target) : base(message, innerException) { diff --git a/src/System.Management.Automation/utils/MshNotImplementedException.cs b/src/System.Management.Automation/utils/MshNotImplementedException.cs index b707784cc..5d5a9bff9 100644 --- a/src/System.Management.Automation/utils/MshNotImplementedException.cs +++ b/src/System.Management.Automation/utils/MshNotImplementedException.cs @@ -25,7 +25,7 @@ namespace System.Management.Automation /// /// Initializes a new instance of the PSNotImplementedException class. /// - /// constructed object + /// Constructed object. public PSNotImplementedException() : base() { @@ -39,7 +39,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PSNotImplementedException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -69,7 +69,7 @@ namespace System.Management.Automation /// Initializes a new instance of the PSNotImplementedException class. /// /// - /// constructed object + /// Constructed object. public PSNotImplementedException(string message) : base(message) { @@ -80,7 +80,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PSNotImplementedException(string message, Exception innerException) : base(message, innerException) diff --git a/src/System.Management.Automation/utils/MshNotSupportedException.cs b/src/System.Management.Automation/utils/MshNotSupportedException.cs index 07d2f0dc1..b7138820b 100644 --- a/src/System.Management.Automation/utils/MshNotSupportedException.cs +++ b/src/System.Management.Automation/utils/MshNotSupportedException.cs @@ -25,7 +25,7 @@ namespace System.Management.Automation /// /// Initializes a new instance of the PSNotSupportedException class. /// - /// constructed object + /// Constructed object. public PSNotSupportedException() : base() { @@ -39,7 +39,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PSNotSupportedException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -69,7 +69,7 @@ namespace System.Management.Automation /// Initializes a new instance of the PSNotSupportedException class. /// /// - /// constructed object + /// Constructed object. public PSNotSupportedException(string message) : base(message) { @@ -80,7 +80,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PSNotSupportedException(string message, Exception innerException) : base(message, innerException) diff --git a/src/System.Management.Automation/utils/MshObjectDisposedException.cs b/src/System.Management.Automation/utils/MshObjectDisposedException.cs index 56820a909..26dc182cb 100644 --- a/src/System.Management.Automation/utils/MshObjectDisposedException.cs +++ b/src/System.Management.Automation/utils/MshObjectDisposedException.cs @@ -26,7 +26,7 @@ namespace System.Management.Automation /// Initializes a new instance of the PSObjectDisposedException class. /// /// - /// constructed object + /// Constructed object. /// /// Per MSDN, the parameter is objectName and not message. /// I confirm this experimentally as well. @@ -42,7 +42,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PSObjectDisposedException(string objectName, string message) : base(objectName, message) { @@ -53,7 +53,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public PSObjectDisposedException(string message, Exception innerException) : base(message, innerException) { @@ -67,7 +67,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected PSObjectDisposedException(SerializationInfo info, StreamingContext context) : base(info, context) diff --git a/src/System.Management.Automation/utils/MshTraceSource.cs b/src/System.Management.Automation/utils/MshTraceSource.cs index f973bfec4..e3b8d80c5 100644 --- a/src/System.Management.Automation/utils/MshTraceSource.cs +++ b/src/System.Management.Automation/utils/MshTraceSource.cs @@ -225,7 +225,7 @@ namespace System.Management.Automation /// /// The name of the parameter whose argument value was null /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSArgumentNullException NewArgumentNullException(string paramName) { if (String.IsNullOrEmpty(paramName)) @@ -253,7 +253,7 @@ namespace System.Management.Automation /// /// Objects corresponding to {0}, {1}, etc. in the resource string /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSArgumentNullException NewArgumentNullException( string paramName, string resourceString, params object[] args) { @@ -284,7 +284,7 @@ namespace System.Management.Automation /// /// The name of the parameter whose argument value was invalid /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSArgumentException NewArgumentException(string paramName) { if (String.IsNullOrEmpty(paramName)) @@ -313,7 +313,7 @@ namespace System.Management.Automation /// /// Objects corresponding to {0}, {1}, etc. in the resource string /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSArgumentException NewArgumentException( string paramName, string resourceString, params object[] args) { @@ -339,7 +339,7 @@ namespace System.Management.Automation /// Traces the Message and StackTrace properties of the exception /// and returns the new exception /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSInvalidOperationException NewInvalidOperationException() { string message = StringUtil.Format(AutomationExceptions.InvalidOperation, @@ -360,7 +360,7 @@ namespace System.Management.Automation /// /// Objects corresponding to {0}, {1}, etc. in the resource string /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSInvalidOperationException NewInvalidOperationException( string resourceString, params object[] args) { @@ -389,7 +389,7 @@ namespace System.Management.Automation /// /// Objects corresponding to {0}, {1}, etc. in the resource string /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSInvalidOperationException NewInvalidOperationException( Exception innerException, string resourceString, params object[] args) @@ -410,7 +410,7 @@ namespace System.Management.Automation /// and returns the new exception. This is not allowed to call other /// Throw*Exception variants, since they call this. /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSNotSupportedException NewNotSupportedException() { string message = StringUtil.Format(AutomationExceptions.NotSupported, @@ -431,7 +431,7 @@ namespace System.Management.Automation /// /// Objects corresponding to {0}, {1}, etc. in the resource string /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSNotSupportedException NewNotSupportedException( string resourceString, params object[] args) @@ -452,7 +452,7 @@ namespace System.Management.Automation /// and returns the new exception. This is not allowed to call other /// Throw*Exception variants, since they call this. /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSNotImplementedException NewNotImplementedException() { string message = StringUtil.Format(AutomationExceptions.NotImplemented, @@ -474,7 +474,7 @@ namespace System.Management.Automation /// /// The value of the argument causing the exception /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSArgumentOutOfRangeException NewArgumentOutOfRangeException(string paramName, object actualValue) { if (String.IsNullOrEmpty(paramName)) @@ -505,7 +505,7 @@ namespace System.Management.Automation /// /// Objects corresponding to {0}, {1}, etc. in the resource string /// - /// Exception instance ready to throw + /// Exception instance ready to throw. internal static PSArgumentOutOfRangeException NewArgumentOutOfRangeException( string paramName, object actualValue, string resourceString, params object[] args) { @@ -534,7 +534,7 @@ namespace System.Management.Automation /// /// The name of the disposed object /// - /// Exception instance ready to throw + /// Exception instance ready to throw. /// /// Note that the parameter is the object name and not the message. /// diff --git a/src/System.Management.Automation/utils/ObjectReader.cs b/src/System.Management.Automation/utils/ObjectReader.cs index 747791d7f..ab13cb490 100644 --- a/src/System.Management.Automation/utils/ObjectReader.cs +++ b/src/System.Management.Automation/utils/ObjectReader.cs @@ -251,7 +251,7 @@ namespace System.Management.Automation.Internal /// Read at most objects /// /// The maximum number of objects to read - /// The objects read + /// The objects read. /// /// This method blocks if the number of objects in the stream is less than /// and the stream is not closed. @@ -264,7 +264,7 @@ namespace System.Management.Automation.Internal /// /// Read a single object from the stream /// - /// the next object in the stream + /// The next object in the stream. /// This method blocks if the stream is empty public override object Read() { @@ -319,7 +319,7 @@ namespace System.Management.Automation.Internal /// /// Peek the next object /// - /// The next object in the stream or ObjectStream.EmptyObject if the stream is empty + /// The next object in the stream or ObjectStream.EmptyObject if the stream is empty. public override object Peek() { return _stream.Peek(); @@ -361,7 +361,7 @@ namespace System.Management.Automation.Internal /// Read at most objects /// /// The maximum number of objects to read - /// The objects read + /// The objects read. /// /// This method blocks if the number of objects in the stream is less than /// and the stream is not closed. @@ -374,7 +374,7 @@ namespace System.Management.Automation.Internal /// /// Read a single PSObject from the stream /// - /// the next PSObject in the stream + /// The next PSObject in the stream. /// This method blocks if the stream is empty public override PSObject Read() { @@ -429,7 +429,7 @@ namespace System.Management.Automation.Internal /// /// Peek the next PSObject /// - /// The next PSObject in the stream or ObjectStream.EmptyObject if the stream is empty + /// The next PSObject in the stream or ObjectStream.EmptyObject if the stream is empty. public override PSObject Peek() { return MakePSObject(_stream.Peek()); @@ -514,7 +514,7 @@ namespace System.Management.Automation.Internal /// This method is not supported. /// /// The maximum number of objects to read - /// The objects read + /// The objects read. public override Collection Read(int count) { throw new NotSupportedException(); @@ -689,7 +689,7 @@ namespace System.Management.Automation.Internal /// This method is not supported. /// /// The maximum number of objects to read - /// The objects read + /// The objects read. public override Collection Read(int count) { throw new NotSupportedException(); @@ -794,7 +794,7 @@ namespace System.Management.Automation.Internal /// Converts to the return type based on language primitives /// /// input object to convert - /// input object converted to the specified return type + /// Input object converted to the specified return type. private ReturnType ConvertToReturnType(object inputObject) { Type resultType = typeof(ReturnType); diff --git a/src/System.Management.Automation/utils/ObjectStream.cs b/src/System.Management.Automation/utils/ObjectStream.cs index 3188c0128..6981f3741 100644 --- a/src/System.Management.Automation/utils/ObjectStream.cs +++ b/src/System.Management.Automation/utils/ObjectStream.cs @@ -115,7 +115,7 @@ namespace System.Management.Automation.Internal /// /// Check if the stream is open for further writes. /// - /// true if the stream is open, false if not. + /// True if the stream is open, false if not. /// /// IsOpen returns true until the first call to Close(). Writers should /// check IsOpen to determine if a write operation can be made. Note that @@ -152,7 +152,7 @@ namespace System.Management.Automation.Internal /// /// Read a single object from the stream /// - /// The next object in the stream or AutomationNull if EndOfPipeline is reached + /// The next object in the stream or AutomationNull if EndOfPipeline is reached. /// This method blocks if the stream is empty internal virtual object Read() { @@ -163,7 +163,7 @@ namespace System.Management.Automation.Internal /// Read at most objects /// /// The maximum number of objects to read - /// The objects read + /// The objects read. /// /// is less than 0 /// @@ -281,7 +281,7 @@ namespace System.Management.Automation.Internal /// written separately. Otherwise, /// will be written as a single object. /// - /// The number of objects written + /// The number of objects written. /// /// The underlying stream is closed /// @@ -765,7 +765,7 @@ namespace System.Management.Automation.Internal /// /// Check if the stream is open for further writes. /// - /// true if the stream is open, false if not. + /// True if the stream is open, false if not. /// /// IsOpen returns true until the first call to Close(). Writers should /// check IsOpen to determine if a write operation can be made. Note that @@ -814,7 +814,7 @@ namespace System.Management.Automation.Internal /// /// Wait for data to be readable /// - /// true if EndOfPipeline is not reached. + /// True if EndOfPipeline is not reached. /// /// WaitRead does not guarantee that data is present in the stream, /// only that data was added when the event was signaled. Since there may be @@ -1081,7 +1081,7 @@ namespace System.Management.Automation.Internal /// /// Read a single object from the stream /// - /// The next object in the stream or AutomationNull if EndOfPipeline is reached + /// The next object in the stream or AutomationNull if EndOfPipeline is reached. /// This method blocks if the stream is empty internal override object Read() { @@ -1100,7 +1100,7 @@ namespace System.Management.Automation.Internal /// Read at most objects /// /// The maximum number of objects to read - /// The objects read + /// The objects read. /// /// is less than 0 /// @@ -1311,7 +1311,7 @@ namespace System.Management.Automation.Internal /// written separately. Otherwise, /// will be written as a single object. /// - /// The number of objects written + /// The number of objects written. /// /// The underlying stream is closed /// @@ -1648,7 +1648,7 @@ namespace System.Management.Automation.Internal /// /// Check if the stream is open for further writes. /// - /// true if the stream is open, false if not. + /// True if the stream is open, false if not. /// /// IsOpen returns true until the first call to Close(). Writers should /// check IsOpen to determine if a write operation can be made. diff --git a/src/System.Management.Automation/utils/ObjectWriter.cs b/src/System.Management.Automation/utils/ObjectWriter.cs index 1ed4087be..e41acbf6f 100644 --- a/src/System.Management.Automation/utils/ObjectWriter.cs +++ b/src/System.Management.Automation/utils/ObjectWriter.cs @@ -158,7 +158,7 @@ namespace System.Management.Automation.Internal /// written separately. Otherwise, /// will be written as a single object. /// - /// The number of objects written + /// The number of objects written. /// /// The underlying stream is closed /// diff --git a/src/System.Management.Automation/utils/ParserException.cs b/src/System.Management.Automation/utils/ParserException.cs index a92077189..34706da06 100644 --- a/src/System.Management.Automation/utils/ParserException.cs +++ b/src/System.Management.Automation/utils/ParserException.cs @@ -32,7 +32,7 @@ namespace System.Management.Automation /// /// The serialization information to use when initializing this object /// The streaming context to use when initializing this object - /// constructed object + /// Constructed object. protected ParseException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -61,7 +61,7 @@ namespace System.Management.Automation /// /// Initializes a new instance of the class ParseException /// - /// constructed object + /// Constructed object. public ParseException() : base() { base.SetErrorId(errorIdString); @@ -72,7 +72,7 @@ namespace System.Management.Automation /// Initializes a new instance of the ParseException class and defines the error message. /// /// The error message to use when initializing this object - /// constructed object + /// Constructed object. public ParseException(string message) : base(message) { base.SetErrorId(errorIdString); @@ -85,7 +85,7 @@ namespace System.Management.Automation /// /// The error message to use when initializing this object /// The errorId to use when initializing this object - /// constructed object + /// Constructed object. internal ParseException(string message, string errorId) : base(message) { base.SetErrorId(errorId); @@ -99,7 +99,7 @@ namespace System.Management.Automation /// The error message to use when initializing this object /// The errorId to use when initializing this object /// The inner exception to use when initializing this object - /// constructed object + /// Constructed object. internal ParseException(string message, string errorId, Exception innerException) : base(message, innerException) { @@ -113,7 +113,7 @@ namespace System.Management.Automation /// /// The error message to use when initializing this object /// The inner exception to use when initializing this object - /// constructed object + /// Constructed object. public ParseException(string message, Exception innerException) : base(message, innerException) @@ -193,7 +193,7 @@ namespace System.Management.Automation /// /// The serialization information to use when initializing this object /// The streaming context to use when initializing this object - /// constructed object + /// Constructed object. protected IncompleteParseException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -204,7 +204,7 @@ namespace System.Management.Automation /// /// Initializes a new instance of the class IncompleteParseException /// - /// constructed object + /// Constructed object. public IncompleteParseException() : base() { // Error category is set in base constructor @@ -215,7 +215,7 @@ namespace System.Management.Automation /// Initializes a new instance of the IncompleteParseException class and defines the error message. /// /// The error message to use when initializing this object - /// constructed object + /// Constructed object. public IncompleteParseException(string message) : base(message) { // Error category is set in base constructor @@ -228,7 +228,7 @@ namespace System.Management.Automation /// /// The error message to use when initializing this object /// The errorId to use when initializing this object - /// constructed object + /// Constructed object. internal IncompleteParseException(string message, string errorId) : base(message, errorId) { // Error category is set in base constructor @@ -241,7 +241,7 @@ namespace System.Management.Automation /// The error message to use when initializing this object /// The errorId to use when initializing this object /// The inner exception to use when initializing this object - /// constructed object + /// Constructed object. internal IncompleteParseException(string message, string errorId, Exception innerException) : base(message, errorId, innerException) { @@ -254,7 +254,7 @@ namespace System.Management.Automation /// /// The error message to use when initializing this object /// The inner exception to use when initializing this object - /// constructed object + /// Constructed object. public IncompleteParseException(string message, Exception innerException) : base(message, innerException) diff --git a/src/System.Management.Automation/utils/PlatformInvokes.cs b/src/System.Management.Automation/utils/PlatformInvokes.cs index a00bc6383..12ac6fee3 100644 --- a/src/System.Management.Automation/utils/PlatformInvokes.cs +++ b/src/System.Management.Automation/utils/PlatformInvokes.cs @@ -801,4 +801,4 @@ namespace System.Management.Automation #endregion } -} \ No newline at end of file +} diff --git a/src/System.Management.Automation/utils/PsUtils.cs b/src/System.Management.Automation/utils/PsUtils.cs index 70442ae78..0ce9c52f5 100644 --- a/src/System.Management.Automation/utils/PsUtils.cs +++ b/src/System.Management.Automation/utils/PsUtils.cs @@ -137,7 +137,7 @@ namespace System.Management.Automation /// Returns processor architecture for the current process. /// If powershell is running inside Wow64, then is returned. /// - /// processor architecture for the current process + /// Processor architecture for the current process. internal static ProcessorArchitecture GetProcessorArchitecture(out bool isRunningOnArm) { var sysInfo = new NativeMethods.SYSTEM_INFO(); @@ -283,7 +283,7 @@ namespace System.Management.Automation /// is used to generate the key. /// /// A using expression - /// Base64 encoded string as the key of the UsingExpressionAst + /// Base64 encoded string as the key of the UsingExpressionAst. internal static string GetUsingExpressionKey(Language.UsingExpressionAst usingAst) { Diagnostics.Assert(usingAst != null, "Caller makes sure the parameter is not null"); @@ -479,7 +479,7 @@ namespace System.Management.Automation internal static readonly string[] ManifestGuidPropertyName = new[] { "GUID" }; internal static readonly string[] ManifestPrivateDataPropertyName = new[] { "PrivateData" }; internal static readonly string[] FastModuleManifestAnalysisPropertyNames = new[] - { + { "AliasesToExport", "CmdletsToExport", "CompatiblePSEditions", @@ -553,7 +553,7 @@ namespace System.Management.Automation /// Converts string to base64 encoded string /// /// string to encode - /// base64 encoded string + /// Base64 encoded string. internal static string StringToBase64String(string input) { // NTRAID#Windows Out Of Band Releases-926471-2005/12/27-JonN @@ -574,7 +574,7 @@ namespace System.Management.Automation /// Decodes base64 encoded string /// /// base64 string to decode - /// decoded string + /// Decoded string. internal static string Base64ToString(string base64) { if (string.IsNullOrEmpty(base64)) diff --git a/src/System.Management.Automation/utils/ResourceManagerCache.cs b/src/System.Management.Automation/utils/ResourceManagerCache.cs index f52dedad7..6265ddfde 100644 --- a/src/System.Management.Automation/utils/ResourceManagerCache.cs +++ b/src/System.Management.Automation/utils/ResourceManagerCache.cs @@ -218,7 +218,7 @@ namespace System.Management.Automation /// /// The main Assembly for the resources /// - /// Resource Manager instance + /// Resource Manager instance. /// /// Thrown if the resource manager instance could not be created /// diff --git a/src/System.Management.Automation/utils/RuntimeException.cs b/src/System.Management.Automation/utils/RuntimeException.cs index bc54603f4..172e8dbf5 100644 --- a/src/System.Management.Automation/utils/RuntimeException.cs +++ b/src/System.Management.Automation/utils/RuntimeException.cs @@ -27,7 +27,7 @@ namespace System.Management.Automation /// /// Initializes a new instance of the RuntimeException class. /// - /// constructed object + /// Constructed object. public RuntimeException() : base() { @@ -41,7 +41,7 @@ namespace System.Management.Automation /// /// serialization information /// streaming context - /// constructed object + /// Constructed object. protected RuntimeException(SerializationInfo info, StreamingContext context) : base(info, context) @@ -73,7 +73,7 @@ namespace System.Management.Automation /// Initializes a new instance of the RuntimeException class. /// /// - /// constructed object + /// Constructed object. public RuntimeException(string message) : base(message) { @@ -84,7 +84,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public RuntimeException(string message, Exception innerException) : base(message, innerException) @@ -98,7 +98,7 @@ namespace System.Management.Automation /// /// /// - /// constructed object + /// Constructed object. public RuntimeException(string message, Exception innerException, ErrorRecord errorRecord) diff --git a/src/System.Management.Automation/utils/tracing/EtwActivity.cs b/src/System.Management.Automation/utils/tracing/EtwActivity.cs index 28491fd2b..c1b6f750e 100644 --- a/src/System.Management.Automation/utils/tracing/EtwActivity.cs +++ b/src/System.Management.Automation/utils/tracing/EtwActivity.cs @@ -281,8 +281,8 @@ namespace System.Management.Automation.Tracing /// nothing. /// /// - /// true when provided activity was set, false if current activity - /// was found to be same and set was not needed + /// True when provided activity was set, false if current activity + /// was found to be same and set was not needed. public static bool SetActivityId(Guid activityId) { if (GetActivityId() != activityId) @@ -359,7 +359,7 @@ namespace System.Management.Automation.Tracing /// /// Levels to check /// Keywords to check - /// True, if any ETW listener is enabled else false + /// True, if any ETW listener is enabled else false. public bool IsProviderEnabled(byte levels, long keywords) { return GetProvider().IsEnabled(levels, keywords); diff --git a/src/System.Management.Automation/utils/tracing/SysLogProvider.cs b/src/System.Management.Automation/utils/tracing/SysLogProvider.cs index c136aeac8..1fc9a582d 100755 --- a/src/System.Management.Automation/utils/tracing/SysLogProvider.cs +++ b/src/System.Management.Automation/utils/tracing/SysLogProvider.cs @@ -173,7 +173,7 @@ namespace System.Management.Automation.Tracing /// /// The PSLevel to check. /// The PSKeyword to check. - /// true if the specified level and keywords are enabled for logging. + /// True if the specified level and keywords are enabled for logging. internal bool IsEnabled(PSLevel level, PSKeyword keywords) { return ( ((ulong) keywords & _keywordFilter) != 0 &&