diff --git a/xml/FrameworksIndex/system-commandline.xml b/xml/FrameworksIndex/system-commandline.xml deleted file mode 100644 index e6a6f6640ff..00000000000 --- a/xml/FrameworksIndex/system-commandline.xml +++ /dev/null @@ -1,568 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/xml/System.CommandLine.Binding/BinderBase`1.xml b/xml/System.CommandLine.Binding/BinderBase`1.xml deleted file mode 100644 index 63dfd628e05..00000000000 --- a/xml/System.CommandLine.Binding/BinderBase`1.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - - - - System.Object - - - - System.CommandLine.Binding.IValueDescriptor - - - System.CommandLine.Binding.IValueDescriptor<T> - - - System.CommandLine.Binding.IValueSource - - - - The type to be bound. - - Supports binding of custom types. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - T - - - - - - - - Gets a value from the binding context. - - - To be added. - - - - - - - - - - Method - - M:System.CommandLine.Binding.IValueDescriptor.GetDefaultValue - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - Gets the default value, if any. - An object representing the default value. - To be added. - - - - - - - - - - Property - - P:System.CommandLine.Binding.IValueDescriptor.HasDefaultValue - - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - Gets a value that specifies whether there is a default value. - To be added. - To be added. - - - - - - - - - - Property - - P:System.CommandLine.Binding.IValueDescriptor.ValueName - - - System.CommandLine - 2.0.0.0 - - - System.String - - - Gets the name of the value. - To be added. - To be added. - - - - - - - - - - Property - - P:System.CommandLine.Binding.IValueDescriptor.ValueType - - - System.CommandLine - 2.0.0.0 - - - System.Type - - - Gets the type of the value. - To be added. - To be added. - - - - - - - - - - Method - - M:System.CommandLine.Binding.IValueSource.TryGetValue(System.CommandLine.Binding.IValueDescriptor,System.CommandLine.Binding.BindingContext,System.Object@) - - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - - - The descriptor for the value to be bound. - The binding context from which to bind the value. - When this method returns, contains the bound value. - Tries to get a value from a binding context. The return value indicates whether a value matching the specified value descriptor was present. - - if a matching value was found; otherwise, . - To be added. - - - - diff --git a/xml/System.CommandLine.Binding/BindingContext.xml b/xml/System.CommandLine.Binding/BindingContext.xml deleted file mode 100644 index e6948aa6ec7..00000000000 --- a/xml/System.CommandLine.Binding/BindingContext.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.NamingConventionBinder - 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.CommandLine.NamingConventionBinder - 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.CommandLine.NamingConventionBinder - 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.CommandLine.NamingConventionBinder - 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.NamingConventionBinder - 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 deleted file mode 100644 index ed35f8855fb..00000000000 --- a/xml/System.CommandLine.Binding/BoundValue.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.NamingConventionBinder - 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.NamingConventionBinder - 2.0.0.0 - - - System.String - - - - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.NamingConventionBinder - 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.NamingConventionBinder - 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.NamingConventionBinder - 2.0.0.0 - - - System.CommandLine.Binding.IValueSource - - - - The source from which the value was bound. - - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine.Binding/IValueDescriptor.xml b/xml/System.CommandLine.Binding/IValueDescriptor.xml deleted file mode 100644 index 8104a2e0ef2..00000000000 --- a/xml/System.CommandLine.Binding/IValueDescriptor.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.NamingConventionBinder - 2.0.0.0 - - - - - Describes and provides access to a bindable named value. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.NamingConventionBinder - 2.0.0.0 - - - System.Object - - - - - Gets the default value, if any. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.NamingConventionBinder - 2.0.0.0 - - - System.Boolean - - - - Gets a value determining whether there is a default value. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.NamingConventionBinder - 2.0.0.0 - - - System.String - - - - The name of the value. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.NamingConventionBinder - 2.0.0.0 - - - System.Type - - - - The type of the value. - - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine.Binding/IValueDescriptor`1.xml b/xml/System.CommandLine.Binding/IValueDescriptor`1.xml deleted file mode 100644 index 7b1c5ce31c8..00000000000 --- a/xml/System.CommandLine.Binding/IValueDescriptor`1.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - - - Covariant - - - - - - System.CommandLine.Binding.IValueDescriptor - - - - To be added. - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine.Binding/IValueSource.xml b/xml/System.CommandLine.Binding/IValueSource.xml deleted file mode 100644 index 337a85a88a0..00000000000 --- a/xml/System.CommandLine.Binding/IValueSource.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.NamingConventionBinder - 2.0.0.0 - - - - - Binds a value from a based on a . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.NamingConventionBinder - 2.0.0.0 - - - System.Boolean - - - - - - - - The descriptor for the value to be bound. - The binding context from which to bind the value. - The bound value. - - Gets a value from a binding context. A return value indicates whether a value matching the specified value descriptor was present. - - - if a matching value was found; otherwise, . - To be added. - - - - diff --git a/xml/System.CommandLine.Builder/CommandLineBuilder.xml b/xml/System.CommandLine.Builder/CommandLineBuilder.xml deleted file mode 100644 index e8e98db9afd..00000000000 --- a/xml/System.CommandLine.Builder/CommandLineBuilder.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Enables composition of command line configurations. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - The root command of the application. - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.Parser - - - - - Creates a parser based on the configuration of the command line builder. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Command - - - - The command that the builder uses the root of the parser. - - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine.Builder/CommandLineBuilderExtensions.xml b/xml/System.CommandLine.Builder/CommandLineBuilderExtensions.xml deleted file mode 100644 index a2f951f6144..00000000000 --- a/xml/System.CommandLine.Builder/CommandLineBuilderExtensions.xml +++ /dev/null @@ -1,704 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides extension methods for . - - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - - A command line builder. - A delegate that will be invoked before a call to a command handler. - A value indicating the order in which the added delegate will be invoked relative to others in the pipeline. - - Adds a middleware delegate to the invocation pipeline called before a command handler is invoked. - - The same instance of . - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - - A command line builder. - A delegate that will be invoked before a call to a command handler. - A value indicating the order in which the added delegate will be invoked relative to others in the pipeline. - - Adds a middleware delegate to the invocation pipeline called before a command handler is invoked. - - The same instance of . - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - A command line builder. - - Enables signaling and handling of process termination via a that can be passed to a during invocation. - - The same instance of . - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - A command line builder. - - to enable directives. to parse directive-like tokens in the same way as any other token. - - Enables the parser to recognize command line directives. - - The same instance of . - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - A command line builder. - - to place all tokens following -- into the collection. to treat all tokens following -- as command arguments, even if they match an existing option. - - Determines the behavior when parsing a double dash (--) in a command line. - - To be added. - When set to , all tokens following -- will be placed into the collection. When set to , all tokens following -- will be treated as command arguments, even if they match an existing option. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - A command line builder. - - to parse POSIX bundles; otherwise, . - - Enables the parser to recognize and expand POSIX-style bundled options. - - The same instance of . - - POSIX conventions recommend that single-character options be allowed to be specified together after a single - prefix. When is set to , the following command lines are equivalent: - - - > myapp -a -b -c - > myapp -abc - - - If an argument is provided after an option bundle, it applies to the last option in the bundle. When is set to , all of the following command lines are equivalent: - - > myapp -a -b -c arg - > myapp -abc arg - > myapp -abcarg - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - A command line builder. - - Ensures that the application is registered with the dotnet-suggest tool to enable command line completions. - - The same instance of . - For command line completions to work, users must install the dotnet-suggest tool as well as the appropriate shim script for their shell. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - A command line builder. - - Uses the default configuration. - - The same instance of . - Calling this method is the equivalent to calling: - - builder - .UseVersionOption() - .UseHelp() - .UseEnvironmentVariableDirective() - .UseParseDirective() - .UseSuggestDirective() - .RegisterWithDotnetSuggest() - .UseTypoCorrections() - .UseParseErrorReporting() - .UseExceptionHandler() - .CancelOnProcessTermination(); - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - A command line builder. - - Enables the use of the [env:key=value] directive, allowing environment variables to be set from the command line during invocation. - - The same instance of . - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - - A command line builder. - A delegate that will be called when an exception is thrown by a command handler. - The exit code to be used when an exception is thrown. - - Enables an exception handler to catch any unhandled exceptions thrown by a command handler during invocation. - - The same instance of . - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - A command line builder. - Maximum output width for default help builder. - - Configures the application to show help when one of the following options are specified on the command line: - - -h - /h - --help - -? - /? - - The same instance of . - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - A command line builder. - The set of aliases that can be specified on the command line to request help. - - Configures the application to show help when one of the specified option aliases are used on the command line. - - The same instance of . - The specified aliases will override the default values. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - - A command line builder. - A delegate that will be called to customize help if help is requested. - Maximum output width for default help builder. - - Configures the application to show help when one of the specified option aliases are used on the command line. - - The same instance of . - The specified aliases will override the default values. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TBuilder - - - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - - - To be added. - A command line builder. - A delegate that returns an instance of - - Specifies an to be used to format help output when help is requested. - - The same instance of . - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - A command line builder. - The localizations resources to use. - - Specifies localization resources to be used when displaying help, error messages, and other user-facing strings. - - The same instance of . - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - A command line builder. - If the parse result contains errors, this exit code will be used when the process exits. - - Enables the use of the [parse] directive, which when specified on the command line will short circuit normal command handling and display a diagram explaining the parse result for the command line input. - - The same instance of . - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - A command line builder. - The exit code to use when parser errors occur. - - Configures the command line to write error information to standard error when there are errors parsing command line input. - - The same instance of . - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - A command line builder. - - Enables the use of the [suggest] directive which when specified in command line input short circuits normal command handling and writes a newline-delimited list of suggestions suitable for use by most shells to provide command line completions. - - The same instance of . - The dotnet-suggest tool requires the suggest directive to be enabled for an application to provide completions. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - A command line builder. - Replaces the specified token with any number of other tokens. - - Specifies a delegate used to replace any token prefixed with @ with zero or more other tokens, prior to parsing. - - The same instance of . - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - A command line builder. - The maximum Levenshtein distance for suggestions based on detected typos in command line input. - - Configures the application to provide alternative suggestions when a parse error is detected. - - The same instance of . - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - A command line builder. - - Enables the use of a option (defaulting to the alias --version) which when specified in command line input will short circuit normal command handling and instead write out version information before exiting. - - The same instance of . - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Builder.CommandLineBuilder - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - A command line builder. - One or more aliases to use instead of the default to signal that version information should be displayed. - To be added. - To be added. - To be added. - - - - - diff --git a/xml/System.CommandLine.Completions/CompletionContext.xml b/xml/System.CommandLine.Completions/CompletionContext.xml index 3bed5a10421..4e05f3a0521 100644 --- a/xml/System.CommandLine.Completions/CompletionContext.xml +++ b/xml/System.CommandLine.Completions/CompletionContext.xml @@ -1,14 +1,10 @@ - - + + - + - - - - - + System.CommandLine 2.0.0.0 @@ -68,36 +64,8 @@ System.String - - - - - A parse result. - The position within the raw input, if available, at which to provide completions. - - Gets the text to be matched for completion, which can be used to filter a list of completions. - - A string containing the user-entered text to be matched for completions. - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - + + A parse result. @@ -110,24 +78,19 @@ - - + + - - - - - - + + Property System.CommandLine 2.0.0.0 - System.CommandLine.ParseResult - System.CommandLine.Parsing.ParseResult + System.CommandLine.ParseResult To be added. diff --git a/xml/System.CommandLine.Completions/CompletionDelegate.xml b/xml/System.CommandLine.Completions/CompletionDelegate.xml deleted file mode 100644 index 15eb8e32e01..00000000000 --- a/xml/System.CommandLine.Completions/CompletionDelegate.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Delegate - - - - - - System.Collections.Generic.IEnumerable<System.CommandLine.Completions.CompletionItem> - - - To be added. - - Provides command line completion. - - A list of completions. - To be added. - - diff --git a/xml/System.CommandLine.Completions/CompletionItem.xml b/xml/System.CommandLine.Completions/CompletionItem.xml index b3f952f70a3..bebc0268c74 100644 --- a/xml/System.CommandLine.Completions/CompletionItem.xml +++ b/xml/System.CommandLine.Completions/CompletionItem.xml @@ -1,15 +1,10 @@ - - + + - - - - - - - - + + + System.CommandLine 2.0.0.0 @@ -18,7 +13,7 @@ System.Object - + System.IEquatable<System.CommandLine.Completions.CompletionItem> @@ -126,19 +121,15 @@ - - + + - + - - - - - + Method - M:System.IEquatable`1.Equals(`0) + M:System.IEquatable`1.Equals(`0) System.CommandLine diff --git a/xml/System.CommandLine.Completions/ICompletionSource.xml b/xml/System.CommandLine.Completions/ICompletionSource.xml deleted file mode 100644 index 16982ddf8c5..00000000000 --- a/xml/System.CommandLine.Completions/ICompletionSource.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - - - Provides completions and example values for help. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IEnumerable<System.CommandLine.Completions.CompletionItem> - - - - - - To be added. - - Gets the suggested values for command line completion. - - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine.Completions/TokenCompletionContext.xml b/xml/System.CommandLine.Completions/TokenCompletionContext.xml deleted file mode 100644 index 91c0722042b..00000000000 --- a/xml/System.CommandLine.Completions/TokenCompletionContext.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Completions.CompletionContext - - - - - Provides details for getting completions when the complete text of the original command line is not available. - - To be added. - - - diff --git a/xml/System.CommandLine.Help/HelpBuilder+Default.xml b/xml/System.CommandLine.Help/HelpBuilder+Default.xml deleted file mode 100644 index 67e44ea51d4..00000000000 --- a/xml/System.CommandLine.Help/HelpBuilder+Default.xml +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides default formatting for help output. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Help.HelpSectionDelegate - - - - - Writes a help section describing a command's additional arguments, typically shown only when is set to . - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Help.HelpSectionDelegate - - - - - Writes a help section describing a command's arguments. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Help.HelpSectionDelegate - - - - - Writes a help section describing a command's usage. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - The argument to get the default value for. - - Gets an argument's default value to be displayed in help. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Gets the description for an argument (typically used in the second column text in the arguments section). - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Gets the usage title for an argument (for example: <value>, typically used in the first column text in the arguments usage section, or within the synopsis. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - The symbol to get the description for. - - Gets the description for the specified symbol (typically the used as the second column in help text). - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - - The symbol to get a help item for. - The help context, used for localization purposes. - - Gets the usage label for the specified symbol (typically used as the first column text in help output). - - Text to display. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - - [System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Help.HelpBuilder+Default+<GetLayout>d__5))] - [<System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Help.HelpBuilder+Default+<GetLayout>d__5))>] - - - - System.Collections.Generic.IEnumerable<System.CommandLine.Help.HelpSectionDelegate> - - - - - Gets the default sections to be written for command line help. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Help.HelpSectionDelegate - - - - - Writes a help section describing a command's options. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Help.HelpSectionDelegate - - - - - Writes a help section describing a command's subcommands. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Help.HelpSectionDelegate - - - - - Writes a help section describing a command's synopsis. - - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine.Help/HelpBuilder.xml b/xml/System.CommandLine.Help/HelpBuilder.xml deleted file mode 100644 index f14f7f1cfb3..00000000000 --- a/xml/System.CommandLine.Help/HelpBuilder.xml +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Formats output to be shown to users to describe how to use a command line tool. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - Resources used to localize the help output. - The maximum width in characters after which help output is wrapped. - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - A delegate that returns the sections in the order in which they should be written. - - Customizes the help sections that will be displayed. - - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - The symbol to specify custom help details for. - A delegate to display the first help column (typically name and usage information). - A delegate to display second help column (typically the description). - A delegate to display the default value for the symbol. - - Specifies custom help details for a specific symbol. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Help.TwoColumnHelpRow - - - - - - - The symbol to get a help item for. - The help context. - - Gets a help item for the specified symbol. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.LocalizationResources - - - - Provides localizable strings for help and error messages. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - The maximum width for which to format help output. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - To be added. - - Writes help output for the specified command. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - The help items to write out in columns. - The help context. - - Writes the specified help rows, aligning output in columns. - - To be added. - - - - diff --git a/xml/System.CommandLine.Help/HelpBuilderExtensions.xml b/xml/System.CommandLine.Help/HelpBuilderExtensions.xml deleted file mode 100644 index 074b197956b..00000000000 --- a/xml/System.CommandLine.Help/HelpBuilderExtensions.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides extension methods for the help builder. - - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - The help builder to write with. - The symbol to customize the help details for. - A delegate to display the first help column (typically name and usage information). - A delegate to display second help column (typically the description). - The displayed default value for the symbol. - - Specifies custom help details for a specific symbol. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - To be added. - To be added. - To be added. - - Writes help output for the specified command. - - To be added. - - - - diff --git a/xml/System.CommandLine.Help/HelpContext.xml b/xml/System.CommandLine.Help/HelpContext.xml deleted file mode 100644 index 901b9530209..00000000000 --- a/xml/System.CommandLine.Help/HelpContext.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Supports formatting command line help. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - - - The current help builder. - The command for which help is being formatted. - A text writer to write output to. - The result of the current parse operation. - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Command - - - - The command for which help is being formatted. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Help.HelpBuilder - - - - The help builder for the current operation. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.IO.TextWriter - - - - A text writer to write output to. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ParseResult - - - - The result of the current parse operation. - - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine.Help/HelpSectionDelegate.xml b/xml/System.CommandLine.Help/HelpSectionDelegate.xml deleted file mode 100644 index c97743907b4..00000000000 --- a/xml/System.CommandLine.Help/HelpSectionDelegate.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Delegate - - - - - - System.Void - - - To be added. - - Specifies help formatting behavior for a section of command line help. - - - if anything was written; otherwise, . - To be added. - - diff --git a/xml/System.CommandLine.Help/TwoColumnHelpRow.xml b/xml/System.CommandLine.Help/TwoColumnHelpRow.xml deleted file mode 100644 index cfcc9f60da9..00000000000 --- a/xml/System.CommandLine.Help/TwoColumnHelpRow.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - - - 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. - - - - diff --git a/xml/System.CommandLine.IO/IStandardError.xml b/xml/System.CommandLine.IO/IStandardError.xml deleted file mode 100644 index 2ce0924313d..00000000000 --- a/xml/System.CommandLine.IO/IStandardError.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - - - Represents a console's standard error stream. - - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.CommandLine.IO.IStandardStreamWriter - - - - The stream writer for standard error. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Boolean - - - - Indicates whether the standard error stream has been redirected. - - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine.IO/IStandardIn.xml b/xml/System.CommandLine.IO/IStandardIn.xml deleted file mode 100644 index 8901364cc42..00000000000 --- a/xml/System.CommandLine.IO/IStandardIn.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - - - Represents a console's standard input stream. - - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Boolean - - - - Gets a value indicating whether input is redirected. - - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine.IO/IStandardOut.xml b/xml/System.CommandLine.IO/IStandardOut.xml deleted file mode 100644 index 314dac84e9c..00000000000 --- a/xml/System.CommandLine.IO/IStandardOut.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - - - Represents a console's standard output stream. - - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Boolean - - - - Indicates whether the standard output stream has been redirected. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.CommandLine.IO.IStandardStreamWriter - - - - The stream writer for standard output. - - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine.IO/IStandardStreamWriter.xml b/xml/System.CommandLine.IO/IStandardStreamWriter.xml deleted file mode 100644 index 7ecdcd1156a..00000000000 --- a/xml/System.CommandLine.IO/IStandardStreamWriter.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - - - Represents a standard stream that can be written to. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Void - - - - - - The value to write. - - Writes the specified string to the stream. - - To be added. - - - - diff --git a/xml/System.CommandLine.IO/StandardStreamWriter.xml b/xml/System.CommandLine.IO/StandardStreamWriter.xml deleted file mode 100644 index ab24189861c..00000000000 --- a/xml/System.CommandLine.IO/StandardStreamWriter.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Object - - - - - Provides methods for working with standard streams. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.CommandLine.IO.IStandardStreamWriter - - - - - - To be added. - - Creates a that writes to the specified . - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.IO.TextWriter - - - - - - To be added. - - Creates a that writes to the specified . - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Void - - - - - - The writer to write to. - - Appends the current environment's line terminator. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Void - - - - - - - The writer to write to. - The value to write. - - Writes the current string value, followed by the current environment's line terminator. - - To be added. - - - - diff --git a/xml/System.CommandLine.IO/SystemConsole.xml b/xml/System.CommandLine.IO/SystemConsole.xml deleted file mode 100644 index 75a68dd9137..00000000000 --- a/xml/System.CommandLine.IO/SystemConsole.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Object - - - - System.CommandLine.IConsole - - - System.CommandLine.IO.IStandardError - - - System.CommandLine.IO.IStandardIn - - - System.CommandLine.IO.IStandardOut - - - - - Provides access to the standard streams via . - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - - - Initializes a new instance of . - - To be added. - - - - - - - - - - Property - - P:System.CommandLine.IO.IStandardError.Error - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.CommandLine.IO.IStandardStreamWriter - - - Gets the stream writer for standard error. - To be added. - To be added. - - - - - - - - - - - Property - - P:System.CommandLine.IO.IStandardError.IsErrorRedirected - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Boolean - - - Gets a value that specifies whether the standard error stream has been redirected. - To be added. - To be added. - - - - - - - - - - - Property - - P:System.CommandLine.IO.IStandardIn.IsInputRedirected - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Boolean - - - Gets a value indicating whether input is redirected. - To be added. - To be added. - - - - - - - - - - - Property - - P:System.CommandLine.IO.IStandardOut.IsOutputRedirected - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Boolean - - - Gets a value that specifies whether the standard output stream has been redirected. - To be added. - To be added. - - - - - - - - - - - Property - - P:System.CommandLine.IO.IStandardOut.Out - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.CommandLine.IO.IStandardStreamWriter - - - Gets the stream writer for standard output. - To be added. - To be added. - - - - - diff --git a/xml/System.CommandLine.IO/TestConsole.xml b/xml/System.CommandLine.IO/TestConsole.xml deleted file mode 100644 index c924128eb64..00000000000 --- a/xml/System.CommandLine.IO/TestConsole.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Object - - - - System.CommandLine.IConsole - - - System.CommandLine.IO.IStandardError - - - System.CommandLine.IO.IStandardIn - - - System.CommandLine.IO.IStandardOut - - - - - Provides access to in-memory standard streams that are not attached to . - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - - - Initializes a new instance of . - - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.CommandLine.IO.IStandardStreamWriter - - - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - System.CommandLine.IO.IStandardStreamWriter - - - To be added. - To be added. - To be added. - - - - - diff --git a/xml/System.CommandLine.Invocation/ICommandHandler.xml b/xml/System.CommandLine.Invocation/ICommandHandler.xml deleted file mode 100644 index 624913b7ecf..00000000000 --- a/xml/System.CommandLine.Invocation/ICommandHandler.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - - - Defines the behavior of a command. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - - - Provides context for the invocation, including parse results and binding support. - - Performs an action when the associated command is invoked on the command line. - - A value that can be used as the exit code for the process. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Threading.Tasks.Task<System.Int32> - - - - - - Provides context for the invocation, including parse results and binding support. - - Performs an action when the associated command is invoked on the command line. - - A value that can be used as the exit code for the process. - To be added. - - - - diff --git a/xml/System.CommandLine.Invocation/IInvocationResult.xml b/xml/System.CommandLine.Invocation/IInvocationResult.xml deleted file mode 100644 index cb89d4d9f6d..00000000000 --- a/xml/System.CommandLine.Invocation/IInvocationResult.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - - - The result of a command handler invocation. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The context for the current invocation. - - Applies the result to the current invocation context. - - To be added. - - - - diff --git a/xml/System.CommandLine.Invocation/InvocationContext.xml b/xml/System.CommandLine.Invocation/InvocationContext.xml deleted file mode 100644 index 8a21f94f4bf..00000000000 --- a/xml/System.CommandLine.Invocation/InvocationContext.xml +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Supports command invocation by providing access to parse results and other services. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - The result of the current parse operation. - The console to which output is to be written. - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Binding.BindingContext - - - - The binding context for the current invocation. - - To be added. - 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. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - A value that can be used to set the exit code for the process. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Threading.CancellationToken - - - - - Gets token to implement cancellation handling. - - Token used by the caller to implement cancellation handling. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Help.HelpBuilder - - - - Enables writing help output. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Invocation.IInvocationResult - - - - The result of the current invocation. - - To be added. - As the is passed through the invocation pipeline to the associated with the invoked command, only the last value of this property will be the one applied. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.LocalizationResources - - - - Provides localizable strings for help and error messages. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.Parser - - - - The parser used to create the . - - To be added. - 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.Invocation/InvocationMiddleware.xml b/xml/System.CommandLine.Invocation/InvocationMiddleware.xml deleted file mode 100644 index 52b9caba7bd..00000000000 --- a/xml/System.CommandLine.Invocation/InvocationMiddleware.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Delegate - - - - - - - System.Threading.Tasks.Task - - - The context for the current invocation, which will be passed to each middleware and then to the command handler, unless a middleware short circuits it. - A continuation. Passing the incoming to it will execute the next middleware in the pipeline and, at the end of the pipeline, the command handler. Middleware can short circuit the invocation by not calling this continuation. - - A delegate used for adding command handler invocation middleware. - - To be added. - To be added. - - diff --git a/xml/System.CommandLine.Invocation/MiddlewareOrder.xml b/xml/System.CommandLine.Invocation/MiddlewareOrder.xml deleted file mode 100644 index 7156c458ede..00000000000 --- a/xml/System.CommandLine.Invocation/MiddlewareOrder.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Enum - - - - Designates ordering of middleware in the invocation pipeline. - - To be added. - - - - - - - - - - Field - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Invocation.MiddlewareOrder - - -1000 - - - The position in the pipeline at which configuration middleware is invoked. - - - - - - - - - - - Field - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Invocation.MiddlewareOrder - - 0 - - - The default position in the pipeline. - - - - - - - - - - - Field - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Invocation.MiddlewareOrder - - 1000 - - - The position in the pipeline at which error reporting middleware is invoked. - - - - - - - - - - - Field - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Invocation.MiddlewareOrder - - -2000 - - - The position in the pipeline at which the exception handler middleware is invoked. - - - - - diff --git a/xml/System.CommandLine.Parsing/ArgumentResult.xml b/xml/System.CommandLine.Parsing/ArgumentResult.xml index 21fa1c9368b..1997af12274 100644 --- a/xml/System.CommandLine.Parsing/ArgumentResult.xml +++ b/xml/System.CommandLine.Parsing/ArgumentResult.xml @@ -1,14 +1,10 @@ - - + + - + - - - - - + System.CommandLine 2.0.0.0 @@ -46,7 +42,7 @@ System.Void - + To be added. @@ -78,29 +74,6 @@ To be added. - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - To be added. - To be added. - To be added. - - - diff --git a/xml/System.CommandLine.Parsing/CommandLineStringSplitter.xml b/xml/System.CommandLine.Parsing/CommandLineStringSplitter.xml deleted file mode 100644 index 5a045e5671c..00000000000 --- a/xml/System.CommandLine.Parsing/CommandLineStringSplitter.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Splits a string based on whitespace and quotation marks - - To be added. - - - - - - - - - - Field - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.CommandLineStringSplitter - - - - A single instance of - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - - [System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Parsing.CommandLineStringSplitter+<Split>d__3))] - [<System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Parsing.CommandLineStringSplitter+<Split>d__3))>] - - - - System.Collections.Generic.IEnumerable<System.String> - - - - - - A command line input string. - - Splits a string into a sequence of strings based on whitespace and quotation marks. - - A sequence of strings. - To be added. - - - - diff --git a/xml/System.CommandLine.Parsing/CommandResult.xml b/xml/System.CommandLine.Parsing/CommandResult.xml index 6078971e6bc..f243b947e5b 100644 --- a/xml/System.CommandLine.Parsing/CommandResult.xml +++ b/xml/System.CommandLine.Parsing/CommandResult.xml @@ -1,14 +1,10 @@ - - + + - + - - - - - + System.CommandLine 2.0.0.0 @@ -99,29 +95,6 @@ To be added. - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.Token - - - - The token that was parsed to specify the command. - - To be added. - To be added. - - diff --git a/xml/System.CommandLine.Parsing/OptionResult.xml b/xml/System.CommandLine.Parsing/OptionResult.xml index 44d15adce7e..97b128a1820 100644 --- a/xml/System.CommandLine.Parsing/OptionResult.xml +++ b/xml/System.CommandLine.Parsing/OptionResult.xml @@ -1,14 +1,10 @@ - - + + - + - - - - - + System.CommandLine 2.0.0.0 @@ -30,29 +26,6 @@ To be added. - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - To be added. - To be added. - To be added. - - - @@ -163,29 +136,6 @@ Implicit results commonly result from options having a default value. - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - Indicates whether the result was created implicitly and not due to the option being specified on the command line. - - To be added. - Implicit results commonly result from options having a default value. - - @@ -209,29 +159,6 @@ To be added. - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.Token - - - - The token that was parsed to specify the option. - - To be added. - To be added. - - diff --git a/xml/System.CommandLine.Parsing/ParseArgument`1.xml b/xml/System.CommandLine.Parsing/ParseArgument`1.xml deleted file mode 100644 index 240ddfa6ebe..00000000000 --- a/xml/System.CommandLine.Parsing/ParseArgument`1.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - - - Covariant - - - - - System.Delegate - - - - - - T - - - The type which the argument is to be parsed as. - The argument result. - - Performs custom parsing of an argument. - - The parsed value. - Validation errors can be returned by setting . - - diff --git a/xml/System.CommandLine.Parsing/ParseError.xml b/xml/System.CommandLine.Parsing/ParseError.xml index b1cc15ff886..221a64b9096 100644 --- a/xml/System.CommandLine.Parsing/ParseError.xml +++ b/xml/System.CommandLine.Parsing/ParseError.xml @@ -1,14 +1,10 @@ - - + + - + - - - - - + System.CommandLine 2.0.0.0 diff --git a/xml/System.CommandLine.Parsing/ParseResult.xml b/xml/System.CommandLine.Parsing/ParseResult.xml deleted file mode 100644 index 1d2a8271ad4..00000000000 --- a/xml/System.CommandLine.Parsing/ParseResult.xml +++ /dev/null @@ -1,503 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Describes the results of parsing a command line input based on a specific parser configuration. - - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.CommandResult - - - - A result indicating the command specified in the command line input. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.DirectiveCollection - - - - Gets the directives found while parsing command line input. - - To be added. - If is set to , then this collection will be empty. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IReadOnlyList<System.CommandLine.Parsing.ParseError> - - - - Gets the parse errors found while parsing command line input. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ArgumentResult - - - - - - The argument for which to find a result. - - Gets the result, if any, for the specified argument. - - A result for the specified argument, or if it was not provided and no default was configured. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.CommandResult - - - - - - The command for which to find a result. - - Gets the result, if any, for the specified command. - - A result for the specified command, or if it was not provided. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.OptionResult - - - - - - The option for which to find a result. - - Gets the result, if any, for the specified option. - - A result for the specified option, or if it was not provided and no default was configured. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.SymbolResult - - - - - - The symbol for which to find a result. - - Gets the result, if any, for the specified symbol. - - A result for the specified symbol, or if it was not provided and no default was configured. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Completions.CompletionContext - - - - - Gets the completion context for the parse result. - - To be added. - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IEnumerable<System.CommandLine.Completions.CompletionItem> - - - - - - The position at which completions are requested. - - Gets completions based on a given parse result. - - A set of completions for completion. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - - The argument for which to get a value. - - Gets the parsed or default value for the specified argument. - - The parsed value or a configured default. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - T - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - - The option for which to get a value. - - Gets the parsed or default value for the specified option. - - The parsed value or a configured default. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - T - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.Parser - - - - The parser used to produce the parse result. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.CommandResult - - - - Gets the root command result. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IReadOnlyList<System.CommandLine.Parsing.Token> - - - - Gets the tokens identified while parsing command line input. - - To be added. - 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.Collections.Generic.IReadOnlyList<System.String> - - - - Gets the list of tokens used on the command line that were not matched by the parser. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IReadOnlyList<System.String> - - - - Gets the list of tokens used on the command line that were ignored by the parser. - - To be added. - This list will contain all of the tokens following the first occurrence of a -- token if is set to . - - - - diff --git a/xml/System.CommandLine.Parsing/ParseResultExtensions.xml b/xml/System.CommandLine.Parsing/ParseResultExtensions.xml deleted file mode 100644 index aeafc50b0e9..00000000000 --- a/xml/System.CommandLine.Parsing/ParseResultExtensions.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides extension methods for parse results. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - The parse result to be diagrammed. - - Formats a string explaining a parse result. - - A string containing a diagram of the parse result. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - - The parse result to check for the presence of the option. - The option to check for the presence of. - - Indicates whether a given option is present in the parse result. - - - if the option is present; otherwise, . - If the option has a default value defined, then will be returned. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - - - - A parse result on which the invocation is based. - A console to which output can be written. By default, is used. - - Invokes the appropriate command handler for a parsed command line input. - - A value that can be used as a process exit code. - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Threading.Tasks.Task<System.Int32> - - - - - - - A parse result on which the invocation is based. - A console to which output can be written. By default, is used. - - Invokes the appropriate command handler for a parsed command line input. - - A task whose result can be used as a process exit code. - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - - - - diff --git a/xml/System.CommandLine.Parsing/Parser.xml b/xml/System.CommandLine.Parsing/Parser.xml deleted file mode 100644 index 7b4ea9268ca..00000000000 --- a/xml/System.CommandLine.Parsing/Parser.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Parses command line input. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - Initializes a new instance of the class using the default . - - To be added. - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - The root command for the parser. - Initializes a new instance of the class using the specified command. - To be added. - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - The configuration on which the parser's grammar and behaviors are based. - Initializes a new instance of the class using the specified configuration. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.CommandLineConfiguration - - - - Gets the configuration on which the parser's grammar and behaviors are based. - - To be added. - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ParseResult - - - - - - - The string array typically passed to a program's Main method. - The complete command line input prior to splitting and tokenization. This input is not typically available when the parser is called from Program.Main. It is primarily used when calculating completions via the dotnet-suggest tool. - - Parses a list of arguments. - - A providing details about the parse operation. - To be added. - - - - diff --git a/xml/System.CommandLine.Parsing/ParserExtensions.xml b/xml/System.CommandLine.Parsing/ParserExtensions.xml deleted file mode 100644 index 2bf16999f79..00000000000 --- a/xml/System.CommandLine.Parsing/ParserExtensions.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides extension methods for parsers. - - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - - - - - To be added. - To be added. - To be added. - - Parses a command line string value and invokes the handler for the indicated command. - - The exit code for the invocation. - The command line string input will be split into tokens as if it had been passed on the command line. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - - - - - To be added. - To be added. - To be added. - - Parses a command line string array and invokes the handler for the indicated command. - - The exit code for the invocation. - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Threading.Tasks.Task<System.Int32> - - - - - - - - To be added. - To be added. - To be added. - - Parses a command line string value and invokes the handler for the indicated command. - - The exit code for the invocation. - The command line string input will be split into tokens as if it had been passed on the command line. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Threading.Tasks.Task<System.Int32> - - - - - - - - To be added. - To be added. - To be added. - - Parses a command line string array and invokes the handler for the indicated command. - - The exit code for the invocation. - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ParseResult - - - - - - - To be added. - To be added. - - Parses a command line string. - - To be added. - The command line string input will be split into tokens as if it had been passed on the command line. - - - - diff --git a/xml/System.CommandLine.Parsing/SymbolResult.xml b/xml/System.CommandLine.Parsing/SymbolResult.xml index 01d939b080c..aa72500bcbd 100644 --- a/xml/System.CommandLine.Parsing/SymbolResult.xml +++ b/xml/System.CommandLine.Parsing/SymbolResult.xml @@ -42,7 +42,7 @@ System.Void - + To be added. @@ -52,52 +52,6 @@ Setting an error will cause the parser to indicate an error for the user and prevent invocation of the command line. - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IReadOnlyList<System.CommandLine.Parsing.SymbolResult> - - - - Child symbol results in the parse tree. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - An error message for this symbol result. - - To be added. - Setting this value to a non-null during parsing will cause the parser to indicate an error for the user and prevent invocation of the command line. - - @@ -111,7 +65,7 @@ 2.0.0.0 - + [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Parsing.SymbolResult+<get_Errors>d__4))] [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Parsing.SymbolResult+<get_Errors>d__4))>] @@ -127,87 +81,6 @@ To be added. - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ArgumentResult - - - - - - The argument for which to find a result. - - Finds a result for the specific argument anywhere in the parse tree, including parent and child symbol results. - - An argument result if the argument was matched by the parser or has a default value; otherwise, null. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.CommandResult - - - - - - The command for which to find a result. - - Finds a result for the specific command anywhere in the parse tree, including parent and child symbol results. - - An command result if the command was matched by the parser; otherwise, null. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.OptionResult - - - - - - The option for which to find a result. - - Finds a result for the specific option anywhere in the parse tree, including parent and child symbol results. - - An option result if the option was matched by the parser or has a default value; otherwise, null. - To be added. - - @@ -234,7 +107,7 @@ - + To be added. @@ -271,7 +144,7 @@ - + To be added. @@ -308,7 +181,7 @@ - + To be added. @@ -342,7 +215,7 @@ - + The argument for which to find a result. @@ -375,7 +248,7 @@ - + The command for which to find a result. @@ -408,7 +281,7 @@ - + The directive for which to find a result. @@ -441,7 +314,7 @@ - + The option for which to find a result. @@ -474,7 +347,7 @@ - + The name of the symbol for which to find a result. @@ -504,7 +377,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -541,7 +414,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -578,7 +451,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -597,141 +470,6 @@ To be added. - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - T - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - T - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.LocalizationResources - - - - Localization resources used to produce messages for this symbol result. - - To be added. - To be added. - - @@ -761,29 +499,6 @@ To be added. - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Symbol - - - - The symbol to which the result applies. - - To be added. - To be added. - - @@ -807,28 +522,5 @@ To be added. - - - - - - - - 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/Token.xml b/xml/System.CommandLine.Parsing/Token.xml index c712549b582..443aefc8054 100644 --- a/xml/System.CommandLine.Parsing/Token.xml +++ b/xml/System.CommandLine.Parsing/Token.xml @@ -1,14 +1,10 @@ - - + + - + - - - - - + System.CommandLine 2.0.0.0 @@ -146,13 +142,12 @@ - + - Method System.CommandLine @@ -177,13 +172,12 @@ - + - Method System.CommandLine diff --git a/xml/System.CommandLine.Parsing/TokenType.xml b/xml/System.CommandLine.Parsing/TokenType.xml index d376999a56b..05cdc5d5fc6 100644 --- a/xml/System.CommandLine.Parsing/TokenType.xml +++ b/xml/System.CommandLine.Parsing/TokenType.xml @@ -69,13 +69,11 @@ - + - + - - Field System.CommandLine @@ -84,7 +82,7 @@ System.CommandLine.Parsing.TokenType - 5 + 4 A directive token. @@ -140,28 +138,5 @@ - - - - - - - - Field - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.TokenType - - 4 - - - A token following when is set to . - - - - diff --git a/xml/System.CommandLine.Parsing/ValidateSymbolResult`1.xml b/xml/System.CommandLine.Parsing/ValidateSymbolResult`1.xml deleted file mode 100644 index 39f15973655..00000000000 --- a/xml/System.CommandLine.Parsing/ValidateSymbolResult`1.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - - - Contravariant - System.CommandLine.Parsing.SymbolResult - - - - - System.Delegate - - - - - - System.Void - - - The type of the . - The symbol result - - A delegate used to validate symbol results during parsing. - - To display an error, set . - - diff --git a/xml/System.CommandLine/Argument.xml b/xml/System.CommandLine/Argument.xml index ac70d95bcc8..de833108f5f 100644 --- a/xml/System.CommandLine/Argument.xml +++ b/xml/System.CommandLine/Argument.xml @@ -1,15 +1,10 @@ - - + + - - - - - - - - + + + System.CommandLine 2.0.0.0 @@ -18,9 +13,6 @@ System.CommandLine.Symbol - - System.CommandLine.Binding.IValueDescriptor - @@ -35,25 +27,6 @@ To be added. - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - Initializes a new instance of the Argument class. - - To be added. - - @@ -67,7 +40,7 @@ 2.0.0.0 - + The name of the argument. This can be used to look up the parsed value and is displayed in help @@ -77,57 +50,6 @@ To be added. - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - The name of the argument. - The description of the argument, shown in help. - - Initializes a new instance of the Argument class. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The delegate to validate the parsed argument. - - Adds a custom to the argument. Validators can be used - to provide custom errors based on user input. - - To be added. - - @@ -151,29 +73,6 @@ To be added. - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.CompletionSourceList - - - - Gets the list of completion sources for the argument. - - To be added. - To be added. - - @@ -225,18 +124,12 @@ - + - - - - - + + Method - - M:System.CommandLine.Binding.IValueDescriptor.GetDefaultValue - System.CommandLine 2.0.0.0 @@ -254,19 +147,13 @@ - + - + - - - - + Property - - P:System.CommandLine.Binding.IValueDescriptor.HasDefaultValue - System.CommandLine 2.0.0.0 @@ -311,110 +198,6 @@ To be added. - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The default value for the argument. - - Sets the default value for the argument. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The delegate to invoke to return the default value. - - Sets a delegate to invoke when the default value for the argument is required. - - In this overload, the is provided to the delegate. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The delegate to invoke to return the default value. - - Sets a delegate to invoke when the default value for the argument is required. - - To be added. - Thrown when is null. - - - - - - - - - - Property - - P:System.CommandLine.Binding.IValueDescriptor.ValueName - - - System.CommandLine - 2.0.0.0 - - - System.String - - - Gets the name of the value. - To be added. - To be added. - - - @@ -470,9 +253,6 @@ Property - - P:System.CommandLine.Binding.IValueDescriptor.ValueType - System.CommandLine 2.0.0.0 diff --git a/xml/System.CommandLine/ArgumentArity.xml b/xml/System.CommandLine/ArgumentArity.xml index 31163e3860b..9364d5b90d9 100644 --- a/xml/System.CommandLine/ArgumentArity.xml +++ b/xml/System.CommandLine/ArgumentArity.xml @@ -22,7 +22,7 @@ [System.Diagnostics.DebuggerDisplay("\{{MinimumNumberOfValues},{MaximumNumberOfValues}\}")] [<System.Diagnostics.DebuggerDisplay("\{{MinimumNumberOfValues},{MaximumNumberOfValues}\}")>] - + [System.Runtime.CompilerServices.IsReadOnly] [<System.Runtime.CompilerServices.IsReadOnly>] diff --git a/xml/System.CommandLine/ArgumentExtensions.xml b/xml/System.CommandLine/ArgumentExtensions.xml deleted file mode 100644 index 70d5d993ffb..00000000000 --- a/xml/System.CommandLine/ArgumentExtensions.xml +++ /dev/null @@ -1,430 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides extension methods for . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TArgument - - - - - System.CommandLine.Argument - - - - - - - - - The type of the argument. - The argument for which to add completions. - A that will be called to provide completions. - - Adds completions for an argument. - - The configured argument. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TArgument - - - - - System.CommandLine.Argument - - - - - - - - - The type of the argument. - The argument for which to add completions. - A that will be called to provide completions. - - Adds completions for an option. - - The option being extended. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TArgument - - - - - System.CommandLine.Argument - - - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The type of the argument. - The argument for which to add completions. - The completions to add. - - Adds completions for an argument. - - The configured argument. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Argument<System.IO.DirectoryInfo> - - - - - - The argument to configure. - - Configures an argument to accept only values corresponding to an existing directory. - - The configured argument. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Argument<System.IO.FileInfo> - - - - - - The argument to configure. - - Configures an argument to accept only values corresponding to an existing file. - - The configured argument. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Argument<System.IO.FileSystemInfo> - - - - - - The argument to configure. - - Configures an argument to accept only values corresponding to an existing file or directory. - - The configured argument. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Argument<T> - - - - - System.Collections.Generic.IEnumerable<System.IO.FileSystemInfo> - - - - - - - - To be added. - The argument to configure. - - Configures an argument to accept only values corresponding to a existing files or directories. - - The configured argument. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TArgument - - - - - System.CommandLine.Argument - - - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The type of the argument. - The argument to configure. - The values that are allowed for the argument. - - Configures an argument to accept only the specified values, and to suggest them as command line completions. - - The configured argument. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TArgument - - - - - System.CommandLine.Argument - - - - - - - - To be added. - The argument to configure. - - Configures an argument to accept only values representing legal file names. - - The configured argument. - A parse error will result, for example, if file path separators are found in the parsed value. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TArgument - - - - - System.CommandLine.Argument - - - - - - - - To be added. - The argument to configure. - - Configures an argument to accept only values representing legal file paths. - - The configured argument. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ParseResult - - - - - - - The argument to use to parse the command line input. - A command line string to parse, which can include spaces and quotes equivalent to what can be entered into a terminal. - - Parses a command line string value using an argument. - - A parse result describing the outcome of the parse operation. - The command line string input will be split into tokens as if it had been passed on the command line. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ParseResult - - - - - - - The argument to use to parse the command line input. - The string arguments to parse. - - Parses a command line string value using an argument. - - A parse result describing the outcome of the parse operation. - To be added. - - - - diff --git a/xml/System.CommandLine/Argument`1.xml b/xml/System.CommandLine/Argument`1.xml index 9dcdb953076..379ddb439c5 100644 --- a/xml/System.CommandLine/Argument`1.xml +++ b/xml/System.CommandLine/Argument`1.xml @@ -1,15 +1,10 @@ - - + + - - - - - - - - + + + System.CommandLine 2.0.0.0 @@ -28,12 +23,6 @@ System.CommandLine.Argument - - System.CommandLine.Binding.IValueDescriptor - - - System.CommandLine.Binding.IValueDescriptor<T> - @@ -48,49 +37,6 @@ - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - Initializes a new instance of the Argument class. - - To be added. - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - The delegate to invoke to return the default value. - - Initializes a new instance of the Argument class. - - To be added. - Thrown when is null. - - @@ -104,7 +50,7 @@ 2.0.0.0 - + The name of the argument. This can be used to look up the parsed value and is displayed in help @@ -114,111 +60,6 @@ To be added. - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - A custom argument parser. - - to use the result as default value. - - Initializes a new instance of the Argument class. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - - The name of the argument. - The delegate to invoke to return the default value. - The description of the argument, shown in help. - - Initializes a new instance of the Argument class. - - To be added. - Thrown when is null. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - - - The name of the argument. - A custom argument parser. - - to use the result as default value. - The description of the argument, shown in help. - - Initializes a new instance of the Argument class. - - To be added. - Thrown when is null. - - @@ -315,9 +156,6 @@ Property - - P:System.CommandLine.Binding.IValueDescriptor.ValueType - System.CommandLine 2.0.0.0 diff --git a/xml/System.CommandLine/Command.xml b/xml/System.CommandLine/Command.xml index 926562f924a..f9d12436519 100644 --- a/xml/System.CommandLine/Command.xml +++ b/xml/System.CommandLine/Command.xml @@ -1,30 +1,21 @@ - - + + - - - - - - - - + + + System.CommandLine 2.0.0.0 System.CommandLine.Symbol - System.CommandLine.IdentifierSymbol System.Collections.IEnumerable - - System.Collections.Generic.IEnumerable<System.CommandLine.Symbol> - @@ -186,138 +177,6 @@ To be added. - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The argument to add to the command. - - Adds an to the command. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The subcommand to add to the command. - - Adds a subcommand to the command. - - Commands can be nested to an arbitrary depth. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The global option to add to the command. - - Adds a global to the command. - - Global options are applied to the command and recursively to subcommands. They do not apply to - parent commands. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The option to add to the command. - - Adds an to the command. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The delegate to validate the symbols during parsing. - - Adds a custom validator to the command. Validators can be used - to create custom validation logic. - - To be added. - - @@ -342,25 +201,19 @@ - - + + - - - - - - - - + + + Property System.CommandLine 2.0.0.0 - System.Collections.Generic.IList<System.CommandLine.Argument> - System.Collections.Generic.IReadOnlyList<System.CommandLine.Argument> + System.Collections.Generic.IList<System.CommandLine.Argument> @@ -383,14 +236,10 @@ 2.0.0.0 - + [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Command+<get_Children>d__7))] [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Command+<get_Children>d__7))>] - - [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Command+<get_Children>d__6))] - [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Command+<get_Children>d__6))>] - System.Collections.Generic.IEnumerable<System.CommandLine.Symbol> @@ -429,81 +278,20 @@ - - - - - - - - Method - - M:System.Collections.Generic.IEnumerable`1.GetEnumerator - - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IEnumerator<System.CommandLine.Symbol> - - - - - Represents all of the symbols for the command. - - An enumerator that can be used to iterate through the collection. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Invocation.ICommandHandler - - - - Gets or sets the for the command. The handler represents the action - that will be performed when the command is invoked. - - To be added. - - Use one of the overloads to construct a handler. - If the handler is not specified, parser errors will be generated for command line input that - invokes this command. - - - - - + + - - - - - - - - + + + Property System.CommandLine 2.0.0.0 - System.Collections.Generic.IList<System.CommandLine.Option> - System.Collections.Generic.IReadOnlyList<System.CommandLine.Option> + System.Collections.Generic.IList<System.CommandLine.Option> @@ -528,8 +316,8 @@ System.CommandLine.ParseResult - - + + [System.Runtime.CompilerServices.Nullable(2)] @@ -563,8 +351,8 @@ System.CommandLine.ParseResult - - + + [System.Runtime.CompilerServices.Nullable(2)] @@ -599,7 +387,7 @@ System.Void - + To be added. @@ -625,7 +413,7 @@ System.Void - + To be added. @@ -651,7 +439,7 @@ System.Void - + To be added. @@ -677,7 +465,7 @@ System.Void - + To be added. @@ -700,7 +488,7 @@ 2.0.0.0 - + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] @@ -709,7 +497,7 @@ System.Void - + To be added. @@ -735,7 +523,7 @@ 2.0.0.0 - + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] @@ -744,7 +532,7 @@ System.Void - + To be added. @@ -758,25 +546,19 @@ - - + + - - - - - - - - + + + Property System.CommandLine 2.0.0.0 - System.Collections.Generic.IList<System.CommandLine.Command> - System.Collections.Generic.IReadOnlyList<System.CommandLine.Command> + System.Collections.Generic.IList<System.CommandLine.Command> @@ -802,11 +584,11 @@ 2.0.0.0 - + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] diff --git a/xml/System.CommandLine/CommandExtensions.xml b/xml/System.CommandLine/CommandExtensions.xml deleted file mode 100644 index 2151f1ecb11..00000000000 --- a/xml/System.CommandLine/CommandExtensions.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides extension methods for . - - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - - - - - The command to invoke. - The command line to parse. - The console to which output is written during invocation. - - Parses and invokes a command. - - The exit code for the invocation. - The command line string input will be split into tokens as if it had been passed on the command line. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - - - - - - The command to invoke. - The arguments to parse. - The console to which output is written during invocation. - - Parses and invokes a command. - - The exit code for the invocation. - To be added. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Threading.Tasks.Task<System.Int32> - - - - - - - - The command to invoke. - The command line to parse. - The console to which output is written during invocation. - - Parses and invokes a command. - - The exit code for the invocation. - The command line string input will be split into tokens as if it had been passed on the command line. - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Threading.Tasks.Task<System.Int32> - - - - - - - - The command to invoke. - The arguments to parse. - The console to which output is written during invocation. - - Parses and invokes a command. - - The exit code for the invocation. - This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ParseResult - - - - - - - The command to use to parse the command line input. - A command line string to parse, which can include spaces and quotes equivalent to what can be entered into a terminal. - - Parses a command line string value using the specified command. - - A parse result describing the outcome of the parse operation. - The command line string input will be split into tokens as if it had been passed on the command line. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ParseResult - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The command to use to parse the command line input. - The string arguments to parse. - - Parses an array strings using the specified command. - - A parse result describing the outcome of the parse operation. - To be added. - - - - diff --git a/xml/System.CommandLine/CommandLineConfiguration.xml b/xml/System.CommandLine/CommandLineConfiguration.xml deleted file mode 100644 index 8698abdc0ed..00000000000 --- a/xml/System.CommandLine/CommandLineConfiguration.xml +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Represents the configuration used by the . - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - - - - - - - - The root command for the parser. - - to enable POSIX bundling; otherwise, . - - to enable directive parsing; otherwise, . - Enables the legacy behavior of the -- token, which is to ignore parsing of subsequent tokens and place them in the list. - - to enable token replacement; otherwise, . - Provide custom validation messages. - Provide a custom middleware pipeline. - Provide a custom help builder. - Replaces the specified token with any number of other tokens. - - Initializes a new instance of the CommandLineConfiguration class. - - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - Gets whether directives are enabled. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - Enables the legacy behavior of the -- token, which is to ignore parsing of subsequent tokens and place them in the list. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - Gets a value indicating whether POSIX bundling is enabled. - - To be added. - - POSIX recommends that single-character options be allowed to be specified together after a single - prefix. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - Gets a value indicating whether token replacement is enabled. - - To be added. - - When enabled, any token prefixed with @ can be replaced with zero or more other tokens. This is mostly commonly used to expand tokens from response files and interpolate them into a command line prior to parsing. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.LocalizationResources - - - - Gets the localizable resources. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Command - - - - Gets the root command. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - Throws an exception if the parser configuration is ambiguous or otherwise not valid. - - Due to the performance cost of this method, it is recommended to be used in unit testing or in scenarios where the parser is configured dynamically at runtime. - Thrown if the configuration is found to be invalid. - - - - diff --git a/xml/System.CommandLine/CommandLineConfigurationException.xml b/xml/System.CommandLine/CommandLineConfigurationException.xml deleted file mode 100644 index 811af0f411e..00000000000 --- a/xml/System.CommandLine/CommandLineConfigurationException.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Exception - - - - - [System.Serializable] - [<System.Serializable>] - - - - - Indicates that a command line configuration is invalid. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - To be added. - To be added. - - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - To be added. - To be added. - To be added. - - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - diff --git a/xml/System.CommandLine/CompletionSourceExtensions.xml b/xml/System.CommandLine/CompletionSourceExtensions.xml index 0bac73cf35b..5d7aeba1593 100644 --- a/xml/System.CommandLine/CompletionSourceExtensions.xml +++ b/xml/System.CommandLine/CompletionSourceExtensions.xml @@ -42,8 +42,8 @@ System.Void - - + + The list of completion sources to add to. @@ -70,99 +70,8 @@ System.Void - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The list of completion sources to add to. - A list of strings to be suggested for command line completions. - - Adds a completion source using a delegate. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - The list of completion sources to add to. - The delegate to be called when calculating completions. - - Adds a completion source using a delegate. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - The list of completion sources to add to. - The delegate to be called when calculating completions. - - Adds a completion source using a delegate. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - + + [System.ParamArray] diff --git a/xml/System.CommandLine/CompletionSourceList.xml b/xml/System.CommandLine/CompletionSourceList.xml deleted file mode 100644 index 8f6a72e95aa..00000000000 --- a/xml/System.CommandLine/CompletionSourceList.xml +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - System.Collections.Generic.IEnumerable<System.CommandLine.Completions.ICompletionSource> - - - System.Collections.Generic.IEnumerable<T> - - - System.Collections.Generic.IReadOnlyCollection<System.CommandLine.Completions.ICompletionSource> - - - System.Collections.Generic.IReadOnlyCollection<T> - - - System.Collections.Generic.IReadOnlyList<System.CommandLine.Completions.ICompletionSource> - - - System.Collections.IEnumerable - - - - - A list of completion sources to be used when providing completions for completion. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The source to add. - - Adds a completion source to the list. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - Clears the completion sources. - - To be added. - - - - - - - - - - Property - - P:System.Collections.Generic.IReadOnlyCollection`1.Count - - - System.CommandLine - 2.0.0.0 - - - System.Int32 - - - Gets the number of elements in the collection. - The number of elements in the collection. - To be added. - - - - - - - - - - - Method - - M:System.Collections.Generic.IEnumerable`1.GetEnumerator - - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IEnumerator<System.CommandLine.Completions.ICompletionSource> - - - - Returns an enumerator that iterates through the collection. - An enumerator that can be used to iterate through the collection. - To be added. - - - - - - - - - - - Property - - P:System.Collections.Generic.IReadOnlyList`1.Item(System.Int32) - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Completions.ICompletionSource - - - - - - The zero-based index of the element to get. - Gets the element at the specified index in the read-only list. - The element at the specified index in the read-only list. - To be added. - - - - - - - - - - - Method - - M:System.Collections.IEnumerable.GetEnumerator - - - System.CommandLine - 2.0.0.0 - - - System.Collections.IEnumerator - - - - Returns an enumerator that iterates through a collection. - An object that can be used to iterate through the collection. - - instance is cast to an interface. - - ]]> - - - - - diff --git a/xml/System.CommandLine/ConsoleExtensions.xml b/xml/System.CommandLine/ConsoleExtensions.xml deleted file mode 100644 index 0b4a75f99e0..00000000000 --- a/xml/System.CommandLine/ConsoleExtensions.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides extension methods for . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - The console to write to. - The value to write. - - Writes the current string value to the standard output stream. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - The console to write to. - The value to write. - - Writes the current string value, followed by the current environment's line terminator, to the standard output stream. - - To be added. - - - - diff --git a/xml/System.CommandLine/DirectiveCollection.xml b/xml/System.CommandLine/DirectiveCollection.xml deleted file mode 100644 index b285640c16d..00000000000 --- a/xml/System.CommandLine/DirectiveCollection.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String,System.Collections.Generic.IEnumerable<System.String>>> - - - System.Collections.IEnumerable - - - - - A collection of directives parsed from a command line. - - A directive is specified on the command line using square brackets, containing no spaces and preceding other tokens unless they are also directives. In the following example, two directives are present, directive-one and directive-two: - > myapp [directive-one] [directive-two:value] arg1 arg2 - The second has a value specified as well, value. Directive values can be read by calling using . - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - The name of the directive. - - Gets a value determining whether a directive with the specified name was parsed. - - - if a directive with the specified name was parsed; otherwise, . - To be added. - - - - - - - - - - Method - - M:System.Collections.Generic.IEnumerable`1.GetEnumerator - - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<System.String,System.Collections.Generic.IEnumerable<System.String>>> - - - - Returns an enumerator that iterates through the collection. - An enumerator that can be used to iterate through the collection. - To be added. - - - - - - - - - - - Method - - M:System.Collections.IEnumerable.GetEnumerator - - - System.CommandLine - 2.0.0.0 - - - System.Collections.IEnumerator - - - - Returns an enumerator that iterates through a collection. - An object that can be used to iterate through the collection. - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - - [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - [<System.Diagnostics.CodeAnalysis.NotNullWhen(true)>] - - - - - - The name of the directive. - The values provided for the specified directive. - - Gets the values specified for a given directive. A return value indicates whether the specified directive name was present. - - - if a directive with the specified name was parsed; otherwise, . - To be added. - - - - diff --git a/xml/System.CommandLine/Handler.xml b/xml/System.CommandLine/Handler.xml deleted file mode 100644 index 81c1f6142f5..00000000000 --- a/xml/System.CommandLine/Handler.xml +++ /dev/null @@ -1,904 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides methods for creating and working with command handlers. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - Sets a command's handler based on an . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - Sets a command's handler based on an . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - Sets a command's handler based on a . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - Sets a command's handler based on a . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on an . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on a . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on an . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on a . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on an . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on a . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on an . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on a . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on an . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on a . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on an . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on a . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on an . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on a . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on an . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - - - - - - - - - - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - Sets a command's handler based on a . - - To be added. - - - - diff --git a/xml/System.CommandLine/IConsole.xml b/xml/System.CommandLine/IConsole.xml deleted file mode 100644 index b849373e01f..00000000000 --- a/xml/System.CommandLine/IConsole.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Rendering - 0.4.0.0 - - - - System.CommandLine.IO.IStandardError - - - System.CommandLine.IO.IStandardIn - - - System.CommandLine.IO.IStandardOut - - - - - Represents the standard console input, output, and error streams. - - To be added. - - - diff --git a/xml/System.CommandLine/IdentifierSymbol.xml b/xml/System.CommandLine/IdentifierSymbol.xml deleted file mode 100644 index dae37e84bae..00000000000 --- a/xml/System.CommandLine/IdentifierSymbol.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Symbol - - - - - A symbol, such as an option or command, having one or more fixed names in a command line interface. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - The description of the symbol, which is displayed in command line help. - - Initializes a new instance of the class. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - The name of the symbol. - The description of the symbol, which is displayed in command line help. - - Initializes a new instance of the class. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The alias to add. - - Adds an alias. - - - You can add multiple aliases for a symbol. - - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IReadOnlyCollection<System.String> - - - - Gets the set of strings that can be used on the command line to specify the symbol. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - The alias to search for. - - Determines whether the specified alias has already been defined. - - - if the alias has already been defined; otherwise . - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - Gets or sets the symbol name. - To be added. - To be added. - - - - - diff --git a/xml/System.CommandLine/LocalizationResources.xml b/xml/System.CommandLine/LocalizationResources.xml deleted file mode 100644 index 7cfaeff3bbe..00000000000 --- a/xml/System.CommandLine/LocalizationResources.xml +++ /dev/null @@ -1,990 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides localizable strings for help and error messages. - - To be added. - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - Initializes a new instance of the class. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - - To be added. - To be added. - - Interpolates values into a localized string similar to Cannot parse argument '{0}' as expected type {1}.. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - - - To be added. - To be added. - To be added. - - Interpolates values into a localized string similar to Cannot parse argument '{0}' for command '{1}' as expected type {2}.. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - - - To be added. - To be added. - To be added. - - Interpolates values into a localized string similar to Cannot parse argument '{0}' for option '{1}' as expected type {2}.. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to Directory does not exist: {0}. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - - To be added. - To be added. - - Interpolates values into a localized string similar to Error reading response file '{0}': {1}. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Unhandled exception: . - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - - - To be added. - To be added. - To be added. - - Interpolates values into a localized string similar to Command '{0}' expects no more than {1} arguments, but {2} were provided. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to Command '{0}' expects a single argument but {1} were provided. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to File does not exist: {0}. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to File or directory does not exist: {0}. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The string template into which values will be interpolated. - The values to interpolate. - - Interpolates values into a localized string. - - The final string after interpolation. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Arguments passed to the application that is being run.. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Additional Arguments:. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to default. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Arguments:. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Commands:. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Description:. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Show help and usage information. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to (REQUIRED). - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Options:. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to [[--] <additional arguments>...]]. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to [command]. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to [options]. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Usage:. - - To be added. - To be added. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.LocalizationResources - - - - Gets a global instance of the class. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to Character not allowed in a file name: {0}. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to Character not allowed in a path: {0}. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to No argument was provided for Command '{0}'.. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to Required argument missing for command: {0}. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Required command was not provided. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to Response file not found '{0}'. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to '{0}' was not matched. Did you mean one of the following?. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - - To be added. - To be added. - - Interpolates values into a localized string similar to Argument '{0}' not recognized. Must be one of:{1}. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to Unrecognized command or argument '{0}'. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - - To be added. - - Interpolates values into a localized string similar to {0} option cannot be combined with other arguments.. - - To be added. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.String - - - - - Interpolates values into a localized string similar to Show version information. - - To be added. - To be added. - - - - diff --git a/xml/System.CommandLine/Option.xml b/xml/System.CommandLine/Option.xml index 1464b6daa75..7b986cb99f1 100644 --- a/xml/System.CommandLine/Option.xml +++ b/xml/System.CommandLine/Option.xml @@ -1,27 +1,18 @@ - - + + - - - - - - - - + + + System.CommandLine 2.0.0.0 System.CommandLine.Symbol - System.CommandLine.IdentifierSymbol - - System.CommandLine.Binding.IValueDescriptor - @@ -34,7 +25,6 @@ A symbol defining a named parameter and a value for that parameter. To be added. - @@ -50,8 +40,8 @@ 2.0.0.0 - - + + The name of the option. This is used during parsing and is displayed in help. @@ -92,32 +82,6 @@ To be added. - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - A delegate used to validate the produced during parsing. - - Adds a validator that will be called when the option is matched by the parser. - - To be added. - - @@ -173,41 +137,13 @@ - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - - Gets or sets the name of the argument when displayed in help. - - - The name of the argument when displayed in help. - - To be added. - - - + - + - - - - + Property System.CommandLine @@ -297,34 +233,6 @@ To be added. - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - - - The alias, which can include a prefix. - - Indicates whether a given alias exists on the option, regardless of its prefix. - - - if the alias exists; otherwise, . - To be added. - - @@ -379,51 +287,6 @@ Useful for localization, as it's not used for actual parsing. - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - Indicates whether the option is required when its parent command is invoked. - - To be added. - When an option is required and its parent command is invoked without it, an error results. - - - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.String - - - To be added. - To be added. - To be added. - - - @@ -470,132 +333,6 @@ When an option is required and its parent command is invoked without it, an error results. - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The default value for the option. - - Sets the default value for the option. - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Void - - - - - - The delegate to invoke to return the default value. - - Sets a delegate to invoke when the default value for the option is required. - - To be added. - Thrown when is null. - - - - - - - - - - Method - - M:System.CommandLine.Binding.IValueDescriptor.GetDefaultValue - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - Gets the default value, if any. - To be added. - To be added. - - - - - - - - - - Property - - P:System.CommandLine.Binding.IValueDescriptor.HasDefaultValue - - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether there is a default value. - To be added. - To be added. - - - - - - - - - - Property - - P:System.CommandLine.Binding.IValueDescriptor.ValueName - - - System.CommandLine - 2.0.0.0 - - - System.String - - - Gets the name of the value. - To be added. - To be added. - - @@ -620,19 +357,13 @@ - + - + - - - - + Property - - P:System.CommandLine.Binding.IValueDescriptor.ValueType - System.CommandLine 2.0.0.0 diff --git a/xml/System.CommandLine/OptionExtensions.xml b/xml/System.CommandLine/OptionExtensions.xml deleted file mode 100644 index 7538ee7b16c..00000000000 --- a/xml/System.CommandLine/OptionExtensions.xml +++ /dev/null @@ -1,430 +0,0 @@ - - - - - - - - - System.CommandLine - 2.0.0.0 - - - System.Object - - - - - Provides extension methods for . - - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TOption - - - - - System.CommandLine.Option - - - - - - - - - The type of the option. - The option for which to add completions. - A that will be called to provide completions. - - Adds completions for an option. - - The option being extended. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TOption - - - - - System.CommandLine.Option - - - - - - - - - The type of the option. - The option for which to add completions. - A that will be called to provide completions. - - Adds completions for an option. - - The option being extended. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TOption - - - - - System.CommandLine.Option - - - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The type of the . - The option for which to add completions. - The completions to add. - - Adds completions for an option. - - The option being extended. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Option<System.IO.DirectoryInfo> - - - - - - The option to configure. - - Configures an option to accept only values corresponding to an existing directory. - - The option being extended. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Option<System.IO.FileInfo> - - - - - - The option to configure. - - Configures an option to accept only values corresponding to an existing file. - - The option being extended. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Option<System.IO.FileSystemInfo> - - - - - - The option to configure. - - Configures an option to accept only values corresponding to an existing file or directory. - - The option being extended. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Option<T> - - - - - System.Collections.Generic.IEnumerable<System.IO.FileSystemInfo> - - - - - - - - To be added. - The option to configure. - - Configures an option to accept only values corresponding to a existing files or directories. - - The option being extended. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TOption - - - - - System.CommandLine.Option - - - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The type of the option's parsed value. - The option to configure. - The values that are allowed for the option. - - Configures an option to accept only the specified values, and to suggest them as command line completions. - - The configured argument. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TOption - - - - - System.CommandLine.Option - - - - - - - - To be added. - The option to configure. - - Configures an option to accept only values representing legal file names. - - The option being extended. - A parse error will result, for example, if file path separators are found in the parsed value. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - TOption - - - - - System.CommandLine.Option - - - - - - - - To be added. - The option to configure. - - Configures an option to accept only values representing legal file paths. - - The option being extended. - To be added. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ParseResult - - - - - - - The option to use to parse the command line input. - A command line string to parse, which can include spaces and quotes equivalent to what can be entered into a terminal. - - Parses a command line string value using an option. - - A parse result describing the outcome of the parse operation. - The command line string input will be split into tokens as if it had been passed on the command line. - - - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.Parsing.ParseResult - - - - - - - The option to use to parse the command line input. - The string options to parse. - - Parses a command line string value using an option. - - A parse result describing the outcome of the parse operation. - To be added. - - - - diff --git a/xml/System.CommandLine/Option`1.xml b/xml/System.CommandLine/Option`1.xml index 05abe78c5f5..b1254e25401 100644 --- a/xml/System.CommandLine/Option`1.xml +++ b/xml/System.CommandLine/Option`1.xml @@ -1,15 +1,10 @@ - - + + - - - - - - - - + + + System.CommandLine 2.0.0.0 @@ -28,12 +23,6 @@ System.CommandLine.Option - - System.CommandLine.Binding.IValueDescriptor - - - System.CommandLine.Binding.IValueDescriptor<T> - @@ -48,29 +37,6 @@ - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - To be added. - To be added. - To be added. - To be added. - - - @@ -84,8 +50,8 @@ 2.0.0.0 - - + + [System.ParamArray] @@ -103,133 +69,6 @@ To be added. - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - To be added. - To be added. - Initializes a new instance of the class. - To be added. - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - - To be added. - To be added. - To be added. - Initializes a new instance of the class. - To be added. - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - - To be added. - To be added. - To be added. - Initializes a new instance of the class. - To be added. - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - - - To be added. - To be added. - To be added. - To be added. - Initializes a new instance of the class. - To be added. - - - - - - - - - - Constructor - - System.CommandLine - 2.0.0.0 - - - - - - - - - To be added. - To be added. - To be added. - To be added. - Initializes a new instance of the class. - To be added. - - - @@ -294,7 +133,7 @@ System.CommandLine.Option<T> - + [System.ParamArray] @@ -312,28 +151,6 @@ To be added. - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.CommandLine.ArgumentArity - - - To be added. - To be added. - To be added. - - - diff --git a/xml/System.CommandLine/RootCommand.xml b/xml/System.CommandLine/RootCommand.xml index e2cbb99f28e..1468e8a4d86 100644 --- a/xml/System.CommandLine/RootCommand.xml +++ b/xml/System.CommandLine/RootCommand.xml @@ -66,7 +66,7 @@ System.Void - + To be added. diff --git a/xml/System.CommandLine/Symbol.xml b/xml/System.CommandLine/Symbol.xml index e11fce3b44f..f72e23964c4 100644 --- a/xml/System.CommandLine/Symbol.xml +++ b/xml/System.CommandLine/Symbol.xml @@ -1,15 +1,10 @@ - - + + - - - - - - - - + + + System.CommandLine 2.0.0.0 @@ -18,9 +13,6 @@ System.Object - - System.CommandLine.Completions.ICompletionSource - @@ -36,15 +28,12 @@ - + - + - - - - + Property System.CommandLine @@ -67,30 +56,6 @@ To be added. - - - - - - - - Method - - System.CommandLine - 2.0.0.0 - - - System.Collections.Generic.IEnumerable<System.CommandLine.Completions.CompletionItem> - - - - - Gets completions for the symbol. - - To be added. - To be added. - - @@ -99,9 +64,6 @@ Method - - M:System.CommandLine.Completions.ICompletionSource.GetCompletions(System.CommandLine.Completions.CompletionContext) - System.CommandLine 2.0.0.0 @@ -145,40 +107,13 @@ To be added. - - - - - - - - Property - - System.CommandLine - 2.0.0.0 - - - System.Boolean - - - - Gets or sets a value indicating whether the symbol is hidden. - - To be added. - To be added. - - - + - - - - - - - + + + Property System.CommandLine @@ -208,14 +143,10 @@ 2.0.0.0 - + [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Symbol+<get_Parents>d__18))] [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Symbol+<get_Parents>d__18))>] - - [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Symbol+<get_Parents>d__20))] - [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Symbol+<get_Parents>d__20))>] - System.Collections.Generic.IEnumerable<System.CommandLine.Symbol>