firedoc
Version:
API Doc generator rewritten from [YUIDoc](https://github.com/yui/yuidoc). We use this tool to document a large JavaScript game engine [Fireball](http://github.com/fireball-x/fireball) at [docs-zh.fireball-x.com/api](http://docs-zh.fireball-x.com/api/) and
1,718 lines (1,146 loc) • 45.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>BuilderContext</title>
<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="../assets/vendor/yui-min.js"></script>
</head>
<body>
<div id="doc">
<header class="main-header">
<div class="content">
<div class="project-title">
<a href="http://docs-zh.fireball-x.com">
<img class="logo" src="http://docs-zh.fireball-x.com/images/logo.png" title="Fireball Engine API">
</a>
<h1 class="project-name">Fireball Engine API</h1>
<p class="description">Fireball is the game engine for the future.</p>
</div>
<ul class="jump-links">
<li><a href="#index" class="index-jump-link">index</a></li>
<li><a href="#top" class="top-jump-link">top</a></li>
</ul>
</div>
</header>
<div id="bd" class="main-body">
<div id="docs-sidebar" class="sidebar apidocs"><div id="api-list">
<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>
<li><a href="#api-enums">Enums</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 class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/AST.html">AST</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/BuilderContext.html">BuilderContext</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/ClazzExample.html">ClazzExample</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/undefinedmodule.html" class="api-list-item-module">@undefinedmodule</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/DocParser.html">DocParser</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/DocView.html">DocView</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/ExampleClass.html">ExampleClass</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/exampleModule.html" class="api-list-item-module">@exampleModule</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/Firedoc.html">Firedoc</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/Locals.html">Locals</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/ParserContext.html">ParserContext</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/SecondClazz.html">SecondClazz</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/undefinedmodule.html" class="api-list-item-module">@undefinedmodule</a>
</li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/exampleModule.html">exampleModule</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/firedoc.html">firedoc</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/helpers.html">helpers</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/mod1.html">mod1</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/mod2.html">mod2</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/submod1.html">submod1</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/submod2.html">submod2</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/undefinedmodule.html">undefinedmodule</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/utils.html">utils</a></li>
</ul>
<ul id="api-enums" class="apis enums">
</ul>
</div>
</div>
</div>
</div>
<div id="docs-main" class="apidocs">
<div class="content container"><h1>BuilderContext Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/lib_builder.js.html#l33"><code>lib/builder.js:33</code></a>
</div>
Module: <a href="../modules/firedoc.html">firedoc</a>
</div>
<div class="box intro">
<p>The Builder Context</p>
</div>
<!-- Class member index -->
<a name="index" class="anchor-link"></a>
<div class="index">
<h2>Index</h2>
<div id="api-options">
Show:
<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="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property">
<a href="#property_ast">ast</a>
</li>
<li class="index-item property">
<a href="#property_options">options</a>
</li>
<li class="index-item property">
<a href="#property_helpers">helpers</a>
</li>
<li class="index-item property">
<a href="#property_cacheView">cacheView</a>
</li>
<li class="index-item property">
<a href="#property_template">template</a>
</li>
<li class="index-item property">
<a href="#property_files">files</a>
</li>
<li class="index-item property">
<a href="#property_metadata">metadata</a>
</li>
<li class="index-item property">
<a href="#property_viewExtname">viewExtname</a>
</li>
</ul>
</div>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_addHelper">addHelper</a>
</li>
<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__parseCrossLink">_parseCrossLink</a>
</li>
<li class="index-item method">
<a href="#method_populateClasses">populateClasses</a>
</li>
<li class="index-item method">
<a href="#method_populateModules">populateModules</a>
</li>
<li class="index-item method">
<a href="#method_populateFiles">populateFiles</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_mixExternal">mixExternal</a>
</li>
<li class="index-item method">
<a href="#method_makeDirs">makeDirs</a>
</li>
<li class="index-item method">
<a href="#method_init">init</a>
</li>
<li class="index-item method">
<a href="#method_correctTheme">correctTheme</a>
</li>
<li class="index-item method">
<a href="#method_compile">compile</a>
</li>
<li class="index-item method">
<a href="#method_render">render</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_filterFileName">filterFileName</a>
</li>
<li class="index-item method">
<a href="#method_compile">compile</a>
</li>
</ul>
</div>
</div>
<div class="class-detail">
<div class="properties-detail">
<h2>Properties</h2>
<a name="property_ast" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>ast</code>
<span class="type"><a href="../classes/AST.html" class="crosslink">AST</a></span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l39"><code>lib/builder.js:39</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The AST object</p>
</div>
</div>
</div>
<a name="property_options" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>options</code>
<span class="type">Option</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l44"><code>lib/builder.js:44</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The command options</p>
</div>
</div>
</div>
<a name="property_helpers" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>helpers</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l49"><code>lib/builder.js:49</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The view helpers function</p>
</div>
</div>
</div>
<a name="property_cacheView" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>cacheView</code>
<span class="type">Boolean</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l54"><code>lib/builder.js:54</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>cache the views</p>
</div>
</div>
</div>
<a name="property_template" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>template</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l59"><code>lib/builder.js:59</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The template</p>
</div>
</div>
</div>
<a name="property_files" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>files</code>
<span class="type">Number</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l64"><code>lib/builder.js:64</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>records the files</p>
</div>
</div>
</div>
<a name="property_metadata" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>metadata</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l69"><code>lib/builder.js:69</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The project meta</p>
</div>
</div>
</div>
<a name="property_viewExtname" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>viewExtname</code>
<span class="type">String</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l92"><code>lib/builder.js:92</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The ext name of current view</p>
</div>
</div>
</div>
<div class="no-visible-items-message">
<p>There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. <a href="#index" class="index-jump-link">index</a></p>
</div>
</div>
<div class="methods-detail">
<h2>Methods</h2>
<a name="method_addHelper" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>addHelper</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>helper</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l99"><code>lib/builder.js:99</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Add helper</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type">String</span>
<div class="param-description">
The helper name
</div>
</li>
<li class="param">
<code class="param-name">helper</code>
<span class="type">Function</span>
<div class="param-description">
The helper logic
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_addHelpers" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>addHelpers</code>
<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>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l111"><code>lib/builder.js:111</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Add helpers</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">helpers</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method__inlineCode" class="anchor-link"></a>
<div class="method item private">
<h3 class="name"><code>_inlineCode</code>
<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>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l123"><code>lib/builder.js:123</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Ported from <a href="https://github.com/rgrove/selleck">Selleck</a>, this handles <code>`</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">
The HTML to parse
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">HTML</span>
<p>
The parsed HTML
</p>
</div>
</div>
</div>
</div>
<a name="method__parseCrossLink" class="anchor-link"></a>
<div class="method item private">
<h3 class="name"><code>_parseCrossLink</code>
<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>
<li class="arg">
<code class="optional">[content]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l141"><code>lib/builder.js:141</code></a>
</p>
</div>
<div class="extended-detail">
<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">String</span>
<div class="param-description">
The item to crossLink
</div>
</li>
<li class="param">
<code class="param-name optional">raw</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional."></span>
<span>, : false</span>
<div class="param-description">
Do not wrap it in HTML
</div>
</li>
<li class="param">
<code class="param-name optional">content</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional."></span>
<div class="param-description">
crossLink helper content
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_populateClasses" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>populateClasses</code>
<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">Object</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l249"><code>lib/builder.js:249</code></a>
</p>
</div>
<div class="extended-detail">
<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">Object</span>
<div class="param-description">
The original options
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
The modified options
</p>
</div>
</div>
</div>
</div>
<a name="method_populateModules" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>populateModules</code>
<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">Object</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l273"><code>lib/builder.js:273</code></a>
</p>
</div>
<div class="extended-detail">
<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">Object</span>
<div class="param-description">
The original options
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
The modified options
</p>
</div>
</div>
</div>
</div>
<a name="method_populateFiles" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>populateFiles</code>
<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">Object</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l298"><code>lib/builder.js:298</code></a>
</p>
</div>
<div class="extended-detail">
<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">Object</span>
<div class="param-description">
The original options
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
The modified options
</p>
</div>
</div>
</div>
</div>
<a name="method_addFoundAt" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>addFoundAt</code>
<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">String</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l318"><code>lib/builder.js:318</code></a>
</p>
</div>
<div class="extended-detail">
<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">Object</span>
<div class="param-description">
The item to parse
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
The parsed HREF
</p>
</div>
</div>
</div>
</div>
<a name="method_augmentData" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>augmentData</code>
<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">Object</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l335"><code>lib/builder.js:335</code></a>
</p>
</div>
<div class="extended-detail">
<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">Object</span>
<div class="param-description">
The object to recurse and augment
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
The augmented object
</p>
</div>
</div>
</div>
</div>
<a name="method_mixExternal" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>mixExternal</code>
<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="returns-inline">
<span class="type">Promise</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l395"><code>lib/builder.js:395</code></a>
</p>
</div>
<div class="extended-detail">
<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">Function</span>
<div class="param-description">
The callback to execute when complete
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Promise</span>
<p>
</p>
</div>
</div>
</div>
</div>
<a name="method_makeDirs" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>makeDirs</code>
<span class="paren">()</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l468"><code>lib/builder.js:468</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Makes the default directories needed</p>
</div>
</div>
</div>
<a name="method_init" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>init</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>ast</code>
</li>
<li class="arg">
<code>options</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/BuilderContext.html" class="crosslink">BuilderContext</a></span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l484"><code>lib/builder.js:484</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Init <code>BuilderContext</code> context and return</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">ast</code>
<span class="type"><a href="../classes/AST.html" class="crosslink">AST</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">options</code>
<span class="type">Option</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type"><a href="../classes/BuilderContext.html" class="crosslink">BuilderContext</a></span>
<p>
</p>
</div>
</div>
</div>
</div>
<a name="method_correctTheme" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>correctTheme</code>
<span class="paren">()</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l502"><code>lib/builder.js:502</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>correct the theme</p>
</div>
</div>
</div>
<a name="method_compile" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>compile</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l521"><code>lib/builder.js:521</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Compule the AST</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Function</span>
<div class="param-description">
The callback
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_render" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>render</code>
<span class="paren">()</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l572"><code>lib/builder.js:572</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Render</p>
</div>
</div>
</div>
<a name="method_NATIVES_LINKER" class="anchor-link"></a>
<div class="method item private">
<h3 class="name"><code>NATIVES_LINKER</code>
<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">String</span>
</span>
<span class="flag private">private</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l727"><code>lib/builder.js:727</code></a>
</p>
</div>
<div class="extended-detail">
<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">String</span>
<div class="param-description">
The name of the type to link
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
The combined URL
</p>
</div>
</div>
</div>
</div>
<a name="method_filterFileName" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>filterFileName</code>
<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">String</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l742"><code>lib/builder.js:742</code></a>
</p>
</div>
<div class="extended-detail">
<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">String</span>
<div class="param-description">
The filename to normalize
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
The filtered file path
</p>
</div>
</div>
</div>
</div>
<a name="method_compile" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>compile</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>ast</code>
</li>
<li class="arg">
<code>options</code>
</li>
<li class="arg">
<code>onfinish</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_builder.js.html#l756"><code>lib/builder.js:756</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>compile</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">ast</code>
<span class="type"><a href="../classes/AST.html" class="crosslink">AST</a></span>
<div class="param-description">
The <code>AST</code> object
</div>
</li>
<li class="param">
<code class="param-name">options</code>
<span class="type">Option</span>
<div class="param-description">
The options
</div>
</li>
<li class="param">
<code class="param-name">onfinish</code>
<span class="type">Function</span>
<div class="param-description">
fired when compile has completed
</div>
</li>
</ul>
</div>
</div>
</div>
<div class="no-visible-items-message">
<p>There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. <a href="#index" class="index-jump-link">index</a></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/vendor/jquery.min.js"></script>
<script src="../assets/js/jquery-offscreen-trigger.js"></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>