gulp-yuidoc
Version:
A yuidoc plugin for Gulp
2,289 lines (900 loc) • 50 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>DocParser</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title=""></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: </em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/CLI.html">CLI</a></li>
<li><a href="../classes/DocBuilder.html">DocBuilder</a></li>
<li><a href="../classes/DocParser.html">DocParser</a></li>
<li><a href="../classes/DocView.html">DocView</a></li>
<li><a href="../classes/Files.html">Files</a></li>
<li><a href="../classes/Help.html">Help</a></li>
<li><a href="../classes/Main.html">Main</a></li>
<li><a href="../classes/Options.html">Options</a></li>
<li><a href="../classes/Server.html">Server</a></li>
<li><a href="../classes/Utils.html">Utils</a></li>
<li><a href="../classes/YUIDoc.html">YUIDoc</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/yuidoc.html">yuidoc</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>DocParser Class</h1>
<div class="box meta">
<div class="extends">
Extends Base
</div>
<div class="foundat">
Defined in: <a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l727"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:727</code></a>
</div>
Module: <a href="../modules/yuidoc.html">yuidoc</a>
</div>
<div class="box intro">
<p>The doc parser accepts a <strong>map</strong> of files to file content.
Once <code>parse()</code> is called, various properties will be populated
with the parsers data (aggregated in the <code>'data'</code> property).</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_DocParser" class="method item">
<h3 class="name"><code>DocParser</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l727"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:727</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type">Object</span>
<div class="param-description">
<p>the config object</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
<li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods extends">
<li class="index-item method private">
<a href="#method__resolveFor">_resolveFor</a>
</li>
<li class="index-item method">
<a href="#method_extract">extract</a>
</li>
<li class="index-item method">
<a href="#method_handlecomment">handlecomment</a>
</li>
<li class="index-item method private">
<a href="#method_implodeString">implodeString</a>
</li>
<li class="index-item method private">
<a href="#method_implodeString">implodeString</a>
</li>
<li class="index-item method">
<a href="#method_parse">parse</a>
</li>
<li class="index-item method">
<a href="#method_processblock">processblock</a>
</li>
<li class="index-item method private">
<a href="#method_stringlog">stringlog</a>
</li>
<li class="index-item method">
<a href="#method_transform">transform</a>
</li>
<li class="index-item method private">
<a href="#method_unindent">unindent</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property">
<a href="#property_CORRECTIONS">CORRECTIONS</a>
</li>
<li class="index-item property">
<a href="#property_DIGESTERS">DIGESTERS</a>
</li>
<li class="index-item property">
<a href="#property_TAGLIST">TAGLIST</a>
</li>
</ul>
</div>
<div class="index-section attrs">
<h3>Attributes</h3>
<ul class="index-list attrs extends">
<li class="index-item attr">
<a href="#attr_currentclass">currentclass</a>
</li>
<li class="index-item attr">
<a href="#attr_currentfile">currentfile</a>
</li>
<li class="index-item attr">
<a href="#attr_currentmodule">currentmodule</a>
</li>
<li class="index-item attr">
<a href="#attr_currentsubmodule">currentsubmodule</a>
</li>
<li class="index-item attr">
<a href="#attr_digesters">digesters</a>
</li>
<li class="index-item attr">
<a href="#attr_dirmap">dirmap</a>
</li>
<li class="index-item attr">
<a href="#attr_emitters">emitters</a>
</li>
<li class="index-item attr">
<a href="#attr_filemap">filemap</a>
</li>
<li class="index-item attr">
<a href="#attr_mainmodule">mainmodule</a>
</li>
<li class="index-item attr">
<a href="#attr_syntaxtype">syntaxtype</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method__resolveFor" class="method item private">
<h3 class="name"><code>_resolveFor</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l1011"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:1011</code></a>
</p>
</div>
<div class="description">
<p>Takes a non-namespaced classname and resolves it to a namespace (to support <code>@for</code>)</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">value</code>
<span class="type">String</span>
<div class="param-description">
<p>The classname to resolve</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>The resolved namespace + classname</p>
</div>
</div>
</div>
<div id="method_extract" class="method item">
<h3 class="name"><code>extract</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>filemap</code>
</li>
<li class="arg">
<code>dirmap</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l1182"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:1182</code></a>
</p>
</div>
<div class="description">
<p>Accepts a map of filenames to file content. Returns
a map of filenames to an array of API comment block
text. This expects the comment to start with / <em>*
on its own line, and end with </em> / on its own
line. Override this function to provide an
alternative comment parser.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">filemap</code>
<span class="type">Object</span>
<div class="param-description">
<p>A map of filenames to file content</p>
</div>
</li>
<li class="param">
<code class="param-name">dirmap</code>
<span class="type">Array</span>
<div class="param-description">
<p>A map of file names to directory name</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
<p>A map of filenames to an array of extracted
comment text.</p>
</div>
</div>
</div>
<div id="method_handlecomment" class="method item">
<h3 class="name"><code>handlecomment</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>comment</code>
</li>
<li class="arg">
<code>file</code>
</li>
<li class="arg">
<code>line</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l1106"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:1106</code></a>
</p>
</div>
<div class="description">
<p>Transforms a JavaDoc style comment block (less the start and end of it)
into a list of tag/text pairs. The leading space and '*' are removed,
but the remaining whitespace is preserved so that the output should be
friendly for both markdown and html parsers.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">comment</code>
<span class="type">String</span>
<div class="param-description">
<p>The comment to parse</p>
</div>
</li>
<li class="param">
<code class="param-name">file</code>
<span class="type">String</span>
<div class="param-description">
<p>The file it was parsed from</p>
</div>
</li>
<li class="param">
<code class="param-name">line</code>
<span class="type">String</span>
<div class="param-description">
<p>The line number it was found on</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_implodeString" class="method item private">
<h3 class="name"><code>implodeString</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>str</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l38"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:38</code></a>
</p>
</div>
<div class="description">
<p>Flatten a string, remove all line breaks and replace them with a token</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">str</code>
<span class="type">String</span>
<div class="param-description">
<p>The string to operate on</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>The modified string</p>
</div>
</div>
</div>
<div id="method_implodeString" class="method item private">
<h3 class="name"><code>implodeString</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>str</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l48"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:48</code></a>
</p>
</div>
<div class="description">
<p>Un-flatten a string, replace tokens injected with <code>implodeString</code></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">str</code>
<span class="type">String</span>
<div class="param-description">
<p>The string to operate on</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>The modified string</p>
</div>
</div>
</div>
<div id="method_parse" class="method item">
<h3 class="name"><code>parse</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>filemap</code>
</li>
<li class="arg">
<code>dirmap</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DocParser.html" class="crosslink">DocParser</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l1424"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:1424</code></a>
</p>
</div>
<div class="description">
<p>Extracts and transforms the filemap provided to constructor</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">filemap</code>
<span class="type">Array</span>
<div class="param-description">
<p>A map of filenames to file content</p>
</div>
</li>
<li class="param">
<code class="param-name">dirmap</code>
<span class="type">Array</span>
<div class="param-description">
<p>A map of file names to directory name</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DocParser.html" class="crosslink">DocParser</a></span>:
<p>this parser instance. The total results
are available in parser.data.</p>
</div>
</div>
</div>
<div id="method_processblock" class="method item">
<h3 class="name"><code>processblock</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>an</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l1237"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:1237</code></a>
</p>
</div>
<div class="description">
<p>Processes all the tags in a single comment block</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">an</code>
<span class="type">Array</span>
<div class="param-description">
<p>array of the tag/text pairs</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_stringlog" class="method item private">
<h3 class="name"><code>stringlog</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>data</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l11"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:11</code></a>
</p>
</div>
<div class="description">
<p>Parses the JSON data and formats it into a nice log string for
filename and line number: <code>/file/name.js:123</code></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The data block from the parser</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>The formatted string.</p>
</div>
</div>
</div>
<div id="method_transform" class="method item">
<h3 class="name"><code>transform</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>commentmap</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l1310"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:1310</code></a>
</p>
</div>
<div class="description">
<p>Transforms a map of filenames to arrays of comment blocks into a
JSON structure that represents the entire processed API doc info
and relationships between elements for the entire project.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">commentmap</code>
<span class="type">Object</span>
<div class="param-description">
<p>The hash of files and parsed comment blocks</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
<p>The transformed data for the project</p>
</div>
</div>
</div>
<div id="method_unindent" class="method item private">
<h3 class="name"><code>unindent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>content</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l1085"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:1085</code></a>
</p>
</div>
<div class="description">
<p>Normalizes the initial indentation of the given <em>content</em> so that the first line
is unindented, and all other lines are unindented to the same degree as the
first line. So if the first line has four spaces at the beginning, then all
lines will be unindented four spaces. Ported from <a href="https://github.com/rgrove/selleck">Selleck</a></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">content</code>
<span class="type">String</span>
<div class="param-description">
<p>Text to unindent.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>Unindented text.</p>
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_CORRECTIONS" class="property item">
<h3 class="name"><code>CORRECTIONS</code></h3>
<span class="type">Object</span>
<span class="flag final">final</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l174"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:174</code></a>
</p>
</div>
<div class="description">
<p>Common errors will get scrubbed instead of being ignored.</p>
</div>
</div>
<div id="property_DIGESTERS" class="property item">
<h3 class="name"><code>DIGESTERS</code></h3>
<span class="type">Object</span>
<span class="flag final">final</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l197"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:197</code></a>
</p>
</div>
<div class="description">
<p>A map of the default tag processors, keyed by the
tag name. Multiple tags can use the same digester
by supplying the string name that points to the
implementation rather than a function.</p>
</div>
</div>
<div id="property_TAGLIST" class="property item">
<h3 class="name"><code>TAGLIST</code></h3>
<span class="type">Array</span>
<span class="flag final">final</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l94"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:94</code></a>
</p>
</div>
<div class="description">
<p>A list of known tags. This populates a member variable
during initialization, and will be updated if additional
digesters are added.</p>
</div>
</div>
</div>
<div id="attrs" class="api-class-tabpanel">
<h2 class="off-left">Attributes</h2>
<div id="attr_currentclass" class="attr item">
<a name="config_currentclass"></a>
<h3 class="name"><code>currentclass</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l971"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:971</code></a>
</p>
</div>
<div class="description">
<p>The class currently being parsed</p>
</div>
</div>
<div id="attr_currentfile" class="attr item">
<a name="config_currentfile"></a>
<h3 class="name"><code>currentfile</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l815"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:815</code></a>
</p>
</div>
<div class="description">
<p>The file currently being parsed</p>
</div>
</div>
<div id="attr_currentmodule" class="attr item">
<a name="config_currentmodule"></a>
<h3 class="name"><code>currentmodule</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l872"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:872</code></a>
</p>
</div>
<div class="description">
<p>The module currently being parsed</p>
</div>
</div>
<div id="attr_currentsubmodule" class="attr item">
<a name="config_currentsubmodule"></a>
<h3 class="name"><code>currentsubmodule</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l931"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:931</code></a>
</p>
</div>
<div class="description">
<p>The submodule currently being parsed</p>
</div>
</div>
<div id="attr_digesters" class="attr item">
<a name="config_digesters"></a>
<h3 class="name"><code>digesters</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l755"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:755</code></a>
</p>
</div>
<div class="description">
<p>Digesters process the tag/text pairs found in a
comment block. They are looked up by tag name.
The digester gets the tagname, the value, the
target object to apply values to, and the full
block that is being processed. Digesters can
be declared as strings instead of a function --
in that case, the program will try to look up
the key listed and use the function there instead
(it is an alias). Digesters can return a host
object in the case the tag defines a new key
block type (modules/classes/methods/events/properties)</p>
</div>
</div>
<div id="attr_dirmap" class="attr item">
<a name="config_dirmap"></a>
<h3 class="name"><code>dirmap</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l805"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:805</code></a>
</p>
</div>
<div class="description">
<p>A map of file names to directory name. Provided in
case this needs to be used to reset the module name
appropriately -- currently not used</p>
</div>
</div>
<div id="attr_emitters" class="attr item">
<a name="config_emitters"></a>
<h3 class="name"><code>emitters</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l777"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:777</code></a>
</p>
</div>
<div class="description">
<p>Emitters will be schemas for the types of payloads
the parser will emit. Not implemented.</p>
</div>
</div>
<div id="attr_filemap" class="attr item">
<a name="config_filemap"></a>
<h3 class="name"><code>filemap</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l797"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:797</code></a>
</p>
</div>
<div class="description">
<p>The map of file names to file content.</p>
</div>
</div>
<div id="attr_mainmodule" class="attr item">
<a name="config_mainmodule"></a>
<h3 class="name"><code>mainmodule</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l836"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:836</code></a>
</p>
</div>
<div class="description">
<p>The main documentation block for the module itself.</p>
</div>
</div>
<div id="attr_syntaxtype" class="attr item">
<a name="config_syntaxtype"></a>
<h3 class="name"><code>syntaxtype</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_docparser.js.html#l788"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/docparser.js:788</code></a>
</p>
</div>
<div class="description">
<p>Comment syntax type.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>