UNPKG

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

161 lines (124 loc) 5.24 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>submod1</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/out/classes/Example.html">mod1.Example</a> <a href="/Users/yorkie/workspace/firebox/firedoc/out/modules/mod1.html" class="api-list-item-module">@mod1</a> </li> <li> <a class="class" href="/Users/yorkie/workspace/firebox/firedoc/out/classes/SubExample.html">submod1.SubExample</a> <a href="/Users/yorkie/workspace/firebox/firedoc/out/modules/submod1.html" class="api-list-item-module">@submod1</a> </li> <li> <a class="class" href="/Users/yorkie/workspace/firebox/firedoc/out/classes/class1.html">mod1.class1</a> <a href="/Users/yorkie/workspace/firebox/firedoc/out/modules/mod1.html" class="api-list-item-module">@mod1</a> </li> </ul> <ul id="api-modules" class="apis modules"> <li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/out/modules/mod1.html">mod1</a></li> <li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/out/modules/mod2.html">mod2</a></li> <li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/out/modules/submod1.html">submod1</a></li> <li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/out/modules/submod2.html">submod2</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>submod1 Module</h1> <div class="box clearfix meta"> <div class="foundat"> Defined in: <a href="../files/test_targets_module_submod1.js.html#l2"><code>test&#x2F;targets&#x2F;module&#x2F;submod1.js:2</code></a> </div> </div> <div class="box intro"> <p>Sub Module Description 1</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/SubExample.html"> SubExample </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> <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/../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>