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
377 lines (292 loc) • 13.9 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>firedoc</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>firedoc Module</h1>
<div class="box clearfix meta">
<div class="foundat">
Defined in: <a href="../files/lib_firedoc.js.html#l2"><code>lib/firedoc.js:2</code></a>
</div>
</div>
<div class="box intro">
<p>The firedoc module</p>
</div>
<!-- Class member index -->
<div class="index-section properties">
<h3>Class</h3>
<ul class="index-list properties">
<li class="index-item">
<a href="classes/DocParser.html">
DocParser
</a>
</li>
<li class="index-item">
<a href="classes/AST.html">
AST
</a>
</li>
<li class="index-item">
<a href="classes/BuilderContext.html">
BuilderContext
</a>
</li>
<li class="index-item">
<a href="classes/ParserContext.html">
ParserContext
</a>
</li>
<li class="index-item">
<a href="classes/DocView.html">
DocView
</a>
</li>
<li class="index-item">
<a href="classes/Firedoc.html">
Firedoc
</a>
</li>
<li class="index-item">
<a href="classes/Locals.html">
Locals
</a>
</li>
</ul>
</div>
<h3>Direct Members</h3>
<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_NATIVES">NATIVES</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_parse">parse</a>
</li>
</ul>
</div>
</div>
<div class="yui3-g">
<div class="yui3-u-1-2">
<h3>Properties:</h3>
<a name="property_NATIVES" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>NATIVES</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/firedoc.html" class="module-name">firedoc</a> module.</p>
<p>
Defined in
<a href="../files/lib_builder.js.html#l21"><code>lib/builder.js:21</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>List of native types to cross link to MDN</p>
</div>
</div>
</div>
</div>
<div class="yui3-u-1-2">
<h3>Methods:</h3>
<a name="method_parse" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>parse</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>syntaxtype</code>
</li>
<li class="arg">
<code>files</code>
</li>
<li class="arg">
<code>dirs</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>Provided by the <a href="../modules/firedoc.html" class="module-name">firedoc</a> module.</p>
<p>
Defined in
<a href="../files/lib_docparser.js.html#l10"><code>lib/docparser.js:10</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>parse and generate the <code>AST</code> object</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">syntaxtype</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">files</code>
<span class="type">Array</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">dirs</code>
<span class="type">Array</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/AST.html" class="crosslink">AST</a></span>
<p>
the ast object
</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/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>