From 4cfc728e84591a0d3c7f3f8594599b8e5709bfde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 29 Aug 2023 11:37:57 -0700 Subject: [PATCH 1/6] System.CommandLine.Binding --- .../BindingContext.xml | 330 +++++++++--------- xml/System.CommandLine.Binding/BoundValue.xml | 298 ++++++++-------- 2 files changed, 314 insertions(+), 314 deletions(-) diff --git a/xml/System.CommandLine.Binding/BindingContext.xml b/xml/System.CommandLine.Binding/BindingContext.xml index 464b1f53804..428007c8e25 100644 --- a/xml/System.CommandLine.Binding/BindingContext.xml +++ b/xml/System.CommandLine.Binding/BindingContext.xml @@ -1,165 +1,165 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - System.IServiceProvider - - - - - Creates object instances based on command line parser results, injected services, and other value sources. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - The type for which this service factory will provide an instance. - A delegate that provides an instance of the specified service type. - - Adds the specified service factory to the binding context. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - The type for which this service factory will provide an instance. - A delegate that provides an instance of the specified service type. - - Adds the specified service factory to the binding context. - - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.IConsole - - - - The console to which output should be written during the current invocation. - - To be added. - To be added. - - - - - - - - - - Method - - M:System.IServiceProvider.GetService(System.Type) - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - - An object that specifies the type of service object to get. - Gets the service object of the specified type. - A service object of type . - - -or- - - if there is no service object of type . - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ParseResult - - - - The parse result for the current invocation. - - To be added. - To be added. - - - - + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + System.IServiceProvider + + + + + Creates object instances based on command line parser results, injected services, and other value sources. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Void + + + + + + + The type for which this service factory will provide an instance. + A delegate that provides an instance of the specified service type. + + Adds the specified service factory to the binding context. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Void + + + + + + + + + The type for which this service factory will provide an instance. + A delegate that provides an instance of the specified service type. + + Adds the specified service factory to the binding context. + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.IConsole + + + + The console to which output should be written during the current invocation. + + To be added. + To be added. + + + + + + + + + + Method + + M:System.IServiceProvider.GetService(System.Type) + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + + An object that specifies the type of service object to get. + Gets the service object of the specified type. + A service object of type . + + -or- + + if there is no service object of type . + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.ParseResult + + + + The parse result for the current invocation. + + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine.Binding/BoundValue.xml b/xml/System.CommandLine.Binding/BoundValue.xml index 593150268ff..0fc192cac09 100644 --- a/xml/System.CommandLine.Binding/BoundValue.xml +++ b/xml/System.CommandLine.Binding/BoundValue.xml @@ -1,149 +1,149 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.ValueType - - - - - [System.Runtime.CompilerServices.IsReadOnly] - [<System.Runtime.CompilerServices.IsReadOnly>] - - - - - A value created by binding command line input. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Binding.BoundValue - - - - - - A value descriptor for which to get the default value. - - Gets a representing the default value for a specified . - - A representing the default value for a specified . - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - The value bound from the specified source. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Binding.IValueDescriptor - - - - The descriptor for the bound value. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Binding.IValueSource - - - - The source from which the value was bound. - - To be added. - To be added. - - - - + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.ValueType + + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + + A value created by binding command line input. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Binding.BoundValue + + + + + + A value descriptor for which to get the default value. + + Gets a representing the default value for a specified . + + A representing the default value for a specified . + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.String + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + The value bound from the specified source. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Binding.IValueDescriptor + + + + The descriptor for the bound value. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Binding.IValueSource + + + + The source from which the value was bound. + + To be added. + To be added. + + + + From c1f413adb9d147353fb13217269e0d0b8a6f9852 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 29 Aug 2023 11:38:17 -0700 Subject: [PATCH 2/6] System.CommandLine.Help --- .../TwoColumnHelpRow.xml | 352 +++++++++--------- 1 file changed, 176 insertions(+), 176 deletions(-) diff --git a/xml/System.CommandLine.Help/TwoColumnHelpRow.xml b/xml/System.CommandLine.Help/TwoColumnHelpRow.xml index cfcc9f60da9..fcd38db9523 100644 --- a/xml/System.CommandLine.Help/TwoColumnHelpRow.xml +++ b/xml/System.CommandLine.Help/TwoColumnHelpRow.xml @@ -1,176 +1,176 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - System.IEquatable<System.CommandLine.Help.TwoColumnHelpRow> - - - - - Provides details about an item to be formatted to output in order to display two-column command line help. - - To be added. - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - The name and invocation details, typically displayed in the first help column. - The description of a symbol, typically displayed in the second help column. - To be added. - To be added. - - - - - - - - - - Method - - M:System.IEquatable`1.Equals(`0) - - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - An object to compare with this object. - Indicates whether the current object is equal to another object of the same type. - - if the current object is equal to the parameter; otherwise, . - To be added. - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - The first column for a help entry, typically containing the name and other usage details about an option or argument. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - The second column for a help entry, typically containing the name and other usage details about an option or argument. - - To be added. - To be added. - - - - + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + System.IEquatable<System.CommandLine.Help.TwoColumnHelpRow> + + + + + Provides details about an item to be formatted to output in order to display two-column command line help. + + To be added. + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + The name and invocation details, typically displayed in the first help column. + The description of a symbol, typically displayed in the second help column. + To be added. + To be added. + + + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + An object to compare with this object. + Indicates whether the current object is equal to another object of the same type. + + if the current object is equal to the parameter; otherwise, . + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The first column for a help entry, typically containing the name and other usage details about an option or argument. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The second column for a help entry, typically containing the name and other usage details about an option or argument. + + To be added. + To be added. + + + + From 0211df2abd4976c77162db19163754709f1561cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 29 Aug 2023 11:38:40 -0700 Subject: [PATCH 3/6] System.CommandLine.Completions --- .../CompletionItem.xml | 582 +++++++++--------- 1 file changed, 291 insertions(+), 291 deletions(-) diff --git a/xml/System.CommandLine.Completions/CompletionItem.xml b/xml/System.CommandLine.Completions/CompletionItem.xml index 37be2de043e..e2206853b03 100644 --- a/xml/System.CommandLine.Completions/CompletionItem.xml +++ b/xml/System.CommandLine.Completions/CompletionItem.xml @@ -1,291 +1,291 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides details about a command line completion item. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - - - - - The label value, which is the text displayed to users and, unless is set, is also used to populate the property. - The kind of completion item. - The value used to sort the completion item in a list. If this is not provided, then is used. - The text to be inserted by this completion item. If this is not provided, then is used. - Documentation about the completion item. - Additional details regarding the completion item. - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - Additional details regarding the completion item. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - Documentation about the completion item. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - - Determines whether two completion items are equal. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - The text to be inserted by this completion item. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - The kind of completion item. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - The label value, which is the text displayed to users. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - The value used to sort the completion item in a list. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - To be added. - To be added. - To be added. - - - - - + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + Provides details about a command line completion item. + + To be added. + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + + + + + The label value, which is the text displayed to users and, unless is set, is also used to populate the property. + The kind of completion item. + The value used to sort the completion item in a list. If this is not provided, then is used. + The text to be inserted by this completion item. If this is not provided, then is used. + Documentation about the completion item. + Additional details regarding the completion item. + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + Additional details regarding the completion item. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + Documentation about the completion item. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + + Determines whether two completion items are equal. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The text to be inserted by this completion item. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The kind of completion item. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The label value, which is the text displayed to users. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The value used to sort the completion item in a list. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.String + + + + To be added. + To be added. + To be added. + + + + + From d343408ec415f43af2c9d1972f9202f404505b5a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 29 Aug 2023 11:39:03 -0700 Subject: [PATCH 4/6] System.CommandLine.Parsing --- .../ArgumentResult.xml | 297 +++++++++--------- xml/System.CommandLine.Parsing/ParseError.xml | 186 +++++------ 2 files changed, 242 insertions(+), 241 deletions(-) diff --git a/xml/System.CommandLine.Parsing/ArgumentResult.xml b/xml/System.CommandLine.Parsing/ArgumentResult.xml index 1fec0409675..9faef4cfd88 100644 --- a/xml/System.CommandLine.Parsing/ArgumentResult.xml +++ b/xml/System.CommandLine.Parsing/ArgumentResult.xml @@ -1,148 +1,149 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.SymbolResult - - - - - A result produced when parsing an . - - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Argument - - - - The argument to which the result applies. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - To be added. - To be added. - To be added. - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - T - - - - - - - To be added. - - Gets the parsed value or the default value for . - - The parsed value or the default value for - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The number of tokens to take. The rest are passed on. - - Specifies the maximum number of tokens to consume for the argument. Remaining tokens are passed on and can be consumed by later arguments, or will otherwise be added to - To be added. - numberOfTokens - Value must be at least 1. - Thrown if this method is called more than once. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - To be added. - To be added. - To be added. - - - - - + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.SymbolResult + + + + + A result produced when parsing an . + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Argument + + + + The argument to which the result applies. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + T + + + + + + + To be added. + + Gets the parsed value or the default value for . + + The parsed value or the default value for + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Void + + + + + + The number of tokens to take. The rest are passed on. + + Specifies the maximum number of tokens to consume for the argument. Remaining tokens are passed on and can be consumed by later arguments, or will otherwise be added to + To be added. + numberOfTokens - Value must be at least 1. + Thrown if this method is called more than once. + Thrown if this method is called by Option-owned ArgumentResult. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.String + + + + To be added. + To be added. + To be added. + + + + + diff --git a/xml/System.CommandLine.Parsing/ParseError.xml b/xml/System.CommandLine.Parsing/ParseError.xml index 173941957d8..d4180dd9fb1 100644 --- a/xml/System.CommandLine.Parsing/ParseError.xml +++ b/xml/System.CommandLine.Parsing/ParseError.xml @@ -1,93 +1,93 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Describes an error that occurs while parsing command line input. - - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - A message to explain the error to a user. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.SymbolResult - - - - The symbol result detailing the symbol that failed to parse and the tokens involved. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - To be added. - To be added. - To be added. - - - - - + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + Describes an error that occurs while parsing command line input. + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + A message to explain the error to a user. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.SymbolResult + + + + The symbol result detailing the symbol that failed to parse and the tokens involved. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.String + + + + To be added. + To be added. + To be added. + + + + + From 5d20f5d3d1cf4eebd5f7ddec7e27fc5230d356c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 29 Aug 2023 11:39:21 -0700 Subject: [PATCH 5/6] System.CommandLine --- xml/System.CommandLine/ArgumentArity.xml | 612 +++++++++++------------ 1 file changed, 306 insertions(+), 306 deletions(-) diff --git a/xml/System.CommandLine/ArgumentArity.xml b/xml/System.CommandLine/ArgumentArity.xml index 18cbaf7296e..428e06804ad 100644 --- a/xml/System.CommandLine/ArgumentArity.xml +++ b/xml/System.CommandLine/ArgumentArity.xml @@ -1,306 +1,306 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.ValueType - - - - System.IEquatable<System.CommandLine.ArgumentArity> - - - - - [System.Diagnostics.DebuggerDisplay("\{{MinimumNumberOfValues},{MaximumNumberOfValues}\}")] - [<System.Diagnostics.DebuggerDisplay("\{{MinimumNumberOfValues},{MaximumNumberOfValues}\}")>] - - - [System.Runtime.CompilerServices.IsReadOnly] - [<System.Runtime.CompilerServices.IsReadOnly>] - - - - - Defines the arity of an option or argument. - - The arity refers to the number of values that can be passed on the command line. - - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - The minimum number of values required for the argument. - The maximum number of values allowed for the argument. - - Initializes a new instance of the ArgumentArity class. - - To be added. - Thrown when is negative. - Thrown when the maximum number is less than the minimum number or the maximum number is greater than MaximumArity. - - - - - - - - - - Method - - M:System.IEquatable`1.Equals(`0) - - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - An object to compare with this object. - Indicates whether the current object is equal to another object of the same type. - - if the current object is equal to the parameter; otherwise, . - To be added. - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.ArgumentArity - - - - An arity that must have exactly one value. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - Gets the maximum number of values allowed for an argument. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - Gets the minimum number of values required for an argument. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.ArgumentArity - - - - An arity that must have at least one value. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.ArgumentArity - - - - An arity that does not allow any values. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.ArgumentArity - - - - An arity that may have multiple values. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.ArgumentArity - - - - An arity that may have one value, but no more than one. - - To be added. - To be added. - - - - + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.ValueType + + + + System.IEquatable<System.CommandLine.ArgumentArity> + + + + + [System.Diagnostics.DebuggerDisplay("\{{MinimumNumberOfValues},{MaximumNumberOfValues}\}")] + [<System.Diagnostics.DebuggerDisplay("\{{MinimumNumberOfValues},{MaximumNumberOfValues}\}")>] + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + + Defines the arity of an option or argument. + + The arity refers to the number of values that can be passed on the command line. + + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + The minimum number of values required for the argument. + The maximum number of values allowed for the argument. + + Initializes a new instance of the ArgumentArity class. + + To be added. + Thrown when is negative. + Thrown when the maximum number is less than the minimum number or the maximum number is greater than MaximumArity. + + + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + An object to compare with this object. + Indicates whether the current object is equal to another object of the same type. + + if the current object is equal to the parameter; otherwise, . + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + An arity that must have exactly one value. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + Gets the maximum number of values allowed for an argument. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + Gets the minimum number of values required for an argument. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + An arity that must have at least one value. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + An arity that does not allow any values. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + An arity that may have multiple values. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + An arity that may have one value, but no more than one. + + To be added. + To be added. + + + + From d62fdca25840dba60f77291ffb0eb3e899c6262b Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Tue, 29 Aug 2023 12:43:48 -0700 Subject: [PATCH 6/6] Update ArgumentResult.xml --- xml/System.CommandLine.Parsing/ArgumentResult.xml | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/xml/System.CommandLine.Parsing/ArgumentResult.xml b/xml/System.CommandLine.Parsing/ArgumentResult.xml index 9faef4cfd88..563741dc6a6 100644 --- a/xml/System.CommandLine.Parsing/ArgumentResult.xml +++ b/xml/System.CommandLine.Parsing/ArgumentResult.xml @@ -15,7 +15,7 @@ - A result produced when parsing an . + Represents the result produced when parsing an . To be added. @@ -36,9 +36,7 @@ System.CommandLine.Argument - - The argument to which the result applies. - + Gets the argument to which the result applies. To be added. To be added. @@ -115,11 +113,12 @@ The number of tokens to take. The rest are passed on. - Specifies the maximum number of tokens to consume for the argument. Remaining tokens are passed on and can be consumed by later arguments, or will otherwise be added to + Specifies the maximum number of tokens to consume for the argument. Remaining tokens are passed on and can be consumed by later arguments, or will otherwise be added to . To be added. - numberOfTokens - Value must be at least 1. - Thrown if this method is called more than once. - Thrown if this method is called by Option-owned ArgumentResult. + + is less than 1. + This method was called more than once. + This method was called by Option-owned ArgumentResult.