github-migration
/
jasmine
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
jasmine/jsdoc/symbols/jasmine.Spec.html

1220 lines
22 KiB
HTML
Raw Normal View History

Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>JsDoc Reference - jasmine.Spec</title>
<style type="text/css">
/* default.css */
body
{
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
width: 800px;
}
.header
{
clear: both;
background-color: #ccc;
padding: 8px;
}
h1
{
font-size: 150%;
font-weight: bold;
padding: 0;
margin: 1em 0 0 .3em;
}
hr
{
border: none 0;
border-top: 1px solid #7F8FB1;
height: 1px;
}
pre.code
{
display: block;
padding: 8px;
border: 1px dashed #ccc;
}
#index
{
margin-top: 24px;
float: left;
width: 160px;
position: absolute;
left: 8px;
background-color: #F3F3F3;
padding: 8px;
}
#content
{
margin-left: 190px;
width: 600px;
}
.classList
{
list-style-type: none;
padding: 0;
margin: 0 0 0 8px;
font-family: arial, sans-serif;
font-size: 1em;
overflow: auto;
}
.classList li
{
padding: 0;
margin: 0 0 8px 0;
}
.summaryTable { width: 100%; }
h1.classTitle
{
font-size:170%;
line-height:130%;
}
h2 { font-size: 110%; }
caption, div.sectionTitle
{
background-color: #7F8FB1;
color: #fff;
font-size:130%;
text-align: left;
padding: 2px 6px 2px 6px;
border: 1px #7F8FB1 solid;
}
div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }
.summaryTable td
{
vertical-align: top;
padding: 4px;
border-bottom: 1px #7F8FB1 solid;
border-right: 1px #7F8FB1 solid;
}
/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
border-left: 1px #7F8FB1 solid;
width: 140px;
text-align: right;
}
td.attributes, .fixedFont
{
line-height: 15px;
color: #002EBE;
font-family: "Courier New",Courier,monospace;
font-size: 13px;
}
.summaryTable td.nameDescription
{
text-align: left;
font-size: 13px;
line-height: 15px;
}
.summaryTable td.nameDescription, .description
{
line-height: 15px;
padding: 4px;
padding-left: 4px;
}
.summaryTable { margin-bottom: 8px; }
ul.inheritsList
{
list-style: square;
margin-left: 20px;
padding-left: 0;
}
.detailList {
margin-left: 20px;
line-height: 15px;
}
.detailList dt { margin-left: 20px; }
.detailList .heading
{
font-weight: bold;
padding-bottom: 6px;
margin-left: 0;
}
.light, td.attributes, .light a:link, .light a:visited
{
color: #777;
font-style: italic;
}
.fineprint
{
text-align: right;
font-size: 10px;
}
</style>
</head>
<body>
<!-- ============================== header ================================= -->
<!-- begin static/header.html -->
<div id="header">
</div>
<!-- end static/header.html -->
<!-- ============================== classes index ============================ -->
<div id="index">
<!-- begin publish.classesIndex -->
<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
<li><a href="../symbols/jasmine.html">jasmine</a></li>
<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>
<li><a href="../symbols/jasmine.Matchers.html">jasmine.Matchers</a></li>
<li><a href="../symbols/jasmine.MultiReporter.html">jasmine.MultiReporter</a></li>
<li><a href="../symbols/jasmine.NestedResults.html">jasmine.NestedResults</a></li>
<li><a href="../symbols/jasmine.Reporter.html">jasmine.Reporter</a></li>
<li><a href="../symbols/jasmine.Runner.html">jasmine.Runner</a></li>
<li><a href="../symbols/jasmine.Spec.html">jasmine.Spec</a></li>
<li><a href="../symbols/jasmine.Spy.html">jasmine.Spy</a></li>
<li><a href="../symbols/jasmine.Suite.html">jasmine.Suite</a></li>
<li><a href="../symbols/jasmine.util.html">jasmine.util</a></li>
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<li><a href="../symbols/jasmine.WaitsForBlock.html">jasmine.WaitsForBlock</a></li>
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</ul>
<hr />
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Class jasmine.Spec
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br /><i>Defined in: </i> <a href="../symbols/src/src_Spec.js.html">Spec.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jasmine.Spec.">
<caption>Class Summary</caption>
<thead>
<tr>
<th scope="col">Constructor Attributes</th>
<th scope="col">Constructor Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/jasmine.Spec.html">jasmine.Spec</a></b>(env, suite, description)
</div>
<div class="description">Internal representation of a Jasmine specification, or test.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jasmine.Spec.">
<caption>Method Summary</caption>
<thead>
<tr>
<th scope="col">Method Attributes</th>
<th scope="col">Method Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#addBeforesAndAftersToQueue">addBeforesAndAftersToQueue</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.Spec.html#addMatcherResult">addMatcherResult</a></b>(result)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#addMatchers">addMatchers</a></b>(matchersPrototype)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#addToQueue">addToQueue</a></b>(block)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#after">after</a></b>(doAfter)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#execute">execute</a></b>(onComplete)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#expect">expect</a></b>(actual)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#explodes">explodes</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.Spec.html#fail">fail</a></b>(e)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#finish">finish</a></b>(onComplete)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#finishCallback">finishCallback</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.Spec.html#getFullName">getFullName</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.Spec.html#getMatchersClass_">getMatchersClass_</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.Spec.html#log">log</a></b>()
</div>
<div class="description">All parameters are pretty-printed and concatenated together, then written to the spec's output.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#removeAllSpies">removeAllSpies</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.Spec.html#results">results</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.Spec.html#runs">runs</a></b>(func)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#spyOn">spyOn</a></b>(obj, methodName, ignoreMethodDoesntExist)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#waits">waits</a></b>(timeout)
</div>
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<div class="description">Waits a fixed time period before moving to the next block.</div>
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<div class="fixedFont"><b><a href="../symbols/jasmine.Spec.html#waitsFor">waitsFor</a></b>(latchFunction, optional_timeoutMessage, optional_timeout)
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</div>
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<div class="description">Waits for the latchFunction to return true before proceeding to the next block.</div>
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Class Detail
</div>
<div class="fixedFont">
<b>jasmine.Spec</b>(env, suite, description)
</div>
<div class="description">
Internal representation of a Jasmine specification, or test.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/jasmine.Env.html">jasmine.Env</a>}</span> <b>env</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/jasmine.Suite.html">jasmine.Suite</a>}</span> <b>suite</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{String}</span> <b>description</b>
</dt>
<dd></dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name="addBeforesAndAftersToQueue"> </a>
<div class="fixedFont">
<b>addBeforesAndAftersToQueue</b>()
</div>
<div class="description">
</div>
<hr />
<a name="addMatcherResult"> </a>
<div class="fixedFont">
<b>addMatcherResult</b>(result)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/jasmine.html#.ExpectationResult">jasmine.ExpectationResult</a>}</span> <b>result</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="addMatchers"> </a>
<div class="fixedFont">
<b>addMatchers</b>(matchersPrototype)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>matchersPrototype</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="addToQueue"> </a>
<div class="fixedFont">
<b>addToQueue</b>(block)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>block</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="after"> </a>
<div class="fixedFont">
<b>after</b>(doAfter)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>doAfter</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="execute"> </a>
<div class="fixedFont">
<b>execute</b>(onComplete)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>onComplete</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="expect"> </a>
<div class="fixedFont">
<b>expect</b>(actual)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>actual</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="explodes"> </a>
<div class="fixedFont">
<b>explodes</b>()
</div>
<div class="description">
</div>
<hr />
<a name="fail"> </a>
<div class="fixedFont">
<b>fail</b>(e)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>e</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="finish"> </a>
<div class="fixedFont">
<b>finish</b>(onComplete)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>onComplete</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="finishCallback"> </a>
<div class="fixedFont">
<b>finishCallback</b>()
</div>
<div class="description">
</div>
<hr />
<a name="getFullName"> </a>
<div class="fixedFont">
<b>getFullName</b>()
</div>
<div class="description">
</div>
<hr />
<a name="getMatchersClass_"> </a>
<div class="fixedFont">
<b>getMatchersClass_</b>()
</div>
<div class="description">
</div>
<hr />
<a name="log"> </a>
<div class="fixedFont">
<b>log</b>()
</div>
<div class="description">
All parameters are pretty-printed and concatenated together, then written to the spec's output.
Be careful not to leave calls to <code>jasmine.log</code> in production code.
</div>
<hr />
<a name="removeAllSpies"> </a>
<div class="fixedFont">
<b>removeAllSpies</b>()
</div>
<div class="description">
</div>
<hr />
<a name="results"> </a>
<div class="fixedFont">
<b>results</b>()
</div>
<div class="description">
</div>
<hr />
<a name="runs"> </a>
<div class="fixedFont">
<b>runs</b>(func)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>func</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="spyOn"> </a>
<div class="fixedFont">
<b>spyOn</b>(obj, methodName, ignoreMethodDoesntExist)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>obj</b>
</dt>
<dd></dd>
<dt>
<b>methodName</b>
</dt>
<dd></dd>
<dt>
<b>ignoreMethodDoesntExist</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="waits"> </a>
<div class="fixedFont">
<b>waits</b>(timeout)
</div>
<div class="description">
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
Waits a fixed time period before moving to the next block.
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<span class="light fixedFont">{Number}</span> <b>timeout</b>
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</dt>
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<dd>milliseconds to wait</dd>
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</dl>
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<dl class="detailList">
<dt class="heading">Deprecated:</dt>
<dt>
Use waitsFor() instead
</dt>
</dl>
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
<hr />
<a name="waitsFor"> </a>
<div class="fixedFont">
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<b>waitsFor</b>(latchFunction, optional_timeoutMessage, optional_timeout)
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</div>
<div class="description">
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
Waits for the latchFunction to return true before proceeding to the next block.
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<span class="light fixedFont">{Function}</span> <b>latchFunction</b>
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</dt>
<dd></dd>
<dt>
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<span class="light fixedFont">{String}</span> <b>optional_timeoutMessage</b>
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</dt>
<dd></dd>
<dt>
Regenerate docs for 1.0.0RC1.
2010-08-26 01:23:19 +00:00
<span class="light fixedFont">{Number}</span> <b>optional_timeout</b>
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</dt>
<dd></dd>
</dl>
<!-- ============================== event details ========================= -->
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Build dist for 1.0.1.
2010-10-05 20:49:50 +00:00
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Tue Oct 05 2010 13:37:01 GMT-0700 (PDT)
Add jsdoc to pages.
2010-06-25 23:06:40 +00:00
</div>
</body>
</html>