aboutsummaryrefslogtreecommitdiffstats
path: root/lib/eunit/doc/eunit_surefire.html
diff options
context:
space:
mode:
Diffstat (limited to 'lib/eunit/doc/eunit_surefire.html')
-rw-r--r--lib/eunit/doc/eunit_surefire.html78
1 files changed, 78 insertions, 0 deletions
diff --git a/lib/eunit/doc/eunit_surefire.html b/lib/eunit/doc/eunit_surefire.html
new file mode 100644
index 0000000000..f2ecbae572
--- /dev/null
+++ b/lib/eunit/doc/eunit_surefire.html
@@ -0,0 +1,78 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>Module eunit_surefire</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_surefire</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>Surefire reports for EUnit (Format used by Maven and Atlassian
+Bamboo for example to integrate test results).
+<p>Copyright � 2009 Micka�l R�mond, Paul Guyot</p>
+
+<p><b>Behaviours:</b> <a href="eunit_listener.html"><tt>eunit_listener</tt></a>.</p>
+<p><b>Authors:</b> Micka�l R�mond (<a href="mailto:[email protected]"><tt>[email protected]</tt></a>).</p>
+<p><b>See also:</b> <a href="eunit.html">eunit</a>.</p>
+
+<h2><a name="description">Description</a></h2><p>Surefire reports for EUnit (Format used by Maven and Atlassian
+Bamboo for example to integrate test results). Based on initial code
+from Paul Guyot.</p>
+
+ Example: Generate XML result file in the current directory:
+ <pre> eunit:test([fib, eunit_examples],
+ [{report,{eunit_surefire,[{dir,"."}]}}]).</pre>
+<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="#handle_begin-3">handle_begin/3</a></td><td></td></tr>
+<tr><td valign="top"><a href="#handle_cancel-3">handle_cancel/3</a></td><td></td></tr>
+<tr><td valign="top"><a href="#handle_end-3">handle_end/3</a></td><td></td></tr>
+<tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
+<tr><td valign="top"><a href="#start-0">start/0</a></td><td></td></tr>
+<tr><td valign="top"><a href="#start-1">start/1</a></td><td></td></tr>
+<tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr>
+</table>
+
+<h2><a name="functions">Function Details</a></h2>
+
+<h3 class="function"><a name="handle_begin-3">handle_begin/3</a></h3>
+<div class="spec">
+<p><tt>handle_begin(X1, Data, St) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="handle_cancel-3">handle_cancel/3</a></h3>
+<div class="spec">
+<p><tt>handle_cancel(X1, Data, St) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="handle_end-3">handle_end/3</a></h3>
+<div class="spec">
+<p><tt>handle_end(X1, Data, St) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="init-1">init/1</a></h3>
+<div class="spec">
+<p><tt>init(Options) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="start-0">start/0</a></h3>
+<div class="spec">
+<p><tt>start() -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="start-1">start/1</a></h3>
+<div class="spec">
+<p><tt>start(Options) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="terminate-2">terminate/2</a></h3>
+<div class="spec">
+<p><tt>terminate(X1, St) -&gt; any()</tt></p>
+</div>
+<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>