279 lines
6.2 KiB
HTML
279 lines
6.2 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset='UTF-8'>
|
|
<title>CoffeeScript API Documentation</title>
|
|
<script src='../../javascript/application.js'></script>
|
|
<script src='../../javascript/search.js'></script>
|
|
<link rel='stylesheet' href='../../stylesheets/application.css' type='text/css'>
|
|
</head>
|
|
<body>
|
|
<div id='base' data-path='../../'></div>
|
|
<div id='header'>
|
|
<div id='menu'>
|
|
<a href='../../extra/README.md.html' title='Yatta'>
|
|
Yatta
|
|
</a>
|
|
»
|
|
<a href='../../alphabetical_index.html' title='Index'>
|
|
Index
|
|
</a>
|
|
»
|
|
<span class='title'>Example</span>
|
|
»
|
|
<span class='title'>Animal</span>
|
|
»
|
|
<span class='title'>Lion</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
Example.Animal.Lion
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>node_modules/grunt-codo/node_modules/codo/spec/_templates/example/src/lion.coffee</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Inherits:</td>
|
|
<td>
|
|
<a href='../../class/Example/Animal.html'>Example.Animal</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Extends:</td>
|
|
<td>
|
|
MissingMixin
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Includes:</td>
|
|
<td>
|
|
<a href='../../mixin/Example/AngryAnimal.html'>Example.AngryAnimal</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<p>A dangerous lion. Take care.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Author:</h3>
|
|
<ul class='author'>
|
|
<li>
|
|
Simba
|
|
</li>
|
|
</ul>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='http://en.wikipedia.org/wiki/Lion'>http://en.wikipedia.org/wiki/Lion</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<h2>Variables Summary</h2>
|
|
<dl class='constants'>
|
|
<dt id='MAX_SPEED-variable'>
|
|
MAX_SPEED
|
|
=
|
|
</dt>
|
|
<dd>
|
|
<pre><code class='coffeescript'>50</code></pre>
|
|
<div class='docstring'>
|
|
<p>Maximum speed in MPH</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</dd>
|
|
</dl>
|
|
<h3 class='inherited'>
|
|
Variable inherited from
|
|
<a href='../../class/Example/Animal.html'>Example.Animal</a>
|
|
</h3>
|
|
<p class='inherited'>
|
|
<a href='../../class/Example/Animal.html#ANSWER-variable'>ANSWER</a>
|
|
</p>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#move-dynamic'>
|
|
#
|
|
(void)
|
|
<b>move</b><span>(direction, speed)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Move the lion fast
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#escape-dynamic'>
|
|
#
|
|
(void)
|
|
<b>escape</b><span>(direction)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Escape at maximum speed.
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>
|
|
<small>Inherited Method Summary</small>
|
|
<h3 class='inherited'>
|
|
Methods inherited from
|
|
<a href='../../class/Example/Animal.html'>Example.Animal</a>
|
|
</h3>
|
|
<p class='inherited'>
|
|
<a href='../../class/Example/Animal.html#move-dynamic'>#move</a>
|
|
<a href='../../class/Example/Animal.html#copulate-dynamic'>#copulate</a>
|
|
<a href='../../class/Example/Animal.html#enterArk-static'>.enterArk</a>
|
|
</p>
|
|
</h2>
|
|
<h2>
|
|
<small>Extended Method Summary</small>
|
|
</h2>
|
|
<h3 class='inherited'>
|
|
Methods extended from
|
|
MissingMixin
|
|
</h3>
|
|
<h2>
|
|
<small>Included Method Summary</small>
|
|
</h2>
|
|
<h3 class='inherited'>
|
|
Methods included from
|
|
<a href='../../mixin/Example/AngryAnimal.html'>Example.AngryAnimal</a>
|
|
</h3>
|
|
<p class='inherited'>
|
|
<a href='../../mixin/Example/AngryAnimal.html#roar-dynamic'>#roar</a>
|
|
</p>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='move-dynamic'>
|
|
#
|
|
(void)
|
|
<b>move</b><span>(direction, speed)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Move the lion fast</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>direction</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>the moving direction </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>speed</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Number</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>the moving speed </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='escape-dynamic'>
|
|
#
|
|
(void)
|
|
<b>escape</b><span>(direction)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Escape at maximum speed.</p><p>@param (see #move)</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id='footer'>
|
|
August 12, 14 06:33:02 by
|
|
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
|
Codo
|
|
</a>
|
|
2.0.9
|
|
✲
|
|
Press H to see the keyboard shortcuts
|
|
✲
|
|
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
|
|
✲
|
|
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
|
|
</div>
|
|
<iframe id='search_frame'></iframe>
|
|
<div id='fuzzySearch'>
|
|
<input type='text'>
|
|
<ol></ol>
|
|
</div>
|
|
<div id='help'>
|
|
<p>
|
|
Quickly fuzzy find classes, mixins, methods, file:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>T</span>
|
|
Open fuzzy finder dialog
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
Control the navigation frame:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>L</span>
|
|
Toggle list view
|
|
</li>
|
|
<li>
|
|
<span>C</span>
|
|
Show class list
|
|
</li>
|
|
<li>
|
|
<span>I</span>
|
|
Show mixin list
|
|
</li>
|
|
<li>
|
|
<span>F</span>
|
|
Show file list
|
|
</li>
|
|
<li>
|
|
<span>M</span>
|
|
Show method list
|
|
</li>
|
|
<li>
|
|
<span>E</span>
|
|
Show extras list
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
You can focus and blur the search input:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>S</span>
|
|
Focus search input
|
|
</li>
|
|
<li>
|
|
<span>Esc</span>
|
|
Blur search input
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html> |