677 lines
16 KiB
HTML
677 lines
16 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'>OverDocumentedClass</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
OverDocumentedClass
|
|
<span class='note title'>Abstract</span>
|
|
<span class='deprecated note title'>Deprecated</span>
|
|
<span class='note private title'>Private</span>
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>node_modules/grunt-codo/node_modules/codo/spec/_templates/example/src/over_documented_class.coffee</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Extends:</td>
|
|
<td>
|
|
<a href='../mixin/OverDocumentedMixin.html'>OverDocumentedMixin</a>
|
|
Casper
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Includes:</td>
|
|
<td>
|
|
<a href='../mixin/OverDocumentedMixin.html'>OverDocumentedMixin</a>
|
|
Casper
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<div class='deprecated note'>
|
|
<strong>Deprecated.</strong>
|
|
Don't use this anymore!!11
|
|
</div>
|
|
<div class='abstract note'>
|
|
<strong>
|
|
This
|
|
class
|
|
is abstract.
|
|
</strong>
|
|
It's so abstract! ^_^ <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
<div class='note todo'>
|
|
<strong>TODO:</strong>
|
|
Run with the wolves <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
<div class='note'>
|
|
<strong>Note:</strong>
|
|
Never fortget this thing! <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
<p>This class is SO DOCUMENTED! Seriously, Just look at that! This is so incredible!</p><p>It even has some links: <a href='http://www.google.com'>Google for instance</a> <a href='../class/OverDocumentedClass.html'>OverDocumentedClass</a>
|
|
<a href='../class/OverDocumentedClass.html'>itself</a> <a href='http://www.github.com'>http://www.github.com</a> <a href='../mixin/OverDocumentedMixin.html#mixed_method-'>OverDocumentedMixin~mixed_method</a>
|
|
{Casper The ghost!}</p>
|
|
<div class='examples'>
|
|
<h3>Examples:</h3>
|
|
<h4>
|
|
Foobar
|
|
</h4>
|
|
<pre><code class='coffeescript'>foo = bar</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Author:</h3>
|
|
<ul class='author'>
|
|
<li>
|
|
The great Yoda <a href='http://www.github.com'>http://www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
<h3>Copyright:</h3>
|
|
<ul class='copyright'>
|
|
<li>
|
|
The great Yoda <a href='http://www.github.com'>http://www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
<h3>Since:</h3>
|
|
<ul class='since'>
|
|
<li>
|
|
1.0
|
|
</li>
|
|
</ul>
|
|
<h3>Version:</h3>
|
|
<ul class='version'>
|
|
<li>
|
|
1.1
|
|
</li>
|
|
</ul>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='www.github.com'>www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<h2>Property Summary</h2>
|
|
<dl class='properties'>
|
|
<dt id='clone-property'>
|
|
<span class='signature'>
|
|
(OverDocumentedClass)
|
|
<b>
|
|
clone
|
|
</b>
|
|
</span>
|
|
<span class='note readonly title'>Readonly</span>
|
|
</dt>
|
|
<dd class='desc'>
|
|
Returns the <a href='../class/OverDocumentedClass.html'>clone</a>.
|
|
</dd>
|
|
</dl>
|
|
<h2>Variables Summary</h2>
|
|
<dl class='constants'>
|
|
<dt id='CONSTANT-variable'>
|
|
CONSTANT
|
|
=
|
|
</dt>
|
|
<dd>
|
|
<pre><code class='coffeescript'>{
|
|
foo: 'bar'
|
|
}</code></pre>
|
|
<div class='docstring'>
|
|
<div class='deprecated note'>
|
|
<strong>Deprecated.</strong>
|
|
Don't use this anymore!!11
|
|
</div>
|
|
<div class='abstract note'>
|
|
<strong>
|
|
This
|
|
variable
|
|
is abstract.
|
|
</strong>
|
|
It's so abstract! ^_^ <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
<div class='note todo'>
|
|
<strong>TODO:</strong>
|
|
Run with the wolves <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
<div class='note'>
|
|
<strong>Note:</strong>
|
|
Never fortget this thing! <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
<p>The constant that is SO DOCUMENTED as well (I feel sick about it)</p>
|
|
<div class='examples'>
|
|
<h3>Examples:</h3>
|
|
<h4>
|
|
Foobar
|
|
</h4>
|
|
<pre><code class='coffeescript'>foo = bar</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Author:</h3>
|
|
<ul class='author'>
|
|
<li>
|
|
The great Yoda <a href='http://www.github.com'>http://www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
<h3>Copyright:</h3>
|
|
<ul class='copyright'>
|
|
<li>
|
|
The great Yoda <a href='http://www.github.com'>http://www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
<h3>Since:</h3>
|
|
<ul class='since'>
|
|
<li>
|
|
1.0
|
|
</li>
|
|
</ul>
|
|
<h3>Version:</h3>
|
|
<ul class='version'>
|
|
<li>
|
|
1.1
|
|
</li>
|
|
</ul>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='www.github.com'>www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</dd>
|
|
</dl>
|
|
<h2>Class Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li deprecated>
|
|
<span class='signature'>
|
|
<a href='#class_method-static'>
|
|
.
|
|
(OverDocumentedClass)
|
|
<b>class_method</b><span>(foo, bar, options = {})</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='abstract note title'>Abstract</span>
|
|
<span class='deprecated note title'>Deprecated</span>
|
|
<span class='desc'>
|
|
<strong>Deprecated.</strong>
|
|
Don't use this anymore!!11
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li deprecated>
|
|
<span class='signature'>
|
|
<a href='#instance_method-dynamic'>
|
|
#
|
|
(void)
|
|
<b>instance_method</b><span>(foo, bar)</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='abstract note title'>Abstract</span>
|
|
<span class='deprecated note title'>Deprecated</span>
|
|
<span class='desc'>
|
|
<strong>Deprecated.</strong>
|
|
Don't use this anymore!!11
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#virtual_method-dynamic'>
|
|
#
|
|
(void)
|
|
<b>virtual_method</b><span>({a, b})</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
This is the virtual method ZOMG
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>
|
|
<small>Extended Method Summary</small>
|
|
</h2>
|
|
<h3 class='inherited'>
|
|
Methods extended from
|
|
<a href='../mixin/OverDocumentedMixin.html'>OverDocumentedMixin</a>
|
|
</h3>
|
|
<p class='inherited'>
|
|
<a href='../mixin/OverDocumentedMixin.html#mixed_method-static'>.mixed_method</a>
|
|
<a href='../mixin/OverDocumentedMixin.html#virtual_method-static'>.virtual_method</a>
|
|
</p>
|
|
<h3 class='inherited'>
|
|
Methods extended from
|
|
Casper
|
|
</h3>
|
|
<h2>
|
|
<small>Included Method Summary</small>
|
|
</h2>
|
|
<h3 class='inherited'>
|
|
Methods included from
|
|
<a href='../mixin/OverDocumentedMixin.html'>OverDocumentedMixin</a>
|
|
</h3>
|
|
<p class='inherited'>
|
|
<a href='../mixin/OverDocumentedMixin.html#mixed_method-dynamic'>#mixed_method</a>
|
|
<a href='../mixin/OverDocumentedMixin.html#virtual_method-dynamic'>#virtual_method</a>
|
|
</p>
|
|
<h3 class='inherited'>
|
|
Methods included from
|
|
Casper
|
|
</h3>
|
|
<h2>Class Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='class_method-static'>
|
|
.
|
|
(OverDocumentedClass)
|
|
<b>class_method</b><span>(foo, bar, options = {})</span>
|
|
<span class='note private'>Private</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<div class='deprecated note'>
|
|
<strong>Deprecated.</strong>
|
|
Don't use this anymore!!11
|
|
</div>
|
|
<div class='abstract note'>
|
|
<strong>
|
|
This
|
|
method
|
|
is abstract.
|
|
</strong>
|
|
It's so abstract! ^_^ <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
<div class='note todo'>
|
|
<strong>TODO:</strong>
|
|
Run with the wolves <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
<div class='note'>
|
|
<strong>Note:</strong>
|
|
Never fortget this thing! <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
|
|
<div class='examples'>
|
|
<h3>Examples:</h3>
|
|
<h4>
|
|
Foobar
|
|
</h4>
|
|
<pre><code class='coffeescript'>foo = bar</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>foo</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The first parameter </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>bar</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Integer</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The second parameter (all of a sudden) </span>
|
|
</li>
|
|
</ul>
|
|
<h3>
|
|
Options Hash:
|
|
(options):
|
|
</h3>
|
|
<ul class='options'>
|
|
<li>
|
|
<span class='name'>option</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The only option (wtf?) </span>
|
|
</li>
|
|
</ul>
|
|
<div class='events'>
|
|
<h3>Events:</h3>
|
|
<div class='event'>
|
|
<p class='signature'>
|
|
simpleEvent
|
|
</p>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='event'>
|
|
<p class='signature'>
|
|
notSoSimpleEvent
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Having description</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='event'>
|
|
<p class='signature'>
|
|
complicatedEvent
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Having description and parameters</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>The</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>string </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3>Throws:</h3>
|
|
<ul class='throw'>
|
|
<li>
|
|
<span class='type'></span>
|
|
(
|
|
<tt><a href='../class/OverDocumentedClass.html'>OverDocumentedClass</a></tt>
|
|
)
|
|
—
|
|
<span class='desc'>EXCEPTION OMG </span>
|
|
</li>
|
|
</ul>
|
|
<h3>Returns:</h3>
|
|
<ul class='return'>
|
|
<li>
|
|
<span class='type'></span>
|
|
(
|
|
<tt><a href='../class/OverDocumentedClass.html'>OverDocumentedClass</a></tt>
|
|
)
|
|
—
|
|
<span class='desc'>RETVAL OMG </span>
|
|
</li>
|
|
</ul>
|
|
<h3>Author:</h3>
|
|
<ul class='author'>
|
|
<li>
|
|
The great Yoda <a href='http://www.github.com'>http://www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
<h3>Copyright:</h3>
|
|
<ul class='copyright'>
|
|
<li>
|
|
The great Yoda <a href='http://www.github.com'>http://www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
<h3>Since:</h3>
|
|
<ul class='since'>
|
|
<li>
|
|
1.0
|
|
</li>
|
|
</ul>
|
|
<h3>Version:</h3>
|
|
<ul class='version'>
|
|
<li>
|
|
1.1
|
|
</li>
|
|
</ul>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='www.github.com'>www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='instance_method-dynamic'>
|
|
#
|
|
(void)
|
|
<b>instance_method</b><span>(foo, bar)</span>
|
|
<br>
|
|
#
|
|
(void)
|
|
<b>instance_method</b><span>(foo, bar, options)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<div class='deprecated note'>
|
|
<strong>Deprecated.</strong>
|
|
Don't use this anymore!!11
|
|
</div>
|
|
<div class='abstract note'>
|
|
<strong>
|
|
This
|
|
method
|
|
is abstract.
|
|
</strong>
|
|
It's so abstract! ^_^ <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
<div class='note todo'>
|
|
<strong>TODO:</strong>
|
|
Run with the wolves <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
<div class='note'>
|
|
<strong>Note:</strong>
|
|
Never fortget this thing! <a href='http://www.github.com'>http://www.github.com</a>
|
|
</div>
|
|
|
|
<div class='examples'>
|
|
<h3>Examples:</h3>
|
|
<h4>
|
|
Foobar
|
|
</h4>
|
|
<pre><code class='coffeescript'>foo = bar</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Throws:</h3>
|
|
<ul class='throw'>
|
|
<li>
|
|
<span class='type'></span>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
—
|
|
<span class='desc'>EXCEPTION OMG </span>
|
|
</li>
|
|
</ul>
|
|
<h3>Returns:</h3>
|
|
<ul class='return'>
|
|
<li>
|
|
<span class='type'></span>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
—
|
|
<span class='desc'>RETVAL OMG </span>
|
|
</li>
|
|
</ul>
|
|
<h3>Author:</h3>
|
|
<ul class='author'>
|
|
<li>
|
|
The great Yoda <a href='http://www.github.com'>http://www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
<h3>Copyright:</h3>
|
|
<ul class='copyright'>
|
|
<li>
|
|
The great Yoda <a href='http://www.github.com'>http://www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
<h3>Since:</h3>
|
|
<ul class='since'>
|
|
<li>
|
|
1.0
|
|
</li>
|
|
</ul>
|
|
<h3>Version:</h3>
|
|
<ul class='version'>
|
|
<li>
|
|
1.1
|
|
</li>
|
|
</ul>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='www.github.com'>www.github.com</a>
|
|
</li>
|
|
</ul>
|
|
<div class='overloads'>
|
|
<h3>Overloads:</h3>
|
|
<div class='overload'>
|
|
<p class='signature'>
|
|
#
|
|
(void)
|
|
<b>instance_method</b><span>(foo, bar)</span>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Obviously you can omit the last parameter</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='overload'>
|
|
<p class='signature'>
|
|
#
|
|
(void)
|
|
<b>instance_method</b><span>(foo, bar, options)</span>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Or you can set it!</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='virtual_method-dynamic'>
|
|
#
|
|
(void)
|
|
<b>virtual_method</b><span>({a, b})</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>This is the virtual method ZOMG</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> |