blob: 6c6ae949ddc62ea3935ac866909c7eafbfbef455 [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="API docs for the usageLineLength property from the ArgParser class, for the Dart programming language.">
<title>usageLineLength property - ArgParser class - 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><a href="package-args_args/package-args_args-library.html">args</a></li>
<li><a href="package-args_args/ArgParser-class.html">ArgParser</a></li>
<li class="self-crumb">usageLineLength property</li>
</ol>
<div class="self-name">usageLineLength</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>ArgParser class</h5>
<ol>
<li class="section-title"><a href="package-args_args/ArgParser-class.html#constructors">Constructors</a></li>
<li><a href="package-args_args/ArgParser/ArgParser.html">ArgParser</a></li>
<li><a href="package-args_args/ArgParser/ArgParser.allowAnything.html">allowAnything</a></li>
<li class="section-title">
<a href="package-args_args/ArgParser-class.html#instance-properties">Properties</a>
</li>
<li><a href="package-args_args/ArgParser/allowsAnything.html">allowsAnything</a></li>
<li><a href="package-args_args/ArgParser/allowTrailingOptions.html">allowTrailingOptions</a></li>
<li><a href="package-args_args/ArgParser/commands.html">commands</a></li>
<li><a href="package-args_args/ArgParser/options.html">options</a></li>
<li><a href="package-args_args/ArgParser/usage.html">usage</a></li>
<li><a href="package-args_args/ArgParser/usageLineLength.html">usageLineLength</a></li>
<li class="inherited"><a href="package-args_args/ArgParser/hashCode.html">hashCode</a></li>
<li class="inherited"><a href="package-args_args/ArgParser/runtimeType.html">runtimeType</a></li>
<li class="section-title"><a href="package-args_args/ArgParser-class.html#instance-methods">Methods</a></li>
<li><a href="package-args_args/ArgParser/addCommand.html">addCommand</a></li>
<li><a href="package-args_args/ArgParser/addFlag.html">addFlag</a></li>
<li><a href="package-args_args/ArgParser/addMultiOption.html">addMultiOption</a></li>
<li><a href="package-args_args/ArgParser/addOption.html">addOption</a></li>
<li><a href="package-args_args/ArgParser/addSeparator.html">addSeparator</a></li>
<li><a href="package-args_args/ArgParser/findByAbbreviation.html">findByAbbreviation</a></li>
<li><a href="package-args_args/ArgParser/getDefault.html">getDefault</a></li>
<li><a class="deprecated" href="package-args_args/ArgParser/getUsage.html">getUsage</a></li>
<li><a href="package-args_args/ArgParser/parse.html">parse</a></li>
<li class="inherited"><a href="package-args_args/ArgParser/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="package-args_args/ArgParser/toString.html">toString</a></li>
<li class="section-title inherited"><a href="package-args_args/ArgParser-class.html#operators">Operators</a></li>
<li class="inherited"><a href="package-args_args/ArgParser/operator_equals.html">operator ==</a></li>
</ol>
</div><!--/.sidebar-offcanvas-->
<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>usageLineLength property</h1>
<section class="multi-line-signature">
<span class="returntype">int</span>
<span class="name ">usageLineLength</span>
<div class="features">final</div>
</section>
<section class="desc markdown">
<p>An optional maximum line length for <a href="package-args_args/ArgParser/usage.html">usage</a> messages.</p>
<p>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).</p>
<p>If null (the default), help messages are not wrapped.</p>
</section>
</div> <!-- /.main-content -->
<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
</div><!--/.sidebar-offcanvas-->
</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>