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,135 lines (762 loc) • 31.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>AST</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>AST Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/lib_ast.js.html#l163"><code>lib/ast.js:163</code></a>
</div>
Module: <a href="../modules/firedoc.html">firedoc</a>
</div>
<div class="box intro">
<p>The AST(Abstract syntax tree) of the comment</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_project">project</a>
</li>
<li class="index-item property">
<a href="#property_files">files</a>
</li>
<li class="index-item property">
<a href="#property_codes">codes</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_members">members</a>
</li>
<li class="index-item property">
<a href="#property_inheritedMembers">inheritedMembers</a>
</li>
<li class="index-item property">
<a href="#property_commentsMap">commentsMap</a>
</li>
<li class="index-item property">
<a href="#property_syntaxType">syntaxType</a>
</li>
<li class="index-item property">
<a href="#property_context">context</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_create">create</a>
</li>
<li class="index-item method">
<a href="#method_reset">reset</a>
</li>
<li class="index-item method">
<a href="#method_oncomment">oncomment</a>
</li>
<li class="index-item method">
<a href="#method_onblock">onblock</a>
</li>
<li class="index-item method">
<a href="#method_ontag">ontag</a>
</li>
<li class="index-item method">
<a href="#method_extract">extract</a>
</li>
<li class="index-item method">
<a href="#method_transform">transform</a>
</li>
<li class="index-item method private">
<a href="#method_resolveFor">resolveFor</a>
</li>
</ul>
</div>
</div>
<div class="class-detail">
<div class="properties-detail">
<h2>Properties</h2>
<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_ast.js.html#l170"><code>lib/ast.js:170</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>About the project</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_ast.js.html#l175"><code>lib/ast.js:175</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The files</p>
</div>
</div>
</div>
<a name="property_codes" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>codes</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l180"><code>lib/ast.js:180</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The source codes</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_ast.js.html#l185"><code>lib/ast.js:185</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The modules</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_ast.js.html#l190"><code>lib/ast.js:190</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The classes</p>
</div>
</div>
</div>
<a name="property_members" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>members</code>
<span class="type">Array</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l195"><code>lib/ast.js:195</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The members</p>
</div>
</div>
</div>
<a name="property_inheritedMembers" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>inheritedMembers</code>
<span class="type">Array</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l200"><code>lib/ast.js:200</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The inherited members</p>
</div>
</div>
</div>
<a name="property_commentsMap" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>commentsMap</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l205"><code>lib/ast.js:205</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The comments map object</p>
</div>
</div>
</div>
<a name="property_syntaxType" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>syntaxType</code>
<span class="type">String</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l210"><code>lib/ast.js:210</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The syntax type</p>
</div>
</div>
</div>
<a name="property_context" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>context</code>
<span class="type">Context</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l215"><code>lib/ast.js:215</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The context object</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_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>files</code>
</li>
<li class="arg">
<code>dirs</code>
</li>
<li class="arg">
<code class="optional">[syntaxType]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/AST.html" class="crosslink">AST</a></span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l225"><code>lib/ast.js:225</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Create a AST object</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">files</code>
<span class="type">Object</span>
<div class="param-description">
The files
</div>
</li>
<li class="param">
<code class="param-name">dirs</code>
<span class="type">Object</span>
<div class="param-description">
The directorys
</div>
</li>
<li class="param">
<code class="param-name optional">syntaxType</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional."></span>
<div class="param-description">
The syntax type: <code>coffee</code> or <code>js</code>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type"><a href="../classes/AST.html" class="crosslink">AST</a></span>
<p>
the created AST object
</p>
</div>
</div>
</div>
</div>
<a name="method_reset" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>reset</code>
<span class="paren">()</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l244"><code>lib/ast.js:244</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Reset the AST instance</p>
</div>
</div>
</div>
<a name="method_oncomment" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>oncomment</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>comment</code>
</li>
<li class="arg">
<code>filename</code>
</li>
<li class="arg">
<code>linenum</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_ast.js.html#l267"><code>lib/ast.js:267</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">comment</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">filename</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">linenum</code>
<span class="type">String</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">Object</span>
<p>
</p>
</div>
</div>
</div>
</div>
<a name="method_onblock" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>onblock</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>an</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l337"><code>lib/ast.js:337</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Processes all the tags in a single comment block</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">an</code>
<span class="type">Array</span>
<div class="param-description">
array of the tag/text pairs
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_ontag" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>ontag</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>item</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l369"><code>lib/ast.js:369</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Process tag</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">item</code>
<span class="type">Object</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">tag</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">value</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<a name="method_extract" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>extract</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>files</code>
</li>
<li class="arg">
<code>dirs</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l416"><code>lib/ast.js:416</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Accepts a map of filenames to file content. Returns
a map of filenames to an array of API comment block
text. This expects the comment to start with / <em>*
on its own line, and end with </em> / on its own
line. Override this function to provide an
alternative comment parser.</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">files</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">dirs</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_transform" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>transform</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>commentmap</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l456"><code>lib/ast.js:456</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Transforms a map of filenames to arrays of comment blocks into a
JSON structure that represents the entire processed API doc info
and relationships between elements for the entire project.</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">commentmap</code>
<span class="type">Object</span>
<div class="param-description">
The hash of files and parsed comment blocks
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
The transformed data for the project
</p>
</div>
</div>
</div>
</div>
<a name="method_resolveFor" class="anchor-link"></a>
<div class="method item private">
<h3 class="name"><code>resolveFor</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<span class="flag private">private</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/lib_ast.js.html#l472"><code>lib/ast.js:472</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Takes a non-namespaced classname and resolves it to a namespace (to support <code>@for</code>)</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">value</code>
<span class="type">String</span>
<div class="param-description">
The classname to resolve
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
The resolved namespace + classname
</p>
</div>
</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>