admin/jasmine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documentation for all non-private functions.

Browse Source
This commit is contained in:
Christian Williams
2009-11-10 17:32:29 -05:00
parent ff8b9d8375
commit 2a5754600a
27 changed files with 5027 additions and 228 deletions
Download Patch File Download Diff File Expand all files Collapse all files

558
doc/symbols/jasmine.html
View File

@@ -195,6 +195,8 @@ ul.inheritsList
<li><a href="../symbols/jasmine.Block.html">jasmine.Block</a></li>
<li><a href="../symbols/jasmine.Clock.html">jasmine.Clock</a></li>
<li><a href="../symbols/jasmine.Env.html">jasmine.Env</a></li>
<li><a href="../symbols/jasmine.JsApiReporter.html">jasmine.JsApiReporter</a></li>
@@ -298,6 +300,17 @@ ul.inheritsList
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
jasmine.<b><a href="../symbols/jasmine.html#.Reporters">Reporters</a></b>
</div>
<div class="description">JasmineReporters.reporter
Base object that will get called whenever a Spec, Suite, or Runner is done.</div>
</td>
</tr>
</tbody>
</table>
@@ -328,6 +341,15 @@ ul.inheritsList
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.createSpy">createSpy</a></b>(name)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
@@ -337,6 +359,24 @@ ul.inheritsList
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.ExpectationResult">ExpectationResult</a></b>(params)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.FakeTimer">FakeTimer</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
@@ -365,6 +405,24 @@ Jasmine environment.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.log">log</a></b>(message)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.MessageResult">MessageResult</a></b>(text)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
@@ -383,6 +441,60 @@ Jasmine environment.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.Queue">Queue</a></b>(env)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.StringPrettyPrinter">StringPrettyPrinter</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.TrivialReporter">TrivialReporter</a></b>(doc)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.WaitsBlock">WaitsBlock</a></b>(env, timeout, spec)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.WaitsForBlock">WaitsForBlock</a></b>(env, timeout, latchFunction, message, spec)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.XmlHttpRequest">XmlHttpRequest</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
@@ -470,6 +582,33 @@ Jasmine environment.</div>
<hr />
<a name=".Reporters"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>Reporters</b>
</div>
<div class="description">
JasmineReporters.reporter
Base object that will get called whenever a Spec, Suite, or Runner is done. It is up to
descendants of this object to do something with the results (see json_reporter.js)
<br />
<i>Defined in: </i> <a href="../symbols/src/src_Reporters.js.html">Reporters.js</a>.
</div>
@@ -526,6 +665,42 @@ expect(mySpy).wasCalledWith(jasmine.any(Function));</pre>
<hr />
<a name=".createSpy"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>createSpy</b>(name)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>name</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".createSpyObj"> </a>
@@ -569,6 +744,70 @@ large in one call.
<hr />
<a name=".ExpectationResult"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>ExpectationResult</b>(params)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>params</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".FakeTimer"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>FakeTimer</b>()
</div>
<div class="description">
<br />
<i>Defined in: </i> <a href="../symbols/src/src_mock-timeout.js.html">mock-timeout.js</a>.
</div>
<hr />
<a name=".getEnv"> </a>
@@ -680,6 +919,78 @@ Jasmine environment.
<hr />
<a name=".log"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>log</b>(message)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>message</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".MessageResult"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>MessageResult</b>(text)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>text</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".pp"> </a>
@@ -751,6 +1062,251 @@ Jasmine environment.
<hr />
<a name=".Queue"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>Queue</b>(env)
</div>
<div class="description">
<br />
<i>Defined in: </i> <a href="../symbols/src/src_Queue.js.html">Queue.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>env</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".StringPrettyPrinter"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>StringPrettyPrinter</b>()
</div>
<div class="description">
<br />
<i>Defined in: </i> <a href="../symbols/src/src_PrettyPrinter.js.html">PrettyPrinter.js</a>.
</div>
<hr />
<a name=".TrivialReporter"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>TrivialReporter</b>(doc)
</div>
<div class="description">
<br />
<i>Defined in: </i> <a href="../symbols/src/lib_TrivialReporter.js.html">TrivialReporter.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>doc</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".WaitsBlock"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>WaitsBlock</b>(env, timeout, spec)
</div>
<div class="description">
<br />
<i>Defined in: </i> <a href="../symbols/src/src_WaitsBlock.js.html">WaitsBlock.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>env</b>
</dt>
<dd></dd>
<dt>
<b>timeout</b>
</dt>
<dd></dd>
<dt>
<b>spec</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".WaitsForBlock"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>WaitsForBlock</b>(env, timeout, latchFunction, message, spec)
</div>
<div class="description">
<br />
<i>Defined in: </i> <a href="../symbols/src/src_WaitsForBlock.js.html">WaitsForBlock.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>env</b>
</dt>
<dd></dd>
<dt>
<b>timeout</b>
</dt>
<dd></dd>
<dt>
<b>latchFunction</b>
</dt>
<dd></dd>
<dt>
<b>message</b>
</dt>
<dd></dd>
<dt>
<b>spec</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".XmlHttpRequest"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>XmlHttpRequest</b>()
</div>
<div class="description">
</div>
@@ -765,7 +1321,7 @@ Jasmine environment.
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Tue Nov 10 2009 14:27:06 GMT-0500 (EST)
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Tue Nov 10 2009 17:31:29 GMT-0500 (EST)
</div>
</body>
</html>