505 lines
10 KiB
HTML
505 lines
10 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'>App</span>
|
|
»
|
|
<span class='title'>TestMethodDocumentation</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
App.TestMethodDocumentation
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>node_modules/grunt-codo/node_modules/codo/spec/_templates/methods/method_documentation.coffee</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Inherits:</td>
|
|
<td>
|
|
App.Doc
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Class Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#lets_do_it-static'>
|
|
.
|
|
(Boolean)
|
|
<b>lets_do_it</b><span>(it, options)</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='desc'>
|
|
Do it!
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#fetchLimit-dynamic'>
|
|
#
|
|
(?)
|
|
<b>fetchLimit</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Should be overloaded to change fetch limit.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#do-dynamic'>
|
|
#
|
|
(Boolean)
|
|
<b>do</b><span>(it, again, options)</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='desc'>
|
|
Do it!
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#doWithoutSpace-dynamic'>
|
|
#
|
|
(Boolean)
|
|
<b>doWithoutSpace</b><span>(it, again, options)</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='desc'>
|
|
Do it!
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Class Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='lets_do_it-static'>
|
|
.
|
|
(Boolean)
|
|
<b>lets_do_it</b><span>(it, options)</span>
|
|
<span class='note private'>Private</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Do it!</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>it</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The thing to do </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>options</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Object</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The do options </span>
|
|
</li>
|
|
</ul>
|
|
<h3>
|
|
Options Hash:
|
|
(options):
|
|
</h3>
|
|
<ul class='options'>
|
|
<li>
|
|
<span class='name'>speed</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The speed </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>repeat</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Number</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>How wany time to repeat </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>tasks</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Array<Tasks></tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The tasks to do </span>
|
|
</li>
|
|
</ul>
|
|
<h3>Returns:</h3>
|
|
<ul class='return'>
|
|
<li>
|
|
<span class='type'></span>
|
|
(
|
|
<tt>Boolean</tt>
|
|
)
|
|
—
|
|
<span class='desc'>When successful executed </span>
|
|
</li>
|
|
</ul>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='{#undo}'>for more information</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='fetchLimit-dynamic'>
|
|
#
|
|
(?)
|
|
<b>fetchLimit</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Should be overloaded to change fetch limit.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Returns:</h3>
|
|
<ul class='return'>
|
|
<li>
|
|
<span class='type'></span>
|
|
(
|
|
<tt>?</tt>
|
|
)
|
|
—
|
|
<span class='desc'>Number of items per fetch </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='do-dynamic'>
|
|
#
|
|
(Boolean)
|
|
<b>do</b><span>(it, again, options)</span>
|
|
<span class='note private'>Private</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Do it!</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>it</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The thing to do </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>again</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Boolean</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>Do it again </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>options</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Object</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The do options </span>
|
|
</li>
|
|
</ul>
|
|
<h3>
|
|
Options Hash:
|
|
(options):
|
|
</h3>
|
|
<ul class='options'>
|
|
<li>
|
|
<span class='name'>speed</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The speed </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>repeat</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Number</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>How wany time to repeat </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>tasks</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Array<Tasks></tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The tasks to do </span>
|
|
</li>
|
|
</ul>
|
|
<h3>Throws:</h3>
|
|
<ul class='throw'>
|
|
<li>
|
|
<span class='type'></span>
|
|
(
|
|
<tt>TypeError</tt>
|
|
)
|
|
—
|
|
<span class='desc'>when it can't be done </span>
|
|
</li>
|
|
</ul>
|
|
<h3>Returns:</h3>
|
|
<ul class='return'>
|
|
<li>
|
|
<span class='type'></span>
|
|
(
|
|
<tt>Boolean</tt>
|
|
)
|
|
—
|
|
<span class='desc'>When successful executed </span>
|
|
</li>
|
|
</ul>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='#undo'>for more information</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='doWithoutSpace-dynamic'>
|
|
#
|
|
(Boolean)
|
|
<b>doWithoutSpace</b><span>(it, again, options)</span>
|
|
<span class='note private'>Private</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Do it!</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>it</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The thing to do </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>again</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Boolean</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>Do it again </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>options</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Object</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The do options </span>
|
|
</li>
|
|
</ul>
|
|
<h3>
|
|
Options Hash:
|
|
(options):
|
|
</h3>
|
|
<ul class='options'>
|
|
<li>
|
|
<span class='name'>speed</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The speed </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>repeat</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Number</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>How wany time to repeat </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>tasks</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Array<Tasks></tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The tasks to do </span>
|
|
</li>
|
|
</ul>
|
|
<h3>Returns:</h3>
|
|
<ul class='return'>
|
|
<li>
|
|
<span class='type'></span>
|
|
(
|
|
<tt>Boolean</tt>
|
|
)
|
|
—
|
|
<span class='desc'>When successful executed </span>
|
|
</li>
|
|
</ul>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='#undo'>for more information</a>
|
|
</li>
|
|
</ul>
|
|
</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> |