warren/jasmine
1
0
Fork 0
Code Issues Pull Requests Actions 1 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
doc/symbols/jasmine.Env.html
+621 -1
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>
@@ -281,6 +283,15 @@ ul.inheritsList
</thead>
<tbody>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#addEqualityTester">addEqualityTester</a></b>(equalityTester)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
@@ -290,6 +301,87 @@ ul.inheritsList
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#afterEach">afterEach</a></b>(afterEachFunction)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#beforeEach">beforeEach</a></b>(beforeEachFunction)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#compareObjects_">compareObjects_</a></b>(a, b, mismatchKeys, mismatchValues)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#contains_">contains_</a></b>(haystack, needle)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#currentRunner">currentRunner</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#describe">describe</a></b>(description, specDefinitions)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#equals_">equals_</a></b>(a, b, mismatchKeys, mismatchValues)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#execute">execute</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#it">it</a></b>(description, func)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
@@ -308,6 +400,15 @@ ul.inheritsList
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#specFilter">specFilter</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
@@ -317,6 +418,24 @@ ul.inheritsList
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#xdescribe">xdescribe</a></b>(desc, specDefinitions)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#xit">xit</a></b>(desc, func)
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
@@ -365,6 +484,42 @@ ul.inheritsList
Method Detail
</div>
<a name="addEqualityTester"> </a>
<div class="fixedFont">
<b>addEqualityTester</b>(equalityTester)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>equalityTester</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="addReporter"> </a>
<div class="fixedFont">
@@ -399,6 +554,362 @@ ul.inheritsList
<hr />
<a name="afterEach"> </a>
<div class="fixedFont">
<b>afterEach</b>(afterEachFunction)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>afterEachFunction</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="beforeEach"> </a>
<div class="fixedFont">
<b>beforeEach</b>(beforeEachFunction)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>beforeEachFunction</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="compareObjects_"> </a>
<div class="fixedFont">
<b>compareObjects_</b>(a, b, mismatchKeys, mismatchValues)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>a</b>
</dt>
<dd></dd>
<dt>
<b>b</b>
</dt>
<dd></dd>
<dt>
<b>mismatchKeys</b>
</dt>
<dd></dd>
<dt>
<b>mismatchValues</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="contains_"> </a>
<div class="fixedFont">
<b>contains_</b>(haystack, needle)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>haystack</b>
</dt>
<dd></dd>
<dt>
<b>needle</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="currentRunner"> </a>
<div class="fixedFont">
<b>currentRunner</b>()
</div>
<div class="description">
</div>
<hr />
<a name="describe"> </a>
<div class="fixedFont">
<b>describe</b>(description, specDefinitions)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>description</b>
</dt>
<dd></dd>
<dt>
<b>specDefinitions</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="equals_"> </a>
<div class="fixedFont">
<b>equals_</b>(a, b, mismatchKeys, mismatchValues)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>a</b>
</dt>
<dd></dd>
<dt>
<b>b</b>
</dt>
<dd></dd>
<dt>
<b>mismatchKeys</b>
</dt>
<dd></dd>
<dt>
<b>mismatchValues</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="execute"> </a>
<div class="fixedFont">
<b>execute</b>()
</div>
<div class="description">
</div>
<hr />
<a name="it"> </a>
<div class="fixedFont">
<b>it</b>(description, func)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>description</b>
</dt>
<dd></dd>
<dt>
<b>func</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="nextSpecId"> </a>
@@ -463,6 +974,31 @@ ul.inheritsList
<hr />
<a name="specFilter"> </a>
<div class="fixedFont">
<b>specFilter</b>()
</div>
<div class="description">
</div>
<hr />
<a name="version"> </a>
@@ -495,6 +1031,90 @@ ul.inheritsList
<hr />
<a name="xdescribe"> </a>
<div class="fixedFont">
<b>xdescribe</b>(desc, specDefinitions)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>desc</b>
</dt>
<dd></dd>
<dt>
<b>specDefinitions</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="xit"> </a>
<div class="fixedFont">
<b>xit</b>(desc, func)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>desc</b>
</dt>
<dd></dd>
<dt>
<b>func</b>
</dt>
<dd></dd>
</dl>
@@ -509,7 +1129,7 @@ ul.inheritsList
<!-- ============================== 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>