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
585 lines (413 loc) • 17.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>testmembers</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">
</ul>
<ul id="api-modules" class="apis modules">
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/out/modules/testmembers.html">testmembers</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>testmembers Module</h1>
<div class="box clearfix meta">
<div class="foundat">
Defined in: <a href="../files/test_targets_members_index.js.html#l2"><code>test/targets/members/index.js:2</code></a>
</div>
</div>
<div class="box intro">
<p>This module is used to test members</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/.html">
</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 deprecated">
<a href="#property_"></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_example_optional">example_optional</a>
</li>
<li class="index-item method public">
<a href="#method_example_sub_params">example_sub_params</a>
</li>
<li class="index-item method">
<a href="#method_md_link_in_method_params_desc">md_link_in_method_params_desc</a>
</li>
<li class="index-item method">
<a href="#method_html_example">html_example</a>
</li>
</ul>
</div>
</div>
<div class="yui3-g">
<div class="yui3-u-1-2">
<h3>Properties:</h3>
<a name="property_" class="anchor-link"></a>
<div class="property item deprecated">
<h3 class="name"><code></code>
<span class="type">Unknown</span>
<span class="flag deprecated" title="this is just deprecated">deprecated</span>
<span class="flag final">final</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/testmembers.html" class="module-name">testmembers</a> module.</p>
<p>
Defined in
<a href="../files/test_targets_members_index.js.html#l43"><code>test/targets/members/index.js:43</code></a>
</p>
<p class="deprecated">deprecated: <span class="message">this is just deprecated</span></p>
</div>
<div class="extended-detail">
<div class="description"><p>const test</p>
</div>
</div>
</div>
</div>
<div class="yui3-u-1-2">
<h3>Methods:</h3>
<a name="method_example_optional" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>example_optional</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[x=10]</code>
</li>
<li class="arg">
<code class="optional">[y={}]</code>
</li>
<li class="arg">
<code class="optional">[z=[]]</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Number</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/testmembers.html" class="module-name">testmembers</a> module.</p>
<p>
Defined in
<a href="../files/test_targets_members_index.js.html#l15"><code>test/targets/members/index.js:15</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>example method</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">x</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional."></span>
<span>, : 10</span>
<div class="param-description">
<p>The default value is 10(test)</p>
</div>
</li>
<li class="param">
<code class="param-name optional">y</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional."></span>
<span>, : {}</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">z</code>
<span class="type">Array</span>
<span class="flag optional" title="This parameter is optional."></span>
<span>, : []</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">commoncall</span>
<div class="param-description">
<p>common callback</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">err</code>
<span class="type">Error</span>
<div class="param-description">
The error as first argument
</div>
</li>
<li class="param">
<code class="param-name">obj</code>
<span class="type">Object</span>
<div class="param-description">
The returned object
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Number</span>
<p>
</p>
</div>
</div>
<div class="example">
<h4>examples:</h4>
<div class="example-content"><pre class="code prettyprint"><code>
example
</code></pre>
</div>
</div>
</div>
</div>
<a name="method_example_sub_params" class="anchor-link"></a>
<div class="method item public">
<h3 class="name"><code>example_sub_params</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Number</span>
</span>
<span class="flag public">public</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/testmembers.html" class="module-name">testmembers</a> module.</p>
<p>
Defined in
<a href="../files/test_targets_members_index.js.html#l30"><code>test/targets/members/index.js:30</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>example method 2</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type">Object</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">x</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">y</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional."></span>
<span>, : {}</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">a</code>
<span class="type">Boolean</span>
<div class="param-description">
</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Number</span>
<p>
</p>
</div>
</div>
<div class="example">
<h4>examples:</h4>
<div class="example-content"><pre><code class="language-Not"></code></pre>
<pre><code class="language-//">var foo = bar;</code></pre>
</div>
</div>
</div>
</div>
<a name="method_md_link_in_method_params_desc" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>md_link_in_method_params_desc</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[webContents]</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/testmembers.html" class="module-name">testmembers</a> module.</p>
<p>
Defined in
<a href="../files/test_targets_members_index.js.html#l50"><code>test/targets/members/index.js:50</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>markdown link in method parameter description</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">webContents</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional."></span>
<div class="param-description">
<p>A <a href="https://github.com/atom/electron/blob/master/docs/api/browser-window.md#class-webcontents">WebContents</a> object</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<a name="method_html_example" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>html_example</code>
<span class="paren">()</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/testmembers.html" class="module-name">testmembers</a> module.</p>
<p>
Defined in
<a href="../files/test_targets_members_index.js.html#l56"><code>test/targets/members/index.js:56</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>html example</p>
</div>
<div class="example">
<h4>examples:</h4>
<div class="example-content"><pre class="code prettyprint"><code>
// index.html
<html>
<body>
<script>
require('ipc').on('foo:bar', function(message) {
console.log(message); // Prints "Hello World!"
});
require("look");
</script>
</body>
</html></code></pre>
</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>