diff --git a/CHANGELOG.md b/CHANGELOG.md index 02e230cb2d..741c51480b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.22.0 +* Added the ability to run external tools on a section of documentation and + replace it with the output of the tool. + ## 0.21.1 * Fix a problem where category ordering specified in categories option was not obeyed. Reintroduce categoryOrder option to solve this problem. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2242bd7f23..426969788f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,8 +25,16 @@ yet in the issue tracker, start by opening an issue. Thanks! 2. When a change is user-facing, please add a new entry to the [changelog](https://github.com/dart-lang/dartdoc/blob/master/CHANGELOG.md) 3. Please include a test for your change. `dartdoc` has both `package:test`-style unittests as well as integration tests. To run the unittests, use `dart test/all.dart`. Most changes can be tested via a unittest, but some require modifying the [test_package](https://github.com/dart-lang/dartdoc/tree/master/testing/test_package) and regenerating its docs via `grind update-test-package-docs`. 4. For major changes, run `grind compare-sdk-warnings` and `grind compare-flutter-warnings`, and include the summary results in your pull request. -5. Be sure to format your Dart code using `dartfmt -w`, otherwise travis will complain. -6. Post your change via a pull request for review and integration! +5. Be sure to format your Dart code using `dartfmt -w`, otherwise travis will complain. +6. Because there are generated versions of the dartdoc docs for stable and development versions of Dart, + you need to update the docs twice: + - Download and install the latest STABLE version of dart from [the Dart website](https://www.dartlang.org/tools/sdk). + (It's probably easiest to download a zip file and change your PATH to the extracted location's `bin` directory) + - Run `pub run grinder update-test-package-docs` to update the stable docs. + - Download and install the latest DEV version of dart from [the Dart website](https://www.dartlang.org/tools/sdk) + (It's probably easiest to download a zip file and change your PATH to the extracted location's `bin` directory) + - Run `pub run grinder update-test-package-docs` to update the dev docs. +7. Post your change via a pull request for review and integration! ## Testing diff --git a/README.md b/README.md index 29f6408f15..886352f939 100644 --- a/README.md +++ b/README.md @@ -221,7 +221,7 @@ You can specify links to videos inline that will be handled with a simple HTML5 You can specify "macros", i.e. reusable pieces of documentation. For that, first specify a template anywhere in the comments, like: -``` +```dart /// {@template template_name} /// Some shared docs /// {@endtemplate} @@ -229,7 +229,7 @@ anywhere in the comments, like: and then you can insert it via `{@macro template_name}`, like -``` +```dart /// Some comment /// {@macro template_name} /// More comments @@ -240,6 +240,60 @@ dartdoc is currently documenting. This can lead to inconsistent behavior betwee packages, especially if different command lines are used for dartdoc. It is recommended to use collision-resistant naming for any macros by including the package name and/or library it is defined in within the name. +### Tools + +Dartdoc allows you to filter parts of the documentation through an external tool +and then include the output of that tool in place of the given input. + +First, you have to configure the tools that will be used in the `dartdoc_options.yaml` file: + +```yaml +dartdoc: + tools: + drill: + command: ["bin/drill.dart"] + description: "Puts holes in things." + echo: + macos: ['/bin/sh', '-c', 'echo'] + linux: ['/bin/sh', '-c', 'echo'] + windows: ['C:\\Windows\\System32\\cmd.exe', '/c', 'echo'] + description: 'Works on everything' +``` + +The `command` tag is used to describe the command executable, and any options +that are common among all executions. If the first element of this list is a +filename that ends in `.dart`, then the dart executable will automatically be +used to invoke that script. The `command` defined will be run on all platforms. + +The `macos`, `linux`, and `windows` tags are used to describe the commands to +be run on each of those platforms. + +The `description` is just a short description of the tool for use as help text. + +Only tools which are configured in the `dartdoc_options.yaml` file are able to +be invoked. + +To use the tools in comment documentation, use the `{@tool [ ...] [$INPUT]}` +directive to invoke the tool: + +```dart +/// {@tool drill --flag --option="value" $INPUT} +/// This is the text that will be sent to the tool as input. +/// {@end-tool} +``` + +The `$INPUT` argument is a special token that will be replaced with the name of +a temporary file that the tool needs to read from. It can appear anywhere in the +options, and can appear multiple times. + +If the example `drill` tool with those options is a tool that turns the content +of its input file into a code-font heading, then the directive above would be +the equivalent of having the following comment in the code: + +```dart +/// # `This is the text that will be sent to the tool as input.` +``` + ### Auto including dependencies If `--auto-include-dependencies` flag is provided, dartdoc tries to automatically add diff --git a/lib/src/dartdoc_options.dart b/lib/src/dartdoc_options.dart index 51a02eab06..1a2eac9b0d 100644 --- a/lib/src/dartdoc_options.dart +++ b/lib/src/dartdoc_options.dart @@ -56,6 +56,9 @@ class DartdocFileMissing extends DartdocOptionError { DartdocFileMissing(String details) : super(details); } +/// Defines the attributes of a category in the options file, corresponding to +/// the 'categories' keyword in the options file, and populated by the +/// [CategoryConfiguration] class. class CategoryDefinition { /// Internal name of the category. final String name; @@ -73,6 +76,8 @@ class CategoryDefinition { String get displayName => _displayName ?? name; } +/// A configuration class that can interpret category definitions from a YAML +/// map. class CategoryConfiguration { /// A map of [CategoryDefinition.name] to [CategoryDefinition] objects. final Map categoryDefinitions; @@ -110,6 +115,112 @@ class CategoryConfiguration { } } +/// Defines the attributes of a tool in the options file, corresponding to +/// the 'tools' keyword in the options file, and populated by the +/// [ToolConfiguration] class. +class ToolDefinition { + /// A list containing the command and options to be run for this tool. The + /// first argument in the command is the tool executable. Must not be an empty + /// list, or be null. + final List command; + + /// A description of the defined tool. Must not be null. + final String description; + + ToolDefinition(this.command, this.description) + : assert(command != null), + assert(command.isNotEmpty), + assert(description != null); + + @override + String toString() => '$runtimeType: "${command.join(' ')}" ($description)'; +} + +/// A configuration class that can interpret [ToolDefinition]s from a YAML map. +class ToolConfiguration { + final Map tools; + + ToolConfiguration._(this.tools); + + static ToolConfiguration get empty { + return new ToolConfiguration._({}); + } + + static ToolConfiguration fromYamlMap( + YamlMap yamlMap, pathLib.Context pathContext) { + var newToolDefinitions = {}; + for (var entry in yamlMap.entries) { + var name = entry.key.toString(); + var toolMap = entry.value; + var description; + List command; + if (toolMap is Map) { + description = toolMap['description']?.toString(); + // If the command key is given, then it applies to all platforms. + var commandFrom = toolMap.containsKey('command') + ? 'command' + : Platform.operatingSystem; + if (toolMap.containsKey(commandFrom)) { + if (toolMap[commandFrom].value is String) { + command = [toolMap[commandFrom].toString()]; + if (command[0].isEmpty) { + throw new DartdocOptionError( + 'Tool commands must not be empty. Tool $name command entry ' + '"$commandFrom" must contain at least one path.'); + } + } else if (toolMap[commandFrom] is YamlList) { + command = (toolMap[commandFrom] as YamlList) + .map((node) => node.toString()) + .toList(); + if (command.isEmpty) { + throw new DartdocOptionError( + 'Tool commands must not be empty. Tool $name command entry ' + '"$commandFrom" must contain at least one path.'); + } + } else { + throw new DartdocOptionError( + 'Tool commands must be a path to an executable, or a list of ' + 'strings that starts with a path to an executable. ' + 'The tool $name has a $commandFrom entry that is a ' + '${toolMap[commandFrom].runtimeType}'); + } + } + } else { + throw new DartdocOptionError( + 'Tools must be defined as a map of tool names to definitions. Tool ' + '$name is not a map.'); + } + if (command == null) { + throw new DartdocOptionError( + 'At least one of "command" or "${Platform.operatingSystem}" must ' + 'be defined for the tool $name.'); + } + var executable = command.removeAt(0); + executable = pathContext.canonicalize(executable); + var executableFile = new File(executable); + var exeStat = executableFile.statSync(); + if (exeStat.type == FileSystemEntityType.notFound) { + throw new DartdocOptionError('Command executables must exist. ' + 'The file "$executable" does not exist for tool $name.'); + } + // Dart scripts don't need to be executable, because they'll be + // executed with the Dart binary. + bool isExecutable(int mode) { + return (0x1 & ((mode >> 6) | (mode >> 3) | mode)) != 0; + } + + if (!executable.endsWith('.dart') && !isExecutable(exeStat.mode)) { + throw new DartdocOptionError('Non-Dart commands must be ' + 'executable. The file "$executable" for tool $name does not have ' + 'executable permission.'); + } + newToolDefinitions[name] = + new ToolDefinition([executable] + command, description); + } + return new ToolConfiguration._(newToolDefinitions); + } +} + /// A container class to keep track of where our yaml data came from. class _YamlFileData { /// The map from the yaml file. @@ -158,9 +269,10 @@ class _OptionValueWithContext { return pathContext.canonicalize(resolveTildePath(value as String)) as T; } else if (value is Map) { return (value as Map) - .map((String mapKey, String mapValue) => new MapEntry( - mapKey, pathContext.canonicalize(resolveTildePath(mapValue)))) - .cast() as T; + .map((String key, String value) { + return new MapEntry( + key, pathContext.canonicalize(resolveTildePath(value))); + }) as T; } else { throw new UnsupportedError('Type $T is not supported for resolvedValue'); } @@ -252,8 +364,7 @@ abstract class DartdocOption { void _onMissing( _OptionValueWithContext valueWithContext, String missingFilename); - /// Call [_onMissing] for every path that does not exist. Returns true if - /// all paths exist or [mustExist] == false. + /// Call [_onMissing] for every path that does not exist. void _validatePaths(_OptionValueWithContext valueWithContext) { if (!mustExist) return; assert(isDir || isFile); @@ -264,6 +375,9 @@ abstract class DartdocOption { resolvedPaths = valueWithContext.resolvedValue.toList(); } else if (valueWithContext.value is Map) { resolvedPaths = valueWithContext.resolvedValue.values.toList(); + } else { + assert(false, "Trying to ensure existence of unsupported type " + "${valueWithContext.value.runtimeType}"); } for (String path in resolvedPaths) { FileSystemEntity f = isDir ? new Directory(path) : new File(path); @@ -1024,6 +1138,7 @@ class DartdocOptionContext { List get includeExternal => optionSet['includeExternal'].valueAt(context); bool get includeSource => optionSet['includeSource'].valueAt(context); + ToolConfiguration get tools => optionSet['tools'].valueAt(context); /// _input is only used to construct synthetic options. // ignore: unused_element @@ -1065,11 +1180,11 @@ Future> createDartdocOptions() async { negatable: true), new DartdocOptionArgFile( 'ambiguousReexportScorerMinConfidence', 0.1, - help: - 'Minimum scorer confidence to suppress warning on ambiguous reexport.'), + help: 'Minimum scorer confidence to suppress warning on ambiguous ' + 'reexport.'), new DartdocOptionArgOnly('autoIncludeDependencies', false, - help: - 'Include all the used libraries into the docs, even the ones not in the current package or "include-external"', + help: 'Include all the used libraries into the docs, even the ones not ' + 'in the current package or "include-external"', negatable: true), new DartdocOptionArgFile>('categoryOrder', [], help: @@ -1078,8 +1193,8 @@ Future> createDartdocOptions() async { new DartdocOptionFileOnly( 'categories', CategoryConfiguration.empty, convertYamlToType: CategoryConfiguration.fromYamlMap, - help: - "A list of all categories, their display names, and markdown documentation in the order they are to be displayed."), + help: 'A list of all categories, their display names, and markdown ' + 'documentation in the order they are to be displayed.'), new DartdocOptionSyntheticOnly>('dropTextFrom', (DartdocSyntheticOption> option, Directory dir) { if (option.parent['hideSdkText'].valueAt(dir)) { @@ -1249,5 +1364,12 @@ Future> createDartdocOptions() async { new DartdocOptionArgOnly('verboseWarnings', true, help: 'Display extra debugging information and help with warnings.', negatable: true), + new DartdocOptionFileOnly( + 'tools', ToolConfiguration.empty, + convertYamlToType: ToolConfiguration.fromYamlMap, + help: 'A map of tool names to executable paths. Each executable must ' + 'exist. Executables for different platforms are specified by ' + 'giving the platform name as a key, and a list of strings as the ' + 'command.'), ]; } diff --git a/lib/src/model.dart b/lib/src/model.dart index a9ef22bc3b..19c9911328 100644 --- a/lib/src/model.dart +++ b/lib/src/model.dart @@ -46,6 +46,7 @@ import 'package:dartdoc/src/markdown_processor.dart' show Documentation; import 'package:dartdoc/src/model_utils.dart'; import 'package:dartdoc/src/package_meta.dart' show PackageMeta, FileContents; import 'package:dartdoc/src/special_elements.dart'; +import 'package:dartdoc/src/tool_runner.dart'; import 'package:dartdoc/src/tuple.dart'; import 'package:dartdoc/src/utils.dart'; import 'package:dartdoc/src/warnings.dart'; @@ -2987,6 +2988,8 @@ abstract class ModelElement extends Canonicalization } else { _rawDocs = computeDocumentationComment ?? ''; _rawDocs = stripComments(_rawDocs) ?? ''; + // Must evaluate tools first, in case they insert any other directives. + _rawDocs = _evaluateTools(_rawDocs); _rawDocs = _injectExamples(_rawDocs); _rawDocs = _injectAnimations(_rawDocs); _rawDocs = _stripMacroTemplatesAndAddToIndex(_rawDocs); @@ -3641,6 +3644,85 @@ abstract class ModelElement extends Canonicalization }); } + /// Replace {@tool ...}{@end-tool} in API comments with the + /// output of an external tool. + /// + /// Looks for tools invocations, looks up their bound executables in the + /// options, and executes them with the source comment material as input, + /// returning the output of the tool. If a named tool isn't configured in the + /// options file, then it will not be executed, and dartdoc will quit with an + /// error. + /// + /// Tool command line arguments are passed to the tool, with the token + /// `$INPUT` replaced with the absolute path to a temporary file containing + /// the content for the tool to read and produce output from. If the tool + /// doesn't need any input, then no `$INPUT` is needed. + /// + /// Nested tool directives will not be evaluated, but tools may generate other + /// directives in their output and those will be evaluated. + /// + /// Syntax: + /// + /// {@tool TOOL [Tool arguments]} + /// Content to send to tool. + /// {@end-tool} + /// + /// Examples: + /// + /// In `dart_options.yaml`: + /// + /// ```yaml + /// dartdoc: + /// tools: + /// # Prefixes the given input with "## " + /// # Path is relative to project root. + /// prefix: "bin/prefix.dart" + /// # Prints the date + /// date: "/bin/date" + /// ``` + /// + /// In code: + /// + /// _This:_ + /// + /// {@tool prefix $INPUT} + /// Content to send to tool. + /// {@end-tool} + /// {@tool date --iso-8601=minutes --utc} + /// {@end-tool} + /// + /// _Produces:_ + /// + /// ## Content to send to tool. + /// 2018-09-18T21:15+00:00 + String _evaluateTools(String rawDocs) { + // Matches all tool directives (even some invalid ones). This is so + // we can give good error messages if the directive is malformed, instead of + // just silently emitting it as-is. + final basicToolRegExp = new RegExp( + r'[ ]*{@tool\s+([^}]+)}\n?([\s\S]+?)\n?{@end-tool}[ ]*\n?', + multiLine: true); + + var runner = new ToolRunner(config.tools, (String message) { + warn(PackageWarning.toolError, message: message); + }); + try { + return rawDocs.replaceAllMapped(basicToolRegExp, (basicMatch) { + List args = _splitUpQuotedArgs(basicMatch[1]).toList(); + // Tool name must come first. + if (args.isEmpty) { + warn(PackageWarning.toolError, + message: + 'Must specify a tool to execute for the @tool directive.'); + return ''; + } + return runner.run(args, basicMatch[2]); + }); + } finally { + runner.dispose(); + } + } + /// Replace {@animation ...} in API comments with some HTML to manage an /// MPEG 4 video as an animation. /// @@ -3871,15 +3953,12 @@ abstract class ModelElement extends Canonicalization /// "foo=bar" argument as "--foo=bar". It does handle quoted args like /// "foo='bar baz'" too, returning just bar (without quotes) for the foo /// value. - /// - /// It then parses the resulting argument list normally with [argParser] and - /// returns the result. - ArgResults _parseArgs( - String argsAsString, ArgParser argParser, String directiveName) { + Iterable _splitUpQuotedArgs(String argsAsString, + {bool convertToArgs = false}) { // Regexp to take care of splitting arguments, and handling the quotes // around arguments, if any. // - // Match group 1 is the "foo=" part of the option, if any. + // Match group 1 is the "foo=" (or "--foo=") part of the option, if any. // Match group 2 contains the quote character used (which is discarded). // Match group 3 is a quoted arg, if any, without the quotes. // Match group 4 is the unquoted arg, if any. @@ -3889,17 +3968,30 @@ abstract class ModelElement extends Canonicalization r'([^ ]+))'); // without quotes. final Iterable matches = argMatcher.allMatches(argsAsString); - // Remove quotes around args, and for any args that look like assignments - // (start with valid option names followed by an equals sign), add a "--" in front - // so that they parse as options. - final Iterable args = matches.map((Match match) { - String option = ''; - if (match[1] != null) { - option = '--${match[1]}'; + // Remove quotes around args, and if convertToArgs is true, then for any + // args that look like assignments (start with valid option names followed + // by an equals sign), add a "--" in front so that they parse as options. + return matches.map((Match match) { + var option = ''; + if (convertToArgs && match[1] != null && !match[1].startsWith('-')) + option = '--'; + if (match[2] != null) { + // This arg has quotes, so strip them. + return '$option${match[1] ?? ''}${match[3] ?? ''}${match[4] ?? ''}'; } - return option + (match[3] ?? '') + (match[4] ?? ''); + return '$option${match[0]}'; }); + } + /// Helper to process arguments given as a (possibly quoted) string. + /// + /// First, this will split the given [argsAsString] into separate arguments + /// with [_splitUpQuotedArgs] it then parses the resulting argument list + /// normally with [argParser] and returns the result. + ArgResults _parseArgs( + String argsAsString, ArgParser argParser, String directiveName) { + var args = + _splitUpQuotedArgs(argsAsString, convertToArgs: true); try { return argParser.parse(args); } on ArgParserException catch (e) { @@ -4458,6 +4550,9 @@ class PackageGraph { case PackageWarning.invalidParameter: warningMessage = 'invalid parameter to dartdoc directive: ${message}'; break; + case PackageWarning.toolError: + warningMessage = 'tool execution failed: ${message}'; + break; case PackageWarning.deprecated: warningMessage = 'deprecated dartdoc usage: ${message}'; break; @@ -6035,6 +6130,7 @@ class PackageBuilder { if (config.showWarnings) { for (PackageWarning kind in PackageWarning.values) { switch (kind) { + case PackageWarning.toolError: case PackageWarning.invalidParameter: case PackageWarning.unresolvedExport: warningOptions.error(kind); diff --git a/lib/src/tool_runner.dart b/lib/src/tool_runner.dart new file mode 100644 index 0000000000..eb457c41d2 --- /dev/null +++ b/lib/src/tool_runner.dart @@ -0,0 +1,120 @@ +// Copyright (c) 2018, the Dart project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +library dartdoc.tool_runner; + +import 'dart:io'; + +import 'package:path/path.dart' as pathLib; +import 'dartdoc_options.dart'; + +typedef ToolErrorCallback = void Function(String message); +typedef FakeResultCallback = String Function(String tool, + {List args, String content}); + +/// A helper class for running external tools. +class ToolRunner { + /// Creates a new ToolRunner. + /// + /// Takes a [toolConfiguration] that describes all of the available tools. + /// An optional `errorCallback` will be called for each error message + /// generated by the tool. + ToolRunner(this.toolConfiguration, [this._errorCallback]) + : temporaryDirectory = + Directory.systemTemp.createTempSync('dartdoc_tools_'); + + final ToolConfiguration toolConfiguration; + final Directory temporaryDirectory; + final ToolErrorCallback _errorCallback; + int _temporaryFileCount = 0; + + void _error(String message) { + if (_errorCallback != null) { + _errorCallback(message); + } + } + + File _createTemporaryFile() { + _temporaryFileCount++; + return new File(pathLib.join( + temporaryDirectory.absolute.path, 'input_$_temporaryFileCount')) + ..createSync(recursive: true); + } + + /// Must be called when the ToolRunner is no longer needed. Ideally, + /// this is called in the finally section of a try/finally. + /// + /// This will remove any temporary files created by the tool runner. + void dispose() { + if (temporaryDirectory.existsSync()) + temporaryDirectory.deleteSync(recursive: true); + } + + /// Run a tool. The name of the tool is the first argument in the [args]. + /// The content to be sent to to the tool is given in the optional [content], + /// and the stdout of the tool is returned. + /// + /// The [args] must not be null, and it must have at least one member (the name + /// of the tool). + String run(List args, [String content]) { + assert(args != null); + assert(args.isNotEmpty); + content ??= ''; + var tool = args.removeAt(0); + if (!toolConfiguration.tools.containsKey(tool)) { + _error('Unable to find definition for tool "$tool" in tool map. ' + 'Did you add it to dartdoc_options.yaml?'); + return ''; + } + var toolDefinition = toolConfiguration.tools[tool]; + var toolArgs = toolDefinition.command; + if (pathLib.extension(toolDefinition.command.first) == '.dart') { + // For dart tools, we want to invoke them with Dart. + toolArgs.insert(0, Platform.resolvedExecutable); + } + + // Ideally, we would just be able to send the input text into stdin, + // but there's no way to do that synchronously, and converting dartdoc + // to an async model of execution is a huge amount of work. Using + // dart:cli's waitFor feels like a hack (and requires a similar amount + // of work anyhow to fix order of execution issues). So, instead, we + // have the tool take a filename as part of its arguments, and write + // the input to a temporary file before running the tool synchronously. + + // Write the content to a temp file. + var tmpFile = _createTemporaryFile(); + tmpFile.writeAsStringSync(content); + + // Substitute the temp filename for the "$INPUT" token. + var fileToken = new RegExp(r'\$INPUT\b'); + var argsWithInput = []; + for (var arg in args) { + argsWithInput.add(arg.replaceAll(fileToken, tmpFile.absolute.path)); + } + + argsWithInput = toolArgs + argsWithInput; + final commandPath = argsWithInput.removeAt(0); + String commandString() => ([commandPath] + argsWithInput).join(' '); + try { + var result = Process.runSync(commandPath, argsWithInput); + if (result.exitCode != 0) { + _error('Tool "$tool" returned non-zero exit code ' + '(${result.exitCode}) when run as ' + '"${commandString()}".\n' + 'Input to $tool was:\n' + '$content\n' + 'Stderr output was:\n${result.stderr}\n'); + return ''; + } else { + return result.stdout; + } + } on ProcessException catch (exception) { + _error('Failed to run tool "$tool" as ' + '"${commandString()}": $exception\n' + 'Input to $tool was:\n' + '$content'); + return ''; + } + } +} diff --git a/lib/src/version.dart b/lib/src/version.dart index ffaad2c6f4..f0ca228f3b 100644 --- a/lib/src/version.dart +++ b/lib/src/version.dart @@ -1,2 +1,2 @@ // Generated code. Do not modify. -const packageVersion = '0.21.1'; +const packageVersion = '0.22.0'; diff --git a/lib/src/warnings.dart b/lib/src/warnings.dart index 9d350c6386..e2ac941f77 100644 --- a/lib/src/warnings.dart +++ b/lib/src/warnings.dart @@ -90,6 +90,10 @@ final Map packageWarningText = const { PackageWarning.invalidParameter, "invalidParameter", "A parameter given to a dartdoc directive was invalid."), + PackageWarning.toolError: const PackageWarningHelpText( + PackageWarning.toolError, + "toolError", + "Unable to execute external tool."), PackageWarning.deprecated: const PackageWarningHelpText( PackageWarning.deprecated, "deprecated", @@ -138,6 +142,7 @@ enum PackageWarning { missingFromSearchIndex, typeAsHtml, invalidParameter, + toolError, deprecated, unresolvedExport, } diff --git a/pubspec.lock b/pubspec.lock index 468b1cb13c..4718064b77 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -155,6 +155,13 @@ packages: url: "https://pub.dartlang.org" source: hosted version: "3.0.0" + file: + dependency: transitive + description: + name: file + url: "https://pub.dartlang.org" + source: hosted + version: "5.0.4" fixnum: dependency: transitive description: @@ -218,6 +225,13 @@ packages: url: "https://pub.dartlang.org" source: hosted version: "3.1.3" + intl: + dependency: transitive + description: + name: intl + url: "https://pub.dartlang.org" + source: hosted + version: "0.15.7" io: dependency: "direct dev" description: @@ -323,6 +337,13 @@ packages: url: "https://pub.dartlang.org" source: hosted version: "1.6.2" + platform: + dependency: transitive + description: + name: platform + url: "https://pub.dartlang.org" + source: hosted + version: "2.2.0" plugin: dependency: transitive description: @@ -337,6 +358,13 @@ packages: url: "https://pub.dartlang.org" source: hosted version: "1.3.6" + process: + dependency: "direct main" + description: + name: process + url: "https://pub.dartlang.org" + source: hosted + version: "3.0.5" pub_semver: dependency: "direct main" description: diff --git a/pubspec.yaml b/pubspec.yaml index f2fbf5a945..04f255263c 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: dartdoc # Also update the `version` field in lib/dartdoc.dart. -version: 0.21.1 +version: 0.22.0 author: Dart Team description: A documentation generator for Dart. homepage: https://github.com/dart-lang/dartdoc @@ -17,6 +17,7 @@ dependencies: # least version 3.0.3 to work around an issue with 3.0.2. http_parser: '>=3.0.3 <4.0.0' logging: ^0.11.3+1 + process: ^3.0.5 markdown: ^2.0.0 # TODO(jcollins-g): use dependency when mustache4dart is # supported on 2.0. diff --git a/test/model_test.dart b/test/model_test.dart index 4df7d30f3d..41bab20fc7 100644 --- a/test/model_test.dart +++ b/test/model_test.dart @@ -78,6 +78,44 @@ void main() { sdkAsPackageGraph = utils.testPackageGraphSdk; }); + group('Tools', () { + Class toolUser; + Method invokeTool; + Method invokeToolNoInput; + + setUp(() { + toolUser = exLibrary.classes.firstWhere((c) => c.name == 'ToolUser'); + invokeTool = + toolUser.allInstanceMethods.firstWhere((m) => m.name == 'invokeTool'); + invokeToolNoInput = toolUser.allInstanceMethods + .firstWhere((m) => m.name == 'invokeToolNoInput'); + packageGraph.allLocalModelElements.forEach((m) => m.documentation); + }); + test("can invoke a tool", () { + expect( + invokeTool.documentation, + contains( + '''Args: [--file=, --special= |\\[]!@#\\"\'\$%^&*()_+]''')); + expect(invokeTool.documentation, contains('## `Yes it is a [Dog]!`')); + }); + test("can invoke a tool and add a reference link", () { + expect(invokeTool.documentation, + contains('Yes it is a [Dog]! Is not a [ToolUser].')); + expect(invokeTool.documentationAsHtml, + contains(r'ToolUser')); + expect(invokeTool.documentationAsHtml, + contains('Dog')); + }); + test(r"can invoke a tool with no $INPUT or args", () { + expect(invokeToolNoInput.documentation, contains('Args: []')); + expect(invokeToolNoInput.documentation, + isNot(contains('This text should not appear in the output'))); + expect(invokeToolNoInput.documentation, isNot(contains('[Dog]'))); + expect(invokeToolNoInput.documentationAsHtml, + isNot(contains('Dog'))); + }); + }); + group('Missing and Remote', () { test('Verify that SDK libraries are not canonical when missing', () { expect( @@ -313,7 +351,7 @@ void main() { }); test('multiple packages, sorted default', () { - expect(ginormousPackageGraph.localPackages, hasLength(4)); + expect(ginormousPackageGraph.localPackages, hasLength(5)); expect(ginormousPackageGraph.localPackages.first.name, equals('test_package')); }); @@ -1244,7 +1282,7 @@ void main() { }); test('correctly finds all the classes', () { - expect(classes, hasLength(28)); + expect(classes, hasLength(29)); }); test('abstract', () { diff --git a/test/tool_runner_test.dart b/test/tool_runner_test.dart new file mode 100644 index 0000000000..3e9e217b4c --- /dev/null +++ b/test/tool_runner_test.dart @@ -0,0 +1,92 @@ +// Copyright (c) 2018, the Dart project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +library dartdoc.model_test; + +import 'dart:io'; + +import 'package:dartdoc/src/dartdoc_options.dart'; +import 'package:dartdoc/src/tool_runner.dart'; +import 'package:path/path.dart' as pathLib; +import 'package:test/test.dart'; + +import 'src/utils.dart' as utils; + +void main() { + var toolMap = ToolConfiguration.empty; + + toolMap.tools.addAll({ + 'missing': new ToolDefinition(['/a/missing/executable'], "missing"), + 'drill': new ToolDefinition( + [pathLib.join(utils.testPackageDir.absolute.path, 'bin', 'drill.dart')], + 'Makes holes'), + // We use the Dart executable for our "non-dart" tool + // test, because it's the only executable that we know the + // exact location of that works on all platforms. + 'non_dart': + new ToolDefinition([Platform.resolvedExecutable], 'non-dart tool'), + }); + ToolRunner runner; + final errors = []; + + setUpAll(() async { + runner = new ToolRunner(toolMap, (String message) => errors.add(message)); + }); + tearDownAll(() { + runner.dispose(); + }); + + group('ToolRunner', () { + setUp(() { + errors.clear(); + }); + test('can invoke a Dart tool', () { + var result = runner.run( + ['drill', r'--file=$INPUT'], + 'TEST INPUT', + ); + expect(errors, isEmpty); + expect(result, contains(new RegExp(r'Args: \[--file=]'))); + expect(result, contains('## `TEST INPUT`')); + }); + test('can invoke a non-Dart tool', () { + String result = runner.run( + ['non_dart', '--version'], + 'TEST INPUT', + ); + expect(errors, isEmpty); + expect(result, isEmpty); // Output is on stderr. + }); + test('fails if tool not in tool map', () { + String result = runner.run( + ['hammer', r'--file=$INPUT'], + 'TEST INPUT', + ); + expect(errors, isNotEmpty); + expect( + errors[0], contains('Unable to find definition for tool "hammer"')); + expect(result, isEmpty); + }); + test('fails if tool returns non-zero status', () { + String result = runner.run( + ['drill', r'--file=/a/missing/file'], + 'TEST INPUT', + ); + expect(errors, isNotEmpty); + expect( + errors[0], contains('Tool "drill" returned non-zero exit code (1)')); + expect(result, isEmpty); + }); + test("fails if tool in tool map doesn't exist", () { + String result = runner.run( + ['missing'], + 'TEST INPUT', + ); + expect(errors, isNotEmpty); + expect(errors[0], + contains('Failed to run tool "missing" as "/a/missing/executable"')); + expect(result, isEmpty); + }); + }); +} diff --git a/testing/test_package/bin/drill.dart b/testing/test_package/bin/drill.dart new file mode 100644 index 0000000000..76d616b78e --- /dev/null +++ b/testing/test_package/bin/drill.dart @@ -0,0 +1,45 @@ +// Copyright (c) 2018, the Dart project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +// Used by tests as an "external tool". Has no other useful purpose. + +// This is a sample "tool" used to test external tool integration into dartdoc. +// It has no practical purpose other than that. + +import 'dart:io'; +import 'package:args/args.dart'; + +void main(List argList) { + final ArgParser argParser = ArgParser(); + argParser.addOption('file'); + argParser.addOption('special'); + final ArgResults args = argParser.parse(argList); + + // Normalize the filename, since it includes random + // and system-specific components, but make sure it + // matches the pattern we expect. + RegExp filenameRegExp = new RegExp( + r'(--file=)(.*)([/\\]dartdoc_tools_)([^/\\]+)([/\\]input_)(\d+)'); + List normalized = argList.map((String arg) { + if (filenameRegExp.hasMatch(arg)) { + return '--file='; + } else { + return arg; + } + }).toList(); + print('Args: $normalized'); + if (args['file'] != null) { + File file = new File(args['file']); + if (file.existsSync()) { + List lines = file.readAsLinesSync(); + for (String line in lines) { + print('## `${line}`'); + print('\n$line Is not a [ToolUser].\n'); + } + } else { + exit(1); + } + } + exit(0); +} diff --git a/testing/test_package/dartdoc_options.yaml b/testing/test_package/dartdoc_options.yaml index 3f65cc67b4..fb0a3df0f3 100644 --- a/testing/test_package/dartdoc_options.yaml +++ b/testing/test_package/dartdoc_options.yaml @@ -7,3 +7,12 @@ dartdoc: Unreal: markdown: "Unreal.md" Real Libraries: + tools: + drill: + command: ["bin/drill.dart"] + description: "Puts holes in things." + echo: + macos: ['/bin/sh', '-c', 'echo'] + linux: ['/bin/sh', '-c', 'echo'] + windows: ['C:\\Windows\\System32\\cmd.exe', '/c', 'echo'] + description: 'Works on everything' diff --git a/testing/test_package/lib/example.dart b/testing/test_package/lib/example.dart index 82d9bccab1..6cc1499147 100644 --- a/testing/test_package/lib/example.dart +++ b/testing/test_package/lib/example.dart @@ -581,3 +581,20 @@ abstract class TypedFunctionsWithoutTypedefs { /// Returns a complex typedef that includes some anonymous typed functions. aComplexTypedef getAComplexTypedef(); } + +abstract class ToolUser { + /// Invokes a tool. + /// + /// {@tool drill --file="$INPUT" --special=" |\[]!@#\"'$%^&*()_+"} + /// Yes it is a [Dog]! + /// Ok, fine it isn't. + /// {@end-tool} + void invokeTool(); + + /// Invokes a tool without the $INPUT token or args. + /// + /// {@tool drill} + /// This text should not appear in the output, even if it references [Dog]. + /// {@end-tool} + void invokeToolNoInput(); +} diff --git a/testing/test_package/pubspec.yaml b/testing/test_package/pubspec.yaml index 1e60e4b8e4..bb7672fb2e 100644 --- a/testing/test_package/pubspec.yaml +++ b/testing/test_package/pubspec.yaml @@ -4,5 +4,6 @@ description: Best package ever. version: 0.0.1 dependencies: meta: ^1.0.0 + args: ^1.5.0 test_package_imported: path: "../test_package_imported" diff --git a/testing/test_package_docs/__404error.html b/testing/test_package_docs/__404error.html index 2081627f8f..041217181a 100644 --- a/testing/test_package_docs/__404error.html +++ b/testing/test_package_docs/__404error.html @@ -4,7 +4,7 @@ - + test_package - Dart API docs @@ -56,6 +56,9 @@
test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/anonymous_library/anonymous_library-library.html b/testing/test_package_docs/anonymous_library/anonymous_library-library.html index 2f0d6ef67d..abd70876d3 100644 --- a/testing/test_package_docs/anonymous_library/anonymous_library-library.html +++ b/testing/test_package_docs/anonymous_library/anonymous_library-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/another_anonymous_lib/another_anonymous_lib-library.html b/testing/test_package_docs/another_anonymous_lib/another_anonymous_lib-library.html index 615dc5679e..2b312988c0 100644 --- a/testing/test_package_docs/another_anonymous_lib/another_anonymous_lib-library.html +++ b/testing/test_package_docs/another_anonymous_lib/another_anonymous_lib-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/categoriesExported/categoriesExported-library.html b/testing/test_package_docs/categoriesExported/categoriesExported-library.html index 13bf0bb7dd..cc422783a5 100644 --- a/testing/test_package_docs/categoriesExported/categoriesExported-library.html +++ b/testing/test_package_docs/categoriesExported/categoriesExported-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/code_in_comments/code_in_comments-library.html b/testing/test_package_docs/code_in_comments/code_in_comments-library.html index 2cef34da6d..3c28e9baa3 100644 --- a/testing/test_package_docs/code_in_comments/code_in_comments-library.html +++ b/testing/test_package_docs/code_in_comments/code_in_comments-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/css/css-library.html b/testing/test_package_docs/css/css-library.html index 76ee0edb73..0b90e6a041 100644 --- a/testing/test_package_docs/css/css-library.html +++ b/testing/test_package_docs/css/css-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/ex/Animal-class.html b/testing/test_package_docs/ex/Animal-class.html index 9d24ddeb30..dc9cf04644 100644 --- a/testing/test_package_docs/ex/Animal-class.html +++ b/testing/test_package_docs/ex/Animal-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/AnotherParameterizedClass-class.html b/testing/test_package_docs/ex/AnotherParameterizedClass-class.html index 904a00a79b..9c1a63b10a 100644 --- a/testing/test_package_docs/ex/AnotherParameterizedClass-class.html +++ b/testing/test_package_docs/ex/AnotherParameterizedClass-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/Apple-class.html b/testing/test_package_docs/ex/Apple-class.html index 6f5e8268c3..3bd9353192 100644 --- a/testing/test_package_docs/ex/Apple-class.html +++ b/testing/test_package_docs/ex/Apple-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/B-class.html b/testing/test_package_docs/ex/B-class.html index 627b374201..fe42247f11 100644 --- a/testing/test_package_docs/ex/B-class.html +++ b/testing/test_package_docs/ex/B-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/COLOR-constant.html b/testing/test_package_docs/ex/COLOR-constant.html index b83cc9113b..8ed51eb106 100644 --- a/testing/test_package_docs/ex/COLOR-constant.html +++ b/testing/test_package_docs/ex/COLOR-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/COLOR_GREEN-constant.html b/testing/test_package_docs/ex/COLOR_GREEN-constant.html index 92612213d6..acfdb113d7 100644 --- a/testing/test_package_docs/ex/COLOR_GREEN-constant.html +++ b/testing/test_package_docs/ex/COLOR_GREEN-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/COLOR_ORANGE-constant.html b/testing/test_package_docs/ex/COLOR_ORANGE-constant.html index 154ae2d942..729e501fcb 100644 --- a/testing/test_package_docs/ex/COLOR_ORANGE-constant.html +++ b/testing/test_package_docs/ex/COLOR_ORANGE-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/COMPLEX_COLOR-constant.html b/testing/test_package_docs/ex/COMPLEX_COLOR-constant.html index 4522aff681..a3cc88b8dc 100644 --- a/testing/test_package_docs/ex/COMPLEX_COLOR-constant.html +++ b/testing/test_package_docs/ex/COMPLEX_COLOR-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/Cat-class.html b/testing/test_package_docs/ex/Cat-class.html index b0249ec9c7..5a387593a1 100644 --- a/testing/test_package_docs/ex/Cat-class.html +++ b/testing/test_package_docs/ex/Cat-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/CatString-class.html b/testing/test_package_docs/ex/CatString-class.html index cd86728741..2f3d6407f9 100644 --- a/testing/test_package_docs/ex/CatString-class.html +++ b/testing/test_package_docs/ex/CatString-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/ConstantCat-class.html b/testing/test_package_docs/ex/ConstantCat-class.html index f7d3273a15..cf91c3a21b 100644 --- a/testing/test_package_docs/ex/ConstantCat-class.html +++ b/testing/test_package_docs/ex/ConstantCat-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/Deprecated-class.html b/testing/test_package_docs/ex/Deprecated-class.html index b343154b86..04729eeda7 100644 --- a/testing/test_package_docs/ex/Deprecated-class.html +++ b/testing/test_package_docs/ex/Deprecated-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/Dog-class.html b/testing/test_package_docs/ex/Dog-class.html index 243ebec08b..1ebab5deaa 100644 --- a/testing/test_package_docs/ex/Dog-class.html +++ b/testing/test_package_docs/ex/Dog-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/E-class.html b/testing/test_package_docs/ex/E-class.html index a2a1c36a35..8d883c8a1d 100644 --- a/testing/test_package_docs/ex/E-class.html +++ b/testing/test_package_docs/ex/E-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/ExtendedShortName-class.html b/testing/test_package_docs/ex/ExtendedShortName-class.html index 57078ab5b2..0c5ce21f9b 100644 --- a/testing/test_package_docs/ex/ExtendedShortName-class.html +++ b/testing/test_package_docs/ex/ExtendedShortName-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/F-class.html b/testing/test_package_docs/ex/F-class.html index f9e79ea76d..8275c5b6cf 100644 --- a/testing/test_package_docs/ex/F-class.html +++ b/testing/test_package_docs/ex/F-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/ForAnnotation-class.html b/testing/test_package_docs/ex/ForAnnotation-class.html index 1883d67324..a60516bc13 100644 --- a/testing/test_package_docs/ex/ForAnnotation-class.html +++ b/testing/test_package_docs/ex/ForAnnotation-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/HasAnnotation-class.html b/testing/test_package_docs/ex/HasAnnotation-class.html index 317e3da30b..75b7a4a60e 100644 --- a/testing/test_package_docs/ex/HasAnnotation-class.html +++ b/testing/test_package_docs/ex/HasAnnotation-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/Helper-class.html b/testing/test_package_docs/ex/Helper-class.html index 4ffa97fb0d..f1241bed91 100644 --- a/testing/test_package_docs/ex/Helper-class.html +++ b/testing/test_package_docs/ex/Helper-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/Klass-class.html b/testing/test_package_docs/ex/Klass-class.html index fd813619a1..a72060a8fa 100644 --- a/testing/test_package_docs/ex/Klass-class.html +++ b/testing/test_package_docs/ex/Klass-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/MY_CAT-constant.html b/testing/test_package_docs/ex/MY_CAT-constant.html index 3c7a24ec51..1ee43d0528 100644 --- a/testing/test_package_docs/ex/MY_CAT-constant.html +++ b/testing/test_package_docs/ex/MY_CAT-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/MyError-class.html b/testing/test_package_docs/ex/MyError-class.html index b4158377da..dc50226021 100644 --- a/testing/test_package_docs/ex/MyError-class.html +++ b/testing/test_package_docs/ex/MyError-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/MyErrorImplements-class.html b/testing/test_package_docs/ex/MyErrorImplements-class.html index badc615e1b..bd1ed51165 100644 --- a/testing/test_package_docs/ex/MyErrorImplements-class.html +++ b/testing/test_package_docs/ex/MyErrorImplements-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/MyException-class.html b/testing/test_package_docs/ex/MyException-class.html index c9ab300b9b..832ee092f0 100644 --- a/testing/test_package_docs/ex/MyException-class.html +++ b/testing/test_package_docs/ex/MyException-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/MyExceptionImplements-class.html b/testing/test_package_docs/ex/MyExceptionImplements-class.html index 7e2b4f2ec3..f3ad151d17 100644 --- a/testing/test_package_docs/ex/MyExceptionImplements-class.html +++ b/testing/test_package_docs/ex/MyExceptionImplements-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/PRETTY_COLORS-constant.html b/testing/test_package_docs/ex/PRETTY_COLORS-constant.html index 1dc2dd0016..7b171ff690 100644 --- a/testing/test_package_docs/ex/PRETTY_COLORS-constant.html +++ b/testing/test_package_docs/ex/PRETTY_COLORS-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/ParameterizedClass-class.html b/testing/test_package_docs/ex/ParameterizedClass-class.html index 49bb70c346..265750e3aa 100644 --- a/testing/test_package_docs/ex/ParameterizedClass-class.html +++ b/testing/test_package_docs/ex/ParameterizedClass-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/ParameterizedTypedef.html b/testing/test_package_docs/ex/ParameterizedTypedef.html index a95fca7dbb..bf2978d5b1 100644 --- a/testing/test_package_docs/ex/ParameterizedTypedef.html +++ b/testing/test_package_docs/ex/ParameterizedTypedef.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/PublicClassExtendsPrivateClass-class.html b/testing/test_package_docs/ex/PublicClassExtendsPrivateClass-class.html index 6739e0cf06..36b55c8f56 100644 --- a/testing/test_package_docs/ex/PublicClassExtendsPrivateClass-class.html +++ b/testing/test_package_docs/ex/PublicClassExtendsPrivateClass-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/PublicClassImplementsPrivateInterface-class.html b/testing/test_package_docs/ex/PublicClassImplementsPrivateInterface-class.html index afda9251b3..4b8a5ab3fa 100644 --- a/testing/test_package_docs/ex/PublicClassImplementsPrivateInterface-class.html +++ b/testing/test_package_docs/ex/PublicClassImplementsPrivateInterface-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/ShapeType-class.html b/testing/test_package_docs/ex/ShapeType-class.html index a1105739c1..cdca4bf0ec 100644 --- a/testing/test_package_docs/ex/ShapeType-class.html +++ b/testing/test_package_docs/ex/ShapeType-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/ShortName-class.html b/testing/test_package_docs/ex/ShortName-class.html index b122544c4e..c1c1cb0e8d 100644 --- a/testing/test_package_docs/ex/ShortName-class.html +++ b/testing/test_package_docs/ex/ShortName-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/SpecializedDuration-class.html b/testing/test_package_docs/ex/SpecializedDuration-class.html index 611d7e2213..c8e5fc7727 100644 --- a/testing/test_package_docs/ex/SpecializedDuration-class.html +++ b/testing/test_package_docs/ex/SpecializedDuration-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/TemplatedClass-class.html b/testing/test_package_docs/ex/TemplatedClass-class.html index d3cce43572..edceac636b 100644 --- a/testing/test_package_docs/ex/TemplatedClass-class.html +++ b/testing/test_package_docs/ex/TemplatedClass-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/TemplatedInterface-class.html b/testing/test_package_docs/ex/TemplatedInterface-class.html index f7b6d47e35..5f85da5258 100644 --- a/testing/test_package_docs/ex/TemplatedInterface-class.html +++ b/testing/test_package_docs/ex/TemplatedInterface-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/ToolUser-class.html b/testing/test_package_docs/ex/ToolUser-class.html new file mode 100644 index 0000000000..316b655ec4 --- /dev/null +++ b/testing/test_package_docs/ex/ToolUser-class.html @@ -0,0 +1,256 @@ + + + + + + + + ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ToolUser
    + +
    + +
    + +
    +
    ex library
    +
      +
    1. Classes
      2. +
    2. AnotherParameterizedClass
      3. +
    3. Apple
      4. +
    4. aThingToDo
      5. +
    5. B
      6. +
    6. Cat
      7. +
    7. CatString
      8. +
    8. ConstantCat
      9. +
    9. Cool
      10. +
    10. Deprecated
      11. +
    11. Dog
      12. +
    12. E
      13. +
    13. ExtendedShortName
      14. +
    14. F
      15. +
    15. ForAnnotation
      16. +
    16. HasAnnotation
      17. +
    17. Helper
      18. +
    18. Klass
      19. +
    19. ParameterizedClass
      20. +
    20. PublicClassExtendsPrivateClass
      21. +
    21. PublicClassImplementsPrivateInterface
      22. +
    22. ShapeType
      23. +
    23. ShortName
      24. +
    24. SpecializedDuration
      25. +
    25. TemplatedClass
      26. +
    26. TemplatedInterface
      27. +
    27. ToolUser
      28. +
    28. TypedFunctionsWithoutTypedefs
      29. +
    29. WithGeneric
      30. +
    30. WithGenericSub
      31. + +
    31. Constants
      32. +
    32. COLOR
      33. +
    33. COLOR_GREEN
      34. +
    34. COLOR_ORANGE
      35. +
    35. COMPLEX_COLOR
      36. +
    36. deprecated
      37. +
    37. incorrectDocReference
      38. +
    38. incorrectDocReferenceFromEx
      39. +
    39. MY_CAT
      40. +
    40. PRETTY_COLORS
      41. + +
    41. Properties
      42. +
    42. deprecatedField
      43. +
    43. deprecatedGetter
      44. +
    44. deprecatedSetter
      45. +
    45. number
      46. +
    46. y
      47. + +
    47. Functions
      48. +
    48. function1
      49. +
    49. genericFunction
      50. + +
    50. Enums
      51. +
    51. Animal
      52. + +
    52. Typedefs
      53. +
    53. aComplexTypedef
      54. +
    54. ParameterizedTypedef
      55. +
    55. processMessage
      56. + +
    56. Exceptions
      57. +
    57. MyError
      58. +
    58. MyErrorImplements
      59. +
    59. MyException
      60. +
    60. MyExceptionImplements
      61. +
    +
    + +
    +

    ToolUser class

    + + + +
    +

    Constructors

    + +
    +
    + ToolUser() +
    +
    + +
    +
    +
    + +
    +

    Properties

    + +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + invokeTool() + → void + +
    +
    + Invokes a tool. [...] + +
    +
    + invokeToolNoInput() + → void + +
    +
    + Invokes a tool without the $INPUT token or args. [...] + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/ex/ToolUser/ToolUser.html b/testing/test_package_docs/ex/ToolUser/ToolUser.html new file mode 100644 index 0000000000..1bb8beed1b --- /dev/null +++ b/testing/test_package_docs/ex/ToolUser/ToolUser.html @@ -0,0 +1,99 @@ + + + + + + + + ToolUser constructor - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ToolUser
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    ToolUser constructor

    + +
    + + ToolUser() +
    + + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/ex/ToolUser/hashCode.html b/testing/test_package_docs/ex/ToolUser/hashCode.html new file mode 100644 index 0000000000..3a0adb3e89 --- /dev/null +++ b/testing/test_package_docs/ex/ToolUser/hashCode.html @@ -0,0 +1,103 @@ + + + + + + + + hashCode property - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/ex/ToolUser/invokeTool.html b/testing/test_package_docs/ex/ToolUser/invokeTool.html new file mode 100644 index 0000000000..7adf58e2df --- /dev/null +++ b/testing/test_package_docs/ex/ToolUser/invokeTool.html @@ -0,0 +1,107 @@ + + + + + + + + invokeTool method - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    invokeTool
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    invokeTool method

    + +
    + void + invokeTool +() +
    +
    +

    Invokes a tool.

    +

    Args: --file=<INPUT_FILE>, --special= |[!@#"'$%^&*()_+]

    +

    Yes it is a [Dog]!

    +

    Yes it is a Dog! Is not a ToolUser.

    +

    Ok, fine it isn't.

    +

    Ok, fine it isn't. Is not a ToolUser.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/ex/ToolUser/invokeToolNoInput.html b/testing/test_package_docs/ex/ToolUser/invokeToolNoInput.html new file mode 100644 index 0000000000..40a328cbc4 --- /dev/null +++ b/testing/test_package_docs/ex/ToolUser/invokeToolNoInput.html @@ -0,0 +1,103 @@ + + + + + + + + invokeToolNoInput method - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    invokeToolNoInput
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    invokeToolNoInput method

    + +
    + void + invokeToolNoInput +() +
    +
    +

    Invokes a tool without the $INPUT token or args.

    +

    Args: []

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/ex/ToolUser/noSuchMethod.html b/testing/test_package_docs/ex/ToolUser/noSuchMethod.html new file mode 100644 index 0000000000..e83addb979 --- /dev/null +++ b/testing/test_package_docs/ex/ToolUser/noSuchMethod.html @@ -0,0 +1,99 @@ + + + + + + + + noSuchMethod method - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/ex/ToolUser/operator_equals.html b/testing/test_package_docs/ex/ToolUser/operator_equals.html new file mode 100644 index 0000000000..9d74b5fb55 --- /dev/null +++ b/testing/test_package_docs/ex/ToolUser/operator_equals.html @@ -0,0 +1,99 @@ + + + + + + + + operator == method - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/ex/ToolUser/runtimeType.html b/testing/test_package_docs/ex/ToolUser/runtimeType.html new file mode 100644 index 0000000000..2931c11346 --- /dev/null +++ b/testing/test_package_docs/ex/ToolUser/runtimeType.html @@ -0,0 +1,103 @@ + + + + + + + + runtimeType property - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/ex/ToolUser/toString.html b/testing/test_package_docs/ex/ToolUser/toString.html new file mode 100644 index 0000000000..8370a7de63 --- /dev/null +++ b/testing/test_package_docs/ex/ToolUser/toString.html @@ -0,0 +1,99 @@ + + + + + + + + toString method - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/ex/TypedFunctionsWithoutTypedefs-class.html b/testing/test_package_docs/ex/TypedFunctionsWithoutTypedefs-class.html index 115a6624db..bb7f483738 100644 --- a/testing/test_package_docs/ex/TypedFunctionsWithoutTypedefs-class.html +++ b/testing/test_package_docs/ex/TypedFunctionsWithoutTypedefs-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/WithGeneric-class.html b/testing/test_package_docs/ex/WithGeneric-class.html index a3d0e8c4ee..8ecac304f4 100644 --- a/testing/test_package_docs/ex/WithGeneric-class.html +++ b/testing/test_package_docs/ex/WithGeneric-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/WithGenericSub-class.html b/testing/test_package_docs/ex/WithGenericSub-class.html index 42674d2882..5b2833452b 100644 --- a/testing/test_package_docs/ex/WithGenericSub-class.html +++ b/testing/test_package_docs/ex/WithGenericSub-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/aComplexTypedef.html b/testing/test_package_docs/ex/aComplexTypedef.html index 7774887cf0..7a92b5f98d 100644 --- a/testing/test_package_docs/ex/aComplexTypedef.html +++ b/testing/test_package_docs/ex/aComplexTypedef.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/aThingToDo-class.html b/testing/test_package_docs/ex/aThingToDo-class.html index 88d52faa9f..c17ddd2fcf 100644 --- a/testing/test_package_docs/ex/aThingToDo-class.html +++ b/testing/test_package_docs/ex/aThingToDo-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/deprecated-constant.html b/testing/test_package_docs/ex/deprecated-constant.html index e39704cfd7..318362f29a 100644 --- a/testing/test_package_docs/ex/deprecated-constant.html +++ b/testing/test_package_docs/ex/deprecated-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/deprecatedField.html b/testing/test_package_docs/ex/deprecatedField.html index b087b38838..166c84538c 100644 --- a/testing/test_package_docs/ex/deprecatedField.html +++ b/testing/test_package_docs/ex/deprecatedField.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/deprecatedGetter.html b/testing/test_package_docs/ex/deprecatedGetter.html index d77dd2e542..e0541a2836 100644 --- a/testing/test_package_docs/ex/deprecatedGetter.html +++ b/testing/test_package_docs/ex/deprecatedGetter.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/deprecatedSetter.html b/testing/test_package_docs/ex/deprecatedSetter.html index 5273186102..ef6cbd3b26 100644 --- a/testing/test_package_docs/ex/deprecatedSetter.html +++ b/testing/test_package_docs/ex/deprecatedSetter.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/ex-library.html b/testing/test_package_docs/ex/ex-library.html index 4ea210c1fe..9b0cd192f9 100644 --- a/testing/test_package_docs/ex/ex-library.html +++ b/testing/test_package_docs/ex/ex-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • @@ -225,6 +228,12 @@

    Classes

    Class for testing expansion of type from implements clause. +
    +
    + ToolUser +
    +
    +
    TypedFunctionsWithoutTypedefs @@ -535,6 +544,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/function1.html b/testing/test_package_docs/ex/function1.html index 5d26328929..a64b0530fc 100644 --- a/testing/test_package_docs/ex/function1.html +++ b/testing/test_package_docs/ex/function1.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/genericFunction.html b/testing/test_package_docs/ex/genericFunction.html index 1fc3db248b..893e3bf046 100644 --- a/testing/test_package_docs/ex/genericFunction.html +++ b/testing/test_package_docs/ex/genericFunction.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/incorrectDocReference-constant.html b/testing/test_package_docs/ex/incorrectDocReference-constant.html index e9b296e002..6630af044f 100644 --- a/testing/test_package_docs/ex/incorrectDocReference-constant.html +++ b/testing/test_package_docs/ex/incorrectDocReference-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/incorrectDocReferenceFromEx-constant.html b/testing/test_package_docs/ex/incorrectDocReferenceFromEx-constant.html index 83eaa31659..d3971cf72d 100644 --- a/testing/test_package_docs/ex/incorrectDocReferenceFromEx-constant.html +++ b/testing/test_package_docs/ex/incorrectDocReferenceFromEx-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/number.html b/testing/test_package_docs/ex/number.html index c89e6fa978..f6ffd36f83 100644 --- a/testing/test_package_docs/ex/number.html +++ b/testing/test_package_docs/ex/number.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/processMessage.html b/testing/test_package_docs/ex/processMessage.html index 021c70e0bc..95cc9644a8 100644 --- a/testing/test_package_docs/ex/processMessage.html +++ b/testing/test_package_docs/ex/processMessage.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/ex/y.html b/testing/test_package_docs/ex/y.html index 8eb237a44f..8246dc599c 100644 --- a/testing/test_package_docs/ex/y.html +++ b/testing/test_package_docs/ex/y.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs/fake/fake-library.html b/testing/test_package_docs/fake/fake-library.html index 8bf037b392..902159ea4f 100644 --- a/testing/test_package_docs/fake/fake-library.html +++ b/testing/test_package_docs/fake/fake-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/index.html b/testing/test_package_docs/index.html index 9476bc9d76..831e15eef3 100644 --- a/testing/test_package_docs/index.html +++ b/testing/test_package_docs/index.html @@ -4,7 +4,7 @@ - + test_package - Dart API docs @@ -56,6 +56,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • @@ -192,6 +195,21 @@

    test_package_imported

    +
    +

    args

    +
    +
    + args +
    +
    + +
    + command_runner +
    +
    + +
    +
    diff --git a/testing/test_package_docs/index.json b/testing/test_package_docs/index.json index 19cadde2f8..1222f84604 100644 --- a/testing/test_package_docs/index.json +++ b/testing/test_package_docs/index.json @@ -49,6 +49,937 @@ "type": "library" } }, + { + "name": "args", + "qualifiedName": "args", + "href": "package-args_args/package-args_args-library.html", + "type": "library", + "overriddenDepth": 0 + }, + { + "name": "ArgParser", + "qualifiedName": "args.ArgParser", + "href": "package-args_args/ArgParser-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "args", + "type": "library" + } + }, + { + "name": "ArgParser", + "qualifiedName": "args.ArgParser", + "href": "package-args_args/ArgParser/ArgParser.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "args.ArgParser.==", + "href": "package-args_args/ArgParser/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "addCommand", + "qualifiedName": "args.ArgParser.addCommand", + "href": "package-args_args/ArgParser/addCommand.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "addFlag", + "qualifiedName": "args.ArgParser.addFlag", + "href": "package-args_args/ArgParser/addFlag.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "addMultiOption", + "qualifiedName": "args.ArgParser.addMultiOption", + "href": "package-args_args/ArgParser/addMultiOption.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "addOption", + "qualifiedName": "args.ArgParser.addOption", + "href": "package-args_args/ArgParser/addOption.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "addSeparator", + "qualifiedName": "args.ArgParser.addSeparator", + "href": "package-args_args/ArgParser/addSeparator.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "ArgParser.allowAnything", + "qualifiedName": "args.ArgParser.allowAnything", + "href": "package-args_args/ArgParser/ArgParser.allowAnything.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "allowTrailingOptions", + "qualifiedName": "args.ArgParser.allowTrailingOptions", + "href": "package-args_args/ArgParser/allowTrailingOptions.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "allowsAnything", + "qualifiedName": "args.ArgParser.allowsAnything", + "href": "package-args_args/ArgParser/allowsAnything.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "commands", + "qualifiedName": "args.ArgParser.commands", + "href": "package-args_args/ArgParser/commands.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "findByAbbreviation", + "qualifiedName": "args.ArgParser.findByAbbreviation", + "href": "package-args_args/ArgParser/findByAbbreviation.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "getDefault", + "qualifiedName": "args.ArgParser.getDefault", + "href": "package-args_args/ArgParser/getDefault.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "getUsage", + "qualifiedName": "args.ArgParser.getUsage", + "href": "package-args_args/ArgParser/getUsage.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "args.ArgParser.hashCode", + "href": "package-args_args/ArgParser/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "args.ArgParser.noSuchMethod", + "href": "package-args_args/ArgParser/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "options", + "qualifiedName": "args.ArgParser.options", + "href": "package-args_args/ArgParser/options.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "parse", + "qualifiedName": "args.ArgParser.parse", + "href": "package-args_args/ArgParser/parse.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "args.ArgParser.runtimeType", + "href": "package-args_args/ArgParser/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "args.ArgParser.toString", + "href": "package-args_args/ArgParser/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "usage", + "qualifiedName": "args.ArgParser.usage", + "href": "package-args_args/ArgParser/usage.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "usageLineLength", + "qualifiedName": "args.ArgParser.usageLineLength", + "href": "package-args_args/ArgParser/usageLineLength.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "ArgParserException", + "qualifiedName": "args.ArgParserException", + "href": "package-args_args/ArgParserException-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "args", + "type": "library" + } + }, + { + "name": "ArgParserException", + "qualifiedName": "args.ArgParserException", + "href": "package-args_args/ArgParserException/ArgParserException.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "args.ArgParserException.==", + "href": "package-args_args/ArgParserException/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "commands", + "qualifiedName": "args.ArgParserException.commands", + "href": "package-args_args/ArgParserException/commands.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "args.ArgParserException.hashCode", + "href": "package-args_args/ArgParserException/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "message", + "qualifiedName": "args.ArgParserException.message", + "href": "package-args_args/ArgParserException/message.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "args.ArgParserException.noSuchMethod", + "href": "package-args_args/ArgParserException/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "offset", + "qualifiedName": "args.ArgParserException.offset", + "href": "package-args_args/ArgParserException/offset.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "args.ArgParserException.runtimeType", + "href": "package-args_args/ArgParserException/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "source", + "qualifiedName": "args.ArgParserException.source", + "href": "package-args_args/ArgParserException/source.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "args.ArgParserException.toString", + "href": "package-args_args/ArgParserException/toString.html", + "type": "method", + "overriddenDepth": 1, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "ArgResults", + "qualifiedName": "args.ArgResults", + "href": "package-args_args/ArgResults-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "args", + "type": "library" + } + }, + { + "name": "operator ==", + "qualifiedName": "args.ArgResults.==", + "href": "package-args_args/ArgResults/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "operator []", + "qualifiedName": "args.ArgResults.[]", + "href": "package-args_args/ArgResults/operator_get.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "arguments", + "qualifiedName": "args.ArgResults.arguments", + "href": "package-args_args/ArgResults/arguments.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "command", + "qualifiedName": "args.ArgResults.command", + "href": "package-args_args/ArgResults/command.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "args.ArgResults.hashCode", + "href": "package-args_args/ArgResults/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "name", + "qualifiedName": "args.ArgResults.name", + "href": "package-args_args/ArgResults/name.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "args.ArgResults.noSuchMethod", + "href": "package-args_args/ArgResults/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "options", + "qualifiedName": "args.ArgResults.options", + "href": "package-args_args/ArgResults/options.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "rest", + "qualifiedName": "args.ArgResults.rest", + "href": "package-args_args/ArgResults/rest.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "args.ArgResults.runtimeType", + "href": "package-args_args/ArgResults/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "args.ArgResults.toString", + "href": "package-args_args/ArgResults/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "wasParsed", + "qualifiedName": "args.ArgResults.wasParsed", + "href": "package-args_args/ArgResults/wasParsed.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "Option", + "qualifiedName": "args.Option", + "href": "package-args_args/Option-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "args", + "type": "library" + } + }, + { + "name": "operator ==", + "qualifiedName": "args.Option.==", + "href": "package-args_args/Option/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "abbr", + "qualifiedName": "args.Option.abbr", + "href": "package-args_args/Option/abbr.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "abbreviation", + "qualifiedName": "args.Option.abbreviation", + "href": "package-args_args/Option/abbreviation.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "allowed", + "qualifiedName": "args.Option.allowed", + "href": "package-args_args/Option/allowed.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "allowedHelp", + "qualifiedName": "args.Option.allowedHelp", + "href": "package-args_args/Option/allowedHelp.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "callback", + "qualifiedName": "args.Option.callback", + "href": "package-args_args/Option/callback.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "defaultValue", + "qualifiedName": "args.Option.defaultValue", + "href": "package-args_args/Option/defaultValue.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "defaultsTo", + "qualifiedName": "args.Option.defaultsTo", + "href": "package-args_args/Option/defaultsTo.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "getOrDefault", + "qualifiedName": "args.Option.getOrDefault", + "href": "package-args_args/Option/getOrDefault.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "args.Option.hashCode", + "href": "package-args_args/Option/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "help", + "qualifiedName": "args.Option.help", + "href": "package-args_args/Option/help.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "hide", + "qualifiedName": "args.Option.hide", + "href": "package-args_args/Option/hide.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "isFlag", + "qualifiedName": "args.Option.isFlag", + "href": "package-args_args/Option/isFlag.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "isMultiple", + "qualifiedName": "args.Option.isMultiple", + "href": "package-args_args/Option/isMultiple.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "isSingle", + "qualifiedName": "args.Option.isSingle", + "href": "package-args_args/Option/isSingle.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "name", + "qualifiedName": "args.Option.name", + "href": "package-args_args/Option/name.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "negatable", + "qualifiedName": "args.Option.negatable", + "href": "package-args_args/Option/negatable.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "args.Option.noSuchMethod", + "href": "package-args_args/Option/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "args.Option.runtimeType", + "href": "package-args_args/Option/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "splitCommas", + "qualifiedName": "args.Option.splitCommas", + "href": "package-args_args/Option/splitCommas.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "args.Option.toString", + "href": "package-args_args/Option/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "type", + "qualifiedName": "args.Option.type", + "href": "package-args_args/Option/type.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "valueHelp", + "qualifiedName": "args.Option.valueHelp", + "href": "package-args_args/Option/valueHelp.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "OptionType", + "qualifiedName": "args.OptionType", + "href": "package-args_args/OptionType-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "args", + "type": "library" + } + }, + { + "name": "operator ==", + "qualifiedName": "args.OptionType.==", + "href": "package-args_args/OptionType/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "FLAG", + "qualifiedName": "args.OptionType.FLAG", + "href": "package-args_args/OptionType/FLAG-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "MULTIPLE", + "qualifiedName": "args.OptionType.MULTIPLE", + "href": "package-args_args/OptionType/MULTIPLE-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "SINGLE", + "qualifiedName": "args.OptionType.SINGLE", + "href": "package-args_args/OptionType/SINGLE-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "flag", + "qualifiedName": "args.OptionType.flag", + "href": "package-args_args/OptionType/flag-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "args.OptionType.hashCode", + "href": "package-args_args/OptionType/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "multiple", + "qualifiedName": "args.OptionType.multiple", + "href": "package-args_args/OptionType/multiple-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "name", + "qualifiedName": "args.OptionType.name", + "href": "package-args_args/OptionType/name.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "args.OptionType.noSuchMethod", + "href": "package-args_args/OptionType/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "args.OptionType.runtimeType", + "href": "package-args_args/OptionType/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "single", + "qualifiedName": "args.OptionType.single", + "href": "package-args_args/OptionType/single-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "args.OptionType.toString", + "href": "package-args_args/OptionType/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, { "name": "categoriesExported", "qualifiedName": "categoriesExported", @@ -57,88 +988,700 @@ "overriddenDepth": 0 }, { - "name": "IAmAClassWithCategories", - "qualifiedName": "categoriesExported.IAmAClassWithCategories", - "href": "categoriesExported/IAmAClassWithCategories-class.html", + "name": "IAmAClassWithCategories", + "qualifiedName": "categoriesExported.IAmAClassWithCategories", + "href": "categoriesExported/IAmAClassWithCategories-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "categoriesExported", + "type": "library" + } + }, + { + "name": "IAmAClassWithCategories", + "qualifiedName": "categoriesExported.IAmAClassWithCategories", + "href": "categoriesExported/IAmAClassWithCategories/IAmAClassWithCategories.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "categoriesExported.IAmAClassWithCategories.==", + "href": "categoriesExported/IAmAClassWithCategories/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "categoriesExported.IAmAClassWithCategories.hashCode", + "href": "categoriesExported/IAmAClassWithCategories/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "categoriesExported.IAmAClassWithCategories.noSuchMethod", + "href": "categoriesExported/IAmAClassWithCategories/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "categoriesExported.IAmAClassWithCategories.runtimeType", + "href": "categoriesExported/IAmAClassWithCategories/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "categoriesExported.IAmAClassWithCategories.toString", + "href": "categoriesExported/IAmAClassWithCategories/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "code_in_comments", + "qualifiedName": "code_in_comments", + "href": "code_in_comments/code_in_comments-library.html", + "type": "library", + "overriddenDepth": 0 + }, + { + "name": "command_runner", + "qualifiedName": "command_runner", + "href": "package-args_command_runner/package-args_command_runner-library.html", + "type": "library", + "overriddenDepth": 0 + }, + { + "name": "Command", + "qualifiedName": "command_runner.Command", + "href": "package-args_command_runner/Command-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "command_runner", + "type": "library" + } + }, + { + "name": "Command", + "qualifiedName": "command_runner.Command", + "href": "package-args_command_runner/Command/Command.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "command_runner.Command.==", + "href": "package-args_command_runner/Command/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "addSubcommand", + "qualifiedName": "command_runner.Command.addSubcommand", + "href": "package-args_command_runner/Command/addSubcommand.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "aliases", + "qualifiedName": "command_runner.Command.aliases", + "href": "package-args_command_runner/Command/aliases.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "argParser", + "qualifiedName": "command_runner.Command.argParser", + "href": "package-args_command_runner/Command/argParser.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "argResults", + "qualifiedName": "command_runner.Command.argResults", + "href": "package-args_command_runner/Command/argResults.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "description", + "qualifiedName": "command_runner.Command.description", + "href": "package-args_command_runner/Command/description.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "globalResults", + "qualifiedName": "command_runner.Command.globalResults", + "href": "package-args_command_runner/Command/globalResults.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "command_runner.Command.hashCode", + "href": "package-args_command_runner/Command/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "hidden", + "qualifiedName": "command_runner.Command.hidden", + "href": "package-args_command_runner/Command/hidden.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "invocation", + "qualifiedName": "command_runner.Command.invocation", + "href": "package-args_command_runner/Command/invocation.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "name", + "qualifiedName": "command_runner.Command.name", + "href": "package-args_command_runner/Command/name.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "command_runner.Command.noSuchMethod", + "href": "package-args_command_runner/Command/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "parent", + "qualifiedName": "command_runner.Command.parent", + "href": "package-args_command_runner/Command/parent.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "printUsage", + "qualifiedName": "command_runner.Command.printUsage", + "href": "package-args_command_runner/Command/printUsage.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "run", + "qualifiedName": "command_runner.Command.run", + "href": "package-args_command_runner/Command/run.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "runner", + "qualifiedName": "command_runner.Command.runner", + "href": "package-args_command_runner/Command/runner.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "command_runner.Command.runtimeType", + "href": "package-args_command_runner/Command/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "subcommands", + "qualifiedName": "command_runner.Command.subcommands", + "href": "package-args_command_runner/Command/subcommands.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "summary", + "qualifiedName": "command_runner.Command.summary", + "href": "package-args_command_runner/Command/summary.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "takesArguments", + "qualifiedName": "command_runner.Command.takesArguments", + "href": "package-args_command_runner/Command/takesArguments.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "command_runner.Command.toString", + "href": "package-args_command_runner/Command/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "usage", + "qualifiedName": "command_runner.Command.usage", + "href": "package-args_command_runner/Command/usage.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "usageException", + "qualifiedName": "command_runner.Command.usageException", + "href": "package-args_command_runner/Command/usageException.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "usageFooter", + "qualifiedName": "command_runner.Command.usageFooter", + "href": "package-args_command_runner/Command/usageFooter.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "CommandRunner", + "qualifiedName": "command_runner.CommandRunner", + "href": "package-args_command_runner/CommandRunner-class.html", "type": "class", "overriddenDepth": 0, "enclosedBy": { - "name": "categoriesExported", + "name": "command_runner", "type": "library" } }, { - "name": "IAmAClassWithCategories", - "qualifiedName": "categoriesExported.IAmAClassWithCategories", - "href": "categoriesExported/IAmAClassWithCategories/IAmAClassWithCategories.html", + "name": "CommandRunner", + "qualifiedName": "command_runner.CommandRunner", + "href": "package-args_command_runner/CommandRunner/CommandRunner.html", "type": "constructor", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", "type": "class" } }, { "name": "operator ==", - "qualifiedName": "categoriesExported.IAmAClassWithCategories.==", - "href": "categoriesExported/IAmAClassWithCategories/operator_equals.html", + "qualifiedName": "command_runner.CommandRunner.==", + "href": "package-args_command_runner/CommandRunner/operator_equals.html", "type": "method", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "addCommand", + "qualifiedName": "command_runner.CommandRunner.addCommand", + "href": "package-args_command_runner/CommandRunner/addCommand.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "argParser", + "qualifiedName": "command_runner.CommandRunner.argParser", + "href": "package-args_command_runner/CommandRunner/argParser.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "commands", + "qualifiedName": "command_runner.CommandRunner.commands", + "href": "package-args_command_runner/CommandRunner/commands.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "description", + "qualifiedName": "command_runner.CommandRunner.description", + "href": "package-args_command_runner/CommandRunner/description.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "executableName", + "qualifiedName": "command_runner.CommandRunner.executableName", + "href": "package-args_command_runner/CommandRunner/executableName.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", "type": "class" } }, { "name": "hashCode", - "qualifiedName": "categoriesExported.IAmAClassWithCategories.hashCode", - "href": "categoriesExported/IAmAClassWithCategories/hashCode.html", + "qualifiedName": "command_runner.CommandRunner.hashCode", + "href": "package-args_command_runner/CommandRunner/hashCode.html", "type": "property", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "invocation", + "qualifiedName": "command_runner.CommandRunner.invocation", + "href": "package-args_command_runner/CommandRunner/invocation.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", "type": "class" } }, { "name": "noSuchMethod", - "qualifiedName": "categoriesExported.IAmAClassWithCategories.noSuchMethod", - "href": "categoriesExported/IAmAClassWithCategories/noSuchMethod.html", + "qualifiedName": "command_runner.CommandRunner.noSuchMethod", + "href": "package-args_command_runner/CommandRunner/noSuchMethod.html", "type": "method", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "parse", + "qualifiedName": "command_runner.CommandRunner.parse", + "href": "package-args_command_runner/CommandRunner/parse.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "printUsage", + "qualifiedName": "command_runner.CommandRunner.printUsage", + "href": "package-args_command_runner/CommandRunner/printUsage.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "run", + "qualifiedName": "command_runner.CommandRunner.run", + "href": "package-args_command_runner/CommandRunner/run.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "runCommand", + "qualifiedName": "command_runner.CommandRunner.runCommand", + "href": "package-args_command_runner/CommandRunner/runCommand.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", "type": "class" } }, { "name": "runtimeType", - "qualifiedName": "categoriesExported.IAmAClassWithCategories.runtimeType", - "href": "categoriesExported/IAmAClassWithCategories/runtimeType.html", + "qualifiedName": "command_runner.CommandRunner.runtimeType", + "href": "package-args_command_runner/CommandRunner/runtimeType.html", "type": "property", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", "type": "class" } }, { "name": "toString", - "qualifiedName": "categoriesExported.IAmAClassWithCategories.toString", - "href": "categoriesExported/IAmAClassWithCategories/toString.html", + "qualifiedName": "command_runner.CommandRunner.toString", + "href": "package-args_command_runner/CommandRunner/toString.html", "type": "method", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", "type": "class" } }, { - "name": "code_in_comments", - "qualifiedName": "code_in_comments", - "href": "code_in_comments/code_in_comments-library.html", - "type": "library", - "overriddenDepth": 0 + "name": "usage", + "qualifiedName": "command_runner.CommandRunner.usage", + "href": "package-args_command_runner/CommandRunner/usage.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "usageException", + "qualifiedName": "command_runner.CommandRunner.usageException", + "href": "package-args_command_runner/CommandRunner/usageException.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "usageFooter", + "qualifiedName": "command_runner.CommandRunner.usageFooter", + "href": "package-args_command_runner/CommandRunner/usageFooter.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "UsageException", + "qualifiedName": "command_runner.UsageException", + "href": "package-args_command_runner/UsageException-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "command_runner", + "type": "library" + } + }, + { + "name": "UsageException", + "qualifiedName": "command_runner.UsageException", + "href": "package-args_command_runner/UsageException/UsageException.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "command_runner.UsageException.==", + "href": "package-args_command_runner/UsageException/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "command_runner.UsageException.hashCode", + "href": "package-args_command_runner/UsageException/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "message", + "qualifiedName": "command_runner.UsageException.message", + "href": "package-args_command_runner/UsageException/message.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "command_runner.UsageException.noSuchMethod", + "href": "package-args_command_runner/UsageException/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "command_runner.UsageException.runtimeType", + "href": "package-args_command_runner/UsageException/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "command_runner.UsageException.toString", + "href": "package-args_command_runner/UsageException/toString.html", + "type": "method", + "overriddenDepth": 1, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "usage", + "qualifiedName": "command_runner.UsageException.usage", + "href": "package-args_command_runner/UsageException/usage.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } }, { "name": "css", @@ -3388,6 +4931,105 @@ "type": "class" } }, + { + "name": "ToolUser", + "qualifiedName": "ex.ToolUser", + "href": "ex/ToolUser-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ex", + "type": "library" + } + }, + { + "name": "ToolUser", + "qualifiedName": "ex.ToolUser", + "href": "ex/ToolUser/ToolUser.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "ex.ToolUser.==", + "href": "ex/ToolUser/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "ex.ToolUser.hashCode", + "href": "ex/ToolUser/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "invokeTool", + "qualifiedName": "ex.ToolUser.invokeTool", + "href": "ex/ToolUser/invokeTool.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "invokeToolNoInput", + "qualifiedName": "ex.ToolUser.invokeToolNoInput", + "href": "ex/ToolUser/invokeToolNoInput.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "ex.ToolUser.noSuchMethod", + "href": "ex/ToolUser/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "ex.ToolUser.runtimeType", + "href": "ex/ToolUser/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "ex.ToolUser.toString", + "href": "ex/ToolUser/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, { "name": "TypedFunctionsWithoutTypedefs", "qualifiedName": "ex.TypedFunctionsWithoutTypedefs", diff --git a/testing/test_package_docs/is_deprecated/is_deprecated-library.html b/testing/test_package_docs/is_deprecated/is_deprecated-library.html index 4cac1680f9..d7f4fd63ea 100644 --- a/testing/test_package_docs/is_deprecated/is_deprecated-library.html +++ b/testing/test_package_docs/is_deprecated/is_deprecated-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/package-args_args/ArgParser-class.html b/testing/test_package_docs/package-args_args/ArgParser-class.html new file mode 100644 index 0000000000..dd88c8407f --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser-class.html @@ -0,0 +1,345 @@ + + + + + + + + ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgParser
    + +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    +

    ArgParser class

    + +
    +

    A class for taking a list of raw command line arguments and parsing out +options and flags from them.

    +
    + + +
    +

    Constructors

    + +
    +
    + ArgParser({bool allowTrailingOptions: true, int usageLineLength }) +
    +
    + Creates a new ArgParser. [...] +
    factory
    +
    +
    + ArgParser.allowAnything() +
    +
    + Creates a new ArgParser that treats all input as non-option arguments. [...] +
    factory
    +
    +
    +
    + +
    +

    Properties

    + +
    +
    + allowsAnything + → bool +
    +
    + Whether or not this parser treats unrecognized options as non-option +arguments. +
    read-only
    +
    +
    + allowTrailingOptions + → bool +
    +
    + Whether or not this parser parses options that appear after non-option +arguments. +
    final
    +
    +
    + commands + → Map<String, ArgParser> +
    +
    + The commands that have been defined for this parser. +
    final
    +
    +
    + options + → Map<String, Option> +
    +
    + The options that have been defined for this parser. +
    final
    +
    +
    + usage + → String +
    +
    + Generates a string displaying usage information for the defined options. [...] +
    read-only
    +
    +
    + usageLineLength + → int +
    +
    + An optional maximum line length for usage messages. [...] +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + addCommand(String name, [ ArgParser parser ]) + → ArgParser + +
    +
    + Defines a command. [...] + +
    +
    + addFlag(String name, { String abbr, String help, bool defaultsTo: false, bool negatable: true, void callback(bool value), bool hide: false }) + → void + +
    +
    + Defines a boolean flag. [...] + +
    +
    + addMultiOption(String name, { String abbr, String help, String valueHelp, Iterable<String> allowed, Map<String, String> allowedHelp, Iterable<String> defaultsTo, void callback(List<String> values), bool splitCommas: true, bool hide: false }) + → void + +
    +
    + Defines an option that takes multiple values. [...] + +
    +
    + addOption(String name, { String abbr, String help, String valueHelp, Iterable<String> allowed, Map<String, String> allowedHelp, String defaultsTo, Function callback, bool allowMultiple: false, bool splitCommas, bool hide: false }) + → void + +
    +
    + Defines an option that takes a value. [...] + +
    +
    + addSeparator(String text) + → void + +
    +
    + Adds a separator line to the usage. [...] + +
    +
    + findByAbbreviation(String abbr) + → Option + +
    +
    + Finds the option whose abbreviation is abbr, or null if no option has +that abbreviation. + +
    +
    + getDefault(String option) + → dynamic + +
    +
    + Get the default value for an option. Useful after parsing to test if the +user specified something other than the default. + +
    +
    + getUsage() + → String + +
    +
    + Generates a string displaying usage information for the defined options. [...] +
    @Deprecated("Replaced with get usage. getUsage() will be removed in args 1.0")
    +
    +
    + parse(Iterable<String> args) + → ArgResults + +
    +
    + Parses args, a list of command-line arguments, matches them against the +flags and options defined by this parser, and returns the result. + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/ArgParser.allowAnything.html b/testing/test_package_docs/package-args_args/ArgParser/ArgParser.allowAnything.html new file mode 100644 index 0000000000..a4de8476ca --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/ArgParser.allowAnything.html @@ -0,0 +1,119 @@ + + + + + + + + ArgParser.allowAnything constructor - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgParser.allowAnything
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    ArgParser.allowAnything constructor

    + +
    + + ArgParser.allowAnything() +
    + +
    +

    Creates a new ArgParser that treats all input as non-option arguments.

    +

    This is intended to allow arguments to be passed through to child +processes without needing to be redefined in the parent.

    +

    Options may not be defined for this parser.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/ArgParser.html b/testing/test_package_docs/package-args_args/ArgParser/ArgParser.html new file mode 100644 index 0000000000..e7d40efa64 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/ArgParser.html @@ -0,0 +1,120 @@ + + + + + + + + ArgParser constructor - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgParser
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    ArgParser constructor

    + +
    + + ArgParser({bool allowTrailingOptions: true, int usageLineLength }) +
    + +
    +

    Creates a new ArgParser.

    +

    If allowTrailingOptions is true (the default), the parser will parse +flags and options that appear after positional arguments. If it's false, +the parser stops parsing as soon as it finds an argument that is neither +an option nor a command.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/addCommand.html b/testing/test_package_docs/package-args_args/ArgParser/addCommand.html new file mode 100644 index 0000000000..511b66e27a --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/addCommand.html @@ -0,0 +1,119 @@ + + + + + + + + addCommand method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addCommand
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    addCommand method

    + +
    + ArgParser + addCommand +(String name, [ ArgParser parser ]) +
    +
    +

    Defines a command.

    +

    A command is a named argument which may in turn define its own options and +subcommands using the given parser. If parser is omitted, implicitly +creates a new one. Returns the parser for the command.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/addFlag.html b/testing/test_package_docs/package-args_args/ArgParser/addFlag.html new file mode 100644 index 0000000000..44f9a926f1 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/addFlag.html @@ -0,0 +1,132 @@ + + + + + + + + addFlag method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addFlag
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    addFlag method

    + +
    + void + addFlag +(String name, { String abbr, String help, bool defaultsTo: false, bool negatable: true, void callback(bool value), bool hide: false }) +
    +
    +

    Defines a boolean flag.

    +

    This adds an Option with the given properties to options.

    +

    The abbr argument is a single-character string that can be used as a +shorthand for this flag. For example, abbr: "a" will allow the user to +pass -a to enable the flag.

    +

    The help argument is used by usage to describe this flag.

    +

    The defaultsTo argument indicates the value this flag will have if the +user doesn't explicitly pass it in.

    +

    The negatable argument indicates whether this flag's value can be set to +false. For example, if name is flag, the user can pass --no-flag +to set its value to false.

    +

    The callback argument is invoked with the flag's value when the flag +is parsed. Note that this makes argument parsing order-dependent in ways +that are often surprising, and its use is discouraged in favor of reading +values from the ArgResult.

    +

    If hide is true, this option won't be included in usage.

    +

    Throws an ArgumentError if:

    • There is already an option named name.
    • There is already an option using abbreviation abbr.
    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/addMultiOption.html b/testing/test_package_docs/package-args_args/ArgParser/addMultiOption.html new file mode 100644 index 0000000000..3788d33e8b --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/addMultiOption.html @@ -0,0 +1,139 @@ + + + + + + + + addMultiOption method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addMultiOption
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    addMultiOption method

    + +
    + void + addMultiOption +(String name, { String abbr, String help, String valueHelp, Iterable<String> allowed, Map<String, String> allowedHelp, Iterable<String> defaultsTo, void callback(List<String> values), bool splitCommas: true, bool hide: false }) +
    +
    +

    Defines an option that takes multiple values.

    +

    The abbr argument is a single-character string that can be used as a +shorthand for this option. For example, abbr: "a" will allow the user to +pass -a value or -avalue.

    +

    The help argument is used by usage to describe this option.

    +

    The valueHelp argument is used by usage as a name for the value this +argument takes. For example, valueHelp: "FOO" will include +--option=<FOO> rather than just --option in the usage string.

    +

    The allowed argument is a list of valid values for this argument. If +it's non-null and the user passes a value that's not included in the +list, parse will throw a FormatException. The allowed values will also +be included in usage.

    +

    The allowedHelp argument is a map from values in allowed to +documentation for those values that will be included in usage.

    +

    The defaultsTo argument indicates the values this option will have if +the user doesn't explicitly pass it in (or [] by default).

    +

    The callback argument is invoked with the option's value when the option +is parsed. Note that this makes argument parsing order-dependent in ways +that are often surprising, and its use is discouraged in favor of reading +values from the ArgResult.

    +

    If splitCommas is true (the default), multiple options may be passed +by writing --option a,b in addition to --option a --option b.

    +

    If hide is true, this option won't be included in usage.

    +

    Throws an ArgumentError if:

    • There is already an option with name name.
    • There is already an option using abbreviation abbr.
    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/addOption.html b/testing/test_package_docs/package-args_args/ArgParser/addOption.html new file mode 100644 index 0000000000..165ae34489 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/addOption.html @@ -0,0 +1,140 @@ + + + + + + + + addOption method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addOption
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    addOption method

    + +
    + void + addOption +(String name, { String abbr, String help, String valueHelp, Iterable<String> allowed, Map<String, String> allowedHelp, String defaultsTo, Function callback, @Deprecated("Use addMultiOption() instead.") bool allowMultiple: false, @Deprecated("Use addMultiOption() instead.") bool splitCommas, bool hide: false }) +
    +
    +

    Defines an option that takes a value.

    +

    This adds an Option with the given properties to options.

    +

    The abbr argument is a single-character string that can be used as a +shorthand for this option. For example, abbr: "a" will allow the user to +pass -a value or -avalue.

    +

    The help argument is used by usage to describe this option.

    +

    The valueHelp argument is used by usage as a name for the value this +option takes. For example, valueHelp: "FOO" will include +--option=<FOO> rather than just --option in the usage string.

    +

    The allowed argument is a list of valid values for this option. If +it's non-null and the user passes a value that's not included in the +list, parse will throw a FormatException. The allowed values will also +be included in usage.

    +

    The allowedHelp argument is a map from values in allowed to +documentation for those values that will be included in usage.

    +

    The defaultsTo argument indicates the value this option will have if the +user doesn't explicitly pass it in (or null by default).

    +

    The callback argument is invoked with the option's value when the option +is parsed. Note that this makes argument parsing order-dependent in ways +that are often surprising, and its use is discouraged in favor of reading +values from the ArgResult.

    +

    The allowMultiple and splitCommas options are deprecated; the +addMultiOption method should be used instead.

    +

    If hide is true, this option won't be included in usage.

    +

    Throws an ArgumentError if:

    • There is already an option with name name.
    • There is already an option using abbreviation abbr.
    • splitCommas is passed but allowMultiple is false.
    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/addSeparator.html b/testing/test_package_docs/package-args_args/ArgParser/addSeparator.html new file mode 100644 index 0000000000..438281af9a --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/addSeparator.html @@ -0,0 +1,118 @@ + + + + + + + + addSeparator method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addSeparator
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    addSeparator method

    + +
    + void + addSeparator +(String text) +
    +
    +

    Adds a separator line to the usage.

    +

    In the usage text for the parser, this will appear between any options +added before this call and ones added after it.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/allowTrailingOptions.html b/testing/test_package_docs/package-args_args/ArgParser/allowTrailingOptions.html new file mode 100644 index 0000000000..aed4a224f7 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/allowTrailingOptions.html @@ -0,0 +1,116 @@ + + + + + + + + allowTrailingOptions property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    allowTrailingOptions
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    allowTrailingOptions property

    + +
    + bool + allowTrailingOptions +
    final
    +
    +
    +

    Whether or not this parser parses options that appear after non-option +arguments.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/allowsAnything.html b/testing/test_package_docs/package-args_args/ArgParser/allowsAnything.html new file mode 100644 index 0000000000..36a1e7c6c6 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/allowsAnything.html @@ -0,0 +1,121 @@ + + + + + + + + allowsAnything property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    allowsAnything
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    allowsAnything property

    + + +
    + +
    + bool + allowsAnything + +
    + +
    +

    Whether or not this parser treats unrecognized options as non-option +arguments.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/commands.html b/testing/test_package_docs/package-args_args/ArgParser/commands.html new file mode 100644 index 0000000000..8588d0ffec --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/commands.html @@ -0,0 +1,115 @@ + + + + + + + + commands property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    commands
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    commands property

    + +
    + Map<String, ArgParser> + commands +
    final
    +
    +
    +

    The commands that have been defined for this parser.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/findByAbbreviation.html b/testing/test_package_docs/package-args_args/ArgParser/findByAbbreviation.html new file mode 100644 index 0000000000..4d91c3ba53 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/findByAbbreviation.html @@ -0,0 +1,117 @@ + + + + + + + + findByAbbreviation method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    findByAbbreviation
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    findByAbbreviation method

    + +
    + Option + findByAbbreviation +(String abbr) +
    +
    +

    Finds the option whose abbreviation is abbr, or null if no option has +that abbreviation.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/getDefault.html b/testing/test_package_docs/package-args_args/ArgParser/getDefault.html new file mode 100644 index 0000000000..e4236732fb --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/getDefault.html @@ -0,0 +1,117 @@ + + + + + + + + getDefault method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    getDefault
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    getDefault method

    + +
    + dynamic + getDefault +(String option) +
    +
    +

    Get the default value for an option. Useful after parsing to test if the +user specified something other than the default.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/getUsage.html b/testing/test_package_docs/package-args_args/ArgParser/getUsage.html new file mode 100644 index 0000000000..4186664537 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/getUsage.html @@ -0,0 +1,122 @@ + + + + + + + + getUsage method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    getUsage
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    getUsage method

    + +
    +
    +
      +
    1. @Deprecated("Replaced with get usage. getUsage() will be removed in args 1.0")
      2. +
    +
    + String + getUsage +() +
    +
    +

    Generates a string displaying usage information for the defined options.

    +

    This is basically the help text shown on the command line.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/hashCode.html b/testing/test_package_docs/package-args_args/ArgParser/hashCode.html new file mode 100644 index 0000000000..c4eb63e360 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/hashCode.html @@ -0,0 +1,117 @@ + + + + + + + + hashCode property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/noSuchMethod.html b/testing/test_package_docs/package-args_args/ArgParser/noSuchMethod.html new file mode 100644 index 0000000000..32a0fe6202 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/noSuchMethod.html @@ -0,0 +1,113 @@ + + + + + + + + noSuchMethod method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/operator_equals.html b/testing/test_package_docs/package-args_args/ArgParser/operator_equals.html new file mode 100644 index 0000000000..df57ae4726 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/operator_equals.html @@ -0,0 +1,113 @@ + + + + + + + + operator == method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/options.html b/testing/test_package_docs/package-args_args/ArgParser/options.html new file mode 100644 index 0000000000..889c96509f --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/options.html @@ -0,0 +1,115 @@ + + + + + + + + options property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    options
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    options property

    + +
    + Map<String, Option> + options +
    final
    +
    +
    +

    The options that have been defined for this parser.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/parse.html b/testing/test_package_docs/package-args_args/ArgParser/parse.html new file mode 100644 index 0000000000..df9e80539a --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/parse.html @@ -0,0 +1,117 @@ + + + + + + + + parse method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    parse
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    parse method

    + +
    + ArgResults + parse +(Iterable<String> args) +
    +
    +

    Parses args, a list of command-line arguments, matches them against the +flags and options defined by this parser, and returns the result.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/runtimeType.html b/testing/test_package_docs/package-args_args/ArgParser/runtimeType.html new file mode 100644 index 0000000000..b866ddf077 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/runtimeType.html @@ -0,0 +1,117 @@ + + + + + + + + runtimeType property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/toString.html b/testing/test_package_docs/package-args_args/ArgParser/toString.html new file mode 100644 index 0000000000..589794d532 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/toString.html @@ -0,0 +1,113 @@ + + + + + + + + toString method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/usage.html b/testing/test_package_docs/package-args_args/ArgParser/usage.html new file mode 100644 index 0000000000..b09d61e884 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/usage.html @@ -0,0 +1,121 @@ + + + + + + + + usage property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usage
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    usage property

    + + +
    + +
    + String + usage + +
    + +
    +

    Generates a string displaying usage information for the defined options.

    +

    This is basically the help text shown on the command line.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParser/usageLineLength.html b/testing/test_package_docs/package-args_args/ArgParser/usageLineLength.html new file mode 100644 index 0000000000..6c6ae949dd --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParser/usageLineLength.html @@ -0,0 +1,122 @@ + + + + + + + + usageLineLength property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usageLineLength
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    usageLineLength property

    + +
    + int + usageLineLength +
    final
    +
    +
    +

    An optional maximum line length for usage messages.

    +

    If specified, then help messages in the usage are wrapped at the given +column, after taking into account the width of the options. Will refuse to +wrap help text to less than 10 characters of help text per line if there +isn't enough space on the line. It preserves embedded newlines, and +attempts to wrap at whitespace breaks (although it will split words if +there is no whitespace at which to split).

    +

    If null (the default), help messages are not wrapped.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException-class.html b/testing/test_package_docs/package-args_args/ArgParserException-class.html new file mode 100644 index 0000000000..a990b8d754 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException-class.html @@ -0,0 +1,236 @@ + + + + + + + + ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgParserException
    + +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    +

    ArgParserException class

    + +
    +

    An exception thrown by ArgParser.

    +
    + +
    +
    +
    Inheritance
    +
      +
    • Object
      • +
    • FormatException
      • +
    • ArgParserException
      • +
    + + + + +
    +
    + +
    +

    Constructors

    + +
    +
    + ArgParserException(String message, [ Iterable<String> commands ]) +
    +
    + +
    +
    +
    + +
    +

    Properties

    + +
    +
    + commands + → List<String> +
    +
    + The command(s) that were parsed before discovering the error. [...] +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + message + → String +
    +
    + +
    final, inherited
    +
    +
    + offset + → int +
    +
    + +
    final, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    + source + → dynamic +
    +
    + +
    final, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException/ArgParserException.html b/testing/test_package_docs/package-args_args/ArgParserException/ArgParserException.html new file mode 100644 index 0000000000..c7ad7a8647 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException/ArgParserException.html @@ -0,0 +1,101 @@ + + + + + + + + ArgParserException constructor - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgParserException
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    ArgParserException constructor

    + +
    + + ArgParserException(String message, [ Iterable<String> commands ]) +
    + + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException/commands.html b/testing/test_package_docs/package-args_args/ArgParserException/commands.html new file mode 100644 index 0000000000..f33b0966b1 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException/commands.html @@ -0,0 +1,104 @@ + + + + + + + + commands property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    commands
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    commands property

    + +
    + List<String> + commands +
    final
    +
    +
    +

    The command(s) that were parsed before discovering the error.

    +

    This will be empty if the error was on the root parser.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException/hashCode.html b/testing/test_package_docs/package-args_args/ArgParserException/hashCode.html new file mode 100644 index 0000000000..b5b08511c2 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException/hashCode.html @@ -0,0 +1,105 @@ + + + + + + + + hashCode property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException/message.html b/testing/test_package_docs/package-args_args/ArgParserException/message.html new file mode 100644 index 0000000000..78c24b520a --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException/message.html @@ -0,0 +1,100 @@ + + + + + + + + message property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    message
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    message property

    + +
    + String + message +
    final, inherited
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException/noSuchMethod.html b/testing/test_package_docs/package-args_args/ArgParserException/noSuchMethod.html new file mode 100644 index 0000000000..150dbab26c --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException/noSuchMethod.html @@ -0,0 +1,101 @@ + + + + + + + + noSuchMethod method - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException/offset.html b/testing/test_package_docs/package-args_args/ArgParserException/offset.html new file mode 100644 index 0000000000..926b1f0020 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException/offset.html @@ -0,0 +1,100 @@ + + + + + + + + offset property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    offset
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    offset property

    + +
    + int + offset +
    final, inherited
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException/operator_equals.html b/testing/test_package_docs/package-args_args/ArgParserException/operator_equals.html new file mode 100644 index 0000000000..bd7aa6c508 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException/operator_equals.html @@ -0,0 +1,101 @@ + + + + + + + + operator == method - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException/runtimeType.html b/testing/test_package_docs/package-args_args/ArgParserException/runtimeType.html new file mode 100644 index 0000000000..903fa9cc48 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException/runtimeType.html @@ -0,0 +1,105 @@ + + + + + + + + runtimeType property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException/source.html b/testing/test_package_docs/package-args_args/ArgParserException/source.html new file mode 100644 index 0000000000..a15b622dae --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException/source.html @@ -0,0 +1,100 @@ + + + + + + + + source property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    source
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    source property

    + +
    + dynamic + source +
    final, inherited
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgParserException/toString.html b/testing/test_package_docs/package-args_args/ArgParserException/toString.html new file mode 100644 index 0000000000..312efe9a38 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgParserException/toString.html @@ -0,0 +1,101 @@ + + + + + + + + toString method - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults-class.html b/testing/test_package_docs/package-args_args/ArgResults-class.html new file mode 100644 index 0000000000..fb2bc01e3f --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults-class.html @@ -0,0 +1,243 @@ + + + + + + + + ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgResults
    + +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    +

    ArgResults class

    + +
    +

    The results of parsing a series of command line arguments using +ArgParser.parse().

    +

    Includes the parsed options and any remaining unparsed command line +arguments.

    +
    + + + +
    +

    Properties

    + +
    +
    + arguments + → List<String> +
    +
    + The original list of arguments that were parsed. +
    final
    +
    +
    + command + → ArgResults +
    +
    + The command that was selected, or null if none was. [...] +
    final
    +
    +
    + name + → String +
    +
    + If these are the results for parsing a command's options, this will be the +name of the command. For top-level results, this returns null. +
    final
    +
    +
    + options + → Iterable<String> +
    +
    + Get the names of the available options as an Iterable. [...] +
    read-only
    +
    +
    + rest + → List<String> +
    +
    + The remaining command-line arguments that were not parsed as options or +flags. [...] +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + wasParsed(String name) + → bool + +
    +
    + Returns true if the option with name was parsed from an actual +argument. [...] + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator [](String name) + → dynamic + +
    +
    + Gets the parsed command-line option named name. + +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/arguments.html b/testing/test_package_docs/package-args_args/ArgResults/arguments.html new file mode 100644 index 0000000000..711e75cf8f --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/arguments.html @@ -0,0 +1,104 @@ + + + + + + + + arguments property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    arguments
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    arguments property

    + +
    + List<String> + arguments +
    final
    +
    +
    +

    The original list of arguments that were parsed.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/command.html b/testing/test_package_docs/package-args_args/ArgResults/command.html new file mode 100644 index 0000000000..cab7e25600 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/command.html @@ -0,0 +1,105 @@ + + + + + + + + command property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    command
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    command property

    + +
    + ArgResults + command +
    final
    +
    +
    +

    The command that was selected, or null if none was.

    +

    This will contain the options that were selected for that command.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/hashCode.html b/testing/test_package_docs/package-args_args/ArgResults/hashCode.html new file mode 100644 index 0000000000..df33cf94e3 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/hashCode.html @@ -0,0 +1,106 @@ + + + + + + + + hashCode property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/name.html b/testing/test_package_docs/package-args_args/ArgResults/name.html new file mode 100644 index 0000000000..ee7357cf24 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/name.html @@ -0,0 +1,105 @@ + + + + + + + + name property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    name
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    name property

    + +
    + String + name +
    final
    +
    +
    +

    If these are the results for parsing a command's options, this will be the +name of the command. For top-level results, this returns null.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/noSuchMethod.html b/testing/test_package_docs/package-args_args/ArgResults/noSuchMethod.html new file mode 100644 index 0000000000..b426626aaa --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/noSuchMethod.html @@ -0,0 +1,102 @@ + + + + + + + + noSuchMethod method - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/operator_equals.html b/testing/test_package_docs/package-args_args/ArgResults/operator_equals.html new file mode 100644 index 0000000000..aaa0aa3c6f --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/operator_equals.html @@ -0,0 +1,102 @@ + + + + + + + + operator == method - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/operator_get.html b/testing/test_package_docs/package-args_args/ArgResults/operator_get.html new file mode 100644 index 0000000000..b834397dda --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/operator_get.html @@ -0,0 +1,105 @@ + + + + + + + + operator [] method - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator []
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    operator [] method

    + +
    + dynamic + operator [] +(String name) +
    +
    +

    Gets the parsed command-line option named name.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/options.html b/testing/test_package_docs/package-args_args/ArgResults/options.html new file mode 100644 index 0000000000..a0ebffb9fe --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/options.html @@ -0,0 +1,111 @@ + + + + + + + + options property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    options
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    options property

    + + +
    + +
    + Iterable<String> + options + +
    + +
    +

    Get the names of the available options as an Iterable.

    +

    This includes the options whose values were parsed or that have defaults. +Options that weren't present and have no default will be omitted.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/rest.html b/testing/test_package_docs/package-args_args/ArgResults/rest.html new file mode 100644 index 0000000000..631bf6008b --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/rest.html @@ -0,0 +1,108 @@ + + + + + + + + rest property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    rest
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    rest property

    + +
    + List<String> + rest +
    final
    +
    +
    +

    The remaining command-line arguments that were not parsed as options or +flags.

    +

    If -- was used to separate the options from the remaining arguments, +it will not be included in this list unless parsing stopped before the +-- was reached.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/runtimeType.html b/testing/test_package_docs/package-args_args/ArgResults/runtimeType.html new file mode 100644 index 0000000000..3e77a1c2bb --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/runtimeType.html @@ -0,0 +1,106 @@ + + + + + + + + runtimeType property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/toString.html b/testing/test_package_docs/package-args_args/ArgResults/toString.html new file mode 100644 index 0000000000..fb6f807462 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/toString.html @@ -0,0 +1,102 @@ + + + + + + + + toString method - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/ArgResults/wasParsed.html b/testing/test_package_docs/package-args_args/ArgResults/wasParsed.html new file mode 100644 index 0000000000..46a31c9e36 --- /dev/null +++ b/testing/test_package_docs/package-args_args/ArgResults/wasParsed.html @@ -0,0 +1,108 @@ + + + + + + + + wasParsed method - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    wasParsed
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    wasParsed method

    + +
    + bool + wasParsed +(String name) +
    +
    +

    Returns true if the option with name was parsed from an actual +argument.

    +

    Returns false if it wasn't provided and the default value or no default +value would be used instead.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option-class.html b/testing/test_package_docs/package-args_args/Option-class.html new file mode 100644 index 0000000000..7976311e6a --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option-class.html @@ -0,0 +1,338 @@ + + + + + + + + Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    Option
    + +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    +

    Option class

    + +
    +

    A command-line option.

    +

    This represents both boolean flags and options which take a value.

    +
    + + + +
    +

    Properties

    + +
    +
    + abbr + → String +
    +
    + A single-character string that can be used as a shorthand for this option. [...] +
    final
    +
    +
    + abbreviation + → String +
    +
    + +
    @Deprecated('Use abbr instead.'), read-only
    +
    +
    + allowed + → List<String> +
    +
    + A list of valid values for this option. +
    final
    +
    +
    + allowedHelp + → Map<String, String> +
    +
    + A map from values in allowed to documentation for those values. +
    final
    +
    +
    + callback + → Function +
    +
    + The callback to invoke with the option's value when the option is parsed. +
    final
    +
    +
    + defaultsTo + → dynamic +
    +
    + The value this option will have if the user doesn't explicitly pass it in +
    final
    +
    +
    + defaultValue + → dynamic +
    +
    + +
    @Deprecated('Use defaultsTo instead.'), read-only
    +
    +
    + help + → String +
    +
    + A description of this option. +
    final
    +
    +
    + hide + → bool +
    +
    + Whether this option should be hidden from usage documentation. +
    final
    +
    +
    + isFlag + → bool +
    +
    + Whether the option is boolean-valued flag. +
    read-only
    +
    +
    + isMultiple + → bool +
    +
    + Whether the option allows multiple values. +
    read-only
    +
    +
    + isSingle + → bool +
    +
    + Whether the option takes a single value. +
    read-only
    +
    +
    + name + → String +
    +
    + The name of the option that the user passes as an argument. +
    final
    +
    +
    + negatable + → bool +
    +
    + Whether this flag's value can be set to false. [...] +
    final
    +
    +
    + splitCommas + → bool +
    +
    + Whether multiple values may be passed by writing --option a,b in +addition to --option a --option b. +
    final
    +
    +
    + type + → OptionType +
    +
    + Whether this is a flag, a single value option, or a multi-value option. +
    final
    +
    +
    + valueHelp + → String +
    +
    + A name for the value this option takes. +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + getOrDefault(dynamic value) + → dynamic + +
    +
    + Returns value if non-null, otherwise returns the default value for +this option. [...] + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/abbr.html b/testing/test_package_docs/package-args_args/Option/abbr.html new file mode 100644 index 0000000000..88803d03c5 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/abbr.html @@ -0,0 +1,117 @@ + + + + + + + + abbr property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    abbr
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    abbr property

    + +
    + String + abbr +
    final
    +
    +
    +

    A single-character string that can be used as a shorthand for this option.

    +

    For example, abbr: "a" will allow the user to pass -a value or +-avalue.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/abbreviation.html b/testing/test_package_docs/package-args_args/Option/abbreviation.html new file mode 100644 index 0000000000..5f99319e84 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/abbreviation.html @@ -0,0 +1,117 @@ + + + + + + + + abbreviation property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    abbreviation
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    abbreviation property

    + + +
    + +
    + String + abbreviation +
    @Deprecated("Use abbr instead.")
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/allowed.html b/testing/test_package_docs/package-args_args/Option/allowed.html new file mode 100644 index 0000000000..bc90e0538b --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/allowed.html @@ -0,0 +1,115 @@ + + + + + + + + allowed property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    allowed
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    allowed property

    + +
    + List<String> + allowed +
    final
    +
    +
    +

    A list of valid values for this option.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/allowedHelp.html b/testing/test_package_docs/package-args_args/Option/allowedHelp.html new file mode 100644 index 0000000000..b41ddc0d7f --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/allowedHelp.html @@ -0,0 +1,115 @@ + + + + + + + + allowedHelp property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    allowedHelp
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    allowedHelp property

    + +
    + Map<String, String> + allowedHelp +
    final
    +
    +
    +

    A map from values in allowed to documentation for those values.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/callback.html b/testing/test_package_docs/package-args_args/Option/callback.html new file mode 100644 index 0000000000..12b815e740 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/callback.html @@ -0,0 +1,115 @@ + + + + + + + + callback property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    callback
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    callback property

    + +
    + Function + callback +
    final
    +
    +
    +

    The callback to invoke with the option's value when the option is parsed.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/defaultValue.html b/testing/test_package_docs/package-args_args/Option/defaultValue.html new file mode 100644 index 0000000000..c684935e98 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/defaultValue.html @@ -0,0 +1,117 @@ + + + + + + + + defaultValue property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    defaultValue
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    defaultValue property

    + + +
    + +
    + dynamic + defaultValue +
    @Deprecated("Use defaultsTo instead.")
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/defaultsTo.html b/testing/test_package_docs/package-args_args/Option/defaultsTo.html new file mode 100644 index 0000000000..abd5a0ae2b --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/defaultsTo.html @@ -0,0 +1,115 @@ + + + + + + + + defaultsTo property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    defaultsTo
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    defaultsTo property

    + +
    + dynamic + defaultsTo +
    final
    +
    +
    +

    The value this option will have if the user doesn't explicitly pass it in

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/getOrDefault.html b/testing/test_package_docs/package-args_args/Option/getOrDefault.html new file mode 100644 index 0000000000..885a17b67a --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/getOrDefault.html @@ -0,0 +1,120 @@ + + + + + + + + getOrDefault method - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    getOrDefault
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    getOrDefault method

    + +
    + dynamic + getOrDefault +(dynamic value) +
    +
    +

    Returns value if non-null, otherwise returns the default value for +this option.

    +

    For single-valued options, it will be defaultsTo if set or null +otherwise. For multiple-valued options, it will be an empty list or a +list containing defaultsTo if set.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/hashCode.html b/testing/test_package_docs/package-args_args/Option/hashCode.html new file mode 100644 index 0000000000..986bf5e959 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/hashCode.html @@ -0,0 +1,117 @@ + + + + + + + + hashCode property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/help.html b/testing/test_package_docs/package-args_args/Option/help.html new file mode 100644 index 0000000000..5f1f4e24fa --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/help.html @@ -0,0 +1,115 @@ + + + + + + + + help property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    help
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    help property

    + +
    + String + help +
    final
    +
    +
    +

    A description of this option.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/hide.html b/testing/test_package_docs/package-args_args/Option/hide.html new file mode 100644 index 0000000000..4a96a4c072 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/hide.html @@ -0,0 +1,115 @@ + + + + + + + + hide property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hide
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    hide property

    + +
    + bool + hide +
    final
    +
    +
    +

    Whether this option should be hidden from usage documentation.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/isFlag.html b/testing/test_package_docs/package-args_args/Option/isFlag.html new file mode 100644 index 0000000000..bc0cc4880c --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/isFlag.html @@ -0,0 +1,120 @@ + + + + + + + + isFlag property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    isFlag
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    isFlag property

    + + +
    + +
    + bool + isFlag + +
    + +
    +

    Whether the option is boolean-valued flag.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/isMultiple.html b/testing/test_package_docs/package-args_args/Option/isMultiple.html new file mode 100644 index 0000000000..f7b8bc0d6e --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/isMultiple.html @@ -0,0 +1,120 @@ + + + + + + + + isMultiple property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    isMultiple
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    isMultiple property

    + + +
    + +
    + bool + isMultiple + +
    + +
    +

    Whether the option allows multiple values.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/isSingle.html b/testing/test_package_docs/package-args_args/Option/isSingle.html new file mode 100644 index 0000000000..46d2f95eca --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/isSingle.html @@ -0,0 +1,120 @@ + + + + + + + + isSingle property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    isSingle
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    isSingle property

    + + +
    + +
    + bool + isSingle + +
    + +
    +

    Whether the option takes a single value.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/name.html b/testing/test_package_docs/package-args_args/Option/name.html new file mode 100644 index 0000000000..0a0b7bb1cf --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/name.html @@ -0,0 +1,115 @@ + + + + + + + + name property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    name
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    name property

    + +
    + String + name +
    final
    +
    +
    +

    The name of the option that the user passes as an argument.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/negatable.html b/testing/test_package_docs/package-args_args/Option/negatable.html new file mode 100644 index 0000000000..edf61746b1 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/negatable.html @@ -0,0 +1,118 @@ + + + + + + + + negatable property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    negatable
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    negatable property

    + +
    + bool + negatable +
    final
    +
    +
    +

    Whether this flag's value can be set to false.

    +

    For example, if name is flag, the user can pass --no-flag to set its +value to false.

    +

    This is null unless type is OptionType.flag.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/noSuchMethod.html b/testing/test_package_docs/package-args_args/Option/noSuchMethod.html new file mode 100644 index 0000000000..d5b2b0c084 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/noSuchMethod.html @@ -0,0 +1,113 @@ + + + + + + + + noSuchMethod method - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/operator_equals.html b/testing/test_package_docs/package-args_args/Option/operator_equals.html new file mode 100644 index 0000000000..517f821181 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/operator_equals.html @@ -0,0 +1,113 @@ + + + + + + + + operator == method - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/runtimeType.html b/testing/test_package_docs/package-args_args/Option/runtimeType.html new file mode 100644 index 0000000000..4730aae102 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/runtimeType.html @@ -0,0 +1,117 @@ + + + + + + + + runtimeType property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/splitCommas.html b/testing/test_package_docs/package-args_args/Option/splitCommas.html new file mode 100644 index 0000000000..ea448e9292 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/splitCommas.html @@ -0,0 +1,116 @@ + + + + + + + + splitCommas property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    splitCommas
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    splitCommas property

    + +
    + bool + splitCommas +
    final
    +
    +
    +

    Whether multiple values may be passed by writing --option a,b in +addition to --option a --option b.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/toString.html b/testing/test_package_docs/package-args_args/Option/toString.html new file mode 100644 index 0000000000..5b8393463c --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/toString.html @@ -0,0 +1,113 @@ + + + + + + + + toString method - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/type.html b/testing/test_package_docs/package-args_args/Option/type.html new file mode 100644 index 0000000000..8ab765a953 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/type.html @@ -0,0 +1,115 @@ + + + + + + + + type property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    type
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    type property

    + +
    + OptionType + type +
    final
    +
    +
    +

    Whether this is a flag, a single value option, or a multi-value option.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/Option/valueHelp.html b/testing/test_package_docs/package-args_args/Option/valueHelp.html new file mode 100644 index 0000000000..8043259b89 --- /dev/null +++ b/testing/test_package_docs/package-args_args/Option/valueHelp.html @@ -0,0 +1,115 @@ + + + + + + + + valueHelp property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    valueHelp
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    valueHelp property

    + +
    + String + valueHelp +
    final
    +
    +
    +

    A name for the value this option takes.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType-class.html b/testing/test_package_docs/package-args_args/OptionType-class.html new file mode 100644 index 0000000000..1c4f71a0de --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType-class.html @@ -0,0 +1,260 @@ + + + + + + + + OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    OptionType
    + +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    +

    OptionType class

    + +
    +

    What kinds of values an option accepts.

    +
    + + + +
    +

    Properties

    + +
    +
    + name + → String +
    +
    + +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + +
    +

    Constants

    + +
    +
    + FLAG + → const OptionType +
    +
    + +
    @Deprecated("Use OptionType.flag instead.")
    +
    + flag +
    +
    +
    + flag + → const OptionType +
    +
    + An option that can only be true or false. [...] + +
    + const OptionType._("OptionType.flag") +
    +
    +
    + MULTIPLE + → const OptionType +
    +
    + +
    @Deprecated("Use OptionType.multiple instead.")
    +
    + multiple +
    +
    +
    + multiple + → const OptionType +
    +
    + An option that allows multiple values. [...] + +
    + const OptionType._("OptionType.multiple") +
    +
    +
    + SINGLE + → const OptionType +
    +
    + +
    @Deprecated("Use OptionType.single instead.")
    +
    + single +
    +
    +
    + single + → const OptionType +
    +
    + An option that takes a single value. [...] + +
    + const OptionType._("OptionType.single") +
    +
    +
    +
    + +
    + +
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/FLAG-constant.html b/testing/test_package_docs/package-args_args/OptionType/FLAG-constant.html new file mode 100644 index 0000000000..445af33f98 --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/FLAG-constant.html @@ -0,0 +1,104 @@ + + + + + + + + FLAG constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    FLAG
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    FLAG constant

    + +
    + OptionType + const FLAG + = + flag +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/MULTIPLE-constant.html b/testing/test_package_docs/package-args_args/OptionType/MULTIPLE-constant.html new file mode 100644 index 0000000000..2088a50390 --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/MULTIPLE-constant.html @@ -0,0 +1,104 @@ + + + + + + + + MULTIPLE constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    MULTIPLE
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    MULTIPLE constant

    + +
    + OptionType + const MULTIPLE + = + multiple +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/SINGLE-constant.html b/testing/test_package_docs/package-args_args/OptionType/SINGLE-constant.html new file mode 100644 index 0000000000..fdc4771e2f --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/SINGLE-constant.html @@ -0,0 +1,104 @@ + + + + + + + + SINGLE constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    SINGLE
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    SINGLE constant

    + +
    + OptionType + const SINGLE + = + single +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/flag-constant.html b/testing/test_package_docs/package-args_args/OptionType/flag-constant.html new file mode 100644 index 0000000000..9f597309a6 --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/flag-constant.html @@ -0,0 +1,108 @@ + + + + + + + + flag constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    flag
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    flag constant

    + +
    + OptionType + const flag + = + const OptionType._("OptionType.flag") +
    + +
    +

    An option that can only be true or false.

    +

    The presence of the option name itself in the argument list means true.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/hashCode.html b/testing/test_package_docs/package-args_args/OptionType/hashCode.html new file mode 100644 index 0000000000..f861460bc9 --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/hashCode.html @@ -0,0 +1,107 @@ + + + + + + + + hashCode property - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/multiple-constant.html b/testing/test_package_docs/package-args_args/OptionType/multiple-constant.html new file mode 100644 index 0000000000..520a49f74b --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/multiple-constant.html @@ -0,0 +1,112 @@ + + + + + + + + multiple constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    multiple
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    multiple constant

    + +
    + OptionType + const multiple + = + const OptionType._("OptionType.multiple") +
    + +
    +

    An option that allows multiple values.

    +

    Example:

    +
    --output text --output xml
+
    +

    In the parsed ArgResults, a multiple-valued option will always return +a list, even if one or no values were passed.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/name.html b/testing/test_package_docs/package-args_args/OptionType/name.html new file mode 100644 index 0000000000..46669cb379 --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/name.html @@ -0,0 +1,102 @@ + + + + + + + + name property - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    name
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    name property

    + +
    + String + name +
    final
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/noSuchMethod.html b/testing/test_package_docs/package-args_args/OptionType/noSuchMethod.html new file mode 100644 index 0000000000..62f79b1c93 --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/noSuchMethod.html @@ -0,0 +1,103 @@ + + + + + + + + noSuchMethod method - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/operator_equals.html b/testing/test_package_docs/package-args_args/OptionType/operator_equals.html new file mode 100644 index 0000000000..b44ece34bb --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/operator_equals.html @@ -0,0 +1,103 @@ + + + + + + + + operator == method - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/runtimeType.html b/testing/test_package_docs/package-args_args/OptionType/runtimeType.html new file mode 100644 index 0000000000..e10e6204b1 --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/runtimeType.html @@ -0,0 +1,107 @@ + + + + + + + + runtimeType property - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/single-constant.html b/testing/test_package_docs/package-args_args/OptionType/single-constant.html new file mode 100644 index 0000000000..a6c99fda01 --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/single-constant.html @@ -0,0 +1,113 @@ + + + + + + + + single constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    single
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    single constant

    + +
    + OptionType + const single + = + const OptionType._("OptionType.single") +
    + +
    +

    An option that takes a single value.

    +

    Examples:

    +
    --mode debug
+-mdebug
+--mode=debug
+
    +

    If the option is passed more than once, the last one wins.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/OptionType/toString.html b/testing/test_package_docs/package-args_args/OptionType/toString.html new file mode 100644 index 0000000000..4742b3e174 --- /dev/null +++ b/testing/test_package_docs/package-args_args/OptionType/toString.html @@ -0,0 +1,103 @@ + + + + + + + + toString method - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_args/package-args_args-library.html b/testing/test_package_docs/package-args_args/package-args_args-library.html new file mode 100644 index 0000000000..06b9893111 --- /dev/null +++ b/testing/test_package_docs/package-args_args/package-args_args-library.html @@ -0,0 +1,162 @@ + + + + + + + + args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    args
    + +
    + +
    + +
    +
    test_package package
    +
      +
    1. Topics
      2. +
    2. Superb
      3. +
    3. Unreal
      4. +
    4. Libraries
      5. +
    5. anonymous_library
      6. +
    6. another_anonymous_lib
      7. +
    7. code_in_comments
      8. +
    8. is_deprecated
      9. +
    9. Unreal
      10. +
    10. reexport_one
      11. +
    11. reexport_two
      12. +
    12. Real Libraries
      13. +
    13. ex
      14. +
    14. fake
      15. +
    15. two_exports
      16. +
    16. Misc
      17. +
    17. two_exports
      18. +
    18. Other
      19. +
    19. css
      20. +
    20. test_package_imported
      21. +
    21. categoriesExported
      22. +
    22. test_package_imported.main
      23. +
    23. args
      24. +
    24. args
      25. +
    25. command_runner
      26. +
    +
    + +
    +

    args library

    + + +
    +

    Classes

    + +
    +
    + ArgParser +
    +
    + A class for taking a list of raw command line arguments and parsing out +options and flags from them. +
    +
    + ArgResults +
    +
    + The results of parsing a series of command line arguments using +ArgParser.parse(). [...] +
    +
    + Option +
    +
    + A command-line option. [...] +
    +
    + OptionType +
    +
    + What kinds of values an option accepts. +
    +
    +
    + + + + + + +
    +

    Exceptions / Errors

    + +
    +
    + ArgParserException +
    +
    + An exception thrown by ArgParser. +
    +
    +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command-class.html b/testing/test_package_docs/package-args_command_runner/Command-class.html new file mode 100644 index 0000000000..908cee1035 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command-class.html @@ -0,0 +1,366 @@ + + + + + + + + Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    Command
    + +
    + +
    + +
    +
    command_runner library
    +
      +
    1. Classes
      2. +
    2. Command
      3. +
    3. CommandRunner
      4. + + + + + + +
    4. Exceptions
      5. +
    5. UsageException
      6. +
    +
    + +
    +

    Command<T> class

    + +
    +

    A single command.

    +

    A command is known as a "leaf command" if it has no subcommands and is meant +to be run. Leaf commands must override run.

    +

    A command with subcommands is known as a "branch command" and cannot be run +itself. It should call addSubcommand (often from the constructor) to +register subcommands.

    +
    + + +
    +

    Constructors

    + +
    +
    + Command() +
    +
    + +
    +
    +
    + +
    +

    Properties

    + +
    +
    + aliases + → List<String> +
    +
    + Alternate names for this command. [...] +
    read-only
    +
    +
    + argParser + → ArgParser +
    +
    + The argument parser for this command. [...] +
    read-only
    +
    +
    + argResults + → ArgResults +
    +
    + The parsed argument results for this command. [...] +
    read-only
    +
    +
    + description + → String +
    +
    + A description of this command, included in usage. +
    read-only
    +
    +
    + globalResults + → ArgResults +
    +
    + The parsed global argument results. [...] +
    read-only
    +
    +
    + hidden + → bool +
    +
    + Whether or not this command should be hidden from help listings. [...] +
    read-only
    +
    +
    + invocation + → String +
    +
    + A single-line template for how to invoke this command (e.g. "pub getpackage"). +
    read-only
    +
    +
    + name + → String +
    +
    + The name of this command. +
    read-only
    +
    +
    + parent + → Command<T> +
    +
    + The command's parent command, if this is a subcommand. [...] +
    read-only
    +
    +
    + runner + → CommandRunner<T> +
    +
    + The command runner for this command. [...] +
    read-only
    +
    +
    + subcommands + → Map<String, Command<T>> +
    +
    + An unmodifiable view of all sublevel commands of this command. +
    read-only
    +
    +
    + summary + → String +
    +
    + A short description of this command, included in parent's +CommandRunner.usage. [...] +
    read-only
    +
    +
    + takesArguments + → bool +
    +
    + Whether or not this command takes positional arguments in addition to +options. [...] +
    read-only
    +
    +
    + usage + → String +
    +
    + Generates a string displaying usage information for this command. [...] +
    read-only
    +
    +
    + usageFooter + → String +
    +
    + An optional footer for usage. [...] +
    read-only
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + addSubcommand(Command<T> command) + → void + +
    +
    + Adds Command as a subcommand of this. + +
    +
    + printUsage() + → void + +
    +
    + Prints the usage information for this command. [...] + +
    +
    + run() + → FutureOr<T> + +
    +
    + Runs this command. [...] + +
    +
    + usageException(String message) + → void + +
    +
    + Throws a UsageException with message. + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/Command.html b/testing/test_package_docs/package-args_command_runner/Command/Command.html new file mode 100644 index 0000000000..dfb9a311b2 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/Command.html @@ -0,0 +1,116 @@ + + + + + + + + Command constructor - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    Command
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    Command<T> constructor

    + +
    + + Command<T>() +
    + + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/addSubcommand.html b/testing/test_package_docs/package-args_command_runner/Command/addSubcommand.html new file mode 100644 index 0000000000..4b37c2d73b --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/addSubcommand.html @@ -0,0 +1,119 @@ + + + + + + + + addSubcommand method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addSubcommand
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    addSubcommand method

    + +
    + void + addSubcommand +(Command<T> command) +
    +
    +

    Adds Command as a subcommand of this.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/aliases.html b/testing/test_package_docs/package-args_command_runner/Command/aliases.html new file mode 100644 index 0000000000..9124eb25d2 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/aliases.html @@ -0,0 +1,126 @@ + + + + + + + + aliases property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    aliases
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    aliases property

    + + +
    + +
    + List<String> + aliases + +
    + +
    +

    Alternate names for this command.

    +

    These names won't be used in the documentation, but they will work when +invoked on the command line.

    +

    This is intended to be overridden.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/argParser.html b/testing/test_package_docs/package-args_command_runner/Command/argParser.html new file mode 100644 index 0000000000..63567b8ff9 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/argParser.html @@ -0,0 +1,129 @@ + + + + + + + + argParser property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    argParser
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    argParser property

    + + +
    + +
    + ArgParser + argParser + +
    + +
    +

    The argument parser for this command.

    +

    Options for this command should be registered with this parser (often in +the constructor); they'll end up available via argResults. Subcommands +should be registered with addSubcommand rather than directly on the +parser.

    +

    This can be overridden to change the arguments passed to the ArgParser +constructor.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/argResults.html b/testing/test_package_docs/package-args_command_runner/Command/argResults.html new file mode 100644 index 0000000000..83bfc12e0d --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/argResults.html @@ -0,0 +1,124 @@ + + + + + + + + argResults property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    argResults
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    argResults property

    + + +
    + +
    + ArgResults + argResults + +
    + +
    +

    The parsed argument results for this command.

    +

    This will be null until just before Command.run is called.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/description.html b/testing/test_package_docs/package-args_command_runner/Command/description.html new file mode 100644 index 0000000000..14514f5073 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/description.html @@ -0,0 +1,123 @@ + + + + + + + + description property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    description
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    description property

    + + +
    + +
    + String + description + +
    + +
    +

    A description of this command, included in usage.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/globalResults.html b/testing/test_package_docs/package-args_command_runner/Command/globalResults.html new file mode 100644 index 0000000000..0fd837d3f6 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/globalResults.html @@ -0,0 +1,124 @@ + + + + + + + + globalResults property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    globalResults
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    globalResults property

    + + +
    + +
    + ArgResults + globalResults + +
    + +
    +

    The parsed global argument results.

    +

    This will be null until just before Command.run is called.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/hashCode.html b/testing/test_package_docs/package-args_command_runner/Command/hashCode.html new file mode 100644 index 0000000000..47fe77bee7 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/hashCode.html @@ -0,0 +1,120 @@ + + + + + + + + hashCode property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/hidden.html b/testing/test_package_docs/package-args_command_runner/Command/hidden.html new file mode 100644 index 0000000000..cf4748dd71 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/hidden.html @@ -0,0 +1,127 @@ + + + + + + + + hidden property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hidden
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    hidden property

    + + +
    + +
    + bool + hidden + +
    + +
    +

    Whether or not this command should be hidden from help listings.

    +

    This is intended to be overridden by commands that want to mark themselves +hidden.

    +

    By default, leaf commands are always visible. Branch commands are visible +as long as any of their leaf commands are visible.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/invocation.html b/testing/test_package_docs/package-args_command_runner/Command/invocation.html new file mode 100644 index 0000000000..056a561663 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/invocation.html @@ -0,0 +1,123 @@ + + + + + + + + invocation property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    invocation
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    invocation property

    + + +
    + +
    + String + invocation + +
    + +
    +

    A single-line template for how to invoke this command (e.g. "pub getpackage").

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/name.html b/testing/test_package_docs/package-args_command_runner/Command/name.html new file mode 100644 index 0000000000..b3f377967e --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/name.html @@ -0,0 +1,123 @@ + + + + + + + + name property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    name
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    name property

    + + +
    + +
    + String + name + +
    + +
    +

    The name of this command.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/noSuchMethod.html b/testing/test_package_docs/package-args_command_runner/Command/noSuchMethod.html new file mode 100644 index 0000000000..3ff626edca --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/noSuchMethod.html @@ -0,0 +1,116 @@ + + + + + + + + noSuchMethod method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/operator_equals.html b/testing/test_package_docs/package-args_command_runner/Command/operator_equals.html new file mode 100644 index 0000000000..9ef5bf61be --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/operator_equals.html @@ -0,0 +1,116 @@ + + + + + + + + operator == method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/parent.html b/testing/test_package_docs/package-args_command_runner/Command/parent.html new file mode 100644 index 0000000000..9bb15bf80e --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/parent.html @@ -0,0 +1,125 @@ + + + + + + + + parent property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    parent
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    parent property

    + + +
    + +
    + Command<T> + parent + +
    + +
    +

    The command's parent command, if this is a subcommand.

    +

    This will be null until addSubcommand has been called with +this command.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/printUsage.html b/testing/test_package_docs/package-args_command_runner/Command/printUsage.html new file mode 100644 index 0000000000..b71986665b --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/printUsage.html @@ -0,0 +1,121 @@ + + + + + + + + printUsage method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    printUsage
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    printUsage method

    + +
    + void + printUsage +() +
    +
    +

    Prints the usage information for this command.

    +

    This is called internally by run and can be overridden by subclasses to +control how output is displayed or integrate with a logging system.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/run.html b/testing/test_package_docs/package-args_command_runner/Command/run.html new file mode 100644 index 0000000000..bf02c892e4 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/run.html @@ -0,0 +1,121 @@ + + + + + + + + run method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    run
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    run method

    + +
    + FutureOr<T> + run +() +
    +
    +

    Runs this command.

    +

    The return value is wrapped in a Future if necessary and returned by +CommandRunner.runCommand.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/runner.html b/testing/test_package_docs/package-args_command_runner/Command/runner.html new file mode 100644 index 0000000000..6f3d46ab88 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/runner.html @@ -0,0 +1,125 @@ + + + + + + + + runner property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runner
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    runner property

    + + +
    + +
    + CommandRunner<T> + runner + +
    + +
    +

    The command runner for this command.

    +

    This will be null until CommandRunner.addCommand has been called with +this command or one of its parents.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/runtimeType.html b/testing/test_package_docs/package-args_command_runner/Command/runtimeType.html new file mode 100644 index 0000000000..63fd913e59 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/runtimeType.html @@ -0,0 +1,120 @@ + + + + + + + + runtimeType property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/subcommands.html b/testing/test_package_docs/package-args_command_runner/Command/subcommands.html new file mode 100644 index 0000000000..c7820b972f --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/subcommands.html @@ -0,0 +1,123 @@ + + + + + + + + subcommands property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    subcommands
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    subcommands property

    + + +
    + +
    + Map<String, Command<T>> + subcommands + +
    + +
    +

    An unmodifiable view of all sublevel commands of this command.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/summary.html b/testing/test_package_docs/package-args_command_runner/Command/summary.html new file mode 100644 index 0000000000..42666af808 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/summary.html @@ -0,0 +1,125 @@ + + + + + + + + summary property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    summary
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    summary property

    + + +
    + +
    + String + summary + +
    + +
    +

    A short description of this command, included in parent's +CommandRunner.usage.

    +

    This defaults to the first line of description.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/takesArguments.html b/testing/test_package_docs/package-args_command_runner/Command/takesArguments.html new file mode 100644 index 0000000000..55bf26ec68 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/takesArguments.html @@ -0,0 +1,128 @@ + + + + + + + + takesArguments property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    takesArguments
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    takesArguments property

    + + +
    + +
    + bool + takesArguments + +
    + +
    +

    Whether or not this command takes positional arguments in addition to +options.

    +

    If false, CommandRunner.run will throw a UsageException if arguments +are provided. Defaults to true.

    +

    This is intended to be overridden by commands that don't want to receive +arguments. It has no effect for branch commands.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/toString.html b/testing/test_package_docs/package-args_command_runner/Command/toString.html new file mode 100644 index 0000000000..2ce8547eae --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/toString.html @@ -0,0 +1,116 @@ + + + + + + + + toString method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/usage.html b/testing/test_package_docs/package-args_command_runner/Command/usage.html new file mode 100644 index 0000000000..9b3fa31281 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/usage.html @@ -0,0 +1,125 @@ + + + + + + + + usage property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usage
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    usage property

    + + +
    + +
    + String + usage + +
    + +
    +

    Generates a string displaying usage information for this command.

    +

    This includes usage for the command's arguments as well as a list of +subcommands, if there are any.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/usageException.html b/testing/test_package_docs/package-args_command_runner/Command/usageException.html new file mode 100644 index 0000000000..eb9835f53a --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/usageException.html @@ -0,0 +1,119 @@ + + + + + + + + usageException method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usageException
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    usageException method

    + +
    + void + usageException +(String message) +
    +
    +

    Throws a UsageException with message.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/Command/usageFooter.html b/testing/test_package_docs/package-args_command_runner/Command/usageFooter.html new file mode 100644 index 0000000000..461a0ed430 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/Command/usageFooter.html @@ -0,0 +1,125 @@ + + + + + + + + usageFooter property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usageFooter
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    usageFooter property

    + + +
    + +
    + String + usageFooter + +
    + +
    +

    An optional footer for usage.

    +

    If a subclass overrides this to return a string, it will automatically be +added to the end of usage.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner-class.html b/testing/test_package_docs/package-args_command_runner/CommandRunner-class.html new file mode 100644 index 0000000000..94de326fa4 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner-class.html @@ -0,0 +1,311 @@ + + + + + + + + CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    CommandRunner
    + +
    + +
    + +
    +
    command_runner library
    +
      +
    1. Classes
      2. +
    2. Command
      3. +
    3. CommandRunner
      4. + + + + + + +
    4. Exceptions
      5. +
    5. UsageException
      6. +
    +
    + +
    +

    CommandRunner<T> class

    + +
    +

    A class for invoking Commands based on raw command-line arguments.

    +

    The type argument T represents the type returned by Command.run and +CommandRunner.run; it can be ommitted if you're not using the return +values.

    +
    + + +
    +

    Constructors

    + +
    +
    + CommandRunner(String executableName, String description) +
    +
    + +
    +
    +
    + +
    +

    Properties

    + +
    +
    + argParser + → ArgParser +
    +
    + The top-level argument parser. [...] +
    read-only
    +
    +
    + commands + → Map<String, Command<T>> +
    +
    + An unmodifiable view of all top-level commands defined for this runner. +
    read-only
    +
    +
    + description + → String +
    +
    + A short description of this executable. +
    final
    +
    +
    + executableName + → String +
    +
    + The name of the executable being run. [...] +
    final
    +
    +
    + invocation + → String +
    +
    + A single-line template for how to invoke this executable. [...] +
    read-only
    +
    +
    + usage + → String +
    +
    + Generates a string displaying usage information for the executable. [...] +
    read-only
    +
    +
    + usageFooter + → String +
    +
    + An optional footer for usage. [...] +
    read-only
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + addCommand(Command<T> command) + → void + +
    +
    + Adds Command as a top-level command to this runner. + +
    +
    + parse(Iterable<String> args) + → ArgResults + +
    +
    + Parses args and returns the result, converting an ArgParserException +to a UsageException. [...] + +
    +
    + printUsage() + → void + +
    +
    + Prints the usage information for this runner. [...] + +
    +
    + run(Iterable<String> args) + → Future<T> + +
    +
    + Parses args and invokes Command.run on the chosen command. [...] + +
    +
    + runCommand(ArgResults topLevelResults) + → Future<T> + +
    +
    + Runs the command specified by topLevelResults. [...] + +
    +
    + usageException(String message) + → void + +
    +
    + Throws a UsageException with message. + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/CommandRunner.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/CommandRunner.html new file mode 100644 index 0000000000..0caaa82246 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/CommandRunner.html @@ -0,0 +1,110 @@ + + + + + + + + CommandRunner constructor - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    CommandRunner
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    CommandRunner<T> constructor

    + +
    + + CommandRunner<T>(String executableName, String description) +
    + + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/addCommand.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/addCommand.html new file mode 100644 index 0000000000..3e2802c24e --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/addCommand.html @@ -0,0 +1,113 @@ + + + + + + + + addCommand method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addCommand
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    addCommand method

    + +
    + void + addCommand +(Command<T> command) +
    +
    +

    Adds Command as a top-level command to this runner.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/argParser.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/argParser.html new file mode 100644 index 0000000000..c39f1d2542 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/argParser.html @@ -0,0 +1,120 @@ + + + + + + + + argParser property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    argParser
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    argParser property

    + + +
    + +
    + ArgParser + argParser + +
    + +
    +

    The top-level argument parser.

    +

    Global options should be registered with this parser; they'll end up +available via Command.globalResults. Commands should be registered with +addCommand rather than directly on the parser.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/commands.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/commands.html new file mode 100644 index 0000000000..ae6cabb2c5 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/commands.html @@ -0,0 +1,117 @@ + + + + + + + + commands property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    commands
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    commands property

    + + +
    + +
    + Map<String, Command<T>> + commands + +
    + +
    +

    An unmodifiable view of all top-level commands defined for this runner.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/description.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/description.html new file mode 100644 index 0000000000..f49f63fc09 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/description.html @@ -0,0 +1,112 @@ + + + + + + + + description property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    description
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    description property

    + +
    + String + description +
    final
    +
    +
    +

    A short description of this executable.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/executableName.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/executableName.html new file mode 100644 index 0000000000..93f4588de7 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/executableName.html @@ -0,0 +1,113 @@ + + + + + + + + executableName property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    executableName
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    executableName property

    + +
    + String + executableName +
    final
    +
    +
    +

    The name of the executable being run.

    +

    Used for error reporting and usage.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/hashCode.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/hashCode.html new file mode 100644 index 0000000000..bcc2d7db8b --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/hashCode.html @@ -0,0 +1,114 @@ + + + + + + + + hashCode property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/invocation.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/invocation.html new file mode 100644 index 0000000000..e5e19df0f1 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/invocation.html @@ -0,0 +1,119 @@ + + + + + + + + invocation property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    invocation
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    invocation property

    + + +
    + +
    + String + invocation + +
    + +
    +

    A single-line template for how to invoke this executable.

    +

    Defaults to "$executableName arguments". Subclasses can +override this for a more specific template.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/noSuchMethod.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/noSuchMethod.html new file mode 100644 index 0000000000..d0f40b77c5 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/noSuchMethod.html @@ -0,0 +1,110 @@ + + + + + + + + noSuchMethod method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/operator_equals.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/operator_equals.html new file mode 100644 index 0000000000..b157f581c1 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/operator_equals.html @@ -0,0 +1,110 @@ + + + + + + + + operator == method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/parse.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/parse.html new file mode 100644 index 0000000000..a902fdf124 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/parse.html @@ -0,0 +1,116 @@ + + + + + + + + parse method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    parse
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    parse method

    + +
    + ArgResults + parse +(Iterable<String> args) +
    +
    +

    Parses args and returns the result, converting an ArgParserException +to a UsageException.

    +

    This is notionally a protected method. It may be overridden or called from +subclasses, but it shouldn't be called externally.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/printUsage.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/printUsage.html new file mode 100644 index 0000000000..0cd8b9dd7c --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/printUsage.html @@ -0,0 +1,115 @@ + + + + + + + + printUsage method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    printUsage
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    printUsage method

    + +
    + void + printUsage +() +
    +
    +

    Prints the usage information for this runner.

    +

    This is called internally by run and can be overridden by subclasses to +control how output is displayed or integrate with a logging system.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/run.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/run.html new file mode 100644 index 0000000000..8ae2ca7855 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/run.html @@ -0,0 +1,115 @@ + + + + + + + + run method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    run
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    run method

    + +
    + Future<T> + run +(Iterable<String> args) +
    +
    +

    Parses args and invokes Command.run on the chosen command.

    +

    This always returns a Future in case the command is asynchronous. The +Future will throw a UsageException if args was invalid.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/runCommand.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/runCommand.html new file mode 100644 index 0000000000..1b2d66bf03 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/runCommand.html @@ -0,0 +1,119 @@ + + + + + + + + runCommand method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runCommand
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    runCommand method

    + +
    + Future<T> + runCommand +(ArgResults topLevelResults) +
    +
    +

    Runs the command specified by topLevelResults.

    +

    This is notionally a protected method. It may be overridden or called from +subclasses, but it shouldn't be called externally.

    +

    It's useful to override this to handle global flags and/or wrap the entire +command in a block. For example, you might handle the --verbose flag +here to enable verbose logging before running the command.

    +

    This returns the return value of Command.run.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/runtimeType.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/runtimeType.html new file mode 100644 index 0000000000..c0416c24ba --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/runtimeType.html @@ -0,0 +1,114 @@ + + + + + + + + runtimeType property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/toString.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/toString.html new file mode 100644 index 0000000000..e11d679eee --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/toString.html @@ -0,0 +1,110 @@ + + + + + + + + toString method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/usage.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/usage.html new file mode 100644 index 0000000000..1e1555503a --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/usage.html @@ -0,0 +1,119 @@ + + + + + + + + usage property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usage
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    usage property

    + + +
    + +
    + String + usage + +
    + +
    +

    Generates a string displaying usage information for the executable.

    +

    This includes usage for the global arguments as well as a list of +top-level commands.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/usageException.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/usageException.html new file mode 100644 index 0000000000..82d09a5169 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/usageException.html @@ -0,0 +1,113 @@ + + + + + + + + usageException method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usageException
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    usageException method

    + +
    + void + usageException +(String message) +
    +
    +

    Throws a UsageException with message.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/CommandRunner/usageFooter.html b/testing/test_package_docs/package-args_command_runner/CommandRunner/usageFooter.html new file mode 100644 index 0000000000..f1a4f5b22d --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/CommandRunner/usageFooter.html @@ -0,0 +1,119 @@ + + + + + + + + usageFooter property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usageFooter
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    usageFooter property

    + + +
    + +
    + String + usageFooter + +
    + +
    +

    An optional footer for usage.

    +

    If a subclass overrides this to return a string, it will automatically be +added to the end of usage.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/UsageException-class.html b/testing/test_package_docs/package-args_command_runner/UsageException-class.html new file mode 100644 index 0000000000..b0a948ad64 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/UsageException-class.html @@ -0,0 +1,213 @@ + + + + + + + + UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    UsageException
    + +
    + +
    + +
    +
    command_runner library
    +
      +
    1. Classes
      2. +
    2. Command
      3. +
    3. CommandRunner
      4. + + + + + + +
    4. Exceptions
      5. +
    5. UsageException
      6. +
    +
    + +
    +

    UsageException class

    + + +
    +
    + +
    Implements
    +
    +
      +
    • Exception
      • +
    +
    + + + +
    +
    + +
    +

    Constructors

    + +
    +
    + UsageException(String message, String usage) +
    +
    + +
    +
    +
    + +
    +

    Properties

    + +
    +
    + message + → String +
    +
    + +
    final
    +
    +
    + usage + → String +
    +
    + +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + toString() + → String + +
    +
    + + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/UsageException/UsageException.html b/testing/test_package_docs/package-args_command_runner/UsageException/UsageException.html new file mode 100644 index 0000000000..44862ff978 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/UsageException/UsageException.html @@ -0,0 +1,99 @@ + + + + + + + + UsageException constructor - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    UsageException
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    UsageException constructor

    + +
    + + UsageException(String message, String usage) +
    + + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/UsageException/hashCode.html b/testing/test_package_docs/package-args_command_runner/UsageException/hashCode.html new file mode 100644 index 0000000000..8cf6a88b41 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/UsageException/hashCode.html @@ -0,0 +1,103 @@ + + + + + + + + hashCode property - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/UsageException/message.html b/testing/test_package_docs/package-args_command_runner/UsageException/message.html new file mode 100644 index 0000000000..312407c75d --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/UsageException/message.html @@ -0,0 +1,98 @@ + + + + + + + + message property - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    message
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    message property

    + +
    + String + message +
    final
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/UsageException/noSuchMethod.html b/testing/test_package_docs/package-args_command_runner/UsageException/noSuchMethod.html new file mode 100644 index 0000000000..f6a8e40565 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/UsageException/noSuchMethod.html @@ -0,0 +1,99 @@ + + + + + + + + noSuchMethod method - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/UsageException/operator_equals.html b/testing/test_package_docs/package-args_command_runner/UsageException/operator_equals.html new file mode 100644 index 0000000000..af3e56e1c0 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/UsageException/operator_equals.html @@ -0,0 +1,99 @@ + + + + + + + + operator == method - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/UsageException/runtimeType.html b/testing/test_package_docs/package-args_command_runner/UsageException/runtimeType.html new file mode 100644 index 0000000000..f8f3c437bf --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/UsageException/runtimeType.html @@ -0,0 +1,103 @@ + + + + + + + + runtimeType property - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/UsageException/toString.html b/testing/test_package_docs/package-args_command_runner/UsageException/toString.html new file mode 100644 index 0000000000..9a9c4a6ff8 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/UsageException/toString.html @@ -0,0 +1,104 @@ + + + + + + + + toString method - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    toString method

    + +
    +
    +
      +
    1. @override
      2. +
    +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/UsageException/usage.html b/testing/test_package_docs/package-args_command_runner/UsageException/usage.html new file mode 100644 index 0000000000..97ecd3b841 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/UsageException/usage.html @@ -0,0 +1,98 @@ + + + + + + + + usage property - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usage
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    usage property

    + +
    + String + usage +
    final
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/package-args_command_runner/package-args_command_runner-library.html b/testing/test_package_docs/package-args_command_runner/package-args_command_runner-library.html new file mode 100644 index 0000000000..b9ed2bdfd1 --- /dev/null +++ b/testing/test_package_docs/package-args_command_runner/package-args_command_runner-library.html @@ -0,0 +1,146 @@ + + + + + + + + command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    command_runner
    + +
    + +
    + +
    +
    test_package package
    +
      +
    1. Topics
      2. +
    2. Superb
      3. +
    3. Unreal
      4. +
    4. Libraries
      5. +
    5. anonymous_library
      6. +
    6. another_anonymous_lib
      7. +
    7. code_in_comments
      8. +
    8. is_deprecated
      9. +
    9. Unreal
      10. +
    10. reexport_one
      11. +
    11. reexport_two
      12. +
    12. Real Libraries
      13. +
    13. ex
      14. +
    14. fake
      15. +
    15. two_exports
      16. +
    16. Misc
      17. +
    17. two_exports
      18. +
    18. Other
      19. +
    19. css
      20. +
    20. test_package_imported
      21. +
    21. categoriesExported
      22. +
    22. test_package_imported.main
      23. +
    23. args
      24. +
    24. args
      25. +
    25. command_runner
      26. +
    +
    + +
    +

    command_runner library

    + + +
    +

    Classes

    + +
    +
    + Command<T> +
    +
    + A single command. [...] +
    +
    + CommandRunner<T> +
    +
    + A class for invoking Commands based on raw command-line arguments. [...] +
    +
    +
    + + + + + + +
    +

    Exceptions / Errors

    + +
    +
    + UsageException +
    +
    + +
    +
    +
    + +
    + +
    +
    command_runner library
    +
      +
    1. Classes
      2. +
    2. Command
      3. +
    3. CommandRunner
      4. + + + + + + +
    4. Exceptions
      5. +
    5. UsageException
      6. +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs/reexport_one/reexport_one-library.html b/testing/test_package_docs/reexport_one/reexport_one-library.html index f21f42c9c5..f1b520de8f 100644 --- a/testing/test_package_docs/reexport_one/reexport_one-library.html +++ b/testing/test_package_docs/reexport_one/reexport_one-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/reexport_two/reexport_two-library.html b/testing/test_package_docs/reexport_two/reexport_two-library.html index e09900e665..f24a607483 100644 --- a/testing/test_package_docs/reexport_two/reexport_two-library.html +++ b/testing/test_package_docs/reexport_two/reexport_two-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/test_package_imported.main/test_package_imported.main-library.html b/testing/test_package_docs/test_package_imported.main/test_package_imported.main-library.html index b402f96406..b26f0549d9 100644 --- a/testing/test_package_docs/test_package_imported.main/test_package_imported.main-library.html +++ b/testing/test_package_docs/test_package_imported.main/test_package_imported.main-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/topics/Superb-topic.html b/testing/test_package_docs/topics/Superb-topic.html index c7288229da..4ced9efa79 100644 --- a/testing/test_package_docs/topics/Superb-topic.html +++ b/testing/test_package_docs/topics/Superb-topic.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/topics/Unreal-topic.html b/testing/test_package_docs/topics/Unreal-topic.html index fc33f2f3d3..c63288fe7d 100644 --- a/testing/test_package_docs/topics/Unreal-topic.html +++ b/testing/test_package_docs/topics/Unreal-topic.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs/two_exports/two_exports-library.html b/testing/test_package_docs/two_exports/two_exports-library.html index 42083e07bb..7a6a4a4351 100644 --- a/testing/test_package_docs/two_exports/two_exports-library.html +++ b/testing/test_package_docs/two_exports/two_exports-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/__404error.html b/testing/test_package_docs_dev/__404error.html index 2081627f8f..041217181a 100644 --- a/testing/test_package_docs_dev/__404error.html +++ b/testing/test_package_docs_dev/__404error.html @@ -4,7 +4,7 @@ - + test_package - Dart API docs @@ -56,6 +56,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/anonymous_library/anonymous_library-library.html b/testing/test_package_docs_dev/anonymous_library/anonymous_library-library.html index 2f0d6ef67d..abd70876d3 100644 --- a/testing/test_package_docs_dev/anonymous_library/anonymous_library-library.html +++ b/testing/test_package_docs_dev/anonymous_library/anonymous_library-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/another_anonymous_lib/another_anonymous_lib-library.html b/testing/test_package_docs_dev/another_anonymous_lib/another_anonymous_lib-library.html index 615dc5679e..2b312988c0 100644 --- a/testing/test_package_docs_dev/another_anonymous_lib/another_anonymous_lib-library.html +++ b/testing/test_package_docs_dev/another_anonymous_lib/another_anonymous_lib-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/categoriesExported/categoriesExported-library.html b/testing/test_package_docs_dev/categoriesExported/categoriesExported-library.html index 13bf0bb7dd..cc422783a5 100644 --- a/testing/test_package_docs_dev/categoriesExported/categoriesExported-library.html +++ b/testing/test_package_docs_dev/categoriesExported/categoriesExported-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/code_in_comments/code_in_comments-library.html b/testing/test_package_docs_dev/code_in_comments/code_in_comments-library.html index 2cef34da6d..3c28e9baa3 100644 --- a/testing/test_package_docs_dev/code_in_comments/code_in_comments-library.html +++ b/testing/test_package_docs_dev/code_in_comments/code_in_comments-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/css/css-library.html b/testing/test_package_docs_dev/css/css-library.html index 76ee0edb73..0b90e6a041 100644 --- a/testing/test_package_docs_dev/css/css-library.html +++ b/testing/test_package_docs_dev/css/css-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/ex/Animal-class.html b/testing/test_package_docs_dev/ex/Animal-class.html index 9d24ddeb30..dc9cf04644 100644 --- a/testing/test_package_docs_dev/ex/Animal-class.html +++ b/testing/test_package_docs_dev/ex/Animal-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/AnotherParameterizedClass-class.html b/testing/test_package_docs_dev/ex/AnotherParameterizedClass-class.html index 904a00a79b..9c1a63b10a 100644 --- a/testing/test_package_docs_dev/ex/AnotherParameterizedClass-class.html +++ b/testing/test_package_docs_dev/ex/AnotherParameterizedClass-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/Apple-class.html b/testing/test_package_docs_dev/ex/Apple-class.html index 6f5e8268c3..3bd9353192 100644 --- a/testing/test_package_docs_dev/ex/Apple-class.html +++ b/testing/test_package_docs_dev/ex/Apple-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/B-class.html b/testing/test_package_docs_dev/ex/B-class.html index 627b374201..fe42247f11 100644 --- a/testing/test_package_docs_dev/ex/B-class.html +++ b/testing/test_package_docs_dev/ex/B-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/COLOR-constant.html b/testing/test_package_docs_dev/ex/COLOR-constant.html index b83cc9113b..8ed51eb106 100644 --- a/testing/test_package_docs_dev/ex/COLOR-constant.html +++ b/testing/test_package_docs_dev/ex/COLOR-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/COLOR_GREEN-constant.html b/testing/test_package_docs_dev/ex/COLOR_GREEN-constant.html index 92612213d6..acfdb113d7 100644 --- a/testing/test_package_docs_dev/ex/COLOR_GREEN-constant.html +++ b/testing/test_package_docs_dev/ex/COLOR_GREEN-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/COLOR_ORANGE-constant.html b/testing/test_package_docs_dev/ex/COLOR_ORANGE-constant.html index 154ae2d942..729e501fcb 100644 --- a/testing/test_package_docs_dev/ex/COLOR_ORANGE-constant.html +++ b/testing/test_package_docs_dev/ex/COLOR_ORANGE-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/COMPLEX_COLOR-constant.html b/testing/test_package_docs_dev/ex/COMPLEX_COLOR-constant.html index 4522aff681..a3cc88b8dc 100644 --- a/testing/test_package_docs_dev/ex/COMPLEX_COLOR-constant.html +++ b/testing/test_package_docs_dev/ex/COMPLEX_COLOR-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/Cat-class.html b/testing/test_package_docs_dev/ex/Cat-class.html index b0249ec9c7..5a387593a1 100644 --- a/testing/test_package_docs_dev/ex/Cat-class.html +++ b/testing/test_package_docs_dev/ex/Cat-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/CatString-class.html b/testing/test_package_docs_dev/ex/CatString-class.html index cd86728741..2f3d6407f9 100644 --- a/testing/test_package_docs_dev/ex/CatString-class.html +++ b/testing/test_package_docs_dev/ex/CatString-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/ConstantCat-class.html b/testing/test_package_docs_dev/ex/ConstantCat-class.html index f7d3273a15..cf91c3a21b 100644 --- a/testing/test_package_docs_dev/ex/ConstantCat-class.html +++ b/testing/test_package_docs_dev/ex/ConstantCat-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/Deprecated-class.html b/testing/test_package_docs_dev/ex/Deprecated-class.html index 0da2333e21..6a14f348d8 100644 --- a/testing/test_package_docs_dev/ex/Deprecated-class.html +++ b/testing/test_package_docs_dev/ex/Deprecated-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/Dog-class.html b/testing/test_package_docs_dev/ex/Dog-class.html index 243ebec08b..1ebab5deaa 100644 --- a/testing/test_package_docs_dev/ex/Dog-class.html +++ b/testing/test_package_docs_dev/ex/Dog-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/E-class.html b/testing/test_package_docs_dev/ex/E-class.html index a2a1c36a35..8d883c8a1d 100644 --- a/testing/test_package_docs_dev/ex/E-class.html +++ b/testing/test_package_docs_dev/ex/E-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/ExtendedShortName-class.html b/testing/test_package_docs_dev/ex/ExtendedShortName-class.html index 57078ab5b2..0c5ce21f9b 100644 --- a/testing/test_package_docs_dev/ex/ExtendedShortName-class.html +++ b/testing/test_package_docs_dev/ex/ExtendedShortName-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/F-class.html b/testing/test_package_docs_dev/ex/F-class.html index f9e79ea76d..8275c5b6cf 100644 --- a/testing/test_package_docs_dev/ex/F-class.html +++ b/testing/test_package_docs_dev/ex/F-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/ForAnnotation-class.html b/testing/test_package_docs_dev/ex/ForAnnotation-class.html index 1883d67324..a60516bc13 100644 --- a/testing/test_package_docs_dev/ex/ForAnnotation-class.html +++ b/testing/test_package_docs_dev/ex/ForAnnotation-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/HasAnnotation-class.html b/testing/test_package_docs_dev/ex/HasAnnotation-class.html index 317e3da30b..75b7a4a60e 100644 --- a/testing/test_package_docs_dev/ex/HasAnnotation-class.html +++ b/testing/test_package_docs_dev/ex/HasAnnotation-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/Helper-class.html b/testing/test_package_docs_dev/ex/Helper-class.html index 4ffa97fb0d..f1241bed91 100644 --- a/testing/test_package_docs_dev/ex/Helper-class.html +++ b/testing/test_package_docs_dev/ex/Helper-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/Klass-class.html b/testing/test_package_docs_dev/ex/Klass-class.html index fd813619a1..a72060a8fa 100644 --- a/testing/test_package_docs_dev/ex/Klass-class.html +++ b/testing/test_package_docs_dev/ex/Klass-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/MY_CAT-constant.html b/testing/test_package_docs_dev/ex/MY_CAT-constant.html index 3c7a24ec51..1ee43d0528 100644 --- a/testing/test_package_docs_dev/ex/MY_CAT-constant.html +++ b/testing/test_package_docs_dev/ex/MY_CAT-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/MyError-class.html b/testing/test_package_docs_dev/ex/MyError-class.html index b4158377da..dc50226021 100644 --- a/testing/test_package_docs_dev/ex/MyError-class.html +++ b/testing/test_package_docs_dev/ex/MyError-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/MyErrorImplements-class.html b/testing/test_package_docs_dev/ex/MyErrorImplements-class.html index badc615e1b..bd1ed51165 100644 --- a/testing/test_package_docs_dev/ex/MyErrorImplements-class.html +++ b/testing/test_package_docs_dev/ex/MyErrorImplements-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/MyException-class.html b/testing/test_package_docs_dev/ex/MyException-class.html index c9ab300b9b..832ee092f0 100644 --- a/testing/test_package_docs_dev/ex/MyException-class.html +++ b/testing/test_package_docs_dev/ex/MyException-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/MyExceptionImplements-class.html b/testing/test_package_docs_dev/ex/MyExceptionImplements-class.html index 7e2b4f2ec3..f3ad151d17 100644 --- a/testing/test_package_docs_dev/ex/MyExceptionImplements-class.html +++ b/testing/test_package_docs_dev/ex/MyExceptionImplements-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/PRETTY_COLORS-constant.html b/testing/test_package_docs_dev/ex/PRETTY_COLORS-constant.html index 1dc2dd0016..7b171ff690 100644 --- a/testing/test_package_docs_dev/ex/PRETTY_COLORS-constant.html +++ b/testing/test_package_docs_dev/ex/PRETTY_COLORS-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/ParameterizedClass-class.html b/testing/test_package_docs_dev/ex/ParameterizedClass-class.html index 49bb70c346..265750e3aa 100644 --- a/testing/test_package_docs_dev/ex/ParameterizedClass-class.html +++ b/testing/test_package_docs_dev/ex/ParameterizedClass-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/ParameterizedTypedef.html b/testing/test_package_docs_dev/ex/ParameterizedTypedef.html index a95fca7dbb..bf2978d5b1 100644 --- a/testing/test_package_docs_dev/ex/ParameterizedTypedef.html +++ b/testing/test_package_docs_dev/ex/ParameterizedTypedef.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/PublicClassExtendsPrivateClass-class.html b/testing/test_package_docs_dev/ex/PublicClassExtendsPrivateClass-class.html index 6739e0cf06..36b55c8f56 100644 --- a/testing/test_package_docs_dev/ex/PublicClassExtendsPrivateClass-class.html +++ b/testing/test_package_docs_dev/ex/PublicClassExtendsPrivateClass-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/PublicClassImplementsPrivateInterface-class.html b/testing/test_package_docs_dev/ex/PublicClassImplementsPrivateInterface-class.html index afda9251b3..4b8a5ab3fa 100644 --- a/testing/test_package_docs_dev/ex/PublicClassImplementsPrivateInterface-class.html +++ b/testing/test_package_docs_dev/ex/PublicClassImplementsPrivateInterface-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/ShapeType-class.html b/testing/test_package_docs_dev/ex/ShapeType-class.html index a1105739c1..cdca4bf0ec 100644 --- a/testing/test_package_docs_dev/ex/ShapeType-class.html +++ b/testing/test_package_docs_dev/ex/ShapeType-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/ShortName-class.html b/testing/test_package_docs_dev/ex/ShortName-class.html index b122544c4e..c1c1cb0e8d 100644 --- a/testing/test_package_docs_dev/ex/ShortName-class.html +++ b/testing/test_package_docs_dev/ex/ShortName-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/SpecializedDuration-class.html b/testing/test_package_docs_dev/ex/SpecializedDuration-class.html index 611d7e2213..c8e5fc7727 100644 --- a/testing/test_package_docs_dev/ex/SpecializedDuration-class.html +++ b/testing/test_package_docs_dev/ex/SpecializedDuration-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/TemplatedClass-class.html b/testing/test_package_docs_dev/ex/TemplatedClass-class.html index d3cce43572..edceac636b 100644 --- a/testing/test_package_docs_dev/ex/TemplatedClass-class.html +++ b/testing/test_package_docs_dev/ex/TemplatedClass-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/TemplatedInterface-class.html b/testing/test_package_docs_dev/ex/TemplatedInterface-class.html index f7b6d47e35..5f85da5258 100644 --- a/testing/test_package_docs_dev/ex/TemplatedInterface-class.html +++ b/testing/test_package_docs_dev/ex/TemplatedInterface-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/ToolUser-class.html b/testing/test_package_docs_dev/ex/ToolUser-class.html new file mode 100644 index 0000000000..316b655ec4 --- /dev/null +++ b/testing/test_package_docs_dev/ex/ToolUser-class.html @@ -0,0 +1,256 @@ + + + + + + + + ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ToolUser
    + +
    + +
    + +
    +
    ex library
    +
      +
    1. Classes
      2. +
    2. AnotherParameterizedClass
      3. +
    3. Apple
      4. +
    4. aThingToDo
      5. +
    5. B
      6. +
    6. Cat
      7. +
    7. CatString
      8. +
    8. ConstantCat
      9. +
    9. Cool
      10. +
    10. Deprecated
      11. +
    11. Dog
      12. +
    12. E
      13. +
    13. ExtendedShortName
      14. +
    14. F
      15. +
    15. ForAnnotation
      16. +
    16. HasAnnotation
      17. +
    17. Helper
      18. +
    18. Klass
      19. +
    19. ParameterizedClass
      20. +
    20. PublicClassExtendsPrivateClass
      21. +
    21. PublicClassImplementsPrivateInterface
      22. +
    22. ShapeType
      23. +
    23. ShortName
      24. +
    24. SpecializedDuration
      25. +
    25. TemplatedClass
      26. +
    26. TemplatedInterface
      27. +
    27. ToolUser
      28. +
    28. TypedFunctionsWithoutTypedefs
      29. +
    29. WithGeneric
      30. +
    30. WithGenericSub
      31. + +
    31. Constants
      32. +
    32. COLOR
      33. +
    33. COLOR_GREEN
      34. +
    34. COLOR_ORANGE
      35. +
    35. COMPLEX_COLOR
      36. +
    36. deprecated
      37. +
    37. incorrectDocReference
      38. +
    38. incorrectDocReferenceFromEx
      39. +
    39. MY_CAT
      40. +
    40. PRETTY_COLORS
      41. + +
    41. Properties
      42. +
    42. deprecatedField
      43. +
    43. deprecatedGetter
      44. +
    44. deprecatedSetter
      45. +
    45. number
      46. +
    46. y
      47. + +
    47. Functions
      48. +
    48. function1
      49. +
    49. genericFunction
      50. + +
    50. Enums
      51. +
    51. Animal
      52. + +
    52. Typedefs
      53. +
    53. aComplexTypedef
      54. +
    54. ParameterizedTypedef
      55. +
    55. processMessage
      56. + +
    56. Exceptions
      57. +
    57. MyError
      58. +
    58. MyErrorImplements
      59. +
    59. MyException
      60. +
    60. MyExceptionImplements
      61. +
    +
    + +
    +

    ToolUser class

    + + + +
    +

    Constructors

    + +
    +
    + ToolUser() +
    +
    + +
    +
    +
    + +
    +

    Properties

    + +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + invokeTool() + → void + +
    +
    + Invokes a tool. [...] + +
    +
    + invokeToolNoInput() + → void + +
    +
    + Invokes a tool without the $INPUT token or args. [...] + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/ex/ToolUser/ToolUser.html b/testing/test_package_docs_dev/ex/ToolUser/ToolUser.html new file mode 100644 index 0000000000..1bb8beed1b --- /dev/null +++ b/testing/test_package_docs_dev/ex/ToolUser/ToolUser.html @@ -0,0 +1,99 @@ + + + + + + + + ToolUser constructor - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ToolUser
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    ToolUser constructor

    + +
    + + ToolUser() +
    + + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/ex/ToolUser/hashCode.html b/testing/test_package_docs_dev/ex/ToolUser/hashCode.html new file mode 100644 index 0000000000..3a0adb3e89 --- /dev/null +++ b/testing/test_package_docs_dev/ex/ToolUser/hashCode.html @@ -0,0 +1,103 @@ + + + + + + + + hashCode property - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/ex/ToolUser/invokeTool.html b/testing/test_package_docs_dev/ex/ToolUser/invokeTool.html new file mode 100644 index 0000000000..7adf58e2df --- /dev/null +++ b/testing/test_package_docs_dev/ex/ToolUser/invokeTool.html @@ -0,0 +1,107 @@ + + + + + + + + invokeTool method - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    invokeTool
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    invokeTool method

    + +
    + void + invokeTool +() +
    +
    +

    Invokes a tool.

    +

    Args: --file=<INPUT_FILE>, --special= |[!@#"'$%^&*()_+]

    +

    Yes it is a [Dog]!

    +

    Yes it is a Dog! Is not a ToolUser.

    +

    Ok, fine it isn't.

    +

    Ok, fine it isn't. Is not a ToolUser.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/ex/ToolUser/invokeToolNoInput.html b/testing/test_package_docs_dev/ex/ToolUser/invokeToolNoInput.html new file mode 100644 index 0000000000..40a328cbc4 --- /dev/null +++ b/testing/test_package_docs_dev/ex/ToolUser/invokeToolNoInput.html @@ -0,0 +1,103 @@ + + + + + + + + invokeToolNoInput method - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    invokeToolNoInput
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    invokeToolNoInput method

    + +
    + void + invokeToolNoInput +() +
    +
    +

    Invokes a tool without the $INPUT token or args.

    +

    Args: []

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/ex/ToolUser/noSuchMethod.html b/testing/test_package_docs_dev/ex/ToolUser/noSuchMethod.html new file mode 100644 index 0000000000..e83addb979 --- /dev/null +++ b/testing/test_package_docs_dev/ex/ToolUser/noSuchMethod.html @@ -0,0 +1,99 @@ + + + + + + + + noSuchMethod method - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/ex/ToolUser/operator_equals.html b/testing/test_package_docs_dev/ex/ToolUser/operator_equals.html new file mode 100644 index 0000000000..9d74b5fb55 --- /dev/null +++ b/testing/test_package_docs_dev/ex/ToolUser/operator_equals.html @@ -0,0 +1,99 @@ + + + + + + + + operator == method - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/ex/ToolUser/runtimeType.html b/testing/test_package_docs_dev/ex/ToolUser/runtimeType.html new file mode 100644 index 0000000000..2931c11346 --- /dev/null +++ b/testing/test_package_docs_dev/ex/ToolUser/runtimeType.html @@ -0,0 +1,103 @@ + + + + + + + + runtimeType property - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/ex/ToolUser/toString.html b/testing/test_package_docs_dev/ex/ToolUser/toString.html new file mode 100644 index 0000000000..8370a7de63 --- /dev/null +++ b/testing/test_package_docs_dev/ex/ToolUser/toString.html @@ -0,0 +1,99 @@ + + + + + + + + toString method - ToolUser class - ex library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    ToolUser class
    +
      +
    1. Constructors
      2. +
    2. ToolUser
      3. + +
    3. + Properties +
      4. +
    4. hashCode
      5. +
    5. runtimeType
      6. + +
    6. Methods
      7. +
    7. invokeTool
      8. +
    8. invokeToolNoInput
      9. +
    9. noSuchMethod
      10. +
    10. toString
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/ex/TypedFunctionsWithoutTypedefs-class.html b/testing/test_package_docs_dev/ex/TypedFunctionsWithoutTypedefs-class.html index 115a6624db..bb7f483738 100644 --- a/testing/test_package_docs_dev/ex/TypedFunctionsWithoutTypedefs-class.html +++ b/testing/test_package_docs_dev/ex/TypedFunctionsWithoutTypedefs-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/WithGeneric-class.html b/testing/test_package_docs_dev/ex/WithGeneric-class.html index a3d0e8c4ee..8ecac304f4 100644 --- a/testing/test_package_docs_dev/ex/WithGeneric-class.html +++ b/testing/test_package_docs_dev/ex/WithGeneric-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/WithGenericSub-class.html b/testing/test_package_docs_dev/ex/WithGenericSub-class.html index 42674d2882..5b2833452b 100644 --- a/testing/test_package_docs_dev/ex/WithGenericSub-class.html +++ b/testing/test_package_docs_dev/ex/WithGenericSub-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/aComplexTypedef.html b/testing/test_package_docs_dev/ex/aComplexTypedef.html index 7774887cf0..7a92b5f98d 100644 --- a/testing/test_package_docs_dev/ex/aComplexTypedef.html +++ b/testing/test_package_docs_dev/ex/aComplexTypedef.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/aThingToDo-class.html b/testing/test_package_docs_dev/ex/aThingToDo-class.html index 88d52faa9f..c17ddd2fcf 100644 --- a/testing/test_package_docs_dev/ex/aThingToDo-class.html +++ b/testing/test_package_docs_dev/ex/aThingToDo-class.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/deprecated-constant.html b/testing/test_package_docs_dev/ex/deprecated-constant.html index e39704cfd7..318362f29a 100644 --- a/testing/test_package_docs_dev/ex/deprecated-constant.html +++ b/testing/test_package_docs_dev/ex/deprecated-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/deprecatedField.html b/testing/test_package_docs_dev/ex/deprecatedField.html index b087b38838..166c84538c 100644 --- a/testing/test_package_docs_dev/ex/deprecatedField.html +++ b/testing/test_package_docs_dev/ex/deprecatedField.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/deprecatedGetter.html b/testing/test_package_docs_dev/ex/deprecatedGetter.html index d77dd2e542..e0541a2836 100644 --- a/testing/test_package_docs_dev/ex/deprecatedGetter.html +++ b/testing/test_package_docs_dev/ex/deprecatedGetter.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/deprecatedSetter.html b/testing/test_package_docs_dev/ex/deprecatedSetter.html index 5273186102..ef6cbd3b26 100644 --- a/testing/test_package_docs_dev/ex/deprecatedSetter.html +++ b/testing/test_package_docs_dev/ex/deprecatedSetter.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/ex-library.html b/testing/test_package_docs_dev/ex/ex-library.html index 4ea210c1fe..9b0cd192f9 100644 --- a/testing/test_package_docs_dev/ex/ex-library.html +++ b/testing/test_package_docs_dev/ex/ex-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • @@ -225,6 +228,12 @@

    Classes

    Class for testing expansion of type from implements clause. +
    +
    + ToolUser +
    +
    +
    TypedFunctionsWithoutTypedefs @@ -535,6 +544,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/function1.html b/testing/test_package_docs_dev/ex/function1.html index 5d26328929..a64b0530fc 100644 --- a/testing/test_package_docs_dev/ex/function1.html +++ b/testing/test_package_docs_dev/ex/function1.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/genericFunction.html b/testing/test_package_docs_dev/ex/genericFunction.html index 1fc3db248b..893e3bf046 100644 --- a/testing/test_package_docs_dev/ex/genericFunction.html +++ b/testing/test_package_docs_dev/ex/genericFunction.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/incorrectDocReference-constant.html b/testing/test_package_docs_dev/ex/incorrectDocReference-constant.html index e9b296e002..6630af044f 100644 --- a/testing/test_package_docs_dev/ex/incorrectDocReference-constant.html +++ b/testing/test_package_docs_dev/ex/incorrectDocReference-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/incorrectDocReferenceFromEx-constant.html b/testing/test_package_docs_dev/ex/incorrectDocReferenceFromEx-constant.html index 83eaa31659..d3971cf72d 100644 --- a/testing/test_package_docs_dev/ex/incorrectDocReferenceFromEx-constant.html +++ b/testing/test_package_docs_dev/ex/incorrectDocReferenceFromEx-constant.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/number.html b/testing/test_package_docs_dev/ex/number.html index c89e6fa978..f6ffd36f83 100644 --- a/testing/test_package_docs_dev/ex/number.html +++ b/testing/test_package_docs_dev/ex/number.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/processMessage.html b/testing/test_package_docs_dev/ex/processMessage.html index 021c70e0bc..95cc9644a8 100644 --- a/testing/test_package_docs_dev/ex/processMessage.html +++ b/testing/test_package_docs_dev/ex/processMessage.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/ex/y.html b/testing/test_package_docs_dev/ex/y.html index 8eb237a44f..8246dc599c 100644 --- a/testing/test_package_docs_dev/ex/y.html +++ b/testing/test_package_docs_dev/ex/y.html @@ -64,6 +64,7 @@
    ex library
  • SpecializedDuration
  • TemplatedClass
  • TemplatedInterface
    • +
  • ToolUser
  • TypedFunctionsWithoutTypedefs
  • WithGeneric
  • WithGenericSub
    • diff --git a/testing/test_package_docs_dev/fake/fake-library.html b/testing/test_package_docs_dev/fake/fake-library.html index 8bf037b392..902159ea4f 100644 --- a/testing/test_package_docs_dev/fake/fake-library.html +++ b/testing/test_package_docs_dev/fake/fake-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/index.html b/testing/test_package_docs_dev/index.html index 9476bc9d76..831e15eef3 100644 --- a/testing/test_package_docs_dev/index.html +++ b/testing/test_package_docs_dev/index.html @@ -4,7 +4,7 @@ - + test_package - Dart API docs @@ -56,6 +56,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • @@ -192,6 +195,21 @@

    test_package_imported

    +
    +

    args

    +
    +
    + args +
    +
    + +
    + command_runner +
    +
    + +
    +
    diff --git a/testing/test_package_docs_dev/index.json b/testing/test_package_docs_dev/index.json index 0ec336ca36..f54154d8e7 100644 --- a/testing/test_package_docs_dev/index.json +++ b/testing/test_package_docs_dev/index.json @@ -49,6 +49,937 @@ "type": "library" } }, + { + "name": "args", + "qualifiedName": "args", + "href": "package-args_args/package-args_args-library.html", + "type": "library", + "overriddenDepth": 0 + }, + { + "name": "ArgParser", + "qualifiedName": "args.ArgParser", + "href": "package-args_args/ArgParser-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "args", + "type": "library" + } + }, + { + "name": "ArgParser", + "qualifiedName": "args.ArgParser", + "href": "package-args_args/ArgParser/ArgParser.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "args.ArgParser.==", + "href": "package-args_args/ArgParser/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "addCommand", + "qualifiedName": "args.ArgParser.addCommand", + "href": "package-args_args/ArgParser/addCommand.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "addFlag", + "qualifiedName": "args.ArgParser.addFlag", + "href": "package-args_args/ArgParser/addFlag.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "addMultiOption", + "qualifiedName": "args.ArgParser.addMultiOption", + "href": "package-args_args/ArgParser/addMultiOption.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "addOption", + "qualifiedName": "args.ArgParser.addOption", + "href": "package-args_args/ArgParser/addOption.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "addSeparator", + "qualifiedName": "args.ArgParser.addSeparator", + "href": "package-args_args/ArgParser/addSeparator.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "ArgParser.allowAnything", + "qualifiedName": "args.ArgParser.allowAnything", + "href": "package-args_args/ArgParser/ArgParser.allowAnything.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "allowTrailingOptions", + "qualifiedName": "args.ArgParser.allowTrailingOptions", + "href": "package-args_args/ArgParser/allowTrailingOptions.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "allowsAnything", + "qualifiedName": "args.ArgParser.allowsAnything", + "href": "package-args_args/ArgParser/allowsAnything.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "commands", + "qualifiedName": "args.ArgParser.commands", + "href": "package-args_args/ArgParser/commands.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "findByAbbreviation", + "qualifiedName": "args.ArgParser.findByAbbreviation", + "href": "package-args_args/ArgParser/findByAbbreviation.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "getDefault", + "qualifiedName": "args.ArgParser.getDefault", + "href": "package-args_args/ArgParser/getDefault.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "getUsage", + "qualifiedName": "args.ArgParser.getUsage", + "href": "package-args_args/ArgParser/getUsage.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "args.ArgParser.hashCode", + "href": "package-args_args/ArgParser/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "args.ArgParser.noSuchMethod", + "href": "package-args_args/ArgParser/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "options", + "qualifiedName": "args.ArgParser.options", + "href": "package-args_args/ArgParser/options.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "parse", + "qualifiedName": "args.ArgParser.parse", + "href": "package-args_args/ArgParser/parse.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "args.ArgParser.runtimeType", + "href": "package-args_args/ArgParser/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "args.ArgParser.toString", + "href": "package-args_args/ArgParser/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "usage", + "qualifiedName": "args.ArgParser.usage", + "href": "package-args_args/ArgParser/usage.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "usageLineLength", + "qualifiedName": "args.ArgParser.usageLineLength", + "href": "package-args_args/ArgParser/usageLineLength.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParser", + "type": "class" + } + }, + { + "name": "ArgParserException", + "qualifiedName": "args.ArgParserException", + "href": "package-args_args/ArgParserException-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "args", + "type": "library" + } + }, + { + "name": "ArgParserException", + "qualifiedName": "args.ArgParserException", + "href": "package-args_args/ArgParserException/ArgParserException.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "args.ArgParserException.==", + "href": "package-args_args/ArgParserException/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "commands", + "qualifiedName": "args.ArgParserException.commands", + "href": "package-args_args/ArgParserException/commands.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "args.ArgParserException.hashCode", + "href": "package-args_args/ArgParserException/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "message", + "qualifiedName": "args.ArgParserException.message", + "href": "package-args_args/ArgParserException/message.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "args.ArgParserException.noSuchMethod", + "href": "package-args_args/ArgParserException/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "offset", + "qualifiedName": "args.ArgParserException.offset", + "href": "package-args_args/ArgParserException/offset.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "args.ArgParserException.runtimeType", + "href": "package-args_args/ArgParserException/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "source", + "qualifiedName": "args.ArgParserException.source", + "href": "package-args_args/ArgParserException/source.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "args.ArgParserException.toString", + "href": "package-args_args/ArgParserException/toString.html", + "type": "method", + "overriddenDepth": 1, + "enclosedBy": { + "name": "ArgParserException", + "type": "class" + } + }, + { + "name": "ArgResults", + "qualifiedName": "args.ArgResults", + "href": "package-args_args/ArgResults-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "args", + "type": "library" + } + }, + { + "name": "operator ==", + "qualifiedName": "args.ArgResults.==", + "href": "package-args_args/ArgResults/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "operator []", + "qualifiedName": "args.ArgResults.[]", + "href": "package-args_args/ArgResults/operator_get.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "arguments", + "qualifiedName": "args.ArgResults.arguments", + "href": "package-args_args/ArgResults/arguments.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "command", + "qualifiedName": "args.ArgResults.command", + "href": "package-args_args/ArgResults/command.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "args.ArgResults.hashCode", + "href": "package-args_args/ArgResults/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "name", + "qualifiedName": "args.ArgResults.name", + "href": "package-args_args/ArgResults/name.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "args.ArgResults.noSuchMethod", + "href": "package-args_args/ArgResults/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "options", + "qualifiedName": "args.ArgResults.options", + "href": "package-args_args/ArgResults/options.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "rest", + "qualifiedName": "args.ArgResults.rest", + "href": "package-args_args/ArgResults/rest.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "args.ArgResults.runtimeType", + "href": "package-args_args/ArgResults/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "args.ArgResults.toString", + "href": "package-args_args/ArgResults/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "wasParsed", + "qualifiedName": "args.ArgResults.wasParsed", + "href": "package-args_args/ArgResults/wasParsed.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ArgResults", + "type": "class" + } + }, + { + "name": "Option", + "qualifiedName": "args.Option", + "href": "package-args_args/Option-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "args", + "type": "library" + } + }, + { + "name": "operator ==", + "qualifiedName": "args.Option.==", + "href": "package-args_args/Option/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "abbr", + "qualifiedName": "args.Option.abbr", + "href": "package-args_args/Option/abbr.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "abbreviation", + "qualifiedName": "args.Option.abbreviation", + "href": "package-args_args/Option/abbreviation.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "allowed", + "qualifiedName": "args.Option.allowed", + "href": "package-args_args/Option/allowed.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "allowedHelp", + "qualifiedName": "args.Option.allowedHelp", + "href": "package-args_args/Option/allowedHelp.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "callback", + "qualifiedName": "args.Option.callback", + "href": "package-args_args/Option/callback.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "defaultValue", + "qualifiedName": "args.Option.defaultValue", + "href": "package-args_args/Option/defaultValue.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "defaultsTo", + "qualifiedName": "args.Option.defaultsTo", + "href": "package-args_args/Option/defaultsTo.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "getOrDefault", + "qualifiedName": "args.Option.getOrDefault", + "href": "package-args_args/Option/getOrDefault.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "args.Option.hashCode", + "href": "package-args_args/Option/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "help", + "qualifiedName": "args.Option.help", + "href": "package-args_args/Option/help.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "hide", + "qualifiedName": "args.Option.hide", + "href": "package-args_args/Option/hide.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "isFlag", + "qualifiedName": "args.Option.isFlag", + "href": "package-args_args/Option/isFlag.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "isMultiple", + "qualifiedName": "args.Option.isMultiple", + "href": "package-args_args/Option/isMultiple.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "isSingle", + "qualifiedName": "args.Option.isSingle", + "href": "package-args_args/Option/isSingle.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "name", + "qualifiedName": "args.Option.name", + "href": "package-args_args/Option/name.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "negatable", + "qualifiedName": "args.Option.negatable", + "href": "package-args_args/Option/negatable.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "args.Option.noSuchMethod", + "href": "package-args_args/Option/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "args.Option.runtimeType", + "href": "package-args_args/Option/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "splitCommas", + "qualifiedName": "args.Option.splitCommas", + "href": "package-args_args/Option/splitCommas.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "args.Option.toString", + "href": "package-args_args/Option/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "type", + "qualifiedName": "args.Option.type", + "href": "package-args_args/Option/type.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "valueHelp", + "qualifiedName": "args.Option.valueHelp", + "href": "package-args_args/Option/valueHelp.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Option", + "type": "class" + } + }, + { + "name": "OptionType", + "qualifiedName": "args.OptionType", + "href": "package-args_args/OptionType-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "args", + "type": "library" + } + }, + { + "name": "operator ==", + "qualifiedName": "args.OptionType.==", + "href": "package-args_args/OptionType/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "FLAG", + "qualifiedName": "args.OptionType.FLAG", + "href": "package-args_args/OptionType/FLAG-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "MULTIPLE", + "qualifiedName": "args.OptionType.MULTIPLE", + "href": "package-args_args/OptionType/MULTIPLE-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "SINGLE", + "qualifiedName": "args.OptionType.SINGLE", + "href": "package-args_args/OptionType/SINGLE-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "flag", + "qualifiedName": "args.OptionType.flag", + "href": "package-args_args/OptionType/flag-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "args.OptionType.hashCode", + "href": "package-args_args/OptionType/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "multiple", + "qualifiedName": "args.OptionType.multiple", + "href": "package-args_args/OptionType/multiple-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "name", + "qualifiedName": "args.OptionType.name", + "href": "package-args_args/OptionType/name.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "args.OptionType.noSuchMethod", + "href": "package-args_args/OptionType/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "args.OptionType.runtimeType", + "href": "package-args_args/OptionType/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "single", + "qualifiedName": "args.OptionType.single", + "href": "package-args_args/OptionType/single-constant.html", + "type": "constant", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "args.OptionType.toString", + "href": "package-args_args/OptionType/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "OptionType", + "type": "class" + } + }, { "name": "categoriesExported", "qualifiedName": "categoriesExported", @@ -57,88 +988,700 @@ "overriddenDepth": 0 }, { - "name": "IAmAClassWithCategories", - "qualifiedName": "categoriesExported.IAmAClassWithCategories", - "href": "categoriesExported/IAmAClassWithCategories-class.html", + "name": "IAmAClassWithCategories", + "qualifiedName": "categoriesExported.IAmAClassWithCategories", + "href": "categoriesExported/IAmAClassWithCategories-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "categoriesExported", + "type": "library" + } + }, + { + "name": "IAmAClassWithCategories", + "qualifiedName": "categoriesExported.IAmAClassWithCategories", + "href": "categoriesExported/IAmAClassWithCategories/IAmAClassWithCategories.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "categoriesExported.IAmAClassWithCategories.==", + "href": "categoriesExported/IAmAClassWithCategories/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "categoriesExported.IAmAClassWithCategories.hashCode", + "href": "categoriesExported/IAmAClassWithCategories/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "categoriesExported.IAmAClassWithCategories.noSuchMethod", + "href": "categoriesExported/IAmAClassWithCategories/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "categoriesExported.IAmAClassWithCategories.runtimeType", + "href": "categoriesExported/IAmAClassWithCategories/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "categoriesExported.IAmAClassWithCategories.toString", + "href": "categoriesExported/IAmAClassWithCategories/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "IAmAClassWithCategories", + "type": "class" + } + }, + { + "name": "code_in_comments", + "qualifiedName": "code_in_comments", + "href": "code_in_comments/code_in_comments-library.html", + "type": "library", + "overriddenDepth": 0 + }, + { + "name": "command_runner", + "qualifiedName": "command_runner", + "href": "package-args_command_runner/package-args_command_runner-library.html", + "type": "library", + "overriddenDepth": 0 + }, + { + "name": "Command", + "qualifiedName": "command_runner.Command", + "href": "package-args_command_runner/Command-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "command_runner", + "type": "library" + } + }, + { + "name": "Command", + "qualifiedName": "command_runner.Command", + "href": "package-args_command_runner/Command/Command.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "command_runner.Command.==", + "href": "package-args_command_runner/Command/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "addSubcommand", + "qualifiedName": "command_runner.Command.addSubcommand", + "href": "package-args_command_runner/Command/addSubcommand.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "aliases", + "qualifiedName": "command_runner.Command.aliases", + "href": "package-args_command_runner/Command/aliases.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "argParser", + "qualifiedName": "command_runner.Command.argParser", + "href": "package-args_command_runner/Command/argParser.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "argResults", + "qualifiedName": "command_runner.Command.argResults", + "href": "package-args_command_runner/Command/argResults.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "description", + "qualifiedName": "command_runner.Command.description", + "href": "package-args_command_runner/Command/description.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "globalResults", + "qualifiedName": "command_runner.Command.globalResults", + "href": "package-args_command_runner/Command/globalResults.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "command_runner.Command.hashCode", + "href": "package-args_command_runner/Command/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "hidden", + "qualifiedName": "command_runner.Command.hidden", + "href": "package-args_command_runner/Command/hidden.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "invocation", + "qualifiedName": "command_runner.Command.invocation", + "href": "package-args_command_runner/Command/invocation.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "name", + "qualifiedName": "command_runner.Command.name", + "href": "package-args_command_runner/Command/name.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "command_runner.Command.noSuchMethod", + "href": "package-args_command_runner/Command/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "parent", + "qualifiedName": "command_runner.Command.parent", + "href": "package-args_command_runner/Command/parent.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "printUsage", + "qualifiedName": "command_runner.Command.printUsage", + "href": "package-args_command_runner/Command/printUsage.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "run", + "qualifiedName": "command_runner.Command.run", + "href": "package-args_command_runner/Command/run.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "runner", + "qualifiedName": "command_runner.Command.runner", + "href": "package-args_command_runner/Command/runner.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "command_runner.Command.runtimeType", + "href": "package-args_command_runner/Command/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "subcommands", + "qualifiedName": "command_runner.Command.subcommands", + "href": "package-args_command_runner/Command/subcommands.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "summary", + "qualifiedName": "command_runner.Command.summary", + "href": "package-args_command_runner/Command/summary.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "takesArguments", + "qualifiedName": "command_runner.Command.takesArguments", + "href": "package-args_command_runner/Command/takesArguments.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "command_runner.Command.toString", + "href": "package-args_command_runner/Command/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "usage", + "qualifiedName": "command_runner.Command.usage", + "href": "package-args_command_runner/Command/usage.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "usageException", + "qualifiedName": "command_runner.Command.usageException", + "href": "package-args_command_runner/Command/usageException.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "usageFooter", + "qualifiedName": "command_runner.Command.usageFooter", + "href": "package-args_command_runner/Command/usageFooter.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "Command", + "type": "class" + } + }, + { + "name": "CommandRunner", + "qualifiedName": "command_runner.CommandRunner", + "href": "package-args_command_runner/CommandRunner-class.html", "type": "class", "overriddenDepth": 0, "enclosedBy": { - "name": "categoriesExported", + "name": "command_runner", "type": "library" } }, { - "name": "IAmAClassWithCategories", - "qualifiedName": "categoriesExported.IAmAClassWithCategories", - "href": "categoriesExported/IAmAClassWithCategories/IAmAClassWithCategories.html", + "name": "CommandRunner", + "qualifiedName": "command_runner.CommandRunner", + "href": "package-args_command_runner/CommandRunner/CommandRunner.html", "type": "constructor", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", "type": "class" } }, { "name": "operator ==", - "qualifiedName": "categoriesExported.IAmAClassWithCategories.==", - "href": "categoriesExported/IAmAClassWithCategories/operator_equals.html", + "qualifiedName": "command_runner.CommandRunner.==", + "href": "package-args_command_runner/CommandRunner/operator_equals.html", "type": "method", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "addCommand", + "qualifiedName": "command_runner.CommandRunner.addCommand", + "href": "package-args_command_runner/CommandRunner/addCommand.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "argParser", + "qualifiedName": "command_runner.CommandRunner.argParser", + "href": "package-args_command_runner/CommandRunner/argParser.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "commands", + "qualifiedName": "command_runner.CommandRunner.commands", + "href": "package-args_command_runner/CommandRunner/commands.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "description", + "qualifiedName": "command_runner.CommandRunner.description", + "href": "package-args_command_runner/CommandRunner/description.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "executableName", + "qualifiedName": "command_runner.CommandRunner.executableName", + "href": "package-args_command_runner/CommandRunner/executableName.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", "type": "class" } }, { "name": "hashCode", - "qualifiedName": "categoriesExported.IAmAClassWithCategories.hashCode", - "href": "categoriesExported/IAmAClassWithCategories/hashCode.html", + "qualifiedName": "command_runner.CommandRunner.hashCode", + "href": "package-args_command_runner/CommandRunner/hashCode.html", "type": "property", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "invocation", + "qualifiedName": "command_runner.CommandRunner.invocation", + "href": "package-args_command_runner/CommandRunner/invocation.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", "type": "class" } }, { "name": "noSuchMethod", - "qualifiedName": "categoriesExported.IAmAClassWithCategories.noSuchMethod", - "href": "categoriesExported/IAmAClassWithCategories/noSuchMethod.html", + "qualifiedName": "command_runner.CommandRunner.noSuchMethod", + "href": "package-args_command_runner/CommandRunner/noSuchMethod.html", "type": "method", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "parse", + "qualifiedName": "command_runner.CommandRunner.parse", + "href": "package-args_command_runner/CommandRunner/parse.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "printUsage", + "qualifiedName": "command_runner.CommandRunner.printUsage", + "href": "package-args_command_runner/CommandRunner/printUsage.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "run", + "qualifiedName": "command_runner.CommandRunner.run", + "href": "package-args_command_runner/CommandRunner/run.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "runCommand", + "qualifiedName": "command_runner.CommandRunner.runCommand", + "href": "package-args_command_runner/CommandRunner/runCommand.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", "type": "class" } }, { "name": "runtimeType", - "qualifiedName": "categoriesExported.IAmAClassWithCategories.runtimeType", - "href": "categoriesExported/IAmAClassWithCategories/runtimeType.html", + "qualifiedName": "command_runner.CommandRunner.runtimeType", + "href": "package-args_command_runner/CommandRunner/runtimeType.html", "type": "property", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", "type": "class" } }, { "name": "toString", - "qualifiedName": "categoriesExported.IAmAClassWithCategories.toString", - "href": "categoriesExported/IAmAClassWithCategories/toString.html", + "qualifiedName": "command_runner.CommandRunner.toString", + "href": "package-args_command_runner/CommandRunner/toString.html", "type": "method", "overriddenDepth": 0, "enclosedBy": { - "name": "IAmAClassWithCategories", + "name": "CommandRunner", "type": "class" } }, { - "name": "code_in_comments", - "qualifiedName": "code_in_comments", - "href": "code_in_comments/code_in_comments-library.html", - "type": "library", - "overriddenDepth": 0 + "name": "usage", + "qualifiedName": "command_runner.CommandRunner.usage", + "href": "package-args_command_runner/CommandRunner/usage.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "usageException", + "qualifiedName": "command_runner.CommandRunner.usageException", + "href": "package-args_command_runner/CommandRunner/usageException.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "usageFooter", + "qualifiedName": "command_runner.CommandRunner.usageFooter", + "href": "package-args_command_runner/CommandRunner/usageFooter.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "CommandRunner", + "type": "class" + } + }, + { + "name": "UsageException", + "qualifiedName": "command_runner.UsageException", + "href": "package-args_command_runner/UsageException-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "command_runner", + "type": "library" + } + }, + { + "name": "UsageException", + "qualifiedName": "command_runner.UsageException", + "href": "package-args_command_runner/UsageException/UsageException.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "command_runner.UsageException.==", + "href": "package-args_command_runner/UsageException/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "command_runner.UsageException.hashCode", + "href": "package-args_command_runner/UsageException/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "message", + "qualifiedName": "command_runner.UsageException.message", + "href": "package-args_command_runner/UsageException/message.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "command_runner.UsageException.noSuchMethod", + "href": "package-args_command_runner/UsageException/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "command_runner.UsageException.runtimeType", + "href": "package-args_command_runner/UsageException/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "command_runner.UsageException.toString", + "href": "package-args_command_runner/UsageException/toString.html", + "type": "method", + "overriddenDepth": 1, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } + }, + { + "name": "usage", + "qualifiedName": "command_runner.UsageException.usage", + "href": "package-args_command_runner/UsageException/usage.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "UsageException", + "type": "class" + } }, { "name": "css", @@ -3399,6 +4942,105 @@ "type": "class" } }, + { + "name": "ToolUser", + "qualifiedName": "ex.ToolUser", + "href": "ex/ToolUser-class.html", + "type": "class", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ex", + "type": "library" + } + }, + { + "name": "ToolUser", + "qualifiedName": "ex.ToolUser", + "href": "ex/ToolUser/ToolUser.html", + "type": "constructor", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "operator ==", + "qualifiedName": "ex.ToolUser.==", + "href": "ex/ToolUser/operator_equals.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "hashCode", + "qualifiedName": "ex.ToolUser.hashCode", + "href": "ex/ToolUser/hashCode.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "invokeTool", + "qualifiedName": "ex.ToolUser.invokeTool", + "href": "ex/ToolUser/invokeTool.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "invokeToolNoInput", + "qualifiedName": "ex.ToolUser.invokeToolNoInput", + "href": "ex/ToolUser/invokeToolNoInput.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "noSuchMethod", + "qualifiedName": "ex.ToolUser.noSuchMethod", + "href": "ex/ToolUser/noSuchMethod.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "runtimeType", + "qualifiedName": "ex.ToolUser.runtimeType", + "href": "ex/ToolUser/runtimeType.html", + "type": "property", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, + { + "name": "toString", + "qualifiedName": "ex.ToolUser.toString", + "href": "ex/ToolUser/toString.html", + "type": "method", + "overriddenDepth": 0, + "enclosedBy": { + "name": "ToolUser", + "type": "class" + } + }, { "name": "TypedFunctionsWithoutTypedefs", "qualifiedName": "ex.TypedFunctionsWithoutTypedefs", diff --git a/testing/test_package_docs_dev/is_deprecated/is_deprecated-library.html b/testing/test_package_docs_dev/is_deprecated/is_deprecated-library.html index 4cac1680f9..d7f4fd63ea 100644 --- a/testing/test_package_docs_dev/is_deprecated/is_deprecated-library.html +++ b/testing/test_package_docs_dev/is_deprecated/is_deprecated-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser-class.html b/testing/test_package_docs_dev/package-args_args/ArgParser-class.html new file mode 100644 index 0000000000..dd88c8407f --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser-class.html @@ -0,0 +1,345 @@ + + + + + + + + ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgParser
    + +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    +

    ArgParser class

    + +
    +

    A class for taking a list of raw command line arguments and parsing out +options and flags from them.

    +
    + + +
    +

    Constructors

    + +
    +
    + ArgParser({bool allowTrailingOptions: true, int usageLineLength }) +
    +
    + Creates a new ArgParser. [...] +
    factory
    +
    +
    + ArgParser.allowAnything() +
    +
    + Creates a new ArgParser that treats all input as non-option arguments. [...] +
    factory
    +
    +
    +
    + +
    +

    Properties

    + +
    +
    + allowsAnything + → bool +
    +
    + Whether or not this parser treats unrecognized options as non-option +arguments. +
    read-only
    +
    +
    + allowTrailingOptions + → bool +
    +
    + Whether or not this parser parses options that appear after non-option +arguments. +
    final
    +
    +
    + commands + → Map<String, ArgParser> +
    +
    + The commands that have been defined for this parser. +
    final
    +
    +
    + options + → Map<String, Option> +
    +
    + The options that have been defined for this parser. +
    final
    +
    +
    + usage + → String +
    +
    + Generates a string displaying usage information for the defined options. [...] +
    read-only
    +
    +
    + usageLineLength + → int +
    +
    + An optional maximum line length for usage messages. [...] +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + addCommand(String name, [ ArgParser parser ]) + → ArgParser + +
    +
    + Defines a command. [...] + +
    +
    + addFlag(String name, { String abbr, String help, bool defaultsTo: false, bool negatable: true, void callback(bool value), bool hide: false }) + → void + +
    +
    + Defines a boolean flag. [...] + +
    +
    + addMultiOption(String name, { String abbr, String help, String valueHelp, Iterable<String> allowed, Map<String, String> allowedHelp, Iterable<String> defaultsTo, void callback(List<String> values), bool splitCommas: true, bool hide: false }) + → void + +
    +
    + Defines an option that takes multiple values. [...] + +
    +
    + addOption(String name, { String abbr, String help, String valueHelp, Iterable<String> allowed, Map<String, String> allowedHelp, String defaultsTo, Function callback, bool allowMultiple: false, bool splitCommas, bool hide: false }) + → void + +
    +
    + Defines an option that takes a value. [...] + +
    +
    + addSeparator(String text) + → void + +
    +
    + Adds a separator line to the usage. [...] + +
    +
    + findByAbbreviation(String abbr) + → Option + +
    +
    + Finds the option whose abbreviation is abbr, or null if no option has +that abbreviation. + +
    +
    + getDefault(String option) + → dynamic + +
    +
    + Get the default value for an option. Useful after parsing to test if the +user specified something other than the default. + +
    +
    + getUsage() + → String + +
    +
    + Generates a string displaying usage information for the defined options. [...] +
    @Deprecated("Replaced with get usage. getUsage() will be removed in args 1.0")
    +
    +
    + parse(Iterable<String> args) + → ArgResults + +
    +
    + Parses args, a list of command-line arguments, matches them against the +flags and options defined by this parser, and returns the result. + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/ArgParser.allowAnything.html b/testing/test_package_docs_dev/package-args_args/ArgParser/ArgParser.allowAnything.html new file mode 100644 index 0000000000..a4de8476ca --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/ArgParser.allowAnything.html @@ -0,0 +1,119 @@ + + + + + + + + ArgParser.allowAnything constructor - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgParser.allowAnything
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    ArgParser.allowAnything constructor

    + +
    + + ArgParser.allowAnything() +
    + +
    +

    Creates a new ArgParser that treats all input as non-option arguments.

    +

    This is intended to allow arguments to be passed through to child +processes without needing to be redefined in the parent.

    +

    Options may not be defined for this parser.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/ArgParser.html b/testing/test_package_docs_dev/package-args_args/ArgParser/ArgParser.html new file mode 100644 index 0000000000..e7d40efa64 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/ArgParser.html @@ -0,0 +1,120 @@ + + + + + + + + ArgParser constructor - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgParser
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    ArgParser constructor

    + +
    + + ArgParser({bool allowTrailingOptions: true, int usageLineLength }) +
    + +
    +

    Creates a new ArgParser.

    +

    If allowTrailingOptions is true (the default), the parser will parse +flags and options that appear after positional arguments. If it's false, +the parser stops parsing as soon as it finds an argument that is neither +an option nor a command.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/addCommand.html b/testing/test_package_docs_dev/package-args_args/ArgParser/addCommand.html new file mode 100644 index 0000000000..511b66e27a --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/addCommand.html @@ -0,0 +1,119 @@ + + + + + + + + addCommand method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addCommand
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    addCommand method

    + +
    + ArgParser + addCommand +(String name, [ ArgParser parser ]) +
    +
    +

    Defines a command.

    +

    A command is a named argument which may in turn define its own options and +subcommands using the given parser. If parser is omitted, implicitly +creates a new one. Returns the parser for the command.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/addFlag.html b/testing/test_package_docs_dev/package-args_args/ArgParser/addFlag.html new file mode 100644 index 0000000000..44f9a926f1 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/addFlag.html @@ -0,0 +1,132 @@ + + + + + + + + addFlag method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addFlag
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    addFlag method

    + +
    + void + addFlag +(String name, { String abbr, String help, bool defaultsTo: false, bool negatable: true, void callback(bool value), bool hide: false }) +
    +
    +

    Defines a boolean flag.

    +

    This adds an Option with the given properties to options.

    +

    The abbr argument is a single-character string that can be used as a +shorthand for this flag. For example, abbr: "a" will allow the user to +pass -a to enable the flag.

    +

    The help argument is used by usage to describe this flag.

    +

    The defaultsTo argument indicates the value this flag will have if the +user doesn't explicitly pass it in.

    +

    The negatable argument indicates whether this flag's value can be set to +false. For example, if name is flag, the user can pass --no-flag +to set its value to false.

    +

    The callback argument is invoked with the flag's value when the flag +is parsed. Note that this makes argument parsing order-dependent in ways +that are often surprising, and its use is discouraged in favor of reading +values from the ArgResult.

    +

    If hide is true, this option won't be included in usage.

    +

    Throws an ArgumentError if:

    • There is already an option named name.
    • There is already an option using abbreviation abbr.
    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/addMultiOption.html b/testing/test_package_docs_dev/package-args_args/ArgParser/addMultiOption.html new file mode 100644 index 0000000000..3788d33e8b --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/addMultiOption.html @@ -0,0 +1,139 @@ + + + + + + + + addMultiOption method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addMultiOption
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    addMultiOption method

    + +
    + void + addMultiOption +(String name, { String abbr, String help, String valueHelp, Iterable<String> allowed, Map<String, String> allowedHelp, Iterable<String> defaultsTo, void callback(List<String> values), bool splitCommas: true, bool hide: false }) +
    +
    +

    Defines an option that takes multiple values.

    +

    The abbr argument is a single-character string that can be used as a +shorthand for this option. For example, abbr: "a" will allow the user to +pass -a value or -avalue.

    +

    The help argument is used by usage to describe this option.

    +

    The valueHelp argument is used by usage as a name for the value this +argument takes. For example, valueHelp: "FOO" will include +--option=<FOO> rather than just --option in the usage string.

    +

    The allowed argument is a list of valid values for this argument. If +it's non-null and the user passes a value that's not included in the +list, parse will throw a FormatException. The allowed values will also +be included in usage.

    +

    The allowedHelp argument is a map from values in allowed to +documentation for those values that will be included in usage.

    +

    The defaultsTo argument indicates the values this option will have if +the user doesn't explicitly pass it in (or [] by default).

    +

    The callback argument is invoked with the option's value when the option +is parsed. Note that this makes argument parsing order-dependent in ways +that are often surprising, and its use is discouraged in favor of reading +values from the ArgResult.

    +

    If splitCommas is true (the default), multiple options may be passed +by writing --option a,b in addition to --option a --option b.

    +

    If hide is true, this option won't be included in usage.

    +

    Throws an ArgumentError if:

    • There is already an option with name name.
    • There is already an option using abbreviation abbr.
    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/addOption.html b/testing/test_package_docs_dev/package-args_args/ArgParser/addOption.html new file mode 100644 index 0000000000..165ae34489 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/addOption.html @@ -0,0 +1,140 @@ + + + + + + + + addOption method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addOption
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    addOption method

    + +
    + void + addOption +(String name, { String abbr, String help, String valueHelp, Iterable<String> allowed, Map<String, String> allowedHelp, String defaultsTo, Function callback, @Deprecated("Use addMultiOption() instead.") bool allowMultiple: false, @Deprecated("Use addMultiOption() instead.") bool splitCommas, bool hide: false }) +
    +
    +

    Defines an option that takes a value.

    +

    This adds an Option with the given properties to options.

    +

    The abbr argument is a single-character string that can be used as a +shorthand for this option. For example, abbr: "a" will allow the user to +pass -a value or -avalue.

    +

    The help argument is used by usage to describe this option.

    +

    The valueHelp argument is used by usage as a name for the value this +option takes. For example, valueHelp: "FOO" will include +--option=<FOO> rather than just --option in the usage string.

    +

    The allowed argument is a list of valid values for this option. If +it's non-null and the user passes a value that's not included in the +list, parse will throw a FormatException. The allowed values will also +be included in usage.

    +

    The allowedHelp argument is a map from values in allowed to +documentation for those values that will be included in usage.

    +

    The defaultsTo argument indicates the value this option will have if the +user doesn't explicitly pass it in (or null by default).

    +

    The callback argument is invoked with the option's value when the option +is parsed. Note that this makes argument parsing order-dependent in ways +that are often surprising, and its use is discouraged in favor of reading +values from the ArgResult.

    +

    The allowMultiple and splitCommas options are deprecated; the +addMultiOption method should be used instead.

    +

    If hide is true, this option won't be included in usage.

    +

    Throws an ArgumentError if:

    • There is already an option with name name.
    • There is already an option using abbreviation abbr.
    • splitCommas is passed but allowMultiple is false.
    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/addSeparator.html b/testing/test_package_docs_dev/package-args_args/ArgParser/addSeparator.html new file mode 100644 index 0000000000..438281af9a --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/addSeparator.html @@ -0,0 +1,118 @@ + + + + + + + + addSeparator method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addSeparator
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    addSeparator method

    + +
    + void + addSeparator +(String text) +
    +
    +

    Adds a separator line to the usage.

    +

    In the usage text for the parser, this will appear between any options +added before this call and ones added after it.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/allowTrailingOptions.html b/testing/test_package_docs_dev/package-args_args/ArgParser/allowTrailingOptions.html new file mode 100644 index 0000000000..aed4a224f7 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/allowTrailingOptions.html @@ -0,0 +1,116 @@ + + + + + + + + allowTrailingOptions property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    allowTrailingOptions
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    allowTrailingOptions property

    + +
    + bool + allowTrailingOptions +
    final
    +
    +
    +

    Whether or not this parser parses options that appear after non-option +arguments.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/allowsAnything.html b/testing/test_package_docs_dev/package-args_args/ArgParser/allowsAnything.html new file mode 100644 index 0000000000..36a1e7c6c6 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/allowsAnything.html @@ -0,0 +1,121 @@ + + + + + + + + allowsAnything property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    allowsAnything
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    allowsAnything property

    + + +
    + +
    + bool + allowsAnything + +
    + +
    +

    Whether or not this parser treats unrecognized options as non-option +arguments.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/commands.html b/testing/test_package_docs_dev/package-args_args/ArgParser/commands.html new file mode 100644 index 0000000000..8588d0ffec --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/commands.html @@ -0,0 +1,115 @@ + + + + + + + + commands property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    commands
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    commands property

    + +
    + Map<String, ArgParser> + commands +
    final
    +
    +
    +

    The commands that have been defined for this parser.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/findByAbbreviation.html b/testing/test_package_docs_dev/package-args_args/ArgParser/findByAbbreviation.html new file mode 100644 index 0000000000..4d91c3ba53 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/findByAbbreviation.html @@ -0,0 +1,117 @@ + + + + + + + + findByAbbreviation method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    findByAbbreviation
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    findByAbbreviation method

    + +
    + Option + findByAbbreviation +(String abbr) +
    +
    +

    Finds the option whose abbreviation is abbr, or null if no option has +that abbreviation.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/getDefault.html b/testing/test_package_docs_dev/package-args_args/ArgParser/getDefault.html new file mode 100644 index 0000000000..e4236732fb --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/getDefault.html @@ -0,0 +1,117 @@ + + + + + + + + getDefault method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    getDefault
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    getDefault method

    + +
    + dynamic + getDefault +(String option) +
    +
    +

    Get the default value for an option. Useful after parsing to test if the +user specified something other than the default.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/getUsage.html b/testing/test_package_docs_dev/package-args_args/ArgParser/getUsage.html new file mode 100644 index 0000000000..4186664537 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/getUsage.html @@ -0,0 +1,122 @@ + + + + + + + + getUsage method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    getUsage
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    getUsage method

    + +
    +
    +
      +
    1. @Deprecated("Replaced with get usage. getUsage() will be removed in args 1.0")
      2. +
    +
    + String + getUsage +() +
    +
    +

    Generates a string displaying usage information for the defined options.

    +

    This is basically the help text shown on the command line.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/hashCode.html b/testing/test_package_docs_dev/package-args_args/ArgParser/hashCode.html new file mode 100644 index 0000000000..c4eb63e360 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/hashCode.html @@ -0,0 +1,117 @@ + + + + + + + + hashCode property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/noSuchMethod.html b/testing/test_package_docs_dev/package-args_args/ArgParser/noSuchMethod.html new file mode 100644 index 0000000000..32a0fe6202 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/noSuchMethod.html @@ -0,0 +1,113 @@ + + + + + + + + noSuchMethod method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/operator_equals.html b/testing/test_package_docs_dev/package-args_args/ArgParser/operator_equals.html new file mode 100644 index 0000000000..df57ae4726 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/operator_equals.html @@ -0,0 +1,113 @@ + + + + + + + + operator == method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/options.html b/testing/test_package_docs_dev/package-args_args/ArgParser/options.html new file mode 100644 index 0000000000..889c96509f --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/options.html @@ -0,0 +1,115 @@ + + + + + + + + options property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    options
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    options property

    + +
    + Map<String, Option> + options +
    final
    +
    +
    +

    The options that have been defined for this parser.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/parse.html b/testing/test_package_docs_dev/package-args_args/ArgParser/parse.html new file mode 100644 index 0000000000..df9e80539a --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/parse.html @@ -0,0 +1,117 @@ + + + + + + + + parse method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    parse
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    parse method

    + +
    + ArgResults + parse +(Iterable<String> args) +
    +
    +

    Parses args, a list of command-line arguments, matches them against the +flags and options defined by this parser, and returns the result.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/runtimeType.html b/testing/test_package_docs_dev/package-args_args/ArgParser/runtimeType.html new file mode 100644 index 0000000000..b866ddf077 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/runtimeType.html @@ -0,0 +1,117 @@ + + + + + + + + runtimeType property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/toString.html b/testing/test_package_docs_dev/package-args_args/ArgParser/toString.html new file mode 100644 index 0000000000..589794d532 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/toString.html @@ -0,0 +1,113 @@ + + + + + + + + toString method - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/usage.html b/testing/test_package_docs_dev/package-args_args/ArgParser/usage.html new file mode 100644 index 0000000000..b09d61e884 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/usage.html @@ -0,0 +1,121 @@ + + + + + + + + usage property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usage
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    usage property

    + + +
    + +
    + String + usage + +
    + +
    +

    Generates a string displaying usage information for the defined options.

    +

    This is basically the help text shown on the command line.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParser/usageLineLength.html b/testing/test_package_docs_dev/package-args_args/ArgParser/usageLineLength.html new file mode 100644 index 0000000000..6c6ae949dd --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParser/usageLineLength.html @@ -0,0 +1,122 @@ + + + + + + + + usageLineLength property - ArgParser class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usageLineLength
    + +
    + +
    + +
    +
    ArgParser class
    +
      +
    1. Constructors
      2. +
    2. ArgParser
      3. +
    3. allowAnything
      4. + +
    4. + Properties +
      5. +
    5. allowsAnything
      6. +
    6. allowTrailingOptions
      7. +
    7. commands
      8. +
    8. options
      9. +
    9. usage
      10. +
    10. usageLineLength
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. addFlag
      16. +
    16. addMultiOption
      17. +
    17. addOption
      18. +
    18. addSeparator
      19. +
    19. findByAbbreviation
      20. +
    20. getDefault
      21. +
    21. getUsage
      22. +
    22. parse
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    usageLineLength property

    + +
    + int + usageLineLength +
    final
    +
    +
    +

    An optional maximum line length for usage messages.

    +

    If specified, then help messages in the usage are wrapped at the given +column, after taking into account the width of the options. Will refuse to +wrap help text to less than 10 characters of help text per line if there +isn't enough space on the line. It preserves embedded newlines, and +attempts to wrap at whitespace breaks (although it will split words if +there is no whitespace at which to split).

    +

    If null (the default), help messages are not wrapped.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException-class.html b/testing/test_package_docs_dev/package-args_args/ArgParserException-class.html new file mode 100644 index 0000000000..a990b8d754 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException-class.html @@ -0,0 +1,236 @@ + + + + + + + + ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgParserException
    + +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    +

    ArgParserException class

    + +
    +

    An exception thrown by ArgParser.

    +
    + +
    +
    +
    Inheritance
    +
      +
    • Object
      • +
    • FormatException
      • +
    • ArgParserException
      • +
    + + + + +
    +
    + +
    +

    Constructors

    + +
    +
    + ArgParserException(String message, [ Iterable<String> commands ]) +
    +
    + +
    +
    +
    + +
    +

    Properties

    + +
    +
    + commands + → List<String> +
    +
    + The command(s) that were parsed before discovering the error. [...] +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + message + → String +
    +
    + +
    final, inherited
    +
    +
    + offset + → int +
    +
    + +
    final, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    + source + → dynamic +
    +
    + +
    final, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException/ArgParserException.html b/testing/test_package_docs_dev/package-args_args/ArgParserException/ArgParserException.html new file mode 100644 index 0000000000..c7ad7a8647 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException/ArgParserException.html @@ -0,0 +1,101 @@ + + + + + + + + ArgParserException constructor - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgParserException
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    ArgParserException constructor

    + +
    + + ArgParserException(String message, [ Iterable<String> commands ]) +
    + + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException/commands.html b/testing/test_package_docs_dev/package-args_args/ArgParserException/commands.html new file mode 100644 index 0000000000..f33b0966b1 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException/commands.html @@ -0,0 +1,104 @@ + + + + + + + + commands property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    commands
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    commands property

    + +
    + List<String> + commands +
    final
    +
    +
    +

    The command(s) that were parsed before discovering the error.

    +

    This will be empty if the error was on the root parser.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException/hashCode.html b/testing/test_package_docs_dev/package-args_args/ArgParserException/hashCode.html new file mode 100644 index 0000000000..b5b08511c2 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException/hashCode.html @@ -0,0 +1,105 @@ + + + + + + + + hashCode property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException/message.html b/testing/test_package_docs_dev/package-args_args/ArgParserException/message.html new file mode 100644 index 0000000000..78c24b520a --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException/message.html @@ -0,0 +1,100 @@ + + + + + + + + message property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    message
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    message property

    + +
    + String + message +
    final, inherited
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException/noSuchMethod.html b/testing/test_package_docs_dev/package-args_args/ArgParserException/noSuchMethod.html new file mode 100644 index 0000000000..150dbab26c --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException/noSuchMethod.html @@ -0,0 +1,101 @@ + + + + + + + + noSuchMethod method - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException/offset.html b/testing/test_package_docs_dev/package-args_args/ArgParserException/offset.html new file mode 100644 index 0000000000..926b1f0020 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException/offset.html @@ -0,0 +1,100 @@ + + + + + + + + offset property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    offset
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    offset property

    + +
    + int + offset +
    final, inherited
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException/operator_equals.html b/testing/test_package_docs_dev/package-args_args/ArgParserException/operator_equals.html new file mode 100644 index 0000000000..bd7aa6c508 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException/operator_equals.html @@ -0,0 +1,101 @@ + + + + + + + + operator == method - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException/runtimeType.html b/testing/test_package_docs_dev/package-args_args/ArgParserException/runtimeType.html new file mode 100644 index 0000000000..903fa9cc48 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException/runtimeType.html @@ -0,0 +1,105 @@ + + + + + + + + runtimeType property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException/source.html b/testing/test_package_docs_dev/package-args_args/ArgParserException/source.html new file mode 100644 index 0000000000..a15b622dae --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException/source.html @@ -0,0 +1,100 @@ + + + + + + + + source property - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    source
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    source property

    + +
    + dynamic + source +
    final, inherited
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgParserException/toString.html b/testing/test_package_docs_dev/package-args_args/ArgParserException/toString.html new file mode 100644 index 0000000000..312efe9a38 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgParserException/toString.html @@ -0,0 +1,101 @@ + + + + + + + + toString method - ArgParserException class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    ArgParserException class
    +
      +
    1. Constructors
      2. +
    2. ArgParserException
      3. + +
    3. + Properties +
      4. +
    4. commands
      5. +
    5. hashCode
      6. +
    6. message
      7. +
    7. offset
      8. +
    8. runtimeType
      9. +
    9. source
      10. + +
    10. Methods
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator ==
      15. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults-class.html b/testing/test_package_docs_dev/package-args_args/ArgResults-class.html new file mode 100644 index 0000000000..fb2bc01e3f --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults-class.html @@ -0,0 +1,243 @@ + + + + + + + + ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    ArgResults
    + +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    +

    ArgResults class

    + +
    +

    The results of parsing a series of command line arguments using +ArgParser.parse().

    +

    Includes the parsed options and any remaining unparsed command line +arguments.

    +
    + + + +
    +

    Properties

    + +
    +
    + arguments + → List<String> +
    +
    + The original list of arguments that were parsed. +
    final
    +
    +
    + command + → ArgResults +
    +
    + The command that was selected, or null if none was. [...] +
    final
    +
    +
    + name + → String +
    +
    + If these are the results for parsing a command's options, this will be the +name of the command. For top-level results, this returns null. +
    final
    +
    +
    + options + → Iterable<String> +
    +
    + Get the names of the available options as an Iterable. [...] +
    read-only
    +
    +
    + rest + → List<String> +
    +
    + The remaining command-line arguments that were not parsed as options or +flags. [...] +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + wasParsed(String name) + → bool + +
    +
    + Returns true if the option with name was parsed from an actual +argument. [...] + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator [](String name) + → dynamic + +
    +
    + Gets the parsed command-line option named name. + +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/arguments.html b/testing/test_package_docs_dev/package-args_args/ArgResults/arguments.html new file mode 100644 index 0000000000..711e75cf8f --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/arguments.html @@ -0,0 +1,104 @@ + + + + + + + + arguments property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    arguments
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    arguments property

    + +
    + List<String> + arguments +
    final
    +
    +
    +

    The original list of arguments that were parsed.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/command.html b/testing/test_package_docs_dev/package-args_args/ArgResults/command.html new file mode 100644 index 0000000000..cab7e25600 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/command.html @@ -0,0 +1,105 @@ + + + + + + + + command property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    command
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    command property

    + +
    + ArgResults + command +
    final
    +
    +
    +

    The command that was selected, or null if none was.

    +

    This will contain the options that were selected for that command.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/hashCode.html b/testing/test_package_docs_dev/package-args_args/ArgResults/hashCode.html new file mode 100644 index 0000000000..df33cf94e3 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/hashCode.html @@ -0,0 +1,106 @@ + + + + + + + + hashCode property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/name.html b/testing/test_package_docs_dev/package-args_args/ArgResults/name.html new file mode 100644 index 0000000000..ee7357cf24 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/name.html @@ -0,0 +1,105 @@ + + + + + + + + name property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    name
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    name property

    + +
    + String + name +
    final
    +
    +
    +

    If these are the results for parsing a command's options, this will be the +name of the command. For top-level results, this returns null.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/noSuchMethod.html b/testing/test_package_docs_dev/package-args_args/ArgResults/noSuchMethod.html new file mode 100644 index 0000000000..b426626aaa --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/noSuchMethod.html @@ -0,0 +1,102 @@ + + + + + + + + noSuchMethod method - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/operator_equals.html b/testing/test_package_docs_dev/package-args_args/ArgResults/operator_equals.html new file mode 100644 index 0000000000..aaa0aa3c6f --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/operator_equals.html @@ -0,0 +1,102 @@ + + + + + + + + operator == method - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/operator_get.html b/testing/test_package_docs_dev/package-args_args/ArgResults/operator_get.html new file mode 100644 index 0000000000..b834397dda --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/operator_get.html @@ -0,0 +1,105 @@ + + + + + + + + operator [] method - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator []
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    operator [] method

    + +
    + dynamic + operator [] +(String name) +
    +
    +

    Gets the parsed command-line option named name.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/options.html b/testing/test_package_docs_dev/package-args_args/ArgResults/options.html new file mode 100644 index 0000000000..a0ebffb9fe --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/options.html @@ -0,0 +1,111 @@ + + + + + + + + options property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    options
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    options property

    + + +
    + +
    + Iterable<String> + options + +
    + +
    +

    Get the names of the available options as an Iterable.

    +

    This includes the options whose values were parsed or that have defaults. +Options that weren't present and have no default will be omitted.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/rest.html b/testing/test_package_docs_dev/package-args_args/ArgResults/rest.html new file mode 100644 index 0000000000..631bf6008b --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/rest.html @@ -0,0 +1,108 @@ + + + + + + + + rest property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    rest
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    rest property

    + +
    + List<String> + rest +
    final
    +
    +
    +

    The remaining command-line arguments that were not parsed as options or +flags.

    +

    If -- was used to separate the options from the remaining arguments, +it will not be included in this list unless parsing stopped before the +-- was reached.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/runtimeType.html b/testing/test_package_docs_dev/package-args_args/ArgResults/runtimeType.html new file mode 100644 index 0000000000..3e77a1c2bb --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/runtimeType.html @@ -0,0 +1,106 @@ + + + + + + + + runtimeType property - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/toString.html b/testing/test_package_docs_dev/package-args_args/ArgResults/toString.html new file mode 100644 index 0000000000..fb6f807462 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/toString.html @@ -0,0 +1,102 @@ + + + + + + + + toString method - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/ArgResults/wasParsed.html b/testing/test_package_docs_dev/package-args_args/ArgResults/wasParsed.html new file mode 100644 index 0000000000..46a31c9e36 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/ArgResults/wasParsed.html @@ -0,0 +1,108 @@ + + + + + + + + wasParsed method - ArgResults class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    wasParsed
    + +
    + +
    + +
    +
    ArgResults class
    +
      + +
    1. + Properties +
      2. +
    2. arguments
      3. +
    3. command
      4. +
    4. name
      5. +
    5. options
      6. +
    6. rest
      7. +
    7. hashCode
      8. +
    8. runtimeType
      9. + +
    9. Methods
      10. +
    10. wasParsed
      11. +
    11. noSuchMethod
      12. +
    12. toString
      13. + +
    13. Operators
      14. +
    14. operator []
      15. +
    15. operator ==
      16. + + + +
    +
    + +
    +

    wasParsed method

    + +
    + bool + wasParsed +(String name) +
    +
    +

    Returns true if the option with name was parsed from an actual +argument.

    +

    Returns false if it wasn't provided and the default value or no default +value would be used instead.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option-class.html b/testing/test_package_docs_dev/package-args_args/Option-class.html new file mode 100644 index 0000000000..7976311e6a --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option-class.html @@ -0,0 +1,338 @@ + + + + + + + + Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    Option
    + +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    +

    Option class

    + +
    +

    A command-line option.

    +

    This represents both boolean flags and options which take a value.

    +
    + + + +
    +

    Properties

    + +
    +
    + abbr + → String +
    +
    + A single-character string that can be used as a shorthand for this option. [...] +
    final
    +
    +
    + abbreviation + → String +
    +
    + +
    @Deprecated('Use abbr instead.'), read-only
    +
    +
    + allowed + → List<String> +
    +
    + A list of valid values for this option. +
    final
    +
    +
    + allowedHelp + → Map<String, String> +
    +
    + A map from values in allowed to documentation for those values. +
    final
    +
    +
    + callback + → Function +
    +
    + The callback to invoke with the option's value when the option is parsed. +
    final
    +
    +
    + defaultsTo + → dynamic +
    +
    + The value this option will have if the user doesn't explicitly pass it in +
    final
    +
    +
    + defaultValue + → dynamic +
    +
    + +
    @Deprecated('Use defaultsTo instead.'), read-only
    +
    +
    + help + → String +
    +
    + A description of this option. +
    final
    +
    +
    + hide + → bool +
    +
    + Whether this option should be hidden from usage documentation. +
    final
    +
    +
    + isFlag + → bool +
    +
    + Whether the option is boolean-valued flag. +
    read-only
    +
    +
    + isMultiple + → bool +
    +
    + Whether the option allows multiple values. +
    read-only
    +
    +
    + isSingle + → bool +
    +
    + Whether the option takes a single value. +
    read-only
    +
    +
    + name + → String +
    +
    + The name of the option that the user passes as an argument. +
    final
    +
    +
    + negatable + → bool +
    +
    + Whether this flag's value can be set to false. [...] +
    final
    +
    +
    + splitCommas + → bool +
    +
    + Whether multiple values may be passed by writing --option a,b in +addition to --option a --option b. +
    final
    +
    +
    + type + → OptionType +
    +
    + Whether this is a flag, a single value option, or a multi-value option. +
    final
    +
    +
    + valueHelp + → String +
    +
    + A name for the value this option takes. +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + getOrDefault(dynamic value) + → dynamic + +
    +
    + Returns value if non-null, otherwise returns the default value for +this option. [...] + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/abbr.html b/testing/test_package_docs_dev/package-args_args/Option/abbr.html new file mode 100644 index 0000000000..88803d03c5 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/abbr.html @@ -0,0 +1,117 @@ + + + + + + + + abbr property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    abbr
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    abbr property

    + +
    + String + abbr +
    final
    +
    +
    +

    A single-character string that can be used as a shorthand for this option.

    +

    For example, abbr: "a" will allow the user to pass -a value or +-avalue.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/abbreviation.html b/testing/test_package_docs_dev/package-args_args/Option/abbreviation.html new file mode 100644 index 0000000000..5f99319e84 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/abbreviation.html @@ -0,0 +1,117 @@ + + + + + + + + abbreviation property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    abbreviation
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    abbreviation property

    + + +
    + +
    + String + abbreviation +
    @Deprecated("Use abbr instead.")
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/allowed.html b/testing/test_package_docs_dev/package-args_args/Option/allowed.html new file mode 100644 index 0000000000..bc90e0538b --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/allowed.html @@ -0,0 +1,115 @@ + + + + + + + + allowed property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    allowed
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    allowed property

    + +
    + List<String> + allowed +
    final
    +
    +
    +

    A list of valid values for this option.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/allowedHelp.html b/testing/test_package_docs_dev/package-args_args/Option/allowedHelp.html new file mode 100644 index 0000000000..b41ddc0d7f --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/allowedHelp.html @@ -0,0 +1,115 @@ + + + + + + + + allowedHelp property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    allowedHelp
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    allowedHelp property

    + +
    + Map<String, String> + allowedHelp +
    final
    +
    +
    +

    A map from values in allowed to documentation for those values.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/callback.html b/testing/test_package_docs_dev/package-args_args/Option/callback.html new file mode 100644 index 0000000000..12b815e740 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/callback.html @@ -0,0 +1,115 @@ + + + + + + + + callback property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    callback
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    callback property

    + +
    + Function + callback +
    final
    +
    +
    +

    The callback to invoke with the option's value when the option is parsed.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/defaultValue.html b/testing/test_package_docs_dev/package-args_args/Option/defaultValue.html new file mode 100644 index 0000000000..c684935e98 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/defaultValue.html @@ -0,0 +1,117 @@ + + + + + + + + defaultValue property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    defaultValue
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    defaultValue property

    + + +
    + +
    + dynamic + defaultValue +
    @Deprecated("Use defaultsTo instead.")
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/defaultsTo.html b/testing/test_package_docs_dev/package-args_args/Option/defaultsTo.html new file mode 100644 index 0000000000..abd5a0ae2b --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/defaultsTo.html @@ -0,0 +1,115 @@ + + + + + + + + defaultsTo property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    defaultsTo
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    defaultsTo property

    + +
    + dynamic + defaultsTo +
    final
    +
    +
    +

    The value this option will have if the user doesn't explicitly pass it in

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/getOrDefault.html b/testing/test_package_docs_dev/package-args_args/Option/getOrDefault.html new file mode 100644 index 0000000000..885a17b67a --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/getOrDefault.html @@ -0,0 +1,120 @@ + + + + + + + + getOrDefault method - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    getOrDefault
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    getOrDefault method

    + +
    + dynamic + getOrDefault +(dynamic value) +
    +
    +

    Returns value if non-null, otherwise returns the default value for +this option.

    +

    For single-valued options, it will be defaultsTo if set or null +otherwise. For multiple-valued options, it will be an empty list or a +list containing defaultsTo if set.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/hashCode.html b/testing/test_package_docs_dev/package-args_args/Option/hashCode.html new file mode 100644 index 0000000000..986bf5e959 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/hashCode.html @@ -0,0 +1,117 @@ + + + + + + + + hashCode property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/help.html b/testing/test_package_docs_dev/package-args_args/Option/help.html new file mode 100644 index 0000000000..5f1f4e24fa --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/help.html @@ -0,0 +1,115 @@ + + + + + + + + help property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    help
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    help property

    + +
    + String + help +
    final
    +
    +
    +

    A description of this option.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/hide.html b/testing/test_package_docs_dev/package-args_args/Option/hide.html new file mode 100644 index 0000000000..4a96a4c072 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/hide.html @@ -0,0 +1,115 @@ + + + + + + + + hide property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hide
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    hide property

    + +
    + bool + hide +
    final
    +
    +
    +

    Whether this option should be hidden from usage documentation.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/isFlag.html b/testing/test_package_docs_dev/package-args_args/Option/isFlag.html new file mode 100644 index 0000000000..bc0cc4880c --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/isFlag.html @@ -0,0 +1,120 @@ + + + + + + + + isFlag property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    isFlag
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    isFlag property

    + + +
    + +
    + bool + isFlag + +
    + +
    +

    Whether the option is boolean-valued flag.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/isMultiple.html b/testing/test_package_docs_dev/package-args_args/Option/isMultiple.html new file mode 100644 index 0000000000..f7b8bc0d6e --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/isMultiple.html @@ -0,0 +1,120 @@ + + + + + + + + isMultiple property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    isMultiple
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    isMultiple property

    + + +
    + +
    + bool + isMultiple + +
    + +
    +

    Whether the option allows multiple values.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/isSingle.html b/testing/test_package_docs_dev/package-args_args/Option/isSingle.html new file mode 100644 index 0000000000..46d2f95eca --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/isSingle.html @@ -0,0 +1,120 @@ + + + + + + + + isSingle property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    isSingle
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    isSingle property

    + + +
    + +
    + bool + isSingle + +
    + +
    +

    Whether the option takes a single value.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/name.html b/testing/test_package_docs_dev/package-args_args/Option/name.html new file mode 100644 index 0000000000..0a0b7bb1cf --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/name.html @@ -0,0 +1,115 @@ + + + + + + + + name property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    name
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    name property

    + +
    + String + name +
    final
    +
    +
    +

    The name of the option that the user passes as an argument.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/negatable.html b/testing/test_package_docs_dev/package-args_args/Option/negatable.html new file mode 100644 index 0000000000..edf61746b1 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/negatable.html @@ -0,0 +1,118 @@ + + + + + + + + negatable property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    negatable
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    negatable property

    + +
    + bool + negatable +
    final
    +
    +
    +

    Whether this flag's value can be set to false.

    +

    For example, if name is flag, the user can pass --no-flag to set its +value to false.

    +

    This is null unless type is OptionType.flag.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/noSuchMethod.html b/testing/test_package_docs_dev/package-args_args/Option/noSuchMethod.html new file mode 100644 index 0000000000..d5b2b0c084 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/noSuchMethod.html @@ -0,0 +1,113 @@ + + + + + + + + noSuchMethod method - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/operator_equals.html b/testing/test_package_docs_dev/package-args_args/Option/operator_equals.html new file mode 100644 index 0000000000..517f821181 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/operator_equals.html @@ -0,0 +1,113 @@ + + + + + + + + operator == method - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/runtimeType.html b/testing/test_package_docs_dev/package-args_args/Option/runtimeType.html new file mode 100644 index 0000000000..4730aae102 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/runtimeType.html @@ -0,0 +1,117 @@ + + + + + + + + runtimeType property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/splitCommas.html b/testing/test_package_docs_dev/package-args_args/Option/splitCommas.html new file mode 100644 index 0000000000..ea448e9292 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/splitCommas.html @@ -0,0 +1,116 @@ + + + + + + + + splitCommas property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    splitCommas
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    splitCommas property

    + +
    + bool + splitCommas +
    final
    +
    +
    +

    Whether multiple values may be passed by writing --option a,b in +addition to --option a --option b.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/toString.html b/testing/test_package_docs_dev/package-args_args/Option/toString.html new file mode 100644 index 0000000000..5b8393463c --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/toString.html @@ -0,0 +1,113 @@ + + + + + + + + toString method - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/type.html b/testing/test_package_docs_dev/package-args_args/Option/type.html new file mode 100644 index 0000000000..8ab765a953 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/type.html @@ -0,0 +1,115 @@ + + + + + + + + type property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    type
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    type property

    + +
    + OptionType + type +
    final
    +
    +
    +

    Whether this is a flag, a single value option, or a multi-value option.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/Option/valueHelp.html b/testing/test_package_docs_dev/package-args_args/Option/valueHelp.html new file mode 100644 index 0000000000..8043259b89 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/Option/valueHelp.html @@ -0,0 +1,115 @@ + + + + + + + + valueHelp property - Option class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    valueHelp
    + +
    + +
    + +
    +
    Option class
    +
      + +
    1. + Properties +
      2. +
    2. abbr
      3. +
    3. abbreviation
      4. +
    4. allowed
      5. +
    5. allowedHelp
      6. +
    6. callback
      7. +
    7. defaultsTo
      8. +
    8. defaultValue
      9. +
    9. help
      10. +
    10. hide
      11. +
    11. isFlag
      12. +
    12. isMultiple
      13. +
    13. isSingle
      14. +
    14. name
      15. +
    15. negatable
      16. +
    16. splitCommas
      17. +
    17. type
      18. +
    18. valueHelp
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. getOrDefault
      23. +
    23. noSuchMethod
      24. +
    24. toString
      25. + +
    25. Operators
      26. +
    26. operator ==
      27. + + + +
    +
    + +
    +

    valueHelp property

    + +
    + String + valueHelp +
    final
    +
    +
    +

    A name for the value this option takes.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType-class.html b/testing/test_package_docs_dev/package-args_args/OptionType-class.html new file mode 100644 index 0000000000..1c4f71a0de --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType-class.html @@ -0,0 +1,260 @@ + + + + + + + + OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    OptionType
    + +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    +

    OptionType class

    + +
    +

    What kinds of values an option accepts.

    +
    + + + +
    +

    Properties

    + +
    +
    + name + → String +
    +
    + +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + +
    +

    Constants

    + +
    +
    + FLAG + → const OptionType +
    +
    + +
    @Deprecated("Use OptionType.flag instead.")
    +
    + flag +
    +
    +
    + flag + → const OptionType +
    +
    + An option that can only be true or false. [...] + +
    + const OptionType._("OptionType.flag") +
    +
    +
    + MULTIPLE + → const OptionType +
    +
    + +
    @Deprecated("Use OptionType.multiple instead.")
    +
    + multiple +
    +
    +
    + multiple + → const OptionType +
    +
    + An option that allows multiple values. [...] + +
    + const OptionType._("OptionType.multiple") +
    +
    +
    + SINGLE + → const OptionType +
    +
    + +
    @Deprecated("Use OptionType.single instead.")
    +
    + single +
    +
    +
    + single + → const OptionType +
    +
    + An option that takes a single value. [...] + +
    + const OptionType._("OptionType.single") +
    +
    +
    +
    + +
    + +
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/FLAG-constant.html b/testing/test_package_docs_dev/package-args_args/OptionType/FLAG-constant.html new file mode 100644 index 0000000000..445af33f98 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/FLAG-constant.html @@ -0,0 +1,104 @@ + + + + + + + + FLAG constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    FLAG
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    FLAG constant

    + +
    + OptionType + const FLAG + = + flag +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/MULTIPLE-constant.html b/testing/test_package_docs_dev/package-args_args/OptionType/MULTIPLE-constant.html new file mode 100644 index 0000000000..2088a50390 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/MULTIPLE-constant.html @@ -0,0 +1,104 @@ + + + + + + + + MULTIPLE constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    MULTIPLE
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    MULTIPLE constant

    + +
    + OptionType + const MULTIPLE + = + multiple +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/SINGLE-constant.html b/testing/test_package_docs_dev/package-args_args/OptionType/SINGLE-constant.html new file mode 100644 index 0000000000..fdc4771e2f --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/SINGLE-constant.html @@ -0,0 +1,104 @@ + + + + + + + + SINGLE constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    SINGLE
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    SINGLE constant

    + +
    + OptionType + const SINGLE + = + single +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/flag-constant.html b/testing/test_package_docs_dev/package-args_args/OptionType/flag-constant.html new file mode 100644 index 0000000000..9f597309a6 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/flag-constant.html @@ -0,0 +1,108 @@ + + + + + + + + flag constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    flag
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    flag constant

    + +
    + OptionType + const flag + = + const OptionType._("OptionType.flag") +
    + +
    +

    An option that can only be true or false.

    +

    The presence of the option name itself in the argument list means true.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/hashCode.html b/testing/test_package_docs_dev/package-args_args/OptionType/hashCode.html new file mode 100644 index 0000000000..f861460bc9 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/hashCode.html @@ -0,0 +1,107 @@ + + + + + + + + hashCode property - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/multiple-constant.html b/testing/test_package_docs_dev/package-args_args/OptionType/multiple-constant.html new file mode 100644 index 0000000000..520a49f74b --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/multiple-constant.html @@ -0,0 +1,112 @@ + + + + + + + + multiple constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    multiple
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    multiple constant

    + +
    + OptionType + const multiple + = + const OptionType._("OptionType.multiple") +
    + +
    +

    An option that allows multiple values.

    +

    Example:

    +
    --output text --output xml
+
    +

    In the parsed ArgResults, a multiple-valued option will always return +a list, even if one or no values were passed.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/name.html b/testing/test_package_docs_dev/package-args_args/OptionType/name.html new file mode 100644 index 0000000000..46669cb379 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/name.html @@ -0,0 +1,102 @@ + + + + + + + + name property - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    name
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    name property

    + +
    + String + name +
    final
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/noSuchMethod.html b/testing/test_package_docs_dev/package-args_args/OptionType/noSuchMethod.html new file mode 100644 index 0000000000..62f79b1c93 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/noSuchMethod.html @@ -0,0 +1,103 @@ + + + + + + + + noSuchMethod method - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/operator_equals.html b/testing/test_package_docs_dev/package-args_args/OptionType/operator_equals.html new file mode 100644 index 0000000000..b44ece34bb --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/operator_equals.html @@ -0,0 +1,103 @@ + + + + + + + + operator == method - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/runtimeType.html b/testing/test_package_docs_dev/package-args_args/OptionType/runtimeType.html new file mode 100644 index 0000000000..e10e6204b1 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/runtimeType.html @@ -0,0 +1,107 @@ + + + + + + + + runtimeType property - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/single-constant.html b/testing/test_package_docs_dev/package-args_args/OptionType/single-constant.html new file mode 100644 index 0000000000..a6c99fda01 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/single-constant.html @@ -0,0 +1,113 @@ + + + + + + + + single constant - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    single
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    single constant

    + +
    + OptionType + const single + = + const OptionType._("OptionType.single") +
    + +
    +

    An option that takes a single value.

    +

    Examples:

    +
    --mode debug
+-mdebug
+--mode=debug
+
    +

    If the option is passed more than once, the last one wins.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/OptionType/toString.html b/testing/test_package_docs_dev/package-args_args/OptionType/toString.html new file mode 100644 index 0000000000..4742b3e174 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/OptionType/toString.html @@ -0,0 +1,103 @@ + + + + + + + + toString method - OptionType class - args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    OptionType class
    +
      + +
    1. + Properties +
      2. +
    2. name
      3. +
    3. hashCode
      4. +
    4. runtimeType
      5. + +
    5. Methods
      6. +
    6. noSuchMethod
      7. +
    7. toString
      8. + +
    8. Operators
      9. +
    9. operator ==
      10. + + + +
    10. Constants
      11. +
    11. FLAG
      12. +
    12. flag
      13. +
    13. MULTIPLE
      14. +
    14. multiple
      15. +
    15. SINGLE
      16. +
    16. single
      17. +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_args/package-args_args-library.html b/testing/test_package_docs_dev/package-args_args/package-args_args-library.html new file mode 100644 index 0000000000..06b9893111 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_args/package-args_args-library.html @@ -0,0 +1,162 @@ + + + + + + + + args library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    args
    + +
    + +
    + +
    +
    test_package package
    +
      +
    1. Topics
      2. +
    2. Superb
      3. +
    3. Unreal
      4. +
    4. Libraries
      5. +
    5. anonymous_library
      6. +
    6. another_anonymous_lib
      7. +
    7. code_in_comments
      8. +
    8. is_deprecated
      9. +
    9. Unreal
      10. +
    10. reexport_one
      11. +
    11. reexport_two
      12. +
    12. Real Libraries
      13. +
    13. ex
      14. +
    14. fake
      15. +
    15. two_exports
      16. +
    16. Misc
      17. +
    17. two_exports
      18. +
    18. Other
      19. +
    19. css
      20. +
    20. test_package_imported
      21. +
    21. categoriesExported
      22. +
    22. test_package_imported.main
      23. +
    23. args
      24. +
    24. args
      25. +
    25. command_runner
      26. +
    +
    + +
    +

    args library

    + + +
    +

    Classes

    + +
    +
    + ArgParser +
    +
    + A class for taking a list of raw command line arguments and parsing out +options and flags from them. +
    +
    + ArgResults +
    +
    + The results of parsing a series of command line arguments using +ArgParser.parse(). [...] +
    +
    + Option +
    +
    + A command-line option. [...] +
    +
    + OptionType +
    +
    + What kinds of values an option accepts. +
    +
    +
    + + + + + + +
    +

    Exceptions / Errors

    + +
    +
    + ArgParserException +
    +
    + An exception thrown by ArgParser. +
    +
    +
    + +
    + +
    +
    args library
    +
      +
    1. Classes
      2. +
    2. ArgParser
      3. +
    3. ArgResults
      4. +
    4. Option
      5. +
    5. OptionType
      6. + + + + + + +
    6. Exceptions
      7. +
    7. ArgParserException
      8. +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command-class.html b/testing/test_package_docs_dev/package-args_command_runner/Command-class.html new file mode 100644 index 0000000000..908cee1035 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command-class.html @@ -0,0 +1,366 @@ + + + + + + + + Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    Command
    + +
    + +
    + +
    +
    command_runner library
    +
      +
    1. Classes
      2. +
    2. Command
      3. +
    3. CommandRunner
      4. + + + + + + +
    4. Exceptions
      5. +
    5. UsageException
      6. +
    +
    + +
    +

    Command<T> class

    + +
    +

    A single command.

    +

    A command is known as a "leaf command" if it has no subcommands and is meant +to be run. Leaf commands must override run.

    +

    A command with subcommands is known as a "branch command" and cannot be run +itself. It should call addSubcommand (often from the constructor) to +register subcommands.

    +
    + + +
    +

    Constructors

    + +
    +
    + Command() +
    +
    + +
    +
    +
    + +
    +

    Properties

    + +
    +
    + aliases + → List<String> +
    +
    + Alternate names for this command. [...] +
    read-only
    +
    +
    + argParser + → ArgParser +
    +
    + The argument parser for this command. [...] +
    read-only
    +
    +
    + argResults + → ArgResults +
    +
    + The parsed argument results for this command. [...] +
    read-only
    +
    +
    + description + → String +
    +
    + A description of this command, included in usage. +
    read-only
    +
    +
    + globalResults + → ArgResults +
    +
    + The parsed global argument results. [...] +
    read-only
    +
    +
    + hidden + → bool +
    +
    + Whether or not this command should be hidden from help listings. [...] +
    read-only
    +
    +
    + invocation + → String +
    +
    + A single-line template for how to invoke this command (e.g. "pub getpackage"). +
    read-only
    +
    +
    + name + → String +
    +
    + The name of this command. +
    read-only
    +
    +
    + parent + → Command<T> +
    +
    + The command's parent command, if this is a subcommand. [...] +
    read-only
    +
    +
    + runner + → CommandRunner<T> +
    +
    + The command runner for this command. [...] +
    read-only
    +
    +
    + subcommands + → Map<String, Command<T>> +
    +
    + An unmodifiable view of all sublevel commands of this command. +
    read-only
    +
    +
    + summary + → String +
    +
    + A short description of this command, included in parent's +CommandRunner.usage. [...] +
    read-only
    +
    +
    + takesArguments + → bool +
    +
    + Whether or not this command takes positional arguments in addition to +options. [...] +
    read-only
    +
    +
    + usage + → String +
    +
    + Generates a string displaying usage information for this command. [...] +
    read-only
    +
    +
    + usageFooter + → String +
    +
    + An optional footer for usage. [...] +
    read-only
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + addSubcommand(Command<T> command) + → void + +
    +
    + Adds Command as a subcommand of this. + +
    +
    + printUsage() + → void + +
    +
    + Prints the usage information for this command. [...] + +
    +
    + run() + → FutureOr<T> + +
    +
    + Runs this command. [...] + +
    +
    + usageException(String message) + → void + +
    +
    + Throws a UsageException with message. + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/Command.html b/testing/test_package_docs_dev/package-args_command_runner/Command/Command.html new file mode 100644 index 0000000000..dfb9a311b2 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/Command.html @@ -0,0 +1,116 @@ + + + + + + + + Command constructor - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    Command
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    Command<T> constructor

    + +
    + + Command<T>() +
    + + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/addSubcommand.html b/testing/test_package_docs_dev/package-args_command_runner/Command/addSubcommand.html new file mode 100644 index 0000000000..4b37c2d73b --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/addSubcommand.html @@ -0,0 +1,119 @@ + + + + + + + + addSubcommand method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addSubcommand
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    addSubcommand method

    + +
    + void + addSubcommand +(Command<T> command) +
    +
    +

    Adds Command as a subcommand of this.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/aliases.html b/testing/test_package_docs_dev/package-args_command_runner/Command/aliases.html new file mode 100644 index 0000000000..9124eb25d2 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/aliases.html @@ -0,0 +1,126 @@ + + + + + + + + aliases property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    aliases
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    aliases property

    + + +
    + +
    + List<String> + aliases + +
    + +
    +

    Alternate names for this command.

    +

    These names won't be used in the documentation, but they will work when +invoked on the command line.

    +

    This is intended to be overridden.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/argParser.html b/testing/test_package_docs_dev/package-args_command_runner/Command/argParser.html new file mode 100644 index 0000000000..63567b8ff9 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/argParser.html @@ -0,0 +1,129 @@ + + + + + + + + argParser property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    argParser
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    argParser property

    + + +
    + +
    + ArgParser + argParser + +
    + +
    +

    The argument parser for this command.

    +

    Options for this command should be registered with this parser (often in +the constructor); they'll end up available via argResults. Subcommands +should be registered with addSubcommand rather than directly on the +parser.

    +

    This can be overridden to change the arguments passed to the ArgParser +constructor.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/argResults.html b/testing/test_package_docs_dev/package-args_command_runner/Command/argResults.html new file mode 100644 index 0000000000..83bfc12e0d --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/argResults.html @@ -0,0 +1,124 @@ + + + + + + + + argResults property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    argResults
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    argResults property

    + + +
    + +
    + ArgResults + argResults + +
    + +
    +

    The parsed argument results for this command.

    +

    This will be null until just before Command.run is called.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/description.html b/testing/test_package_docs_dev/package-args_command_runner/Command/description.html new file mode 100644 index 0000000000..14514f5073 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/description.html @@ -0,0 +1,123 @@ + + + + + + + + description property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    description
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    description property

    + + +
    + +
    + String + description + +
    + +
    +

    A description of this command, included in usage.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/globalResults.html b/testing/test_package_docs_dev/package-args_command_runner/Command/globalResults.html new file mode 100644 index 0000000000..0fd837d3f6 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/globalResults.html @@ -0,0 +1,124 @@ + + + + + + + + globalResults property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    globalResults
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    globalResults property

    + + +
    + +
    + ArgResults + globalResults + +
    + +
    +

    The parsed global argument results.

    +

    This will be null until just before Command.run is called.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/hashCode.html b/testing/test_package_docs_dev/package-args_command_runner/Command/hashCode.html new file mode 100644 index 0000000000..47fe77bee7 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/hashCode.html @@ -0,0 +1,120 @@ + + + + + + + + hashCode property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/hidden.html b/testing/test_package_docs_dev/package-args_command_runner/Command/hidden.html new file mode 100644 index 0000000000..cf4748dd71 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/hidden.html @@ -0,0 +1,127 @@ + + + + + + + + hidden property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hidden
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    hidden property

    + + +
    + +
    + bool + hidden + +
    + +
    +

    Whether or not this command should be hidden from help listings.

    +

    This is intended to be overridden by commands that want to mark themselves +hidden.

    +

    By default, leaf commands are always visible. Branch commands are visible +as long as any of their leaf commands are visible.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/invocation.html b/testing/test_package_docs_dev/package-args_command_runner/Command/invocation.html new file mode 100644 index 0000000000..056a561663 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/invocation.html @@ -0,0 +1,123 @@ + + + + + + + + invocation property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    invocation
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    invocation property

    + + +
    + +
    + String + invocation + +
    + +
    +

    A single-line template for how to invoke this command (e.g. "pub getpackage").

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/name.html b/testing/test_package_docs_dev/package-args_command_runner/Command/name.html new file mode 100644 index 0000000000..b3f377967e --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/name.html @@ -0,0 +1,123 @@ + + + + + + + + name property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    name
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    name property

    + + +
    + +
    + String + name + +
    + +
    +

    The name of this command.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/noSuchMethod.html b/testing/test_package_docs_dev/package-args_command_runner/Command/noSuchMethod.html new file mode 100644 index 0000000000..3ff626edca --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/noSuchMethod.html @@ -0,0 +1,116 @@ + + + + + + + + noSuchMethod method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/operator_equals.html b/testing/test_package_docs_dev/package-args_command_runner/Command/operator_equals.html new file mode 100644 index 0000000000..9ef5bf61be --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/operator_equals.html @@ -0,0 +1,116 @@ + + + + + + + + operator == method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/parent.html b/testing/test_package_docs_dev/package-args_command_runner/Command/parent.html new file mode 100644 index 0000000000..9bb15bf80e --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/parent.html @@ -0,0 +1,125 @@ + + + + + + + + parent property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    parent
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    parent property

    + + +
    + +
    + Command<T> + parent + +
    + +
    +

    The command's parent command, if this is a subcommand.

    +

    This will be null until addSubcommand has been called with +this command.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/printUsage.html b/testing/test_package_docs_dev/package-args_command_runner/Command/printUsage.html new file mode 100644 index 0000000000..b71986665b --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/printUsage.html @@ -0,0 +1,121 @@ + + + + + + + + printUsage method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    printUsage
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    printUsage method

    + +
    + void + printUsage +() +
    +
    +

    Prints the usage information for this command.

    +

    This is called internally by run and can be overridden by subclasses to +control how output is displayed or integrate with a logging system.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/run.html b/testing/test_package_docs_dev/package-args_command_runner/Command/run.html new file mode 100644 index 0000000000..bf02c892e4 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/run.html @@ -0,0 +1,121 @@ + + + + + + + + run method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    run
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    run method

    + +
    + FutureOr<T> + run +() +
    +
    +

    Runs this command.

    +

    The return value is wrapped in a Future if necessary and returned by +CommandRunner.runCommand.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/runner.html b/testing/test_package_docs_dev/package-args_command_runner/Command/runner.html new file mode 100644 index 0000000000..6f3d46ab88 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/runner.html @@ -0,0 +1,125 @@ + + + + + + + + runner property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runner
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    runner property

    + + +
    + +
    + CommandRunner<T> + runner + +
    + +
    +

    The command runner for this command.

    +

    This will be null until CommandRunner.addCommand has been called with +this command or one of its parents.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/runtimeType.html b/testing/test_package_docs_dev/package-args_command_runner/Command/runtimeType.html new file mode 100644 index 0000000000..63fd913e59 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/runtimeType.html @@ -0,0 +1,120 @@ + + + + + + + + runtimeType property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/subcommands.html b/testing/test_package_docs_dev/package-args_command_runner/Command/subcommands.html new file mode 100644 index 0000000000..c7820b972f --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/subcommands.html @@ -0,0 +1,123 @@ + + + + + + + + subcommands property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    subcommands
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    subcommands property

    + + +
    + +
    + Map<String, Command<T>> + subcommands + +
    + +
    +

    An unmodifiable view of all sublevel commands of this command.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/summary.html b/testing/test_package_docs_dev/package-args_command_runner/Command/summary.html new file mode 100644 index 0000000000..42666af808 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/summary.html @@ -0,0 +1,125 @@ + + + + + + + + summary property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    summary
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    summary property

    + + +
    + +
    + String + summary + +
    + +
    +

    A short description of this command, included in parent's +CommandRunner.usage.

    +

    This defaults to the first line of description.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/takesArguments.html b/testing/test_package_docs_dev/package-args_command_runner/Command/takesArguments.html new file mode 100644 index 0000000000..55bf26ec68 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/takesArguments.html @@ -0,0 +1,128 @@ + + + + + + + + takesArguments property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    takesArguments
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    takesArguments property

    + + +
    + +
    + bool + takesArguments + +
    + +
    +

    Whether or not this command takes positional arguments in addition to +options.

    +

    If false, CommandRunner.run will throw a UsageException if arguments +are provided. Defaults to true.

    +

    This is intended to be overridden by commands that don't want to receive +arguments. It has no effect for branch commands.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/toString.html b/testing/test_package_docs_dev/package-args_command_runner/Command/toString.html new file mode 100644 index 0000000000..2ce8547eae --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/toString.html @@ -0,0 +1,116 @@ + + + + + + + + toString method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/usage.html b/testing/test_package_docs_dev/package-args_command_runner/Command/usage.html new file mode 100644 index 0000000000..9b3fa31281 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/usage.html @@ -0,0 +1,125 @@ + + + + + + + + usage property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usage
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    usage property

    + + +
    + +
    + String + usage + +
    + +
    +

    Generates a string displaying usage information for this command.

    +

    This includes usage for the command's arguments as well as a list of +subcommands, if there are any.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/usageException.html b/testing/test_package_docs_dev/package-args_command_runner/Command/usageException.html new file mode 100644 index 0000000000..eb9835f53a --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/usageException.html @@ -0,0 +1,119 @@ + + + + + + + + usageException method - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usageException
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    usageException method

    + +
    + void + usageException +(String message) +
    +
    +

    Throws a UsageException with message.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/Command/usageFooter.html b/testing/test_package_docs_dev/package-args_command_runner/Command/usageFooter.html new file mode 100644 index 0000000000..461a0ed430 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/Command/usageFooter.html @@ -0,0 +1,125 @@ + + + + + + + + usageFooter property - Command class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usageFooter
    + +
    + +
    + +
    +
    Command class
    +
      +
    1. Constructors
      2. +
    2. Command
      3. + +
    3. + Properties +
      4. +
    4. aliases
      5. +
    5. argParser
      6. +
    6. argResults
      7. +
    7. description
      8. +
    8. globalResults
      9. +
    9. hidden
      10. +
    10. invocation
      11. +
    11. name
      12. +
    12. parent
      13. +
    13. runner
      14. +
    14. subcommands
      15. +
    15. summary
      16. +
    16. takesArguments
      17. +
    17. usage
      18. +
    18. usageFooter
      19. +
    19. hashCode
      20. +
    20. runtimeType
      21. + +
    21. Methods
      22. +
    22. addSubcommand
      23. +
    23. printUsage
      24. +
    24. run
      25. +
    25. usageException
      26. +
    26. noSuchMethod
      27. +
    27. toString
      28. + +
    28. Operators
      29. +
    29. operator ==
      30. + + + +
    +
    + +
    +

    usageFooter property

    + + +
    + +
    + String + usageFooter + +
    + +
    +

    An optional footer for usage.

    +

    If a subclass overrides this to return a string, it will automatically be +added to the end of usage.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner-class.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner-class.html new file mode 100644 index 0000000000..94de326fa4 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner-class.html @@ -0,0 +1,311 @@ + + + + + + + + CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    CommandRunner
    + +
    + +
    + +
    +
    command_runner library
    +
      +
    1. Classes
      2. +
    2. Command
      3. +
    3. CommandRunner
      4. + + + + + + +
    4. Exceptions
      5. +
    5. UsageException
      6. +
    +
    + +
    +

    CommandRunner<T> class

    + +
    +

    A class for invoking Commands based on raw command-line arguments.

    +

    The type argument T represents the type returned by Command.run and +CommandRunner.run; it can be ommitted if you're not using the return +values.

    +
    + + +
    +

    Constructors

    + +
    +
    + CommandRunner(String executableName, String description) +
    +
    + +
    +
    +
    + +
    +

    Properties

    + +
    +
    + argParser + → ArgParser +
    +
    + The top-level argument parser. [...] +
    read-only
    +
    +
    + commands + → Map<String, Command<T>> +
    +
    + An unmodifiable view of all top-level commands defined for this runner. +
    read-only
    +
    +
    + description + → String +
    +
    + A short description of this executable. +
    final
    +
    +
    + executableName + → String +
    +
    + The name of the executable being run. [...] +
    final
    +
    +
    + invocation + → String +
    +
    + A single-line template for how to invoke this executable. [...] +
    read-only
    +
    +
    + usage + → String +
    +
    + Generates a string displaying usage information for the executable. [...] +
    read-only
    +
    +
    + usageFooter + → String +
    +
    + An optional footer for usage. [...] +
    read-only
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + addCommand(Command<T> command) + → void + +
    +
    + Adds Command as a top-level command to this runner. + +
    +
    + parse(Iterable<String> args) + → ArgResults + +
    +
    + Parses args and returns the result, converting an ArgParserException +to a UsageException. [...] + +
    +
    + printUsage() + → void + +
    +
    + Prints the usage information for this runner. [...] + +
    +
    + run(Iterable<String> args) + → Future<T> + +
    +
    + Parses args and invokes Command.run on the chosen command. [...] + +
    +
    + runCommand(ArgResults topLevelResults) + → Future<T> + +
    +
    + Runs the command specified by topLevelResults. [...] + +
    +
    + usageException(String message) + → void + +
    +
    + Throws a UsageException with message. + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    + toString() + → String + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/CommandRunner.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/CommandRunner.html new file mode 100644 index 0000000000..0caaa82246 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/CommandRunner.html @@ -0,0 +1,110 @@ + + + + + + + + CommandRunner constructor - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    CommandRunner
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    CommandRunner<T> constructor

    + +
    + + CommandRunner<T>(String executableName, String description) +
    + + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/addCommand.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/addCommand.html new file mode 100644 index 0000000000..3e2802c24e --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/addCommand.html @@ -0,0 +1,113 @@ + + + + + + + + addCommand method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    addCommand
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    addCommand method

    + +
    + void + addCommand +(Command<T> command) +
    +
    +

    Adds Command as a top-level command to this runner.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/argParser.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/argParser.html new file mode 100644 index 0000000000..c39f1d2542 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/argParser.html @@ -0,0 +1,120 @@ + + + + + + + + argParser property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    argParser
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    argParser property

    + + +
    + +
    + ArgParser + argParser + +
    + +
    +

    The top-level argument parser.

    +

    Global options should be registered with this parser; they'll end up +available via Command.globalResults. Commands should be registered with +addCommand rather than directly on the parser.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/commands.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/commands.html new file mode 100644 index 0000000000..ae6cabb2c5 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/commands.html @@ -0,0 +1,117 @@ + + + + + + + + commands property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    commands
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    commands property

    + + +
    + +
    + Map<String, Command<T>> + commands + +
    + +
    +

    An unmodifiable view of all top-level commands defined for this runner.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/description.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/description.html new file mode 100644 index 0000000000..f49f63fc09 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/description.html @@ -0,0 +1,112 @@ + + + + + + + + description property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    description
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    description property

    + +
    + String + description +
    final
    +
    +
    +

    A short description of this executable.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/executableName.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/executableName.html new file mode 100644 index 0000000000..93f4588de7 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/executableName.html @@ -0,0 +1,113 @@ + + + + + + + + executableName property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    executableName
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    executableName property

    + +
    + String + executableName +
    final
    +
    +
    +

    The name of the executable being run.

    +

    Used for error reporting and usage.

    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/hashCode.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/hashCode.html new file mode 100644 index 0000000000..bcc2d7db8b --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/hashCode.html @@ -0,0 +1,114 @@ + + + + + + + + hashCode property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/invocation.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/invocation.html new file mode 100644 index 0000000000..e5e19df0f1 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/invocation.html @@ -0,0 +1,119 @@ + + + + + + + + invocation property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    invocation
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    invocation property

    + + +
    + +
    + String + invocation + +
    + +
    +

    A single-line template for how to invoke this executable.

    +

    Defaults to "$executableName arguments". Subclasses can +override this for a more specific template.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/noSuchMethod.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/noSuchMethod.html new file mode 100644 index 0000000000..d0f40b77c5 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/noSuchMethod.html @@ -0,0 +1,110 @@ + + + + + + + + noSuchMethod method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/operator_equals.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/operator_equals.html new file mode 100644 index 0000000000..b157f581c1 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/operator_equals.html @@ -0,0 +1,110 @@ + + + + + + + + operator == method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/parse.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/parse.html new file mode 100644 index 0000000000..a902fdf124 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/parse.html @@ -0,0 +1,116 @@ + + + + + + + + parse method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    parse
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    parse method

    + +
    + ArgResults + parse +(Iterable<String> args) +
    +
    +

    Parses args and returns the result, converting an ArgParserException +to a UsageException.

    +

    This is notionally a protected method. It may be overridden or called from +subclasses, but it shouldn't be called externally.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/printUsage.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/printUsage.html new file mode 100644 index 0000000000..0cd8b9dd7c --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/printUsage.html @@ -0,0 +1,115 @@ + + + + + + + + printUsage method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    printUsage
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    printUsage method

    + +
    + void + printUsage +() +
    +
    +

    Prints the usage information for this runner.

    +

    This is called internally by run and can be overridden by subclasses to +control how output is displayed or integrate with a logging system.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/run.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/run.html new file mode 100644 index 0000000000..8ae2ca7855 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/run.html @@ -0,0 +1,115 @@ + + + + + + + + run method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    run
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    run method

    + +
    + Future<T> + run +(Iterable<String> args) +
    +
    +

    Parses args and invokes Command.run on the chosen command.

    +

    This always returns a Future in case the command is asynchronous. The +Future will throw a UsageException if args was invalid.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/runCommand.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/runCommand.html new file mode 100644 index 0000000000..1b2d66bf03 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/runCommand.html @@ -0,0 +1,119 @@ + + + + + + + + runCommand method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runCommand
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    runCommand method

    + +
    + Future<T> + runCommand +(ArgResults topLevelResults) +
    +
    +

    Runs the command specified by topLevelResults.

    +

    This is notionally a protected method. It may be overridden or called from +subclasses, but it shouldn't be called externally.

    +

    It's useful to override this to handle global flags and/or wrap the entire +command in a block. For example, you might handle the --verbose flag +here to enable verbose logging before running the command.

    +

    This returns the return value of Command.run.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/runtimeType.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/runtimeType.html new file mode 100644 index 0000000000..c0416c24ba --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/runtimeType.html @@ -0,0 +1,114 @@ + + + + + + + + runtimeType property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/toString.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/toString.html new file mode 100644 index 0000000000..e11d679eee --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/toString.html @@ -0,0 +1,110 @@ + + + + + + + + toString method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    toString method

    + +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/usage.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/usage.html new file mode 100644 index 0000000000..1e1555503a --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/usage.html @@ -0,0 +1,119 @@ + + + + + + + + usage property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usage
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    usage property

    + + +
    + +
    + String + usage + +
    + +
    +

    Generates a string displaying usage information for the executable.

    +

    This includes usage for the global arguments as well as a list of +top-level commands.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/usageException.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/usageException.html new file mode 100644 index 0000000000..82d09a5169 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/usageException.html @@ -0,0 +1,113 @@ + + + + + + + + usageException method - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usageException
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    usageException method

    + +
    + void + usageException +(String message) +
    +
    +

    Throws a UsageException with message.

    +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/usageFooter.html b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/usageFooter.html new file mode 100644 index 0000000000..f1a4f5b22d --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/CommandRunner/usageFooter.html @@ -0,0 +1,119 @@ + + + + + + + + usageFooter property - CommandRunner class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usageFooter
    + +
    + +
    + +
    +
    CommandRunner class
    +
      +
    1. Constructors
      2. +
    2. CommandRunner
      3. + +
    3. + Properties +
      4. +
    4. argParser
      5. +
    5. commands
      6. +
    6. description
      7. +
    7. executableName
      8. +
    8. invocation
      9. +
    9. usage
      10. +
    10. usageFooter
      11. +
    11. hashCode
      12. +
    12. runtimeType
      13. + +
    13. Methods
      14. +
    14. addCommand
      15. +
    15. parse
      16. +
    16. printUsage
      17. +
    17. run
      18. +
    18. runCommand
      19. +
    19. usageException
      20. +
    20. noSuchMethod
      21. +
    21. toString
      22. + +
    22. Operators
      23. +
    23. operator ==
      24. + + + +
    +
    + +
    +

    usageFooter property

    + + +
    + +
    + String + usageFooter + +
    + +
    +

    An optional footer for usage.

    +

    If a subclass overrides this to return a string, it will automatically be +added to the end of usage.

    +
    + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/UsageException-class.html b/testing/test_package_docs_dev/package-args_command_runner/UsageException-class.html new file mode 100644 index 0000000000..b0a948ad64 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/UsageException-class.html @@ -0,0 +1,213 @@ + + + + + + + + UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    UsageException
    + +
    + +
    + +
    +
    command_runner library
    +
      +
    1. Classes
      2. +
    2. Command
      3. +
    3. CommandRunner
      4. + + + + + + +
    4. Exceptions
      5. +
    5. UsageException
      6. +
    +
    + +
    +

    UsageException class

    + + +
    +
    + +
    Implements
    +
    +
      +
    • Exception
      • +
    +
    + + + +
    +
    + +
    +

    Constructors

    + +
    +
    + UsageException(String message, String usage) +
    +
    + +
    +
    +
    + +
    +

    Properties

    + +
    +
    + message + → String +
    +
    + +
    final
    +
    +
    + usage + → String +
    +
    + +
    final
    +
    +
    + hashCode + → int +
    +
    + +
    read-only, inherited
    +
    +
    + runtimeType + → Type +
    +
    + +
    read-only, inherited
    +
    +
    +
    + +
    +

    Methods

    +
    +
    + toString() + → String + +
    +
    + + +
    +
    + noSuchMethod(Invocation invocation) + → dynamic + +
    +
    + +
    inherited
    +
    +
    +
    + +
    +

    Operators

    +
    +
    + operator ==(dynamic other) + → bool + +
    +
    + +
    inherited
    +
    +
    +
    + + + + +
    + +
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/UsageException/UsageException.html b/testing/test_package_docs_dev/package-args_command_runner/UsageException/UsageException.html new file mode 100644 index 0000000000..44862ff978 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/UsageException/UsageException.html @@ -0,0 +1,99 @@ + + + + + + + + UsageException constructor - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    UsageException
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    UsageException constructor

    + +
    + + UsageException(String message, String usage) +
    + + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/UsageException/hashCode.html b/testing/test_package_docs_dev/package-args_command_runner/UsageException/hashCode.html new file mode 100644 index 0000000000..8cf6a88b41 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/UsageException/hashCode.html @@ -0,0 +1,103 @@ + + + + + + + + hashCode property - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    hashCode
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    hashCode property

    + + +
    + +
    + int + hashCode +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/UsageException/message.html b/testing/test_package_docs_dev/package-args_command_runner/UsageException/message.html new file mode 100644 index 0000000000..312407c75d --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/UsageException/message.html @@ -0,0 +1,98 @@ + + + + + + + + message property - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    message
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    message property

    + +
    + String + message +
    final
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/UsageException/noSuchMethod.html b/testing/test_package_docs_dev/package-args_command_runner/UsageException/noSuchMethod.html new file mode 100644 index 0000000000..f6a8e40565 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/UsageException/noSuchMethod.html @@ -0,0 +1,99 @@ + + + + + + + + noSuchMethod method - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    noSuchMethod
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    noSuchMethod method

    + +
    + dynamic + noSuchMethod +(Invocation invocation) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/UsageException/operator_equals.html b/testing/test_package_docs_dev/package-args_command_runner/UsageException/operator_equals.html new file mode 100644 index 0000000000..af3e56e1c0 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/UsageException/operator_equals.html @@ -0,0 +1,99 @@ + + + + + + + + operator == method - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    operator ==
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    operator == method

    + +
    + bool + operator == +(dynamic other) +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/UsageException/runtimeType.html b/testing/test_package_docs_dev/package-args_command_runner/UsageException/runtimeType.html new file mode 100644 index 0000000000..f8f3c437bf --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/UsageException/runtimeType.html @@ -0,0 +1,103 @@ + + + + + + + + runtimeType property - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    runtimeType
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    runtimeType property

    + + +
    + +
    + Type + runtimeType +
    inherited
    +
    + + +
    + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/UsageException/toString.html b/testing/test_package_docs_dev/package-args_command_runner/UsageException/toString.html new file mode 100644 index 0000000000..9a9c4a6ff8 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/UsageException/toString.html @@ -0,0 +1,104 @@ + + + + + + + + toString method - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    toString
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    toString method

    + +
    +
    +
      +
    1. @override
      2. +
    +
    + String + toString +() +
    + + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/UsageException/usage.html b/testing/test_package_docs_dev/package-args_command_runner/UsageException/usage.html new file mode 100644 index 0000000000..97ecd3b841 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/UsageException/usage.html @@ -0,0 +1,98 @@ + + + + + + + + usage property - UsageException class - command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    usage
    + +
    + +
    + +
    +
    UsageException class
    +
      +
    1. Constructors
      2. +
    2. UsageException
      3. + +
    3. + Properties +
      4. +
    4. message
      5. +
    5. usage
      6. +
    6. hashCode
      7. +
    7. runtimeType
      8. + +
    8. Methods
      9. +
    9. toString
      10. +
    10. noSuchMethod
      11. + +
    11. Operators
      12. +
    12. operator ==
      13. + + + +
    +
    + +
    +

    usage property

    + +
    + String + usage +
    final
    +
    + + +
    + +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/package-args_command_runner/package-args_command_runner-library.html b/testing/test_package_docs_dev/package-args_command_runner/package-args_command_runner-library.html new file mode 100644 index 0000000000..b9ed2bdfd1 --- /dev/null +++ b/testing/test_package_docs_dev/package-args_command_runner/package-args_command_runner-library.html @@ -0,0 +1,146 @@ + + + + + + + + command_runner library - Dart API + + + + + + + + + + + + +
    + +
    + + +
    command_runner
    + +
    + +
    + +
    +
    test_package package
    +
      +
    1. Topics
      2. +
    2. Superb
      3. +
    3. Unreal
      4. +
    4. Libraries
      5. +
    5. anonymous_library
      6. +
    6. another_anonymous_lib
      7. +
    7. code_in_comments
      8. +
    8. is_deprecated
      9. +
    9. Unreal
      10. +
    10. reexport_one
      11. +
    11. reexport_two
      12. +
    12. Real Libraries
      13. +
    13. ex
      14. +
    14. fake
      15. +
    15. two_exports
      16. +
    16. Misc
      17. +
    17. two_exports
      18. +
    18. Other
      19. +
    19. css
      20. +
    20. test_package_imported
      21. +
    21. categoriesExported
      22. +
    22. test_package_imported.main
      23. +
    23. args
      24. +
    24. args
      25. +
    25. command_runner
      26. +
    +
    + +
    +

    command_runner library

    + + +
    +

    Classes

    + +
    +
    + Command<T> +
    +
    + A single command. [...] +
    +
    + CommandRunner<T> +
    +
    + A class for invoking Commands based on raw command-line arguments. [...] +
    +
    +
    + + + + + + +
    +

    Exceptions / Errors

    + +
    +
    + UsageException +
    +
    + +
    +
    +
    + +
    + +
    +
    command_runner library
    +
      +
    1. Classes
      2. +
    2. Command
      3. +
    3. CommandRunner
      4. + + + + + + +
    4. Exceptions
      5. +
    5. UsageException
      6. +
    +
    + +
    + +
    + + test_package 0.0.1 + + +
    + + + + + + + + + + + diff --git a/testing/test_package_docs_dev/reexport_one/reexport_one-library.html b/testing/test_package_docs_dev/reexport_one/reexport_one-library.html index f21f42c9c5..f1b520de8f 100644 --- a/testing/test_package_docs_dev/reexport_one/reexport_one-library.html +++ b/testing/test_package_docs_dev/reexport_one/reexport_one-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/reexport_two/reexport_two-library.html b/testing/test_package_docs_dev/reexport_two/reexport_two-library.html index e09900e665..f24a607483 100644 --- a/testing/test_package_docs_dev/reexport_two/reexport_two-library.html +++ b/testing/test_package_docs_dev/reexport_two/reexport_two-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/test_package_imported.main/test_package_imported.main-library.html b/testing/test_package_docs_dev/test_package_imported.main/test_package_imported.main-library.html index b402f96406..b26f0549d9 100644 --- a/testing/test_package_docs_dev/test_package_imported.main/test_package_imported.main-library.html +++ b/testing/test_package_docs_dev/test_package_imported.main/test_package_imported.main-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/topics/Superb-topic.html b/testing/test_package_docs_dev/topics/Superb-topic.html index c7288229da..4ced9efa79 100644 --- a/testing/test_package_docs_dev/topics/Superb-topic.html +++ b/testing/test_package_docs_dev/topics/Superb-topic.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/topics/Unreal-topic.html b/testing/test_package_docs_dev/topics/Unreal-topic.html index fc33f2f3d3..c63288fe7d 100644 --- a/testing/test_package_docs_dev/topics/Unreal-topic.html +++ b/testing/test_package_docs_dev/topics/Unreal-topic.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner
    • diff --git a/testing/test_package_docs_dev/two_exports/two_exports-library.html b/testing/test_package_docs_dev/two_exports/two_exports-library.html index 42083e07bb..7a6a4a4351 100644 --- a/testing/test_package_docs_dev/two_exports/two_exports-library.html +++ b/testing/test_package_docs_dev/two_exports/two_exports-library.html @@ -59,6 +59,9 @@
    test_package pa
  • test_package_imported
  • categoriesExported
  • test_package_imported.main
    • +
  • args
    • +
  • args
    • +
  • command_runner