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,475 lines (987 loc) • 39.5 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Locals</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>Locals Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/lib_locals.js.html#l13"><code>lib/locals.js:13</code></a>
</div>
Module: <a href="../modules/utils.html">utils</a><br>
Parent Module: <a href="../modules/firedoc.html">firedoc</a>
</div>
<div class="box intro">
<p>The Theme Locals</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_context">context</a>
</li>
<li class="index-item property">
<a href="#property_options">options</a>
</li>
<li class="index-item property">
<a href="#property_ast">ast</a>
</li>
<li class="index-item property">
<a href="#property_project">project</a>
</li>
<li class="index-item property">
<a href="#property_i18n">i18n</a>
</li>
<li class="index-item property">
<a href="#property_modules">modules</a>
</li>
<li class="index-item property">
<a href="#property_classes">classes</a>
</li>
<li class="index-item property">
<a href="#property_files">files</a>
</li>
<li class="index-item property private">
<a href="#property__mergeCounter">_mergeCounter</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_addFoundAt">addFoundAt</a>
</li>
<li class="index-item method">
<a href="#method_getMethodName">getMethodName</a>
</li>
<li class="index-item method private">
<a href="#method__parseCode">_parseCode</a>
</li>
<li class="index-item method private">
<a href="#method_markdown">markdown</a>
</li>
<li class="index-item method">
<a href="#method_appendClassToModule">appendClassToModule</a>
</li>
<li class="index-item method">
<a href="#method_getClassInheritanceTree">getClassInheritanceTree</a>
</li>
<li class="index-item method">
<a href="#method_buildMember">buildMember</a>
</li>
<li class="index-item method">
<a href="#method_buildMembers">buildMembers</a>
</li>
<li class="index-item method">
<a href="#method_mergeExtends">mergeExtends</a>
</li>
<li class="index-item method private">
<a href="#method_getExpandIterator">getExpandIterator</a>
</li>
<li class="index-item method">
<a href="#method_extendMembers">extendMembers</a>
</li>
<li class="index-item method">
<a href="#method_expandMembersFromModules">expandMembersFromModules</a>
</li>
<li class="index-item method">
<a href="#method_expandMembersFromModules">expandMembersFromModules</a>
</li>
<li class="index-item method">
<a href="#method_create">create</a>
</li>
</ul>
</div>
</div>
<div class="class-detail">
<div class="properties-detail">
<h2>Properties</h2>
<a name="property_context" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>context</code>
<span class="type"><a href="../classes/BuilderContext.html" class="crosslink">BuilderContext</a></span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l20"><code>lib/locals.js:20</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>Builder Context</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_locals.js.html#l25"><code>lib/locals.js:25</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The options</p>
</div>
</div>
</div>
<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_locals.js.html#l30"><code>lib/locals.js:30</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The AST object</p>
</div>
</div>
</div>
<a name="property_project" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>project</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l35"><code>lib/locals.js:35</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>Get the project to export</p>
</div>
</div>
</div>
<a name="property_i18n" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>i18n</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l48"><code>lib/locals.js:48</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>Get i18n object</p>
</div>
</div>
</div>
<a name="property_modules" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>modules</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l66"><code>lib/locals.js:66</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>Get modules object to export</p>
</div>
</div>
</div>
<a name="property_classes" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>classes</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l90"><code>lib/locals.js:90</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>Get classes object to export</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">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l115"><code>lib/locals.js:115</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>Get files object to export</p>
</div>
</div>
</div>
<a name="property__mergeCounter" class="anchor-link"></a>
<div class="property item private">
<h3 class="name"><code>_mergeCounter</code>
<span class="type">Number</span>
<span class="flag private">private</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l345"><code>lib/locals.js:345</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>Counter for stepping into merges</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_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_locals.js.html#l127"><code>lib/locals.js:127</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_getMethodName" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>getMethodName</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>params</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l145"><code>lib/locals.js:145</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>build the method name by its name and parameters</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 function/method name
</div>
</li>
<li class="param">
<code class="param-name">params</code>
<span class="type">Array</span>
<div class="param-description">
The function/method parameters list
</div>
<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 parameter
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<a name="method__parseCode" class="anchor-link"></a>
<div class="method item private">
<h3 class="name"><code>_parseCode</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_locals.js.html#l159"><code>lib/locals.js:159</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Parses <code><pre><code></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">
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_markdown" class="anchor-link"></a>
<div class="method item private">
<h3 class="name"><code>markdown</code>
<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">HTML</span>
</span>
<span class="flag private">private</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l174"><code>lib/locals.js:174</code></a>
</p>
</div>
<div class="extended-detail">
<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">data</code>
<span class="type">String</span>
<div class="param-description">
The Markdown string 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 rendered HTML
</p>
</div>
</div>
</div>
</div>
<a name="method_appendClassToModule" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>appendClassToModule</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>clazz</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l202"><code>lib/locals.js:202</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>append the clazz to its module</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">clazz</code>
<span class="type">Object</span>
<div class="param-description">
The class object
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">module</code>
<span class="type">String</span>
<div class="param-description">
The module name of this clazz object
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<a name="method_getClassInheritanceTree" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>getClassInheritanceTree</code>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Object</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l218"><code>lib/locals.js:218</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>get class inheritance tree</p>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
return the inheritance tree object
</p>
</div>
</div>
</div>
</div>
<a name="method_buildMember" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>buildMember</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>memeber</code>
</li>
<li class="arg">
<code>forceBeMethod</code>
</li>
<li class="arg">
<code>parent</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_locals.js.html#l258"><code>lib/locals.js:258</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>build the member</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">memeber</code>
<span class="type">Object</span>
<div class="param-description">
The member object
</div>
</li>
<li class="param">
<code class="param-name">forceBeMethod</code>
<span class="type">Boolean</span>
<div class="param-description">
force make the build process be for method
</div>
</li>
<li class="param">
<code class="param-name">parent</code>
<span class="type">Object</span>
<div class="param-description">
The parent context
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
returned member object
</p>
</div>
</div>
</div>
</div>
<a name="method_buildMembers" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>buildMembers</code>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l318"><code>lib/locals.js:318</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>build the members</p>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Boolean</span>
<p>
always be true
</p>
</div>
</div>
</div>
</div>
<a name="method_mergeExtends" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>mergeExtends</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>info</code>
</li>
<li class="arg">
<code>members</code>
</li>
<li class="arg">
<code>first</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l353"><code>lib/locals.js:353</code></a>
</p>
</div>
<div class="extended-detail">
<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">Object</span>
<div class="param-description">
The item to extend
</div>
</li>
<li class="param">
<code class="param-name">members</code>
<span class="type">Array</span>
<div class="param-description">
The list of items to merge in
</div>
</li>
<li class="param">
<code class="param-name">first</code>
<span class="type">Boolean</span>
<div class="param-description">
Set for the first call
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_getExpandIterator" class="anchor-link"></a>
<div class="method item private">
<h3 class="name"><code>getExpandIterator</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>parent</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_locals.js.html#l405"><code>lib/locals.js:405</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>generate expand function</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">parent</code>
<span class="type">Object</span>
<div class="param-description">
The object to be set
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_extendMembers" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>extendMembers</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>meta</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l429"><code>lib/locals.js:429</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>extends members array</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">meta</code>
<span class="type">Object</span>
<div class="param-description">
The meta object
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_expandMembersFromModules" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>expandMembersFromModules</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>meta</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l449"><code>lib/locals.js:449</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>extends modules</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">meta</code>
<span class="type">Object</span>
<div class="param-description">
The meta object
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_expandMembersFromModules" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>expandMembersFromModules</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>meta</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l471"><code>lib/locals.js:471</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>extends members from classes</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">meta</code>
<span class="type">Object</span>
<div class="param-description">
The meta object
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_create" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>create</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>context</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_locals.js.html#l493"><code>lib/locals.js:493</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Create a locals object from context</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">context</code>
<span class="type"><a href="../classes/BuilderContext.html" class="crosslink">BuilderContext</a></span>
<div class="param-description">
The <code>BuilderContext</code> instance
</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>