Documentation first draft

This commit is contained in:
Mat Groves 2013-02-24 17:12:35 +00:00
parent 5786d33f94
commit 0558060de2
65 changed files with 2106 additions and 423 deletions

View file

@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Stage - The Foo API</title>
<title>Stage - Pixi.js API</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0pr2&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="..&#x2F;assets/css/logo.png" title="The Foo API"></h1>
<h1><img src="..&#x2F;logo_small.png" title="Pixi.js API"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.2.1</em>
<em>API Docs for: 0.9</em>
</div>
</div>
<div id="bd" class="yui3-g">
@ -148,7 +148,17 @@
<h3 class="name"><code>Stage</code></h3>
<span class="paren">()</span>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>backgroundColor</code>
</li>
</ul><span class="paren">)</span>
</div>
@ -191,6 +201,29 @@
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">backgroundColor</code>
<span class="type">Number</span>
<div class="param-description">
<p>the background color of the stage</p>
</div>
</li>
</ul>
</div>
@ -224,20 +257,6 @@
<ul class="index-list methods extends">
<li class="index-item method">
<a href="#method___addChild">__addChild</a>
</li>
<li class="index-item method">
<a href="#method___removeChild">__removeChild</a>
</li>
<li class="index-item method inherited">
<a href="#method_addChild">addChild</a>
@ -257,6 +276,13 @@
</li>
<li class="index-item method">
<a href="#method_setBackgroundColor">setBackgroundColor</a>
</li>
<li class="index-item method">
@ -346,114 +372,6 @@
<h2 class="off-left">Methods</h2>
<div id="method___addChild" class="method item">
<h3 class="name"><code>__addChild</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;pixi_Stage.js.html#l44"><code>pixi&#x2F;Stage.js:44</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method___removeChild" class="method item">
<h3 class="name"><code>__removeChild</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;pixi_Stage.js.html#l63"><code>pixi&#x2F;Stage.js:63</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method_addChild" class="method item inherited">
<h3 class="name"><code>addChild</code></h3>
@ -522,7 +440,7 @@
<div class="param-description">
</div>
@ -612,7 +530,7 @@
<div class="param-description">
</div>
@ -627,7 +545,7 @@
<div class="param-description">
</div>
@ -710,6 +628,93 @@
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_setBackgroundColor" class="method item">
<h3 class="name"><code>setBackgroundColor</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>backgroundColor</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;pixi_Stage.js.html#l44"><code>pixi&#x2F;Stage.js:44</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">backgroundColor</code>
<span class="type">Number</span>
<div class="param-description">
</div>
@ -759,7 +764,7 @@
<a href="..&#x2F;files&#x2F;pixi_Stage.js.html#l26"><code>pixi&#x2F;Stage.js:26</code></a>
<a href="..&#x2F;files&#x2F;pixi_Stage.js.html#l30"><code>pixi&#x2F;Stage.js:30</code></a>
</p>