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
215 lines (152 loc) • 5.84 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>ExampleClass - test</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="https://github.com/fireball-x/firedoc" title="test">
</a>
<h1 class="project-name">test</h1>
<p class="description">test</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/ExampleClass.html">exampleModule.ExampleClass</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/out/modules/exampleModule.html" class="api-list-item-module">@exampleModule</a>
</li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/out/modules/exampleModule.html">exampleModule</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>ExampleClass Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/test_targets_basic_index.js.html#l2"><code>test/targets/basic/index.js:2</code></a>
</div>
Module: <a href="../modules/exampleModule.html">exampleModule</a>
</div>
<div class="box intro">
<p>Module Description</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 methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_method1">method1</a>
</li>
</ul>
</div>
</div>
<div class="class-detail">
<div class="methods-detail">
<h2>Methods</h2>
<a name="method_method1" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>method1</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>num</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/test_targets_basic_index.js.html#l12"><code>test/targets/basic/index.js:12</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>class Description</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">num</code>
<span class="type">Number</span>
<div class="param-description">
<p>The Number</p>
</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>