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
861 lines (778 loc) • 30.6 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>yuidoc</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/ico" href="../assets/favicon.ico">
<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" style="height:100%">
<div id="api-tabview" class="tabview" style="height:100%">
<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-items" class="apis items">
<li>
<div class="api-list-item-clickable wave-btn">
<a class="module" href="../modules/firedoc.html">firedoc</a>
<i class="flag">module</i>
</div>
<div class="members-list hidden">
<h3>properties</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#property_NATIVES">
NATIVES
</a>
</li>
</ul>
</div>
</li>
<li>
<div class="api-list-item-clickable wave-btn">
<a class="module" href="../modules/helpers.html">helpers</a>
<i class="flag">module</i>
</div>
<div class="members-list hidden">
</div>
</li>
<li>
<div class="api-list-item-clickable wave-btn">
<a class="module" href="../modules/utils.html">utils</a>
<i class="flag">module</i>
</div>
<div class="members-list hidden">
</div>
</li>
<li>
<div class="api-list-item-clickable wave-btn">
<a class="module" href="../modules/yuidoc.html">yuidoc</a>
<i class="flag">module</i>
</div>
<div class="members-list hidden">
</div>
</li>
<li>
<div class="api-list-item-clickable wave-btn">
<a class="class"
href="../classes/AST.html"
title="firedoc.AST">firedoc.AST</a>
<i class="flag">class</i>
</div>
<div class="members-list hidden">
<h3>properties</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#property_project">
project
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_files">
files
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_modules">
modules
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_classes">
classes
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_members">
members
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_inheritedMembers">
inheritedMembers
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_commentsMap">
commentsMap
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_syntaxType">
syntaxType
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_context">
context
</a>
</li>
</ul>
<h3>methods</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#method_create">
create
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_oncomment">
oncomment
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_onblock">
onblock
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_ontag">
ontag
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_extract">
extract
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_transform">
transform
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_resolveFor">
resolveFor
</a>
</li>
</ul>
</div>
</li>
<li>
<div class="api-list-item-clickable wave-btn">
<a class="class"
href="../classes/BuilderContext.html"
title="firedoc.BuilderContext">firedoc.BuilderContext</a>
<i class="flag">class</i>
</div>
<div class="members-list hidden">
<h3>properties</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#property_ast">
ast
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_options">
options
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_helpers">
helpers
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_cacheView">
cacheView
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_template">
template
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_files">
files
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_metadata">
metadata
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_viewExtname">
viewExtname
</a>
</li>
</ul>
<h3>methods</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#method_addHelper">
addHelper
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_addHelpers">
addHelpers
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method__inlineCode">
_inlineCode
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method__parseCrossLink">
_parseCrossLink
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_populateClasses">
populateClasses
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_populateModules">
populateModules
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_populateFiles">
populateFiles
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_addFoundAt">
addFoundAt
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_augmentData">
augmentData
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_mixExternal">
mixExternal
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_makeDirs">
makeDirs
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_init">
init
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_correctTheme">
correctTheme
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_compile">
compile
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_render">
render
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_NATIVES_LINKER">
NATIVES_LINKER
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_filterFileName">
filterFileName
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_compile">
compile
</a>
</li>
</ul>
</div>
</li>
<li>
<div class="api-list-item-clickable wave-btn">
<a class="class"
href="../classes/DocParser.html"
title="firedoc.DocParser">firedoc.DocParser</a>
<i class="flag">class</i>
</div>
<div class="members-list hidden">
<h3>properties</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#property_TAGLIST">
TAGLIST
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_IGNORE_TAGLIST">
IGNORE_TAGLIST
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_CORRECTIONS">
CORRECTIONS
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_DIGESTERS">
DIGESTERS
</a>
</li>
</ul>
<h3>methods</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#method_implodeString">
implodeString
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_implodeString">
implodeString
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_parse">
parse
</a>
</li>
</ul>
</div>
</li>
<li>
<div class="api-list-item-clickable wave-btn">
<a class="class"
href="../classes/DocView.html"
title="firedoc.DocView">firedoc.DocView</a>
<i class="flag">class</i>
</div>
<div class="members-list hidden">
<h3>methods</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#method_htmlTitle">
htmlTitle
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_title">
title
</a>
</li>
</ul>
</div>
</li>
<li>
<div class="api-list-item-clickable wave-btn">
<a class="class"
href="../classes/Locals.html"
title="firedoc.Locals">firedoc.Locals</a>
<i class="flag">class</i>
</div>
<div class="members-list hidden">
<h3>properties</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#property_context">
context
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_options">
options
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_ast">
ast
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_">
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_">
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_">
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_">
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_">
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property__mergeCounter">
_mergeCounter
</a>
</li>
</ul>
<h3>methods</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#method_addFoundAt">
addFoundAt
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_getMethodName">
getMethodName
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method__parseCode">
_parseCode
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_markdown">
markdown
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_appendClassToModule">
appendClassToModule
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_getClassInheritanceTree">
getClassInheritanceTree
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_buildMember">
buildMember
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_buildMembers">
buildMembers
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_mergeExtends">
mergeExtends
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_getExpandIterator">
getExpandIterator
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_extendMembers">
extendMembers
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_expandMembersFromModules">
expandMembersFromModules
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_expandMembersFromModules">
expandMembersFromModules
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_escapeHTML">
escapeHTML
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_safetrim">
safetrim
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_getLayouts">
getLayouts
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_filterFileName">
filterFileName
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_getPage">
getPage
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_unindent">
unindent
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_getPages">
getPages
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_getPartials">
getPartials
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_prepare">
prepare
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_getProjectData">
getProjectData
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_getDirs">
getDirs
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_validatePaths">
validatePaths
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_fixType">
fixType
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_webpath">
webpath
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_localize">
localize
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#method_markdownLink">
markdownLink
</a>
</li>
</ul>
</div>
</li>
<li>
<div class="api-list-item-clickable wave-btn">
<a class="class"
href="../classes/ParserContext.html"
title="firedoc.ParserContext">firedoc.ParserContext</a>
<i class="flag">class</i>
</div>
<div class="members-list hidden">
<h3>properties</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/firedoc.html#property_fil">
fil
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_mainModul">
mainModul
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_modul">
modul
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_proces">
proces
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_submodul">
submodul
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_bloc">
bloc
</a>
</li>
<li>
<a class="name" href="../modules/firedoc.html#property_namespac">
namespac
</a>
</li>
</ul>
</div>
</li>
<li>
<div class="api-list-item-clickable wave-btn">
<a class="class"
href="../classes/YUIDoc.html"
title="firedoc.YUIDoc">firedoc.YUIDoc</a>
<i class="flag">class</i>
</div>
<div class="members-list hidden">
<h3>properties</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/yuidoc.html#property_filecount">
filecount
</a>
</li>
<li>
<a class="name" href="../modules/yuidoc.html#property_filemap">
filemap
</a>
</li>
<li>
<a class="name" href="../modules/yuidoc.html#property_dirmap">
dirmap
</a>
</li>
<li>
<a class="name" href="../modules/yuidoc.html#property_options">
options
</a>
</li>
</ul>
<h3>methods</h3>
<ul class="apis members api-members">
<li>
<a class="name" href="../modules/yuidoc.html#method__setDefaultExcludes">
_setDefaultExcludes
</a>
</li>
<li>
<a class="name" href="../modules/yuidoc.html#method__processConfig">
_processConfig
</a>
</li>
<li>
<a class="name" href="../modules/yuidoc.html#method_walk">
walk
</a>
</li>
<li>
<a class="name" href="../modules/yuidoc.html#method_runPreprocessors">
runPreprocessors
</a>
</li>
<li>
<a class="name" href="../modules/yuidoc.html#method_writeJSON">
writeJSON
</a>
</li>
<li>
<a class="name" href="../modules/yuidoc.html#method_build">
build
</a>
</li>
<li>
<a class="name" href="../modules/helpers.html#method_buildFileTree">
buildFileTree
</a>
</li>
<li>
<a class="name" href="../modules/helpers.html#method_crossLink">
crossLink
</a>
</li>
<li>
<a class="name" href="../modules/helpers.html#method_crossLinkModule">
crossLinkModule
</a>
</li>
<li>
<a class="name" href="../modules/helpers.html#method_crossLinkRaw">
crossLinkRaw
</a>
</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="docs-main" class="apidocs">
<div class="content container">
<h1>
<span class="type">Module</span>
<span class="name">yuidoc</span>
</h1>
<div class="box clearfix meta">
</div>
<div class="box intro">
</div>
<!-- Class member index -->
<h2>Direct Members</h2>
<a name="index" class="anchor-link"></a>
<div class="index">
<h3>Index</h3>
<div id="api-options">
Filter:
<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>
<div class="yui3-g">
</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/js/api-list.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>