aboutsummaryrefslogblamecommitdiffstats
path: root/lib/eunit/doc/eunit.html
blob: a181d12ce3d39cf55428a053411399a63e0ac859 (plain) (tree)





































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Module eunit</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>

<h1>Module eunit</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>This module is the main EUnit user interface.
<p>Copyright � 2004-2009 Micka�l R�mond, Richard Carlsson</p>

<p><b>Version:</b> 2.1.1, Apr 22 2009 22:37:19</p>
<p><b>Authors:</b> Micka�l R�mond (<a href="mailto:mickael.remond@process-one.net"><tt>mickael.remond@process-one.net</tt></a>) [<em>web site:</em> <tt><a href="http://www.process-one.net/" target="_top">http://www.process-one.net/</a></tt>], Richard Carlsson (<a href="mailto:richardc@it.uu.se"><tt>richardc@it.uu.se</tt></a>) [<em>web site:</em> <tt><a href="http://user.it.uu.se/~richardc/" target="_top">http://user.it.uu.se/~richardc/</a></tt>].</p>

<h2><a name="description">Description</a></h2>This module is the main EUnit user interface.
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#start-0">start/0</a></td><td>Starts the EUnit server.</td></tr>
<tr><td valign="top"><a href="#stop-0">stop/0</a></td><td>Stops the EUnit server.</td></tr>
<tr><td valign="top"><a href="#test-1">test/1</a></td><td>Equivalent to <a href="#test-2"><tt>test(Tests, [])</tt></a>.
</td></tr>
<tr><td valign="top"><a href="#test-2">test/2</a></td><td>Runs a set of tests.</td></tr>
</table>

<h2><a name="functions">Function Details</a></h2>

<h3 class="function"><a name="start-0">start/0</a></h3>
<div class="spec">
<p><tt>start() -&gt; any()</tt></p>
</div><p>Starts the EUnit server. Normally, you don't need to call this
  function; it is started automatically.</p>

<h3 class="function"><a name="stop-0">stop/0</a></h3>
<div class="spec">
<p><tt>stop() -&gt; any()</tt></p>
</div><p>Stops the EUnit server. Normally, you don't need to call this
  function.</p>

<h3 class="function"><a name="test-1">test/1</a></h3>
<div class="spec">
<p><tt>test(Tests) -&gt; any()</tt></p>
</div><p>Equivalent to <a href="#test-2"><tt>test(Tests, [])</tt></a>.</p>


<h3 class="function"><a name="test-2">test/2</a></h3>
<div class="spec">
<p><tt>test(Tests::term(), Options::[term()]) -&gt; ok | {error, term()}</tt></p>
</div><p><p>Runs a set of tests. The format of <code>Tests</code> is described in the
  section <a href="overview-summary.html#EUnit_test_representation">EUnit test
  representation</a> of the overview.</p>
 
  Example: <pre>  eunit:test(fred)</pre><p> runs all tests in the module <code>fred</code>
  and also any tests in the module <code>fred_tests</code>, if that module exists.</p>
 
  Options:
  <dl>
  <dt><code>verbose</code></dt>
  <dd>Displays more details about the running tests.</dd>
  </dl>
 
  Options in the environment variable EUNIT are also included last in
  the option list, i.e., have lower precedence than those in <code>Options</code>.</p>
<p><b>See also:</b> <a href="#test-1">test/1</a>.</p>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Apr 22 2009, 22:37:19.</i></p>
</body>
</html>