blob: 06b9893111820bbe2858f6c7edec1101a01efb26 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="args library API docs, for the Dart programming language.">
<title>args library - Dart API</title>
<!-- required because all the links are pseudo-absolute -->
<base href="..">
<link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500,400i,400,300|Source+Sans+Pro:400,300,700" rel="stylesheet">
<link rel="stylesheet" href="static-assets/github.css">
<link rel="stylesheet" href="static-assets/styles.css">
<link rel="icon" href="static-assets/favicon.png">
</head>
<body>
<div id="overlay-under-drawer"></div>
<header id="title">
<button id="sidenav-left-toggle" type="button">&nbsp;</button>
<ol class="breadcrumbs gt-separated dark hidden-xs">
<li><a href="index.html">test_package</a></li>
<li class="self-crumb">args library</li>
</ol>
<div class="self-name">args</div>
<form class="search navbar-right" role="search">
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
</header>
<main>
<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5><span class="package-name">test_package</span> <span class="package-kind">package</span></h5>
<ol>
<li class="section-title">Topics</li>
<li><a href="topics/Superb-topic.html">Superb</a></li>
<li><a href="topics/Unreal-topic.html">Unreal</a></li>
<li class="section-title">Libraries</li>
<li><a href="anonymous_library/anonymous_library-library.html">anonymous_library</a></li>
<li><a href="another_anonymous_lib/another_anonymous_lib-library.html">another_anonymous_lib</a></li>
<li><a href="code_in_comments/code_in_comments-library.html">code_in_comments</a></li>
<li><a class="deprecated" href="is_deprecated/is_deprecated-library.html">is_deprecated</a></li>
<li class="section-subtitle">Unreal</li>
<li class="section-subitem"><a href="reexport_one/reexport_one-library.html">reexport_one</a></li>
<li class="section-subitem"><a href="reexport_two/reexport_two-library.html">reexport_two</a></li>
<li class="section-subtitle">Real Libraries</li>
<li class="section-subitem"><a href="ex/ex-library.html">ex</a></li>
<li class="section-subitem"><a href="fake/fake-library.html">fake</a></li>
<li class="section-subitem"><a href="two_exports/two_exports-library.html">two_exports</a></li>
<li class="section-subtitle">Misc</li>
<li class="section-subitem"><a href="two_exports/two_exports-library.html">two_exports</a></li>
<li class="section-subtitle">Other</li>
<li class="section-subitem"><a href="css/css-library.html">css</a></li>
<li class="section-title">test_package_imported</li>
<li><a href="categoriesExported/categoriesExported-library.html">categoriesExported</a></li>
<li><a href="test_package_imported.main/test_package_imported.main-library.html">test_package_imported.main</a></li>
<li class="section-title">args</li>
<li><a href="package-args_args/package-args_args-library.html">args</a></li>
<li><a href="package-args_command_runner/package-args_command_runner-library.html">command_runner</a></li>
</ol>
</div>
<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>args library </h1>
<section class="summary offset-anchor" id="classes">
<h2>Classes</h2>
<dl>
<dt id="ArgParser">
<span class="name "><a href="package-args_args/ArgParser-class.html">ArgParser</a></span>
</dt>
<dd>
A class for taking a list of raw command line arguments and parsing out
options and flags from them.
</dd>
<dt id="ArgResults">
<span class="name "><a href="package-args_args/ArgResults-class.html">ArgResults</a></span>
</dt>
<dd>
The results of parsing a series of command line arguments using
<a href="package-args_args/ArgParser/parse.html">ArgParser.parse()</a>. <a href="package-args_args/ArgResults-class.html">[...]</a>
</dd>
<dt id="Option">
<span class="name "><a href="package-args_args/Option-class.html">Option</a></span>
</dt>
<dd>
A command-line option. <a href="package-args_args/Option-class.html">[...]</a>
</dd>
<dt id="OptionType">
<span class="name "><a href="package-args_args/OptionType-class.html">OptionType</a></span>
</dt>
<dd>
What kinds of values an option accepts.
</dd>
</dl>
</section>
<section class="summary offset-anchor" id="exceptions">
<h2>Exceptions / Errors</h2>
<dl>
<dt id="ArgParserException">
<span class="name "><a href="package-args_args/ArgParserException-class.html">ArgParserException</a></span>
</dt>
<dd>
An exception thrown by <code>ArgParser</code>.
</dd>
</dl>
</section>
</div> <!-- /.main-content -->
<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>args library</h5>
<ol>
<li class="section-title"><a href="package-args_args/package-args_args-library.html#classes">Classes</a></li>
<li><a href="package-args_args/ArgParser-class.html">ArgParser</a></li>
<li><a href="package-args_args/ArgResults-class.html">ArgResults</a></li>
<li><a href="package-args_args/Option-class.html">Option</a></li>
<li><a href="package-args_args/OptionType-class.html">OptionType</a></li>
<li class="section-title"><a href="package-args_args/package-args_args-library.html#exceptions">Exceptions</a></li>
<li><a href="package-args_args/ArgParserException-class.html">ArgParserException</a></li>
</ol>
</div><!--/sidebar-offcanvas-right-->
</main>
<footer>
<span class="no-break">
test_package 0.0.1
</span>
</footer>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<script src="static-assets/typeahead.bundle.min.js"></script>
<script src="static-assets/highlight.pack.js"></script>
<script src="static-assets/URI.js"></script>
<script src="static-assets/script.js"></script>
</body>
</html>