documon
Version:
A documentation system for mortals. Use with any language.
465 lines (259 loc) • 12.5 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>tag</title>
<meta name="description" content="Processes the following flags">
<!-- 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.tag",
name: "tag"
}
</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.tag"></a><a name="tag"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
tag ()
</span>
<span class="member-name-right">
<span class="member-file">documon/src/tag.js</span>
<span class="member-line-number">69</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.tag<span></div>
<div class="meta-line"><span class="meta-label" >file</span> <span class="meta-target">documon/src/tag.js<span></div>
</div>
<p>Processes the following flags</p>
<ul>
<li>property</li>
</ul>
<h2 id="--package-namespace">- package, namespace</h2>
<ul>
<li>property</li>
<li>method</li>
<li>event</li>
<li>class</li>
</ul>
<h2 id="--module">- module</h2>
<ul>
<li>private</li>
<li>protected</li>
<li>static</li>
<li>public</li>
</ul>
<h2 id="--readonly">- readonly</h2>
<ul>
<li>overrides</li>
<li>impliments</li>
<li>extends</li>
</ul>
<h2 id="--inherits">- inherits</h2>
<ul>
<li>constructor</li>
<li>example</li>
<li>param</li>
</ul>
<h2 id="--return-returns">- return, returns</h2>
<ul>
<li>type</li>
<li>order</li>
<li>optional</li>
<li>header</li>
<li>defaultVal, default</li>
<li>see</li>
<li>requires</li>
</ul>
<p>Fills the flags object</p>
<p>"Source Item", are manufactured from the <a href="parseFlag">parseFlag</a> class, and generally provided to many of the methods as the "item" argument, and they contain the following fields:</p>
<pre><code> Source Item {
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>
</div>
</div>
</div>
</div>
<div class="parts">
<a name="methods"></a>
<div class="part-methods">
<div class="heading-part">Methods</div>
<a name="documon.tag.fillFlag"></a><a name="fillFlag"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
fillFlag (<span class="method-arguments">item</span>, <span class="method-arguments">obj</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/src/tag.js</span>
<span class="member-line-number">438</span>
</span>
</div>
<div class="member-description">
<p>[fillFlag description]</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">item</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">type</span>
<div class="member-description">
<p>description</p>
</div>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">obj</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">type</span>
<div class="member-description">
<p>description</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="heading-returns">Returns
<span class="type">type</span>
</div>
<div class="member"><p>description description</p></div>
</div>
</div>
<a name="documon.tag.processItems"></a><a name="processItems"></a>
<div class="member" data-access="private" >
<div class="member-name clearfix">
<span class="member-name-left">
processItems (<span class="method-arguments">Vlist</span>)
<span class="flag private">private</span> <!-- public private protected -->
</span>
<span class="member-name-right">
<span class="member-file">documon/src/tag.js</span>
<span class="member-line-number">341</span>
</span>
</div>
<div class="member-description">
<p>Process flags for an entire list of items</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">Vlist</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">array</span>
<div class="member-description">
<p>Vlist</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<a name="documon.tag.processOne"></a><a name="processOne"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
processOne (<span class="method-arguments">item</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/src/tag.js</span>
<span class="member-line-number">281</span>
</span>
</div>
<div class="member-description">
<p>processOne</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">item</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">Source Object</span>
<div class="member-description">
<p>the source item as parsed from comments</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="heading-returns">Returns
<span class="type">object</span>
</div>
<div class="member"><p>An object containing flag data</p></div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>