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
578 lines (392 loc) • 14.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>SecondClazz</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/ClazzExample.html">undefinedmodule.ClazzExample</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/out/modules/undefinedmodule.html" class="api-list-item-module">@undefinedmodule</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/out/classes/SecondClazz.html">undefinedmodule.SecondClazz</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/out/modules/undefinedmodule.html" class="api-list-item-module">@undefinedmodule</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/out/classes/ThirdClazz.html">undefinedmodule.ThirdClazz</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/out/modules/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/out/modules/undefinedmodule.html">undefinedmodule</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>SecondClazz Class</h1>
<div class="box meta">
<div class="extends">
Extends <a href="../classes/ClazzExample.html" class="crosslink">ClazzExample</a>
</div>
<div class="foundat">
Defined in: <a href="../files/test_targets_class_index.js.html#l30"><code>test/targets/class/index.js:30</code></a>
</div>
Module: <a href="../modules/undefinedmodule.html">undefinedmodule</a>
</div>
<div class="box intro">
<p>The second class</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_name">name</a>
</li>
<li class="index-item property">
<a href="#property_name2">name2</a>
</li>
</ul>
</div>
<div class="index-section attrs">
<h3></h3>
<ul class="index-list attrs">
<li class="index-item attr">
<a href="#attr_attr1">attr1</a>
</li>
<li class="index-item attr">
<a href="#attr_attr2">attr2</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_method2_with_description">method2_with_description</a>
</li>
<li class="index-item method">
<a href="#method_method1">method1</a>
</li>
<li class="index-item method">
<a href="#method_method2">method2</a>
</li>
</ul>
</div>
<div class="index-section events">
<h3>Events</h3>
<ul class="index-list events">
<li class="index-item event">
<a href="#event_evt1">evt1</a>
</li>
</ul>
</div>
<div class="index-section inherits-members">
<h3>inherited members</h3>
<h4>Properties</h4>
<ul class="index-list properties">
<li class="index-item property">
<a href=".html#property_name">name</a>
</li>
<li class="index-item property">
<a href=".html#property_name2">name2</a>
</li>
</ul>
<h4></h4>
<ul class="index-list attrs">
</ul>
<h4>Methods</h4>
<ul class="index-list methods">
<li class="index-item method">
<a href=".html#method_method2">method2</a>
</li>
</ul>
<h4>Events</h4>
<ul class="index-list events">
<li class="index-item event">
<a href=".html#event_evt1">evt1</a>
</li>
</ul>
</div>
</div>
<div class="class-detail">
<div class="properties-detail">
<h2>Properties</h2>
<a name="property_name" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>name</code>
<span class="type">String</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/test_targets_class_index.js.html#l8"><code>test/targets/class/index.js:8</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The prop 1</p>
</div>
</div>
</div>
<a name="property_name2" class="anchor-link"></a>
<div class="property item">
<h3 class="name"><code>name2</code>
<span class="type">Object</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/test_targets_class_index.js.html#l12"><code>test/targets/class/index.js:12</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description"><p>The name2</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="attrs-detail">
<h2>Attributes</h2>
<div id="attr_attr1" class="attr item">
<a name="config_attr1"></a>
<h3 class="name"><code>attr1</code></h3>
<span class="type">Unknown</span>
<div class="meta">
<p>
Defined in
<a href="../files/test_targets_class_index.js.html#l50"><code>test/targets/class/index.js:50</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="attr_attr2" class="attr item">
<a name="config_attr2"></a>
<h3 class="name"><code>attr2</code></h3>
<span class="type">Unknown</span>
<div class="meta">
<p>
Defined in
<a href="../files/test_targets_class_index.js.html#l55"><code>test/targets/class/index.js:55</code></a>
</p>
</div>
<div class="description">
</div>
</div>
</div>
<div class="methods-detail">
<h2>Methods</h2>
<a name="method_method2_with_description" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>method2_with_description</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
</h3>
<div class="meta">
<p>
Defined in
<a href="../files/test_targets_class_index.js.html#l36"><code>test/targets/class/index.js:36</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>method2 description 2</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type">String</span>
<div class="param-description">
<p>The name description</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
The return value
</p>
</div>
</div>
</div>
</div>
<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>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String | Boolean</span>
</span>
</h3>
<div class="meta">
<p>Inherited from
<a href="../classes/unknown.html#method_method1" class="type">
</a>
but overwritten in
<a href="../files/test_targets_class_index.js.html#l43"><code>test/targets/class/index.js:43</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>extended from class1 and rewritten in this class</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</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">String | Boolean</span>
<p>
</p>
</div>
</div>
</div>
</div>
<a name="method_method2" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>method2</code>
<span class="paren">()</span>
</h3>
<div class="meta">
<p>Inherited from
<a href="../classes/ClazzExample.html#method_method2" class="type">ClazzExample</a>:
<a href="../files/test_targets_class_index.js.html#l25"><code>test/targets/class/index.js:25</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>method2 description</p>
</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 class="events-detail">
<h2>Events</h2>
<a name="event_evt1" class="anchor-link"></a>
<div class="events item">
<h3 class="name"><code>evt1</code></h3>
<span class="type">Unknown</span>
<div class="meta">
<p>
Defined in
<a href="../files/test_targets_class_index.js.html#l60"><code>test/targets/class/index.js:60</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
</div>
</div>
</div>
<div class="no-visible-items-message">
<p>There are no events 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>