Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

4036 lines (1597 sloc) 93.37 kB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>DocBuilder - YUIDoc</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="..&#x2F;assets/favicon.png">
<script src="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;combo?3.8.0&#x2F;build&#x2F;yui&#x2F;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="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.36</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="..&#x2F;classes/CLI.html">CLI</a></li>
<li><a href="..&#x2F;classes/DocBuilder.html">DocBuilder</a></li>
<li><a href="..&#x2F;classes/DocParser.html">DocParser</a></li>
<li><a href="..&#x2F;classes/DocView.html">DocView</a></li>
<li><a href="..&#x2F;classes/Files.html">Files</a></li>
<li><a href="..&#x2F;classes/Help.html">Help</a></li>
<li><a href="..&#x2F;classes/Main.html">Main</a></li>
<li><a href="..&#x2F;classes/Options.html">Options</a></li>
<li><a href="..&#x2F;classes/Server.html">Server</a></li>
<li><a href="..&#x2F;classes/Utils.html">Utils</a></li>
<li><a href="..&#x2F;classes/YUIDoc.html">YUIDoc</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="..&#x2F;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>DocBuilder Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="..&#x2F;files&#x2F;lib_builder.js.html#l13"><code>lib&#x2F;builder.js:13</code></a>
</div>
Module: <a href="../modules/yuidoc.html">yuidoc</a>
</div>
<div class="box intro">
<p>Takes the <code>JSON</code> data from the <code>DocParser</code> class, creates and parses markdown and handlebars
based templates to generate static HTML content</p>
</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>
</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">
<li class="index-item method">
<a href="#method__addHelpers">_addHelpers</a>
</li>
<li class="index-item method private">
<a href="#method__inlineCode">_inlineCode</a>
</li>
<li class="index-item method private">
<a href="#method__mixExternal">_mixExternal</a>
</li>
<li class="index-item method private">
<a href="#method__parseCode">_parseCode</a>
</li>
<li class="index-item method private">
<a href="#method__parseCrossLink">_parseCrossLink</a>
</li>
<li class="index-item method">
<a href="#method_addFoundAt">addFoundAt</a>
</li>
<li class="index-item method">
<a href="#method_augmentData">augmentData</a>
</li>
<li class="index-item method">
<a href="#method_compile">compile</a>
</li>
<li class="index-item method">
<a href="#method_filterFileName">filterFileName</a>
</li>
<li class="index-item method">
<a href="#method_getProjectMeta">getProjectMeta</a>
</li>
<li class="index-item method">
<a href="#method_hasProperty">hasProperty</a>
</li>
<li class="index-item method">
<a href="#method_makeDirs">makeDirs</a>
</li>
<li class="index-item method private">
<a href="#method_markdown">markdown</a>
</li>
<li class="index-item method">
<a href="#method_mergeExtends">mergeExtends</a>
</li>
<li class="index-item method">
<a href="#method_mixExternal">mixExternal</a>
</li>
<li class="index-item method">
<a href="#method_nameSort">nameSort</a>
</li>
<li class="index-item method private">
<a href="#method_NATIVES_LINKER">NATIVES_LINKER</a>
</li>
<li class="index-item method">
<a href="#method_populateClasses">populateClasses</a>
</li>
<li class="index-item method">
<a href="#method_populateFiles">populateFiles</a>
</li>
<li class="index-item method">
<a href="#method_populateModules">populateModules</a>
</li>
<li class="index-item method">
<a href="#method_render">render</a>
</li>
<li class="index-item method">
<a href="#method_renderAPIMeta">renderAPIMeta</a>
</li>
<li class="index-item method">
<a href="#method_renderClass">renderClass</a>
</li>
<li class="index-item method">
<a href="#method_renderFile">renderFile</a>
</li>
<li class="index-item method">
<a href="#method_renderIndex">renderIndex</a>
</li>
<li class="index-item method">
<a href="#method_renderModule">renderModule</a>
</li>
<li class="index-item method">
<a href="#method_writeAPIMeta">writeAPIMeta</a>
</li>
<li class="index-item method">
<a href="#method_writeClasses">writeClasses</a>
</li>
<li class="index-item method">
<a href="#method_writeFiles">writeFiles</a>
</li>
<li class="index-item method">
<a href="#method_writeIndex">writeIndex</a>
</li>
<li class="index-item method">
<a href="#method_writeModules">writeModules</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property private">
<a href="#property__mergeCounter">_mergeCounter</a>
</li>
<li class="index-item property private">
<a href="#property__meta">_meta</a>
</li>
<li class="index-item property">
<a href="#property_defaultReturnTags">defaultReturnTags</a>
</li>
<li class="index-item property">
<a href="#property_defaultTags">defaultTags</a>
</li>
<li class="index-item property">
<a href="#property_files">files</a>
</li>
<li class="index-item property">
<a href="#property_NATIVES">NATIVES</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method__addHelpers" class="method item">
<h3 class="name"><code>_addHelpers</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>helpers</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l115"><code>lib&#x2F;builder.js:115</code></a>
</p>
</div>
<div class="description">
<p>Register a <code>Y.Handlebars</code> helper method</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">helpers</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>Object containing a hash of names and functions</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__inlineCode" class="method item private">
<h3 class="name"><code>_inlineCode</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>html</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTML</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l750"><code>lib&#x2F;builder.js:750</code></a>
</p>
</div>
<div class="description">
<p>Ported from <a href="https://github.com/rgrove/selleck">Selleck</a>, this handles <code>&#x60;</code>'s in fields
that are not parsed by the <strong>Markdown</strong> parser.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">html</code>
<span class="type">HTML</span>
<div class="param-description">
<p>The HTML to parse</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTML</span>:
The parsed HTML
</div>
</div>
</div>
<div id="method__mixExternal" class="method item private">
<h3 class="name"><code>_mixExternal</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l311"><code>lib&#x2F;builder.js:311</code></a>
</p>
</div>
<div class="description">
<p>Mixes the various external data soures together into the local data, augmenting
it with flags.</p>
</div>
</div>
<div id="method__parseCode" class="method item private">
<h3 class="name"><code>_parseCode</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>html</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTML</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l737"><code>lib&#x2F;builder.js:737</code></a>
</p>
</div>
<div class="description">
<p>Parses <code>&lt;pre&gt;&lt;code&gt;</code> tags and adds the <strong>prettyprint</strong> <code>className</code> to them</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">html</code>
<span class="type">HTML</span>
<div class="param-description">
<p>The HTML to parse</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTML</span>:
The parsed HTML
</div>
</div>
</div>
<div id="method__parseCrossLink" class="method item private">
<h3 class="name"><code>_parseCrossLink</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>item</code>
</li>
<li class="arg">
<code class="optional">[raw=false]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l158"><code>lib&#x2F;builder.js:158</code></a>
</p>
</div>
<div class="description">
<p>Parse the item to be cross linked and return an HREF linked to the item</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">item</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The item to crossLink</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[raw=false]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Do not wrap it in HTML</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_addFoundAt" class="method item">
<h3 class="name"><code>addFoundAt</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>a</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l602"><code>lib&#x2F;builder.js:602</code></a>
</p>
</div>
<div class="description">
<p>Parses file and line number from an item object and build's an HREF</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">a</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The item to parse</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
The parsed HREF
</div>
</div>
</div>
<div id="method_augmentData" class="method item">
<h3 class="name"><code>augmentData</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>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l618"><code>lib&#x2F;builder.js:618</code></a>
</p>
</div>
<div class="description">
<p>Augments the <strong>DocParser</strong> meta data to provide default values for certain keys as well as parses all descriptions
with the <code>Markdown Parser</code></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The object to recurse and augment</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
The augmented object
</div>
</div>
</div>
<div id="method_compile" class="method item">
<h3 class="name"><code>compile</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1546"><code>lib&#x2F;builder.js:1546</code></a>
</p>
</div>
<div class="description">
<p>Compiles the templates from the meta-data provided by DocParser</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute after it's completed</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_filterFileName" class="method item">
<h3 class="name"><code>filterFileName</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>f</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1533"><code>lib&#x2F;builder.js:1533</code></a>
</p>
</div>
<div class="description">
<p>Normalizes a file path to a writable filename:</p>
<p>var path = 'lib/file.js';
returns 'lib_file.js';</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">f</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The filename to normalize</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
The filtered file path
</div>
</div>
</div>
<div id="method_getProjectMeta" class="method item">
<h3 class="name"><code>getProjectMeta</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l451"><code>lib&#x2F;builder.js:451</code></a>
</p>
</div>
<div class="description">
<p>Prep the meta data to be fed to Selleck</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
The project metadata
</div>
</div>
</div>
<div id="method_hasProperty" class="method item">
<h3 class="name"><code>hasProperty</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>a</code>
</li>
<li class="arg">
<code>b</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l985"><code>lib&#x2F;builder.js:985</code></a>
</p>
</div>
<div class="description">
<p>Checks an array of items (class items) to see if an item is in that list</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">a</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>
<div class="param-description">
<p>The Array of items to check</p>
</div>
</li>
<li class="param">
<code class="param-name">b</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The object to find</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
Boolean
</div>
</div>
</div>
<div id="method_makeDirs" class="method item">
<h3 class="name"><code>makeDirs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l684"><code>lib&#x2F;builder.js:684</code></a>
</p>
</div>
<div class="description">
<p>Makes the default directories needed</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute after it's completed</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_markdown" class="method item private">
<h3 class="name"><code>markdown</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>md</code>
</li>
<li class="arg">
<code>def</code>
</li>
<li class="arg">
<code>tags</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTML</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l132"><code>lib&#x2F;builder.js:132</code></a>
</p>
</div>
<div class="description">
<p>Wrapper around the Markdown parser so it can be normalized or even side stepped</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">md</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The Markdown string to parse</p>
</div>
</li>
<li class="param">
<code class="param-name">def</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>Only allow default set of HTML tags</p>
</div>
</li>
<li class="param">
<code class="param-name">tags</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>
<div class="param-description">
<p>An array of tags to allow</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTML</span>:
The rendered HTML
</div>
</div>
</div>
<div id="method_mergeExtends" class="method item">
<h3 class="name"><code>mergeExtends</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>info</code>
</li>
<li class="arg">
<code>classItems</code>
</li>
<li class="arg">
<code>first</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1009"><code>lib&#x2F;builder.js:1009</code></a>
</p>
</div>
<div class="description">
<p>Merge superclass data into a child class</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">info</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The item to extend</p>
</div>
</li>
<li class="param">
<code class="param-name">classItems</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>
<div class="param-description">
<p>The list of items to merge in</p>
</div>
</li>
<li class="param">
<code class="param-name">first</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>Set for the first call</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_mixExternal" class="method item">
<h3 class="name"><code>mixExternal</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag async">async</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l359"><code>lib&#x2F;builder.js:359</code></a>
</p>
</div>
<div class="description">
<p>Fetches the remote data and fires the callback when it's all complete</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute when complete</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_nameSort" class="method item">
<h3 class="name"><code>nameSort</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>a</code>
</li>
<li class="arg">
<code>b</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/Number.html" class="crosslink external" target="_blank">Number</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1380"><code>lib&#x2F;builder.js:1380</code></a>
</p>
</div>
<div class="description">
<p>Sort method of array of objects with a property called <strong>name</strong></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">a</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>First object to compare</p>
</div>
</li>
<li class="param">
<code class="param-name">b</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>Second object to compare</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/Number.html" class="crosslink external" target="_blank">Number</a></span>:
1, -1 or 0 for sorting.
</div>
</div>
</div>
<div id="method_NATIVES_LINKER" class="method item private">
<h3 class="name"><code>NATIVES_LINKER</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l297"><code>lib&#x2F;builder.js:297</code></a>
</p>
</div>
<div class="description">
<p>Function to link an external type uses <code>NATIVES</code> object</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the type to link</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
The combined URL
</div>
</div>
</div>
<div id="method_populateClasses" class="method item">
<h3 class="name"><code>populateClasses</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>opts</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l494"><code>lib&#x2F;builder.js:494</code></a>
</p>
</div>
<div class="description">
<p>Populate the meta data for classes</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">opts</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The original options</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
The modified options
</div>
</div>
</div>
<div id="method_populateFiles" class="method item">
<h3 class="name"><code>populateFiles</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>opts</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l553"><code>lib&#x2F;builder.js:553</code></a>
</p>
</div>
<div class="description">
<p>Populate the meta data for files</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">opts</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The original options</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
The modified options
</div>
</div>
</div>
<div id="method_populateModules" class="method item">
<h3 class="name"><code>populateModules</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>opts</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l516"><code>lib&#x2F;builder.js:516</code></a>
</p>
</div>
<div class="description">
<p>Populate the meta data for modules</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">opts</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The original options</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
The modified options
</div>
</div>
</div>
<div id="method_render" class="method item">
<h3 class="name"><code>render</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</code>
</li>
<li class="arg">
<code>view</code>
</li>
<li class="arg">
<code class="optional">[layout=null]</code>
</li>
<li class="arg">
<code class="optional">[partials={}]</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l769"><code>lib&#x2F;builder.js:769</code></a>
</p>
</div>
<div class="description">
<p>Ported from <a href="https://github.com/rgrove/selleck">Selleck</a>
Renders the handlebars templates with the default View class.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">source</code>
<span class="type">HTML</span>
<div class="param-description">
<p>The default template to parse</p>
</div>
</li>
<li class="param">
<code class="param-name">view</code>
<span class="type">Class</span>
<div class="param-description">
<p>The default view handler</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[layout=null]</code>
<span class="type">HTML</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The HTML from the layout to use.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[partials={}]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>List of partials to include in this template</p>
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">err</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">html</code>
<span class="type">HTML</span>
<div class="param-description">
<p>The assembled template markup</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="method_renderAPIMeta" class="method item">
<h3 class="name"><code>renderAPIMeta</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag async">async</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1503"><code>lib&#x2F;builder.js:1503</code></a>
</p>
</div>
<div class="description">
<p>Render the API meta and return the Javascript</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_renderClass" class="method item">
<h3 class="name"><code>renderClass</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
<li class="arg">
<code>cv.view</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1060"><code>lib&#x2F;builder.js:1060</code></a>
</p>
</div>
<div class="description">
<p>Render the class file</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>The callback fired when complete</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">html</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The HTML to render this view</p>
</div>
</li>
</ul>
</li>
<li class="param">
<code class="param-name">cv.view</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The View Data</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_renderFile" class="method item">
<h3 class="name"><code>renderFile</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
<li class="arg">
<code>cv.view</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1441"><code>lib&#x2F;builder.js:1441</code></a>
</p>
</div>
<div class="description">
<p>Render the source file</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>The callback fired when complete</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">html</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The HTML to render this view</p>
</div>
</li>
</ul>
</li>
<li class="param">
<code class="param-name">cv.view</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The View Data</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_renderIndex" class="method item">
<h3 class="name"><code>renderIndex</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
<li class="arg">
<code>cv.view</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l823"><code>lib&#x2F;builder.js:823</code></a>
</p>
</div>
<div class="description">
<p>Render the index file</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>The callback fired when complete</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">html</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The HTML to render this view</p>
</div>
</li>
</ul>
</li>
<li class="param">
<code class="param-name">cv.view</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The View Data</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_renderModule" class="method item">
<h3 class="name"><code>renderModule</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
<li class="arg">
<code>cv.view</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l872"><code>lib&#x2F;builder.js:872</code></a>
</p>
</div>
<div class="description">
<p>Render a module</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>The callback fired when complete</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">html</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The HTML to render this view</p>
</div>
</li>
</ul>
</li>
<li class="param">
<code class="param-name">cv.view</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The View Data</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_writeAPIMeta" class="method item">
<h3 class="name"><code>writeAPIMeta</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag async">async</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1490"><code>lib&#x2F;builder.js:1490</code></a>
</p>
</div>
<div class="description">
<p>Write the API meta data used for the AutoComplete widget</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute when complete</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_writeClasses" class="method item">
<h3 class="name"><code>writeClasses</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1345"><code>lib&#x2F;builder.js:1345</code></a>
</p>
</div>
<div class="description">
<p>Generates the class files under "out"/classes/</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute after it's completed</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_writeFiles" class="method item">
<h3 class="name"><code>writeFiles</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1403"><code>lib&#x2F;builder.js:1403</code></a>
</p>
</div>
<div class="description">
<p>Generates the syntax files under <code>"out"/files/</code></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute after it's completed</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_writeIndex" class="method item">
<h3 class="name"><code>writeIndex</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l848"><code>lib&#x2F;builder.js:848</code></a>
</p>
</div>
<div class="description">
<p>Generates the index.html file</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute after it's completed</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_writeModules" class="method item">
<h3 class="name"><code>writeModules</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l950"><code>lib&#x2F;builder.js:950</code></a>
</p>
</div>
<div class="description">
<p>Generates the module files under "out"/modules/</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute after it's completed</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property__mergeCounter" class="property item private">
<h3 class="name"><code>_mergeCounter</code></h3>
<span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/Number.html" class="crosslink external" target="_blank">Number</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_builder.js.html#l1002"><code>lib&#x2F;builder.js:1002</code></a>
</p>
</div>
<div class="description">
<p>Counter for stepping into merges</p>
</div>
</div>
<div id="property__meta" class="property item private">
<h3 class="name"><code>_meta</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<div class="meta">