summaryrefslogtreecommitdiffstats
path: root/org/perl8/test/harness/SummaryReporter.html
diff options
context:
space:
mode:
Diffstat (limited to 'org/perl8/test/harness/SummaryReporter.html')
-rw-r--r--org/perl8/test/harness/SummaryReporter.html39
1 files changed, 25 insertions, 14 deletions
diff --git a/org/perl8/test/harness/SummaryReporter.html b/org/perl8/test/harness/SummaryReporter.html
index c1a08b3..364aaf3 100644
--- a/org/perl8/test/harness/SummaryReporter.html
+++ b/org/perl8/test/harness/SummaryReporter.html
@@ -44,7 +44,10 @@
</span>
</h4>
- <div id="comment" class="fullcommenttop"><div class="toggleContainer block">
+ <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Runs a series of tests. The TAP output from these tests is parsed, and
+output is produced which is similar in style to Perl's
+<a href="https://metacpan.org/module/Test::Harness" target="_blank">Test::Harness</a>.
+</p></div><div class="toggleContainer block">
<span class="toggle">Linear Supertypes</span>
<div class="superTypes hiddenContent"><a href="SummarizedTests.html" class="extype" name="org.perl8.test.harness.SummarizedTests">SummarizedTests</a>, <a href="MultiTestReporter.html" class="extype" name="org.perl8.test.harness.MultiTestReporter">MultiTestReporter</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
</div></div>
@@ -320,8 +323,8 @@
</span>
</h4>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
- </li><li name="org.perl8.test.harness.SummaryReporter#printTestSummary" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
- <a id="printTestSummary(success:Boolean,results:Map[String,org.perl8.test.tap.Consumer.TAPResult]):Unit"></a>
+ </li><li name="org.perl8.test.harness.SummaryReporter#printTestSummary" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="printTestSummary(success:Boolean,results:Map[String,org.perl8.test.tap.TAPResult]):Unit"></a>
<a id="printTestSummary(Boolean,Map[String,TAPResult]):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
@@ -329,10 +332,10 @@
<span class="kind">def</span>
</span>
<span class="symbol">
- <span class="name">printTestSummary</span><span class="params">(<span name="success">success: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="results">results: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <a href="../tap/Consumer$$TAPResult.html" class="extype" name="org.perl8.test.tap.Consumer.TAPResult">TAPResult</a>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
+ <span class="name">printTestSummary</span><span class="params">(<span name="success">success: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="results">results: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <a href="../tap/TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4>
-
+ <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd></dl></div>
</li><li name="org.perl8.test.harness.SummaryReporter#run" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="run(testNames:Seq[String]):Int"></a>
<a id="run(Seq[String]):Int"></a>
@@ -345,9 +348,13 @@
<span class="name">run</span><span class="params">(<span name="testNames">testNames: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4>
- <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.harness.SummaryReporter">SummaryReporter</a> → <a href="MultiTestReporter.html" class="extype" name="org.perl8.test.harness.MultiTestReporter">MultiTestReporter</a></dd></dl></div>
- </li><li name="org.perl8.test.harness.SummarizedTests#runOneTest" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
- <a id="runOneTest(test:org.perl8.test.Test,cb:org.perl8.test.tap.TAPEvent=&gt;Unit):org.perl8.test.tap.Consumer.TAPResult"></a>
+ <p class="shortcomment cmt">Runs the test classes identifed by the list of fully qualified class
+names <code>testNames</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Runs the test classes identifed by the list of fully qualified class
+names <code>testNames</code>.
+</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>The exit code for the harness to use. Will be 0 on success.
+</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.harness.SummaryReporter">SummaryReporter</a> → <a href="MultiTestReporter.html" class="extype" name="org.perl8.test.harness.MultiTestReporter">MultiTestReporter</a></dd></dl></div>
+ </li><li name="org.perl8.test.harness.SummarizedTests#runOneTest" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="runOneTest(test:org.perl8.test.Test,cb:org.perl8.test.tap.TAPEvent=&gt;Unit):org.perl8.test.tap.TAPResult"></a>
<a id="runOneTest(Test,(TAPEvent)⇒Unit):TAPResult"></a>
<h4 class="signature">
<span class="modifier_kind">
@@ -355,12 +362,16 @@
<span class="kind">def</span>
</span>
<span class="symbol">
- <span class="name">runOneTest</span><span class="params">(<span name="test">test: <a href="../Test.html" class="extype" name="org.perl8.test.Test">Test</a></span>, <span name="cb">cb: (<a href="../tap/TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a>) ⇒ <span class="extype" name="scala.Unit">Unit</span></span>)</span><span class="result">: <a href="../tap/Consumer$$TAPResult.html" class="extype" name="org.perl8.test.tap.Consumer.TAPResult">TAPResult</a></span>
+ <span class="name">runOneTest</span><span class="params">(<span name="test">test: <a href="../Test.html" class="extype" name="org.perl8.test.Test">Test</a></span>, <span name="cb">cb: (<a href="../tap/TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a>) ⇒ <span class="extype" name="scala.Unit">Unit</span></span>)</span><span class="result">: <a href="../tap/TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a></span>
</span>
</h4>
- <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="SummarizedTests.html" class="extype" name="org.perl8.test.harness.SummarizedTests">SummarizedTests</a></dd></dl></div>
- </li><li name="org.perl8.test.harness.SummaryReporter#runTests" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
- <a id="runTests(testNames:Seq[String]):Map[String,org.perl8.test.tap.Consumer.TAPResult]"></a>
+ <p class="shortcomment cmt">Runs a single <a href="../Test.html" class="extype" name="org.perl8.test.Test">test</a> instance, calling <code>cb</code> with
+each <a href="../tap/TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAP event</a> as it is produced.</p><div class="fullcomment"><div class="comment cmt"><p>Runs a single <a href="../Test.html" class="extype" name="org.perl8.test.Test">test</a> instance, calling <code>cb</code> with
+each <a href="../tap/TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAP event</a> as it is produced.
+</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>The overall result of the test instance.
+</p></dd></dl><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="SummarizedTests.html" class="extype" name="org.perl8.test.harness.SummarizedTests">SummarizedTests</a></dd></dl></div>
+ </li><li name="org.perl8.test.harness.SummaryReporter#runTests" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="runTests(testNames:Seq[String]):Map[String,org.perl8.test.tap.TAPResult]"></a>
<a id="runTests(Seq[String]):Map[String,TAPResult]"></a>
<h4 class="signature">
<span class="modifier_kind">
@@ -368,10 +379,10 @@
<span class="kind">def</span>
</span>
<span class="symbol">
- <span class="name">runTests</span><span class="params">(<span name="testNames">testNames: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result">: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <a href="../tap/Consumer$$TAPResult.html" class="extype" name="org.perl8.test.tap.Consumer.TAPResult">TAPResult</a>]</span>
+ <span class="name">runTests</span><span class="params">(<span name="testNames">testNames: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result">: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <a href="../tap/TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a>]</span>
</span>
</h4>
-
+ <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd></dl></div>
</li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="synchronized[T0](x$1:=&gt;T0):T0"></a>
<a id="synchronized[T0](⇒T0):T0"></a>