From 0e6af4f67c6ad96167d33c7d7e865a0e41bfe6de Mon Sep 17 00:00:00 2001 From: Alma Jenks Date: Tue, 22 Mar 2022 16:26:31 -0700 Subject: [PATCH] Adding commandline API --- xml/FrameworksIndex/system-commandline.xml | 595 ++++++ .../BinderBase`1.xml | 211 ++ .../BindingContext.xml | 161 ++ xml/System.CommandLine.Binding/BoundValue.xml | 149 ++ .../IValueDescriptor.xml | 114 + .../IValueDescriptor`1.xml | 31 + .../IValueSource.xml | 53 + .../CommandLineBuilder.xml | 184 ++ .../CommandLineBuilderExtensions.xml | 700 ++++++ .../CompletionContext.xml | 94 + .../CompletionDelegate.xml | 29 + .../CompletionItem.xml | 291 +++ .../ICompletionSource.xml | 48 + .../TextCompletionContext.xml | 97 + .../TokenCompletionContext.xml | 23 + .../HelpBuilder+Default.xml | 335 +++ xml/System.CommandLine.Help/HelpBuilder.xml | 232 ++ .../HelpBuilderExtensions.xml | 87 + xml/System.CommandLine.Help/HelpContext.xml | 142 ++ .../HelpSectionDelegate.xml | 30 + .../TwoColumnHelpRow.xml | 175 ++ xml/System.CommandLine.IO/IStandardError.xml | 67 + xml/System.CommandLine.IO/IStandardIn.xml | 44 + xml/System.CommandLine.IO/IStandardOut.xml | 67 + .../IStandardStreamWriter.xml | 47 + .../StandardStreamWriter.xml | 132 ++ xml/System.CommandLine.IO/SystemConsole.xml | 181 ++ xml/System.CommandLine.IO/TestConsole.xml | 166 ++ .../ICommandHandler.xml | 48 + .../IInvocationResult.xml | 47 + .../InvocationContext.xml | 254 +++ .../InvocationMiddleware.xml | 31 + .../MiddlewareOrder.xml | 111 + .../ArgumentResult.xml | 148 ++ .../CommandLineStringSplitter.xml | 78 + .../CommandResult.xml | 70 + .../OptionResult.xml | 150 ++ .../ParseArgument`1.xml | 37 + xml/System.CommandLine.Parsing/ParseError.xml | 93 + .../ParseResult.xml | 503 +++++ .../ParseResultExtensions.xml | 137 ++ xml/System.CommandLine.Parsing/Parser.xml | 137 ++ .../ParserExtensions.xml | 173 ++ .../ResponseFileHandling.xml | 92 + .../SymbolResult.xml | 378 ++++ xml/System.CommandLine.Parsing/Token.xml | 266 +++ xml/System.CommandLine.Parsing/TokenType.xml | 161 ++ .../TokenizeError.xml | 70 + .../ValidateSymbolResult`1.xml | 37 + xml/System.CommandLine/Argument.xml | 396 ++++ xml/System.CommandLine/ArgumentArity.xml | 305 +++ xml/System.CommandLine/ArgumentExtensions.xml | 430 ++++ xml/System.CommandLine/Argument`1.xml | 204 ++ xml/System.CommandLine/Command.xml | 498 +++++ xml/System.CommandLine/CommandExtensions.xml | 209 ++ .../CommandLineConfiguration.xml | 203 ++ .../CommandLineConfigurationException.xml | 118 ++ .../CompletionSourceExtensions.xml | 115 + .../CompletionSourceList.xml | 214 ++ xml/System.CommandLine/ConsoleExtensions.xml | 80 + .../DirectiveCollection.xml | 167 ++ xml/System.CommandLine/Handler.xml | 1872 +++++++++++++++++ xml/System.CommandLine/IConsole.xml | 30 + xml/System.CommandLine/IdentifierSymbol.xml | 169 ++ .../LocalizationResources.xml | 990 +++++++++ xml/System.CommandLine/Option.xml | 446 ++++ xml/System.CommandLine/OptionExtensions.xml | 430 ++++ xml/System.CommandLine/Option`1.xml | 206 ++ xml/System.CommandLine/RootCommand.xml | 94 + xml/System.CommandLine/Symbol.xml | 202 ++ xml/ns-System.CommandLine.Binding.xml | 6 + xml/ns-System.CommandLine.Builder.xml | 6 + xml/ns-System.CommandLine.Completions.xml | 6 + xml/ns-System.CommandLine.Help.xml | 6 + xml/ns-System.CommandLine.IO.xml | 6 + xml/ns-System.CommandLine.Invocation.xml | 6 + xml/ns-System.CommandLine.Parsing.xml | 6 + xml/ns-System.CommandLine.xml | 6 + 78 files changed, 14932 insertions(+) create mode 100644 xml/FrameworksIndex/system-commandline.xml create mode 100644 xml/System.CommandLine.Binding/BinderBase`1.xml create mode 100644 xml/System.CommandLine.Binding/BindingContext.xml create mode 100644 xml/System.CommandLine.Binding/BoundValue.xml create mode 100644 xml/System.CommandLine.Binding/IValueDescriptor.xml create mode 100644 xml/System.CommandLine.Binding/IValueDescriptor`1.xml create mode 100644 xml/System.CommandLine.Binding/IValueSource.xml create mode 100644 xml/System.CommandLine.Builder/CommandLineBuilder.xml create mode 100644 xml/System.CommandLine.Builder/CommandLineBuilderExtensions.xml create mode 100644 xml/System.CommandLine.Completions/CompletionContext.xml create mode 100644 xml/System.CommandLine.Completions/CompletionDelegate.xml create mode 100644 xml/System.CommandLine.Completions/CompletionItem.xml create mode 100644 xml/System.CommandLine.Completions/ICompletionSource.xml create mode 100644 xml/System.CommandLine.Completions/TextCompletionContext.xml create mode 100644 xml/System.CommandLine.Completions/TokenCompletionContext.xml create mode 100644 xml/System.CommandLine.Help/HelpBuilder+Default.xml create mode 100644 xml/System.CommandLine.Help/HelpBuilder.xml create mode 100644 xml/System.CommandLine.Help/HelpBuilderExtensions.xml create mode 100644 xml/System.CommandLine.Help/HelpContext.xml create mode 100644 xml/System.CommandLine.Help/HelpSectionDelegate.xml create mode 100644 xml/System.CommandLine.Help/TwoColumnHelpRow.xml create mode 100644 xml/System.CommandLine.IO/IStandardError.xml create mode 100644 xml/System.CommandLine.IO/IStandardIn.xml create mode 100644 xml/System.CommandLine.IO/IStandardOut.xml create mode 100644 xml/System.CommandLine.IO/IStandardStreamWriter.xml create mode 100644 xml/System.CommandLine.IO/StandardStreamWriter.xml create mode 100644 xml/System.CommandLine.IO/SystemConsole.xml create mode 100644 xml/System.CommandLine.IO/TestConsole.xml create mode 100644 xml/System.CommandLine.Invocation/ICommandHandler.xml create mode 100644 xml/System.CommandLine.Invocation/IInvocationResult.xml create mode 100644 xml/System.CommandLine.Invocation/InvocationContext.xml create mode 100644 xml/System.CommandLine.Invocation/InvocationMiddleware.xml create mode 100644 xml/System.CommandLine.Invocation/MiddlewareOrder.xml create mode 100644 xml/System.CommandLine.Parsing/ArgumentResult.xml create mode 100644 xml/System.CommandLine.Parsing/CommandLineStringSplitter.xml create mode 100644 xml/System.CommandLine.Parsing/CommandResult.xml create mode 100644 xml/System.CommandLine.Parsing/OptionResult.xml create mode 100644 xml/System.CommandLine.Parsing/ParseArgument`1.xml create mode 100644 xml/System.CommandLine.Parsing/ParseError.xml create mode 100644 xml/System.CommandLine.Parsing/ParseResult.xml create mode 100644 xml/System.CommandLine.Parsing/ParseResultExtensions.xml create mode 100644 xml/System.CommandLine.Parsing/Parser.xml create mode 100644 xml/System.CommandLine.Parsing/ParserExtensions.xml create mode 100644 xml/System.CommandLine.Parsing/ResponseFileHandling.xml create mode 100644 xml/System.CommandLine.Parsing/SymbolResult.xml create mode 100644 xml/System.CommandLine.Parsing/Token.xml create mode 100644 xml/System.CommandLine.Parsing/TokenType.xml create mode 100644 xml/System.CommandLine.Parsing/TokenizeError.xml create mode 100644 xml/System.CommandLine.Parsing/ValidateSymbolResult`1.xml create mode 100644 xml/System.CommandLine/Argument.xml create mode 100644 xml/System.CommandLine/ArgumentArity.xml create mode 100644 xml/System.CommandLine/ArgumentExtensions.xml create mode 100644 xml/System.CommandLine/Argument`1.xml create mode 100644 xml/System.CommandLine/Command.xml create mode 100644 xml/System.CommandLine/CommandExtensions.xml create mode 100644 xml/System.CommandLine/CommandLineConfiguration.xml create mode 100644 xml/System.CommandLine/CommandLineConfigurationException.xml create mode 100644 xml/System.CommandLine/CompletionSourceExtensions.xml create mode 100644 xml/System.CommandLine/CompletionSourceList.xml create mode 100644 xml/System.CommandLine/ConsoleExtensions.xml create mode 100644 xml/System.CommandLine/DirectiveCollection.xml create mode 100644 xml/System.CommandLine/Handler.xml create mode 100644 xml/System.CommandLine/IConsole.xml create mode 100644 xml/System.CommandLine/IdentifierSymbol.xml create mode 100644 xml/System.CommandLine/LocalizationResources.xml create mode 100644 xml/System.CommandLine/Option.xml create mode 100644 xml/System.CommandLine/OptionExtensions.xml create mode 100644 xml/System.CommandLine/Option`1.xml create mode 100644 xml/System.CommandLine/RootCommand.xml create mode 100644 xml/System.CommandLine/Symbol.xml create mode 100644 xml/ns-System.CommandLine.Binding.xml create mode 100644 xml/ns-System.CommandLine.Builder.xml create mode 100644 xml/ns-System.CommandLine.Completions.xml create mode 100644 xml/ns-System.CommandLine.Help.xml create mode 100644 xml/ns-System.CommandLine.IO.xml create mode 100644 xml/ns-System.CommandLine.Invocation.xml create mode 100644 xml/ns-System.CommandLine.Parsing.xml create mode 100644 xml/ns-System.CommandLine.xml diff --git a/xml/FrameworksIndex/system-commandline.xml b/xml/FrameworksIndex/system-commandline.xml new file mode 100644 index 00000000000..c8f1210739d --- /dev/null +++ b/xml/FrameworksIndex/system-commandline.xml @@ -0,0 +1,595 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/xml/System.CommandLine.Binding/BinderBase`1.xml b/xml/System.CommandLine.Binding/BinderBase`1.xml new file mode 100644 index 00000000000..ddfa1b5d1df --- /dev/null +++ b/xml/System.CommandLine.Binding/BinderBase`1.xml @@ -0,0 +1,211 @@ + + + + + + + + + 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 + + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + P:System.CommandLine.Binding.IValueDescriptor.HasDefaultValue + + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + P:System.CommandLine.Binding.IValueDescriptor.ValueName + + + System.CommandLine + 2.0.0.0 + + + System.String + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + P:System.CommandLine.Binding.IValueDescriptor.ValueType + + + System.CommandLine + 2.0.0.0 + + + System.Type + + + To be added. + 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 + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine.Binding/BindingContext.xml b/xml/System.CommandLine.Binding/BindingContext.xml new file mode 100644 index 00000000000..d5c3337427f --- /dev/null +++ b/xml/System.CommandLine.Binding/BindingContext.xml @@ -0,0 +1,161 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + System.IServiceProvider + + + + + Creates object instances based on command line parser results, injected services, and other value sources. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Void + + + + + + + The type for which this service factory will provide an instance. + A delegate that provides an instance of the specified service type. + + Adds the specified service factory to the binding context. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Void + + + + + + + + + The type for which this service factory will provide an instance. + A delegate that provides an instance of the specified service type. + + Adds the specified service factory to the binding context. + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.IConsole + + + + The console to which output should be written during the current invocation. + + To be added. + To be added. + + + + + + + + + + Method + + M:System.IServiceProvider.GetService(System.Type) + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + + To be added. + To be added. + 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.Binding/BoundValue.xml b/xml/System.CommandLine.Binding/BoundValue.xml new file mode 100644 index 00000000000..593150268ff --- /dev/null +++ b/xml/System.CommandLine.Binding/BoundValue.xml @@ -0,0 +1,149 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.ValueType + + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + + A value created by binding command line input. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Binding.BoundValue + + + + + + A value descriptor for which to get the default value. + + Gets a representing the default value for a specified . + + A representing the default value for a specified . + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.String + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + The value bound from the specified source. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Binding.IValueDescriptor + + + + The descriptor for the bound value. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Binding.IValueSource + + + + The source from which the value was bound. + + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine.Binding/IValueDescriptor.xml b/xml/System.CommandLine.Binding/IValueDescriptor.xml new file mode 100644 index 00000000000..481facf43d7 --- /dev/null +++ b/xml/System.CommandLine.Binding/IValueDescriptor.xml @@ -0,0 +1,114 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + + + Describes and provides access to a bindable named value. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 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.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.String + + + + The name of the value. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 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 new file mode 100644 index 00000000000..7b1c5ce31c8 --- /dev/null +++ b/xml/System.CommandLine.Binding/IValueDescriptor`1.xml @@ -0,0 +1,31 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..48c3fea4696 --- /dev/null +++ b/xml/System.CommandLine.Binding/IValueSource.xml @@ -0,0 +1,53 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + + + Binds a value from a based on a . + + To be added. + + + + + + + + + + Method + + 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. + 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 new file mode 100644 index 00000000000..3cb30719064 --- /dev/null +++ b/xml/System.CommandLine.Builder/CommandLineBuilder.xml @@ -0,0 +1,184 @@ + + + + + + + + + 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. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + Determines whether the parser recognizes command line directives. + + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + 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. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + Determines whether the parser recognize and expands POSIX-style bundled options. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.ResponseFileHandling + + + + Configures the parser's handling of response files. When enabled, a command line token beginning with @ that is a valid file path will be expanded as though inserted into the command line. + + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine.Builder/CommandLineBuilderExtensions.xml b/xml/System.CommandLine.Builder/CommandLineBuilderExtensions.xml new file mode 100644 index 00000000000..9254192de6f --- /dev/null +++ b/xml/System.CommandLine.Builder/CommandLineBuilderExtensions.xml @@ -0,0 +1,700 @@ + + + + + + + + + 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 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. + A command line builder. + + 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. + If set to , then directives are enabled. Otherwise, they are parsed like 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 + + + + + + + To be added. + To be added. + + 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. + If set to , then POSIX bundles are parsed. ; 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 + + + + + + + Specifies whether or how response files are parsed. + A command line builder. + To be added. + The same instance of . + To be added. + + + + + + + + + + + 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 + + + + + + + The exit code to use when parser errors occur. + A command line builder. + + 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. + 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>] + + + + + + One or more aliases to use instead of the default to signal that version information should be displayed. + A command line builder. + 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 new file mode 100644 index 00000000000..5a6e87b909d --- /dev/null +++ b/xml/System.CommandLine.Completions/CompletionContext.xml @@ -0,0 +1,94 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + Supports command line completion operations. + + To be added. + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + 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. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.ParseResult + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + To be added. + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine.Completions/CompletionDelegate.xml b/xml/System.CommandLine.Completions/CompletionDelegate.xml new file mode 100644 index 00000000000..15eb8e32e01 --- /dev/null +++ b/xml/System.CommandLine.Completions/CompletionDelegate.xml @@ -0,0 +1,29 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..37be2de043e --- /dev/null +++ b/xml/System.CommandLine.Completions/CompletionItem.xml @@ -0,0 +1,291 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + Provides details about a command line completion item. + + To be added. + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + + + + + The label value, which is the text displayed to users and, unless is set, is also used to populate the property. + The kind of completion item. + The value used to sort the completion item in a list. If this is not provided, then is used. + The text to be inserted by this completion item. If this is not provided, then is used. + Documentation about the completion item. + Additional details regarding the completion item. + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + Additional details regarding the completion item. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + Documentation about the completion item. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + + Determines whether two completion items are equal. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The text to be inserted by this completion item. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The kind of completion item. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The label value, which is the text displayed to users. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The value used to sort the completion item in a list. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.String + + + + To be added. + To be added. + To be added. + + + + + diff --git a/xml/System.CommandLine.Completions/ICompletionSource.xml b/xml/System.CommandLine.Completions/ICompletionSource.xml new file mode 100644 index 00000000000..16982ddf8c5 --- /dev/null +++ b/xml/System.CommandLine.Completions/ICompletionSource.xml @@ -0,0 +1,48 @@ + + + + + + + + + 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/TextCompletionContext.xml b/xml/System.CommandLine.Completions/TextCompletionContext.xml new file mode 100644 index 00000000000..6ea98f93d36 --- /dev/null +++ b/xml/System.CommandLine.Completions/TextCompletionContext.xml @@ -0,0 +1,97 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Completions.CompletionContext + + + + + Provides details for calculating completions in the context of complete, unsplit command line text. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Completions.TextCompletionContext + + + + + + The cursor position at which completions are calculated. + + Creates a new instance of at the specified cursor position. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The complete text of the command line prior to splitting, including any additional whitespace. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + The position of the cursor within the command line. + + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine.Completions/TokenCompletionContext.xml b/xml/System.CommandLine.Completions/TokenCompletionContext.xml new file mode 100644 index 00000000000..91c0722042b --- /dev/null +++ b/xml/System.CommandLine.Completions/TokenCompletionContext.xml @@ -0,0 +1,23 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..67e44ea51d4 --- /dev/null +++ b/xml/System.CommandLine.Help/HelpBuilder+Default.xml @@ -0,0 +1,335 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..f14f7f1cfb3 --- /dev/null +++ b/xml/System.CommandLine.Help/HelpBuilder.xml @@ -0,0 +1,232 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..074b197956b --- /dev/null +++ b/xml/System.CommandLine.Help/HelpBuilderExtensions.xml @@ -0,0 +1,87 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..901b9530209 --- /dev/null +++ b/xml/System.CommandLine.Help/HelpContext.xml @@ -0,0 +1,142 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..c97743907b4 --- /dev/null +++ b/xml/System.CommandLine.Help/HelpSectionDelegate.xml @@ -0,0 +1,30 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..3552c350689 --- /dev/null +++ b/xml/System.CommandLine.Help/TwoColumnHelpRow.xml @@ -0,0 +1,175 @@ + + + + + + + + + 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 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + 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 new file mode 100644 index 00000000000..47b8fcb94be --- /dev/null +++ b/xml/System.CommandLine.IO/IStandardError.xml @@ -0,0 +1,67 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + + + Represents a console's standard error stream. + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.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.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 new file mode 100644 index 00000000000..a1cc91d3afa --- /dev/null +++ b/xml/System.CommandLine.IO/IStandardIn.xml @@ -0,0 +1,44 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + + + Represents a console's standard input stream. + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.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 new file mode 100644 index 00000000000..572e2b89323 --- /dev/null +++ b/xml/System.CommandLine.IO/IStandardOut.xml @@ -0,0 +1,67 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + + + Represents a console's standard output stream. + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.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.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 new file mode 100644 index 00000000000..3dbb18f59a6 --- /dev/null +++ b/xml/System.CommandLine.IO/IStandardStreamWriter.xml @@ -0,0 +1,47 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + + + Represents a standard stream that can be written to. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.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 new file mode 100644 index 00000000000..2961ad0aa1b --- /dev/null +++ b/xml/System.CommandLine.IO/StandardStreamWriter.xml @@ -0,0 +1,132 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + Provides methods for working with standard streams. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.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.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.Void + + + + + + The writer to write to. + + Appends the current environment's line terminator. + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.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 new file mode 100644 index 00000000000..ac60899f4f8 --- /dev/null +++ b/xml/System.CommandLine.IO/SystemConsole.xml @@ -0,0 +1,181 @@ + + + + + + + + + System.CommandLine + 2.0.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 + + + + + Initializes a new instance of . + + To be added. + + + + + + + + + + Property + + P:System.CommandLine.IO.IStandardError.Error + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.IO.IStandardStreamWriter + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + P:System.CommandLine.IO.IStandardError.IsErrorRedirected + + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + P:System.CommandLine.IO.IStandardIn.IsInputRedirected + + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + P:System.CommandLine.IO.IStandardOut.IsOutputRedirected + + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + P:System.CommandLine.IO.IStandardOut.Out + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.IO.IStandardStreamWriter + + + To be added. + To be added. + To be added. + + + + + diff --git a/xml/System.CommandLine.IO/TestConsole.xml b/xml/System.CommandLine.IO/TestConsole.xml new file mode 100644 index 00000000000..9a0124c12e7 --- /dev/null +++ b/xml/System.CommandLine.IO/TestConsole.xml @@ -0,0 +1,166 @@ + + + + + + + + + System.CommandLine + 2.0.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 + + + + + Initializes a new instance of . + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.IO.IStandardStreamWriter + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.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 new file mode 100644 index 00000000000..657ec81fec7 --- /dev/null +++ b/xml/System.CommandLine.Invocation/ICommandHandler.xml @@ -0,0 +1,48 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + + + Defines the behavior of a command. + + 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 new file mode 100644 index 00000000000..cb89d4d9f6d --- /dev/null +++ b/xml/System.CommandLine.Invocation/IInvocationResult.xml @@ -0,0 +1,47 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..8a21f94f4bf --- /dev/null +++ b/xml/System.CommandLine.Invocation/InvocationContext.xml @@ -0,0 +1,254 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..52b9caba7bd --- /dev/null +++ b/xml/System.CommandLine.Invocation/InvocationMiddleware.xml @@ -0,0 +1,31 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..7156c458ede --- /dev/null +++ b/xml/System.CommandLine.Invocation/MiddlewareOrder.xml @@ -0,0 +1,111 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..1fec0409675 --- /dev/null +++ b/xml/System.CommandLine.Parsing/ArgumentResult.xml @@ -0,0 +1,148 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.SymbolResult + + + + + A result produced when parsing an . + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Argument + + + + The argument to which the result applies. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + T + + + + + + + To be added. + + Gets the parsed value or the default value for . + + The parsed value or the default value for + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Void + + + + + + The number of tokens to take. The rest are passed on. + + Specifies the maximum number of tokens to consume for the argument. Remaining tokens are passed on and can be consumed by later arguments, or will otherwise be added to + To be added. + numberOfTokens - Value must be at least 1. + Thrown if this method is called more than once. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.String + + + + To be added. + To be added. + To be added. + + + + + diff --git a/xml/System.CommandLine.Parsing/CommandLineStringSplitter.xml b/xml/System.CommandLine.Parsing/CommandLineStringSplitter.xml new file mode 100644 index 00000000000..5a045e5671c --- /dev/null +++ b/xml/System.CommandLine.Parsing/CommandLineStringSplitter.xml @@ -0,0 +1,78 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..d543ecef54c --- /dev/null +++ b/xml/System.CommandLine.Parsing/CommandResult.xml @@ -0,0 +1,70 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.SymbolResult + + + + + A result produced when parsing a . + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Command + + + + The command to which the result applies. + + To be added. + 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 new file mode 100644 index 00000000000..585e82f9f74 --- /dev/null +++ b/xml/System.CommandLine.Parsing/OptionResult.xml @@ -0,0 +1,150 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.SymbolResult + + + + + A result produced when parsing an . + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + T + + + [System.Diagnostics.CodeAnalysis.MaybeNull] + [<System.Diagnostics.CodeAnalysis.MaybeNull>] + + + + + + + + + To be added. + + Gets the parsed value or the default value for . + + The parsed value or the default value for + To be added. + + + + + + + + + + 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. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Option + + + + The option to which the result applies. + + To be added. + 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 new file mode 100644 index 00000000000..240ddfa6ebe --- /dev/null +++ b/xml/System.CommandLine.Parsing/ParseArgument`1.xml @@ -0,0 +1,37 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..173941957d8 --- /dev/null +++ b/xml/System.CommandLine.Parsing/ParseError.xml @@ -0,0 +1,93 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + Describes an error that occurs while parsing command line input. + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + A message to explain the error to a user. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.SymbolResult + + + + The symbol result detailing the symbol that failed to parse and the tokens involved. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.String + + + + To be added. + To be added. + To be added. + + + + + diff --git a/xml/System.CommandLine.Parsing/ParseResult.xml b/xml/System.CommandLine.Parsing/ParseResult.xml new file mode 100644 index 00000000000..8f055adc685 --- /dev/null +++ b/xml/System.CommandLine.Parsing/ParseResult.xml @@ -0,0 +1,503 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..3bf3e462881 --- /dev/null +++ b/xml/System.CommandLine.Parsing/ParseResultExtensions.xml @@ -0,0 +1,137 @@ + + + + + + + + + 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. + To be added. + + + + diff --git a/xml/System.CommandLine.Parsing/Parser.xml b/xml/System.CommandLine.Parsing/Parser.xml new file mode 100644 index 00000000000..cd3088dfd24 --- /dev/null +++ b/xml/System.CommandLine.Parsing/Parser.xml @@ -0,0 +1,137 @@ + + + + + + + + + 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 Parser class with using the default . + + To be added. + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + The root command for the parser. + To be added. + To be added. + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + The configuration on which the parser's grammar and behaviors are based. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.CommandLineConfiguration + + + + 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. + Holds the value of a complete command line input prior to splitting and tokenization, when provided. This will typically not be 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 new file mode 100644 index 00000000000..408866c99b9 --- /dev/null +++ b/xml/System.CommandLine.Parsing/ParserExtensions.xml @@ -0,0 +1,173 @@ + + + + + + + + + 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. + To be added. + + + + + + + + + + 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/ResponseFileHandling.xml b/xml/System.CommandLine.Parsing/ResponseFileHandling.xml new file mode 100644 index 00000000000..c9952775a30 --- /dev/null +++ b/xml/System.CommandLine.Parsing/ResponseFileHandling.xml @@ -0,0 +1,92 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Enum + + + + Specifies settings for response file parsing. + + To be added. + + + + + + + + + + Field + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.ResponseFileHandling + + 2 + + + Do not parse response files. Command line tokens beginning with @ receive no special treatment. + + + + + + + + + + + Field + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.ResponseFileHandling + + 0 + + + Each line in the file is treated as a single argument, regardless of whitespace on the line. + + + Empty lines and lines beginning with # are skipped. + + + + + + + + + + + Field + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.ResponseFileHandling + + 1 + + + Arguments are separated by whitespace (spaces and/or new-lines) + + + + + diff --git a/xml/System.CommandLine.Parsing/SymbolResult.xml b/xml/System.CommandLine.Parsing/SymbolResult.xml new file mode 100644 index 00000000000..9a655ba607a --- /dev/null +++ b/xml/System.CommandLine.Parsing/SymbolResult.xml @@ -0,0 +1,378 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + A result produced during parsing for a specific symbol. + + To be added. + + + + + + + + + + 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. + + + + + + + + + + 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. + + + + + + + + + + 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. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.SymbolResult + + + + The parent symbol result in the parse tree. + + To be added. + 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. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Collections.Generic.IReadOnlyList<System.CommandLine.Parsing.Token> + + + + The list of tokens associated with this symbol result during parsing. + + To be added. + 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 new file mode 100644 index 00000000000..1970341268f --- /dev/null +++ b/xml/System.CommandLine.Parsing/Token.xml @@ -0,0 +1,266 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.ValueType + + + + System.IEquatable<System.CommandLine.Parsing.Token> + + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + + A unit of significant text on the command line. + + To be added. + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + + The string value of the token. + The type of the token. + The symbol represented by the token + To be added. + To be added. + + + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + + The first . + The second . + + Checks if two specified instances have the same value. + + + if the objects are equal. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + + The first . + The second . + + Checks if two specified instances have different values. + + + if the objects are not equal. + 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.CommandLine.Parsing.TokenType + + + + The type of the token. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The string value of the token. + + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine.Parsing/TokenType.xml b/xml/System.CommandLine.Parsing/TokenType.xml new file mode 100644 index 00000000000..cecd1818f41 --- /dev/null +++ b/xml/System.CommandLine.Parsing/TokenType.xml @@ -0,0 +1,161 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Enum + + + + Identifies the type of a . + + To be added. + + + + + + + + + + Field + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.TokenType + + 0 + + + An argument token. + + + + + + + + + + + + Field + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.TokenType + + 1 + + + A command token. + + + + + + + + + + + + Field + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.TokenType + + 5 + + + A directive token. + + + + + + + + + + + + Field + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.TokenType + + 3 + + + A double dash (--) token, which changes the meaning of subsequent tokens. + + + + + + + + + + + + Field + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Parsing.TokenType + + 2 + + + An option token. + + + + + + + + + + + + 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/TokenizeError.xml b/xml/System.CommandLine.Parsing/TokenizeError.xml new file mode 100644 index 00000000000..417bb74f37e --- /dev/null +++ b/xml/System.CommandLine.Parsing/TokenizeError.xml @@ -0,0 +1,70 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + Describes an error that occurs while tokenizing command line input. + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + A message to explain the error to a user. + + To be added. + To be added. + + + + + + + + + + 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/ValidateSymbolResult`1.xml b/xml/System.CommandLine.Parsing/ValidateSymbolResult`1.xml new file mode 100644 index 00000000000..39f15973655 --- /dev/null +++ b/xml/System.CommandLine.Parsing/ValidateSymbolResult`1.xml @@ -0,0 +1,37 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..ee3788d26a2 --- /dev/null +++ b/xml/System.CommandLine/Argument.xml @@ -0,0 +1,396 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Symbol + + + + System.CommandLine.Binding.IValueDescriptor + + + + + A symbol defining a value that can be passed on the command line to a command or option. + + To be added. + + + + + + + + + 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 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. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + Gets or sets the arity of the argument. + + To be added. + 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. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Collections.Generic.IEnumerable<System.CommandLine.Completions.CompletionItem> + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + M:System.CommandLine.Binding.IValueDescriptor.GetDefaultValue + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + Gets the default value for the argument. + + Returns the default value for the argument, if defined. Null otherwise. + To be added. + + + + + + + + + + Property + + P:System.CommandLine.Binding.IValueDescriptor.HasDefaultValue + + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + Specifies if a default value is defined for the argument. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The name used in help output to describe the argument. + + To be added. + 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 + + + To be added. + 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.Type + + + + Gets or sets the that the argument token(s) will be converted to. + + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine/ArgumentArity.xml b/xml/System.CommandLine/ArgumentArity.xml new file mode 100644 index 00000000000..85872aa1dd5 --- /dev/null +++ b/xml/System.CommandLine/ArgumentArity.xml @@ -0,0 +1,305 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.ValueType + + + + System.IEquatable<System.CommandLine.ArgumentArity> + + + + + [System.Diagnostics.DebuggerDisplay("\{{MinimumNumberOfValues},{MaximumNumberOfValues}\}")] + [<System.Diagnostics.DebuggerDisplay("\{{MinimumNumberOfValues},{MaximumNumberOfValues}\}")>] + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + + Defines the arity of an option or argument. + + The arity refers to the number of values that can be passed on the command line. + + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + The minimum number of values required for the argument. + The maximum number of values allowed for the argument. + + Initializes a new instance of the ArgumentArity class. + + To be added. + Thrown when is negative. + Thrown when the maximum number is less than the minimum number or the maximum number is greater than MaximumArity. + + + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + An arity that must have exactly one value. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + Gets the maximum number of values allowed for an argument. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Int32 + + + + Gets the minimum number of values required for an argument. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + An arity that must have at least one value. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + An arity that does not allow any values. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + An arity that may have multiple values. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + An arity that may have one value, but no more than one. + + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine/ArgumentExtensions.xml b/xml/System.CommandLine/ArgumentExtensions.xml new file mode 100644 index 00000000000..70d5d993ffb --- /dev/null +++ b/xml/System.CommandLine/ArgumentExtensions.xml @@ -0,0 +1,430 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..4776b05cdf1 --- /dev/null +++ b/xml/System.CommandLine/Argument`1.xml @@ -0,0 +1,204 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + + + + System.CommandLine.Argument + + + + System.CommandLine.Binding.IValueDescriptor + + + System.CommandLine.Binding.IValueDescriptor<T> + + + + To be added. + To be added. + To be added. + + + + + + + + + + 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. + + + + + + + + + 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. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Type + + + To be added. + To be added. + To be added. + + + + + diff --git a/xml/System.CommandLine/Command.xml b/xml/System.CommandLine/Command.xml new file mode 100644 index 00000000000..ad1c07f2810 --- /dev/null +++ b/xml/System.CommandLine/Command.xml @@ -0,0 +1,498 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.IdentifierSymbol + + + + System.Collections.Generic.IEnumerable<System.CommandLine.Symbol> + + + System.Collections.IEnumerable + + + + + Represents a specific action that the application performs. + + + Use the Command object for actions that correspond to a specific string (the command name). See + for simple applications that only have one action. For example, dotnet run + uses run as the command. + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + The name of the command. + The description of the command, shown in help. + + Initializes a new instance of the Command class. + + 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 option to add to the command. + + Adds an to the command. + + 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. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Collections.Generic.IReadOnlyList<System.CommandLine.Argument> + + + + Represents all of the arguments for the command. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + + [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Command+<get_Children>d__5))] + [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.CommandLine.Command+<get_Children>d__5))>] + + + + System.Collections.Generic.IEnumerable<System.CommandLine.Symbol> + + + + Gets the child symbols. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Collections.Generic.IEnumerable<System.CommandLine.Completions.CompletionItem> + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + 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. + + To be added. + 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.IReadOnlyList<System.CommandLine.Option> + + + + Represents all of the options for the command, including global options that have been applied to any of the command's ancestors. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Collections.Generic.IReadOnlyList<System.CommandLine.Command> + + + + Represents all of the subcommands for the command. + + To be added. + To be added. + + + + + + + + + + Method + + M:System.Collections.IEnumerable.GetEnumerator + + + System.CommandLine + 2.0.0.0 + + + System.Collections.IEnumerator + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + Gets or sets a value that indicates whether unmatched tokens should be treated as errors. For example, + if set to and an extra command or argument is provided, validation will fail. + + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine/CommandExtensions.xml b/xml/System.CommandLine/CommandExtensions.xml new file mode 100644 index 00000000000..b9593400277 --- /dev/null +++ b/xml/System.CommandLine/CommandExtensions.xml @@ -0,0 +1,209 @@ + + + + + + + + + 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. + To be added. + + + + + + + + + + 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 new file mode 100644 index 00000000000..b3e369ea74f --- /dev/null +++ b/xml/System.CommandLine/CommandLineConfiguration.xml @@ -0,0 +1,203 @@ + + + + + + + + + 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. + Provide custom validation messages. + One of the enumeration values that specifies how response files (.rsp) are handled. + Provide a custom middleware pipeline. + Provide a custom help builder. + + 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 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.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 new file mode 100644 index 00000000000..811af0f411e --- /dev/null +++ b/xml/System.CommandLine/CommandLineConfigurationException.xml @@ -0,0 +1,118 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..ddc9f990844 --- /dev/null +++ b/xml/System.CommandLine/CompletionSourceExtensions.xml @@ -0,0 +1,115 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + + Provides extension methods for working with completion sources. + + 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] + [<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. + + + + diff --git a/xml/System.CommandLine/CompletionSourceList.xml b/xml/System.CommandLine/CompletionSourceList.xml new file mode 100644 index 00000000000..d6b276553a5 --- /dev/null +++ b/xml/System.CommandLine/CompletionSourceList.xml @@ -0,0 +1,214 @@ + + + + + + + + + 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 + + + To be added. + To be added. + 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> + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Property + + P:System.Collections.Generic.IReadOnlyList`1.Item(System.Int32) + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Completions.ICompletionSource + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + M:System.Collections.IEnumerable.GetEnumerator + + + System.CommandLine + 2.0.0.0 + + + System.Collections.IEnumerator + + + + To be added. + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine/ConsoleExtensions.xml b/xml/System.CommandLine/ConsoleExtensions.xml new file mode 100644 index 00000000000..0b4a75f99e0 --- /dev/null +++ b/xml/System.CommandLine/ConsoleExtensions.xml @@ -0,0 +1,80 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..52613d48cbd --- /dev/null +++ b/xml/System.CommandLine/DirectiveCollection.xml @@ -0,0 +1,167 @@ + + + + + + + + + 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>>> + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + M:System.Collections.IEnumerable.GetEnumerator + + + System.CommandLine + 2.0.0.0 + + + System.Collections.IEnumerator + + + + To be added. + To be added. + To be added. + + + + + + + + + + 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 new file mode 100644 index 00000000000..ac30e657c46 --- /dev/null +++ b/xml/System.CommandLine/Handler.xml @@ -0,0 +1,1872 @@ + + + + + + + + + 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 a . + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Void + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Void + + + + + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Void + + + + + + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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. + To be added. + + Sets a command's handler based on an . + + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Void + + + + + + + + + + + + + + + + + + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + 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. + 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 new file mode 100644 index 00000000000..3d32d56b96b --- /dev/null +++ b/xml/System.CommandLine/IConsole.xml @@ -0,0 +1,30 @@ + + + + + + + + + System.CommandLine + 2.0.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 new file mode 100644 index 00000000000..862bdc95485 --- /dev/null +++ b/xml/System.CommandLine/IdentifierSymbol.xml @@ -0,0 +1,169 @@ + + + + + + + + + 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. Multiple aliases can be added, most often used to provide a shorthand alternative. + + To be added. + + + + + + + + + + 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 alias has already been defined. + + + true if the alias has already been defined; otherwise false. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + To be added. + To be added. + To be added. + + + + + diff --git a/xml/System.CommandLine/LocalizationResources.xml b/xml/System.CommandLine/LocalizationResources.xml new file mode 100644 index 00000000000..bda6b5a5b04 --- /dev/null +++ b/xml/System.CommandLine/LocalizationResources.xml @@ -0,0 +1,990 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..2757769bbfc --- /dev/null +++ b/xml/System.CommandLine/Option.xml @@ -0,0 +1,446 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.IdentifierSymbol + + + + System.CommandLine.Binding.IValueDescriptor + + + + + A symbol defining a named parameter and a value for that parameter. + + To be added. + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + + + + The name of the option, which can be used to specify it on the command line. + The description of the option shown in help. + The type that the option's argument(s) can be parsed to. + A delegate used to get a default value for the option when it is not specified on the command line. + The arity of the option. + + Initializes a new instance of the class. + + To be added. + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + + + + The set of strings that can be used on the command line to specify the option. + The description of the option shown in help. + The type that the option's argument(s) can be parsed to. + A delegate used to get a default value for the option when it is not specified on the command line. + The arity of the option. + + Initializes a new instance of the class. + + 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. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether multiple argument tokens are allowed for each option identifier token. + + To be added. + To be added. + + If set to , the following command line is valid for passing multiple arguments: + + > --opt 1 2 3 + + The following is equivalent and is always valid: + + > --opt 1 --opt 2 --opt 3 + + + + + + + + + + + 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 + 2.0.0.0 + + + System.CommandLine.ArgumentArity + + + + Gets or sets the arity of the option. + + To be added. + To be added. + + + + + + + + + + Method + + System.CommandLine + 2.0.0.0 + + + System.Collections.Generic.IEnumerable<System.CommandLine.Completions.CompletionItem> + + + + + + To be added. + To be added. + To be added. + 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. + + + + + + + + + + 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. + + + + + + + + + + + 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 + + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + P:System.CommandLine.Binding.IValueDescriptor.HasDefaultValue + + + System.CommandLine + 2.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + P:System.CommandLine.Binding.IValueDescriptor.ValueName + + + System.CommandLine + 2.0.0.0 + + + System.String + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + P:System.CommandLine.Binding.IValueDescriptor.ValueType + + + System.CommandLine + 2.0.0.0 + + + System.Type + + + + The that the option's arguments are expected to be parsed as. + + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine/OptionExtensions.xml b/xml/System.CommandLine/OptionExtensions.xml new file mode 100644 index 00000000000..7538ee7b16c --- /dev/null +++ b/xml/System.CommandLine/OptionExtensions.xml @@ -0,0 +1,430 @@ + + + + + + + + + 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 new file mode 100644 index 00000000000..efe02dda922 --- /dev/null +++ b/xml/System.CommandLine/Option`1.xml @@ -0,0 +1,206 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + + + + System.CommandLine.Option + + + + System.CommandLine.Binding.IValueDescriptor + + + System.CommandLine.Binding.IValueDescriptor<T> + + + + The that the option's arguments are expected to be parsed as. + 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. + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + + To be added. + 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. + To be added. + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + + + + To be added. + To be added. + 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. + To be added. + 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 new file mode 100644 index 00000000000..534d43a7791 --- /dev/null +++ b/xml/System.CommandLine/RootCommand.xml @@ -0,0 +1,94 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.CommandLine.Command + + + + + Represents the main action that the application performs. + + + Use the RootCommand object without any subcommands for applications that perform one action. Add subcommands + to the root for applications that require actions identified by specific strings. For example, `dir` does not + use any subcommands. See for applications with multiple actions. + + + + + + + + + + Constructor + + System.CommandLine + 2.0.0.0 + + + + + + The description of the command, shown in help. + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The name of the currently running executable. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + The path to the currently running executable. + + To be added. + To be added. + + + + diff --git a/xml/System.CommandLine/Symbol.xml b/xml/System.CommandLine/Symbol.xml new file mode 100644 index 00000000000..ac002999420 --- /dev/null +++ b/xml/System.CommandLine/Symbol.xml @@ -0,0 +1,202 @@ + + + + + + + + + System.CommandLine + 2.0.0.0 + + + System.Object + + + + System.CommandLine.Completions.ICompletionSource + + + + + Defines a named symbol that resides in a hierarchy with parent and child symbols. + + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + System.String + + + + Gets or sets the description of the symbol. + + To be added. + 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. + + + + + + + + + + Method + + M:System.CommandLine.Completions.ICompletionSource.GetCompletions(System.CommandLine.Completions.CompletionContext) + + + System.CommandLine + 2.0.0.0 + + + System.Collections.Generic.IEnumerable<System.CommandLine.Completions.CompletionItem> + + + + + + To be added. + To be added. + To be added. + 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 + 2.0.0.0 + + + System.String + + + + Gets or sets the name of the symbol. + + To be added. + To be added. + + + + + + + + + + Property + + System.CommandLine + 2.0.0.0 + + + + [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> + + + + Gets the parent symbols. + + To be added. + 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/ns-System.CommandLine.Binding.xml b/xml/ns-System.CommandLine.Binding.xml new file mode 100644 index 00000000000..fe54a258d0d --- /dev/null +++ b/xml/ns-System.CommandLine.Binding.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + + diff --git a/xml/ns-System.CommandLine.Builder.xml b/xml/ns-System.CommandLine.Builder.xml new file mode 100644 index 00000000000..7a766f40f9f --- /dev/null +++ b/xml/ns-System.CommandLine.Builder.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + + diff --git a/xml/ns-System.CommandLine.Completions.xml b/xml/ns-System.CommandLine.Completions.xml new file mode 100644 index 00000000000..50593f27380 --- /dev/null +++ b/xml/ns-System.CommandLine.Completions.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + + diff --git a/xml/ns-System.CommandLine.Help.xml b/xml/ns-System.CommandLine.Help.xml new file mode 100644 index 00000000000..405cb4f54b3 --- /dev/null +++ b/xml/ns-System.CommandLine.Help.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + + diff --git a/xml/ns-System.CommandLine.IO.xml b/xml/ns-System.CommandLine.IO.xml new file mode 100644 index 00000000000..101f5f4656a --- /dev/null +++ b/xml/ns-System.CommandLine.IO.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + + diff --git a/xml/ns-System.CommandLine.Invocation.xml b/xml/ns-System.CommandLine.Invocation.xml new file mode 100644 index 00000000000..f7bbbb2e8e2 --- /dev/null +++ b/xml/ns-System.CommandLine.Invocation.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + + diff --git a/xml/ns-System.CommandLine.Parsing.xml b/xml/ns-System.CommandLine.Parsing.xml new file mode 100644 index 00000000000..1444170f2db --- /dev/null +++ b/xml/ns-System.CommandLine.Parsing.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + + diff --git a/xml/ns-System.CommandLine.xml b/xml/ns-System.CommandLine.xml new file mode 100644 index 00000000000..97bbbcf2d5c --- /dev/null +++ b/xml/ns-System.CommandLine.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + +