documon
Version:
A documentation system for mortals. Use with any language.
147 lines (91 loc) • 4.1 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>parseFlags</title>
<meta name="description" content="Fills the output object with the following properties (if they exist)">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "documon.parseFlags",
name: "parseFlags"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<div class="main-method">
<a name="methods"></a>
<div class="part-methods">
<a name="documon.parseFlags"></a><a name="parseFlags"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
parseFlags ()
</span>
<span class="member-name-right">
<span class="member-file">documon/src/parseFlag.js</span>
<span class="member-line-number">192</span>
</span>
</div>
<div class="member-description">
<div class="meta-block meta-block-klass">
<div class="meta-line"><span class="meta-label" >xpath</span> <span class="meta-target">documon.parseFlags<span></div>
<div class="meta-line"><span class="meta-label" >file</span> <span class="meta-target">documon/src/parseFlag.js<span></div>
</div>
<p>Fills the output object with the following properties (if they exist)</p>
<pre><code> object {
source // Entire first line inlcuding the @flag (only first line)
after // Everything after the @flag
name // One word following {type}. Or first word after the @flag definition when no {type}.
children // name.kid - Array of children
parent // if am a child, this is my parent.
flag // @flag token with @ stripped
defaultVal // name=val
afterType // first line after
text //
}</code></pre>
<p>Here's an expanded and exmple'd definition list</p>
<dl>
<dt>source</dt>
<dd><p>The entire comment block</p></dd>
<dt>after</dt>
<dd><p>Everything after the <a href="https://github.com/flag">@flag</a> token "as is" (kinda like source)</p></dd>
</dl>
<ul>
<li><p><strong>source</strong> : The entire comment block</p></li>
<li><p><strong>after</strong> : Everything after the <a href="https://github.com/flag">@flag</a> token "as is" (kinda like source)</p>
<p>e.g. in this line:</p></li>
</ul>
</div>
</div>
</div>
</div>
<div class="parts">
</div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>