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

685 lines
14 KiB
HTML
Raw Normal View History

dwf: added JsDoc files & lots of documentation in the source
2009-06-28 20:25:26 +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</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>
Automatically build jsdocs on rake build tasks
2009-08-28 05:15:50 +00:00
<li><a href="../symbols/jasmine.Block.html">jasmine.Block</a></li>
dwf: added JsDoc files & lots of documentation in the source
2009-06-28 20:25:26 +00:00
dwf: merging in Xian's multi-reporter updates
2009-07-10 04:53:28 +00:00
<li><a href="../symbols/jasmine.Env.html">jasmine.Env</a></li>
Automatically build jsdocs on rake build tasks
2009-08-28 05:15:50 +00:00
<li><a href="../symbols/jasmine.JsApiReporter.html">jasmine.JsApiReporter</a></li>
dwf: merging in Xian's multi-reporter updates
2009-07-10 04:53:28 +00:00
<li><a href="../symbols/jasmine.MultiReporter.html">jasmine.MultiReporter</a></li>
dwf: added JsDoc files & lots of documentation in the source
2009-06-28 20:25:26 +00:00
<li><a href="../symbols/jasmine.NestedResults.html">jasmine.NestedResults</a></li>
dwf: merging in Xian's multi-reporter updates
2009-07-10 04:53:28 +00:00
<li><a href="../symbols/jasmine.Reporter.html">jasmine.Reporter</a></li>
dwf: added JsDoc files & lots of documentation in the source
2009-06-28 20:25:26 +00:00
<li><a href="../symbols/jasmine.Runner.html">jasmine.Runner</a></li>
dwf: merging in Xian's multi-reporter updates
2009-07-10 04:53:28 +00:00
<li><a href="../symbols/jasmine.Spec.html">jasmine.Spec</a></li>
dwf: added JsDoc files & lots of documentation in the source
2009-06-28 20:25:26 +00:00
<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>
</ul>
<hr />
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Namespace jasmine
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
Automatically build jsdocs on rake build tasks
2009-08-28 05:15:50 +00:00
<br /><i>Defined in: </i> <a href="../symbols/src/lib_jasmine-0.9.0.js.html">jasmine-0.9.0.js</a>.
dwf: added JsDoc files & lots of documentation in the source
2009-06-28 20:25:26 +00:00
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jasmine.">
<caption>Namespace 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">
Automatically build jsdocs on rake build tasks
2009-08-28 05:15:50 +00:00
<b><a href="../symbols/jasmine.html">jasmine</a></b>
dwf: added JsDoc files & lots of documentation in the source
2009-06-28 20:25:26 +00:00
</div>
<div class="description">Top level namespace for Jasmine, a lightweight JavaScript BDD/spec/testing framework.</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.">
<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">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">jasmine.<b><a href="../symbols/jasmine.html#.any">any</a></b>(clazz)
</div>
<div class="description">Returns a matchable 'generic' object of the class type.</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#.createSpyObj">createSpyObj</a></b>(baseName, methodNames)
</div>
<div class="description">Creates a more complicated spy: an Object that has every property a function that is a spy.</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#.getEnv">getEnv</a></b>()
</div>
<div class="description">Getter for the 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#.include">include</a></b>(url, opt_global)
</div>
<div class="description">Adds suite files to an HTML document so that they are executed, thus adding them to the current
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#.isDomNode">isDomNode</a></b>(obj)
</div>
<div class="description">Returns true if the object is a DOM Node.</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#.pp">pp</a></b>(value)
</div>
<div class="description">Pretty printer for expecations.</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#.PrettyPrinter">PrettyPrinter</a></b>()
</div>
<div class="description">Base class for pretty printing for expectation results.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Namespace Detail
</div>
<div class="fixedFont">
<b>jasmine</b>
</div>
<div class="description">
Top level namespace for Jasmine, a lightweight JavaScript BDD/spec/testing framework.
</div>
</div>
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name=".any"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>any</b>(clazz)
</div>
<div class="description">
Returns a matchable 'generic' object of the class type. For use in expecations of type when values don't matter.
</div>
<pre class="code">// don't care about which function is passed in, as long as it's a function
expect(mySpy).wasCalledWith(jasmine.any(Function));</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Class}</span> <b>clazz</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd>matchable object of the type clazz</dd>
</dl>
<hr />
<a name=".createSpyObj"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>createSpyObj</b>(baseName, methodNames)
</div>
<div class="description">
Creates a more complicated spy: an Object that has every property a function that is a spy. Used for stubbing something
large in one call.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>baseName</b>
</dt>
<dd>name of spy class</dd>
<dt>
<span class="light fixedFont">{Array}</span> <b>methodNames</b>
</dt>
<dd>array of names of methods to make spies</dd>
</dl>
<hr />
<a name=".getEnv"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>getEnv</b>()
</div>
<div class="description">
Getter for the Jasmine environment. Ensures one gets created
</div>
<hr />
<a name=".include"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>include</b>(url, opt_global)
</div>
<div class="description">
Adds suite files to an HTML document so that they are executed, thus adding them to the current
Jasmine environment.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>url</b>
</dt>
<dd>path to the file to include</dd>
<dt>
<span class="light fixedFont">{Boolean}</span> <b>opt_global</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".isDomNode"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Boolean}</span>
<span class="light">jasmine.</span><b>isDomNode</b>(obj)
</div>
<div class="description">
Returns true if the object is a DOM Node.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>obj</b>
</dt>
<dd>object to check</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Boolean}</span> </dd>
</dl>
<hr />
<a name=".pp"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{String}</span>
<span class="light">jasmine.</span><b>pp</b>(value)
</div>
<div class="description">
Pretty printer for expecations. Takes any object and turns it into a human-readable string.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>value</b>
</dt>
<dd>{Object} an object to be outputted</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{String}</span> </dd>
</dl>
<hr />
<a name=".PrettyPrinter"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">jasmine.</span><b>PrettyPrinter</b>()
</div>
<div class="description">
Base class for pretty printing for expectation results.
</div>
<!-- ============================== event details ========================= -->
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Merged in Xian's speed fixes
2009-09-04 17:57:08 +00:00
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Fri Sep 04 2009 10:56:11 GMT-0700 (PDT)
dwf: added JsDoc files & lots of documentation in the source
2009-06-28 20:25:26 +00:00
</div>
</body>
</html>