diff options
| author | Jesse Luehrs <doy@tozt.net> | 2013-03-04 16:07:14 -0600 |
|---|---|---|
| committer | Jesse Luehrs <doy@tozt.net> | 2013-03-04 16:07:14 -0600 |
| commit | 6af4f35d83a18f9c5939e22e13f6bac0a5e28d11 (patch) | |
| tree | 87fa1c80505683f415f64b0c865ddcd467e767c4 | |
| parent | d756dfb61fbd78df938e8070be570eaa5aa9d610 (diff) | |
| download | scala-test-more-6af4f35d83a18f9c5939e22e13f6bac0a5e28d11.tar.gz scala-test-more-6af4f35d83a18f9c5939e22e13f6bac0a5e28d11.zip | |
doc update
40 files changed, 398 insertions, 1052 deletions
diff --git a/index/index-d.html b/index/index-d.html index 530d95d..f7d68c6 100644 --- a/index/index-d.html +++ b/index/index-d.html @@ -21,7 +21,7 @@ <div class="name">diag</div> <div class="occurrences"><a href="../org/perl8/test/tap/TestBuilder.html" class="extype" name="org.perl8.test.tap.TestBuilder">TestBuilder</a> <a href="../org/perl8/test/TestMore.html" class="extype" name="org.perl8.test.TestMore">TestMore</a> </div> </div><div class="entry"> - <div class="name">Directive</div> + <div class="name">directive</div> <div class="occurrences"><a href="../org/perl8/test/tap/package.html" class="extype" name="org.perl8.test.tap">tap</a> <a href="../org/perl8/test/tap/TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a> </div> </div><div class="entry"> <div class="name">doneTesting</div> diff --git a/index/index-e.html b/index/index-e.html index 73ed8e7..b4416ee 100644 --- a/index/index-e.html +++ b/index/index-e.html @@ -12,9 +12,6 @@ </head> <body><div class="entry"> - <div class="name">Elem</div> - <div class="occurrences"><a href="../org/perl8/test/tap/Parser.html" class="extype" name="org.perl8.test.tap.Parser">Parser</a> </div> - </div><div class="entry"> <div class="name">EndEvent</div> <div class="occurrences"><a href="../org/perl8/test/tap/package.html" class="extype" name="org.perl8.test.tap">tap</a> </div> </div><div class="entry"> diff --git a/index/index-o.html b/index/index-o.html index ce41850..3103b10 100644 --- a/index/index-o.html +++ b/index/index-o.html @@ -15,9 +15,6 @@ <div class="name">ok</div> <div class="occurrences"><a href="../org/perl8/test/tap/TestBuilder.html" class="extype" name="org.perl8.test.tap.TestBuilder">TestBuilder</a> <a href="../org/perl8/test/TestMore.html" class="extype" name="org.perl8.test.TestMore">TestMore</a> </div> </div><div class="entry"> - <div class="name">okTodo</div> - <div class="occurrences"><a href="../org/perl8/test/tap/TestBuilder.html" class="extype" name="org.perl8.test.tap.TestBuilder">TestBuilder</a> </div> - </div><div class="entry"> <div class="name">org</div> <div class="occurrences"><a href="../package.html" class="extype" name="_root_">root</a> </div> </div></body> diff --git a/index/index-t.html b/index/index-t.html index 0c93bdc..9f9aae0 100644 --- a/index/index-t.html +++ b/index/index-t.html @@ -13,7 +13,7 @@ </head> <body><div class="entry"> <div class="name">tap</div> - <div class="occurrences"><a href="../org/perl8/test/package.html" class="extype" name="org.perl8.test">test</a> <a href="../org/perl8/test/tap/Parser.html" class="extype" name="org.perl8.test.tap.Parser">Parser</a> </div> + <div class="occurrences"><a href="../org/perl8/test/package.html" class="extype" name="org.perl8.test">test</a> </div> </div><div class="entry"> <div class="name">TAPEvent</div> <div class="occurrences"><a href="../org/perl8/test/tap/package.html" class="extype" name="org.perl8.test.tap">tap</a> </div> @@ -52,7 +52,7 @@ <div class="occurrences"><a href="../org/perl8/test/tap/CommentEvent.html" class="extype" name="org.perl8.test.tap.CommentEvent">CommentEvent</a> <a href="../org/perl8/test/tap/Consumer$$CommentLine.html" class="extype" name="org.perl8.test.tap.Consumer.CommentLine">CommentLine</a> </div> </div><div class="entry"> <div class="name">todo</div> - <div class="occurrences"><a href="../org/perl8/test/TestMore.html" class="extype" name="org.perl8.test.TestMore">TestMore</a> </div> + <div class="occurrences"><a href="../org/perl8/test/tap/TestBuilder.html" class="extype" name="org.perl8.test.tap.TestBuilder">TestBuilder</a> <a href="../org/perl8/test/TestMore.html" class="extype" name="org.perl8.test.TestMore">TestMore</a> </div> </div><div class="entry"> <div class="name">TodoDirective</div> <div class="occurrences"><a href="../org/perl8/test/tap/package.html" class="extype" name="org.perl8.test.tap">tap</a> </div> diff --git a/org/perl8/test/ExternalTest.html b/org/perl8/test/ExternalTest.html index 903d08b..b456520 100644 --- a/org/perl8/test/ExternalTest.html +++ b/org/perl8/test/ExternalTest.html @@ -44,7 +44,14 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Runs an external process which emits TAP, and parses it as a test.</p><p>This test class can be used if you have existing tests that you would like +to be able to include in a test suite using this framework. You just need +to write a test class for each external test that looks like this:</p><pre><span class="kw">class</span> MyTest1 <span class="kw">extends</span> ExternalTest(<span class="lit">"perl"</span>, <span class="lit">"t/basic.t"</span>)</pre><p>This will run your external process, and use its TAP stream as its output. +This will allow it to, for instance, be a part of the test suite that runs +via <code>sbt test</code>. As with any other test class, its stdout and stderr will +be sent to <code>Console.out</code> and <code>Console.err</code>, where they can be overridden +as needed. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><a href="Test.html" class="extype" name="org.perl8.test.Test">Test</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -360,7 +367,7 @@ Console.err, so you can swap these out as required in order to parse it. stderr, where they are typically displayed as-is) prefix the message with a newline, to ensure that the output starts on its own line. </p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Test.html" class="extype" name="org.perl8.test.Test">Test</a></dd></dl></div> - </li><li name="org.perl8.test.ExternalTest#runTests" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> + </li><li name="org.perl8.test.ExternalTest#runTests" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="runTests(raw:Boolean):Int"></a> <a id="runTests(Boolean):Int"></a> <h4 class="signature"> @@ -372,7 +379,7 @@ Console.err, so you can swap these out as required in order to parse it. <span class="name">runTests</span><span class="params">(<span name="raw">raw: <span class="extype" name="scala.Boolean">Boolean</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.ExternalTest">ExternalTest</a> → <a href="Test.html" class="extype" name="org.perl8.test.Test">Test</a></dd></dl></div> + <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.ExternalTest">ExternalTest</a> → <a href="Test.html" class="extype" name="org.perl8.test.Test">Test</a></dd></dl></div> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> diff --git a/org/perl8/test/TestMore.html b/org/perl8/test/TestMore.html index 2d86c14..2451df0 100644 --- a/org/perl8/test/TestMore.html +++ b/org/perl8/test/TestMore.html @@ -184,19 +184,6 @@ </span> </h4> - </li><li name="org.perl8.test.TestMore#BAIL_OUT" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="BAIL_OUT:Unit"></a> - <a id="BAIL_OUT:Unit"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">BAIL_OUT</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - </li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="asInstanceOf[T0]:T0"></a> <a id="asInstanceOf[T0]:T0"></a> @@ -620,19 +607,6 @@ Console.err, so you can swap these out as required in order to parse it. </span> </h4> - </li><li name="org.perl8.test.TestMore#skip" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="skip(count:Int)(body:=>Unit):Unit"></a> - <a id="skip(Int)(⇒Unit):Unit"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">skip</span><span class="params">(<span name="count">count: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="params">(<span name="body">body: ⇒ <span class="extype" name="scala.Unit">Unit</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - </li><li name="org.perl8.test.TestMore#subtest" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="subtest(name:String,plan:org.perl8.test.Plan)(body:=>Unit):Boolean"></a> <a id="subtest(String,Plan)(⇒Unit):Boolean"></a> diff --git a/org/perl8/test/harness/MultiTestReporter.html b/org/perl8/test/harness/MultiTestReporter.html index e2b35c4..20561d4 100644 --- a/org/perl8/test/harness/MultiTestReporter.html +++ b/org/perl8/test/harness/MultiTestReporter.html @@ -46,8 +46,9 @@ <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Classes that implement <code>MultiTestReporter</code> are capable of running a group of test classes, given their names. This typically involves some sort of -summarization.</p><p>See also: <a href="" class="extype" name="org.perl8.test.harness.MultiTestReporter">org.perl8.test.harness.MultiTestReporter</a>. -</p></div><div class="toggleContainer block"> +summarization. +</p></div><dl class="attributes block"> <dt>See also</dt><dd><span class="cmt"><p><a href="Reporter.html" class="extype" name="org.perl8.test.harness.Reporter">Reporter</a>. +</p></span></dd></dl><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div><div class="toggleContainer block"> diff --git a/org/perl8/test/harness/Reporter.html b/org/perl8/test/harness/Reporter.html index dac6223..865c1f2 100644 --- a/org/perl8/test/harness/Reporter.html +++ b/org/perl8/test/harness/Reporter.html @@ -45,8 +45,9 @@ </h4> <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Classes that implement <code>Reporter</code> are capable of running a test class, -given its name.</p><p>See also: <a href="MultiTestReporter.html" class="extype" name="org.perl8.test.harness.MultiTestReporter">org.perl8.test.harness.MultiTestReporter</a>. -</p></div><div class="toggleContainer block"> +given its name. +</p></div><dl class="attributes block"> <dt>See also</dt><dd><span class="cmt"><p><a href="MultiTestReporter.html" class="extype" name="org.perl8.test.harness.MultiTestReporter">MultiTestReporter</a>. +</p></span></dd></dl><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div><div class="toggleContainer block"> diff --git a/org/perl8/test/harness/TestHarness$.html b/org/perl8/test/harness/TestHarness$.html index 3b80990..6bee01e 100644 --- a/org/perl8/test/harness/TestHarness$.html +++ b/org/perl8/test/harness/TestHarness$.html @@ -44,7 +44,28 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>This is the entry point to running tests written with this library from +the command line. Note that this library also implements the +<a href="https://github.com/harrah/test-interface" target="_blank">common testing interface</a> for +test libraries, so tests should also just work with <code>sbt test</code>.</p><p>If this application is run and given just a single test class name, it +will run that test and write its TAP stream to the console.</p><pre>$ scala org.perl8.test.harness.TestHarness MyTest +ok <span class="num">1</span> +ok <span class="num">2</span> +<span class="num">1.</span><span class="num">.2</span></pre><p>If this application is run and given multiple test class names, it will +run each of those tests, and present a summary report, similar to the one +produces by +<a href="https://metacpan.org/module/Test::Harness" target="_blank">Perl's Test::Harness</a>.</p><pre>$ scala org.perl8.test.harness.TestHarness MyTest1 MyTest2 +MyTest1 .. ok +MyTest2 .. ok +All tests successful. +Files=<span class="num">2</span>, Tests=<span class="num">4</span> +Result: PASS</pre><p>This application also accepts a few command line options to customize its +behavior:</p><ul><li><code>-r</code>: Alternative <a href="Reporter.html" class="extype" name="org.perl8.test.harness.Reporter">Reporter</a> class to + use for running a single test.</li><li><code>-R</code>: Alternative + <a href="MultiTestReporter.html" class="extype" name="org.perl8.test.harness.MultiTestReporter">MultiTestReporter</a> + class to use for running a group of tests. Also enables using the + MultiTestReporter for a single test.</li><li><code>--help</code>: Prints usage information. +</li></ul></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -277,7 +298,7 @@ <span class="name">main</span><span class="params">(<span name="args">args: <span class="extype" name="scala.Array">Array</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> </span> </h4> - + <p class="shortcomment cmt">Entry point for the harness application.</p> </li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="ne(x$1:AnyRef):Boolean"></a> <a id="ne(AnyRef):Boolean"></a> @@ -317,7 +338,7 @@ </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.TestHarness#parseOpts" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.harness.TestHarness#parseOpts" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="parseOpts(args:List[String]):Map[String,Any]"></a> <a id="parseOpts(List[String]):Map[String,Any]"></a> <h4 class="signature"> @@ -329,7 +350,7 @@ <span class="name">parseOpts</span><span class="params">(<span name="args">args: <span class="extype" name="scala.List">List</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>, <span class="extype" name="scala.Any">Any</span>]</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:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> @@ -356,7 +377,7 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> - </li><li name="org.perl8.test.harness.TestHarness#usage" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.harness.TestHarness#usage" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="usage(exitCode:Int):Nothing"></a> <a id="usage(Int):Nothing"></a> <h4 class="signature"> @@ -368,7 +389,7 @@ <span class="name">usage</span><span class="params">(<span name="exitCode">exitCode: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Nothing">Nothing</span></span> </span> </h4> - + <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd></dl></div> </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="wait():Unit"></a> <a id="wait():Unit"></a> diff --git a/org/perl8/test/harness/package.html b/org/perl8/test/harness/package.html index 42e3e6b..ce046e1 100644 --- a/org/perl8/test/harness/package.html +++ b/org/perl8/test/harness/package.html @@ -44,8 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Classes to handle running test instances and providing output. -</p></div><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Classes to handle running test instances and providing output.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -173,7 +172,8 @@ given its name.</p> <a href="TestHarness$.html"><span class="name">TestHarness</span></a> </span> </h4> - + <p class="comment cmt">This is the entry point to running tests written with this library from +the command line.</p> </li><li name="org.perl8.test.harness.package#loadClass" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="loadClass[T](className:String)(implicitevidence$1:scala.reflect.ClassTag[T]):Class[_]"></a> <a id="loadClass[T](String)(ClassTag[T]):Class[_]"></a> @@ -187,7 +187,7 @@ given its name.</p> </span> </h4> <p class="shortcomment cmt">Loads <code>className</code>, returning the -<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html" target="_blank">java.lang.Class</a> +<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html" target="_blank">Class</a> instance.</p> </li><li name="org.perl8.test.harness.package#newInstance" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="newInstance[T,U<:AnyRef](className:String,arg:U)(implicitevidence$3:scala.reflect.ClassTag[T],implicitevidence$4:scala.reflect.ClassTag[U]):T"></a> diff --git a/org/perl8/test/package$$BailOutException.html b/org/perl8/test/package$$BailOutException.html index 3b8d897..94a3fce 100644 --- a/org/perl8/test/package$$BailOutException.html +++ b/org/perl8/test/package$$BailOutException.html @@ -44,7 +44,9 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Exception thrown when a test bails out. Corresponds to +<code>Bail out! [message]</code> in TAP. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <span class="extype" name="java.lang.RuntimeException">RuntimeException</span>, <span class="extype" name="java.lang.Exception">Exception</span>, <span class="extype" name="java.lang.Throwable">Throwable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> diff --git a/org/perl8/test/package$$NoPlan$.html b/org/perl8/test/package$$NoPlan$.html index 1d6f339..fa0279c 100644 --- a/org/perl8/test/package$$NoPlan$.html +++ b/org/perl8/test/package$$NoPlan$.html @@ -44,7 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A test which did not declare a plan yet.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -303,7 +303,8 @@ <span class="name">plan</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.NoPlan">NoPlan</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> + <p class="shortcomment cmt"> How many tests will be run.</p><div class="fullcomment"><div class="comment cmt"><p> How many tests will be run.</p><p>Always 0 for this class. +</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.NoPlan">NoPlan</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> </li><li name="org.perl8.test.NoPlan#skipAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="skipAll:None.type"></a> <a id="skipAll:None.type"></a> @@ -316,7 +317,9 @@ <span class="name">skipAll</span><span class="result">: <span class="extype" name="scala.None">None</span>.type</span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.NoPlan">NoPlan</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> + <p class="shortcomment cmt"> Whether this test was skipped.</p><div class="fullcomment"><div class="comment cmt"><p> Whether this test was skipped. It should contain <code>Some(message)</code> if +the test is skipped, and <code>None</code> otherwise.</p><p>Always <code>None</code> for this class. +</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.NoPlan">NoPlan</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> diff --git a/org/perl8/test/package$$NumericPlan.html b/org/perl8/test/package$$NumericPlan.html index d09b832..4230e6d 100644 --- a/org/perl8/test/package$$NumericPlan.html +++ b/org/perl8/test/package$$NumericPlan.html @@ -44,7 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>An explicit plan number. Corresponds to <code>1..5</code> in TAP.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -306,7 +306,7 @@ <span class="name">plan</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.NumericPlan">NumericPlan</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> + <p class="shortcomment cmt">How many tests will be run.</p><div class="fullcomment"><div class="comment cmt"><p>How many tests will be run.</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.NumericPlan">NumericPlan</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> </li><li name="org.perl8.test.NumericPlan#skipAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="skipAll:None.type"></a> <a id="skipAll:None.type"></a> @@ -319,7 +319,9 @@ <span class="name">skipAll</span><span class="result">: <span class="extype" name="scala.None">None</span>.type</span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.NumericPlan">NumericPlan</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> + <p class="shortcomment cmt"> Whether this test was skipped.</p><div class="fullcomment"><div class="comment cmt"><p> Whether this test was skipped. It should contain <code>Some(message)</code> if +the test is skipped, and <code>None</code> otherwise.</p><p>Always <code>None</code> for this class. +</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.NumericPlan">NumericPlan</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> diff --git a/org/perl8/test/package$$Plan.html b/org/perl8/test/package$$Plan.html index d8dd8fc..70b68bb 100644 --- a/org/perl8/test/package$$Plan.html +++ b/org/perl8/test/package$$Plan.html @@ -44,7 +44,9 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A test plan. This represents the TAP statement telling how many tests +will be run. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div><div class="toggleContainer block"> @@ -103,8 +105,8 @@ <span class="name">plan</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> </span> </h4> - - </li><li name="org.perl8.test.Plan#skipAll" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> + <p class="shortcomment cmt">How many tests will be run.</p> + </li><li name="org.perl8.test.Plan#skipAll" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped"> <a id="skipAll:Option[String]"></a> <a id="skipAll:Option[String]"></a> <h4 class="signature"> @@ -116,7 +118,9 @@ <span class="name">skipAll</span><span class="result">: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Predef.String">String</span>]</span> </span> </h4> - + <p class="shortcomment cmt">Whether this test was skipped.</p><div class="fullcomment"><div class="comment cmt"><p>Whether this test was skipped. It should contain <code>Some(message)</code> if +the test is skipped, and <code>None</code> otherwise. +</p></div></div> </li></ol> </div> diff --git a/org/perl8/test/package$$SkipAll.html b/org/perl8/test/package$$SkipAll.html index 58023cf..0122b80 100644 --- a/org/perl8/test/package$$SkipAll.html +++ b/org/perl8/test/package$$SkipAll.html @@ -44,7 +44,9 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A test which has declared that the entire test has been skipped. +Corresponds to <code>1..0 # SKIP [message]</code> in TAP. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -319,7 +321,8 @@ <span class="name">plan</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.SkipAll">SkipAll</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> + <p class="shortcomment cmt"> How many tests will be run.</p><div class="fullcomment"><div class="comment cmt"><p> How many tests will be run.</p><p>Always 0 for this class. +</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.SkipAll">SkipAll</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> </li><li name="org.perl8.test.SkipAll#skipAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="skipAll:Some[String]"></a> <a id="skipAll:Some[String]"></a> @@ -332,7 +335,9 @@ <span class="name">skipAll</span><span class="result">: <span class="extype" name="scala.Some">Some</span>[<span class="extype" name="scala.Predef.String">String</span>]</span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.SkipAll">SkipAll</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> + <p class="shortcomment cmt"> Whether this test was skipped.</p><div class="fullcomment"><div class="comment cmt"><p> Whether this test was skipped. It should contain <code>Some(message)</code> if +the test is skipped, and <code>None</code> otherwise.</p><p>Never <code>None</code> for this class. +</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.SkipAll">SkipAll</a> → <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></dd></dl></div> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> diff --git a/org/perl8/test/package.html b/org/perl8/test/package.html index bc373e0..eaf77f2 100644 --- a/org/perl8/test/package.html +++ b/org/perl8/test/package.html @@ -98,7 +98,7 @@ <a href="package$$BailOutException.html"><span class="name">BailOutException</span></a><span class="params">(<span name="message">message: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <span class="extype" name="java.lang.RuntimeException">RuntimeException</span> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">Exception thrown when a test bails out.</p> </li><li name="org.perl8.test.ExternalTest" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="ExternalTestextendsTest"></a> <a id="ExternalTest:ExternalTest"></a> @@ -111,7 +111,7 @@ <a href="ExternalTest.html"><span class="name">ExternalTest</span></a><span class="result"> extends <a href="Test.html" class="extype" name="org.perl8.test.Test">Test</a></span> </span> </h4> - + <p class="comment cmt">Runs an external process which emits TAP, and parses it as a test.</p> </li><li name="org.perl8.test.NumericPlan" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="NumericPlanextendspackage.PlanwithProductwithSerializable"></a> <a id="NumericPlan:NumericPlan"></a> @@ -124,7 +124,7 @@ <a href="package$$NumericPlan.html"><span class="name">NumericPlan</span></a><span class="params">(<span name="plan">plan: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result"> extends <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">An explicit plan number.</p> </li><li name="org.perl8.test.Plan" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> <a id="PlanextendsObject"></a> <a id="Plan:Plan"></a> @@ -137,7 +137,7 @@ <a href="package$$Plan.html"><span class="name">Plan</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> </span> </h4> - + <p class="comment cmt">A test plan.</p> </li><li name="org.perl8.test.SkipAll" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="SkipAllextendspackage.PlanwithProductwithSerializable"></a> <a id="SkipAll:SkipAll"></a> @@ -150,7 +150,7 @@ <a href="package$$SkipAll.html"><span class="name">SkipAll</span></a><span class="params">(<span name="message">message: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">A test which has declared that the entire test has been skipped.</p> </li><li name="org.perl8.test.Test" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> <a id="TestextendsObject"></a> <a id="Test:Test"></a> @@ -196,7 +196,7 @@ <a href="package$$NoPlan$.html"><span class="name">NoPlan</span></a><span class="result"> extends <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">A test which did not declare a plan yet.</p> </li><li name="org.perl8.test.harness" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="harness"></a> <a id="harness:harness"></a> @@ -222,7 +222,9 @@ <span class="name">intToPlan</span><span class="params">(<span name="p">p: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <a href="package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span> </span> </h4> - + <p class="shortcomment cmt">Converts an +<a href="http://www.scala-lang.org/api/current/index.html#scala.Int" target="_blank">Int</a> to a +<a href="package$$NumericPlan.html" class="extype" name="org.perl8.test.NumericPlan">NumericPlan</a>.</p> </li><li name="org.perl8.test.sbt" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="sbt"></a> <a id="sbt:sbt"></a> diff --git a/org/perl8/test/sbt/SBTReporter.html b/org/perl8/test/sbt/SBTReporter.html index 6f4bd6c..27842ff 100644 --- a/org/perl8/test/sbt/SBTReporter.html +++ b/org/perl8/test/sbt/SBTReporter.html @@ -44,8 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Runs a single test under the SBT test harness. -</p></div><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Runs a single test under the SBT test harness.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><a href="../harness/SummarizedTests.html" class="extype" name="org.perl8.test.harness.SummarizedTests">SummarizedTests</a>, <a href="../harness/Reporter.html" class="extype" name="org.perl8.test.harness.Reporter">Reporter</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> diff --git a/org/perl8/test/sbt/package.html b/org/perl8/test/sbt/package.html index 6a41b05..e371f60 100644 --- a/org/perl8/test/sbt/package.html +++ b/org/perl8/test/sbt/package.html @@ -44,8 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Classes for interoperating with <code>sbt test</code>. -</p></div><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Classes for interoperating with <code>sbt test</code>.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> diff --git a/org/perl8/test/tap/CommentEvent.html b/org/perl8/test/tap/CommentEvent.html index 284512f..0cf77bb 100644 --- a/org/perl8/test/tap/CommentEvent.html +++ b/org/perl8/test/tap/CommentEvent.html @@ -40,11 +40,11 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <span class="name">CommentEvent</span><span class="params">(<span name="text">text: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <span class="name">CommentEvent</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A comment (currently unused).</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -82,23 +82,7 @@ <div id="template"> <div id="allMembers"> - <div id="constructors" class="members"> - <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.CommentEvent#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="<init>(text:String):org.perl8.test.tap.CommentEvent"></a> - <a id="<init>:CommentEvent"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">new</span> - </span> - <span class="symbol"> - <span class="name">CommentEvent</span><span class="params">(<span name="text">text: <span class="extype" name="scala.Predef.String">String</span></span>)</span> - </span> - </h4> - - </li></ol> - </div> + diff --git a/org/perl8/test/tap/Consumer$$CommentLine.html b/org/perl8/test/tap/Consumer$$CommentLine.html index 365c9e5..61f27dd 100644 --- a/org/perl8/test/tap/Consumer$$CommentLine.html +++ b/org/perl8/test/tap/Consumer$$CommentLine.html @@ -40,11 +40,12 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <span class="name">CommentLine</span><span class="params">(<span name="text">text: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="indent">indent: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <span class="name">CommentLine</span><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A parsed TAP line containing a comment. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -82,23 +83,7 @@ <div id="template"> <div id="allMembers"> - <div id="constructors" class="members"> - <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.Consumer.CommentLine#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="<init>(text:String,indent:String):org.perl8.test.tap.Consumer.CommentLine"></a> - <a id="<init>:CommentLine"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">new</span> - </span> - <span class="symbol"> - <span class="name">CommentLine</span><span class="params">(<span name="text">text: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="indent">indent: <span class="extype" name="scala.Predef.String">String</span></span>)</span> - </span> - </h4> - - </li></ol> - </div> + @@ -212,7 +197,7 @@ <span class="name">contents</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.CommentLine">CommentLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> + <p class="shortcomment cmt">The meaningful portion of the TAP line.</p><div class="fullcomment"><div class="comment cmt"><p>The meaningful portion of the TAP line.</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.CommentLine">CommentLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="eq(x$1:AnyRef):Boolean"></a> <a id="eq(AnyRef):Boolean"></a> @@ -267,7 +252,7 @@ <span class="name">indent</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.CommentLine">CommentLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> + <p class="shortcomment cmt">The indentation of the TAP line (used in subtests).</p><div class="fullcomment"><div class="comment cmt"><p>The indentation of the TAP line (used in subtests).</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.CommentLine">CommentLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> </li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="isInstanceOf[T0]:Boolean"></a> <a id="isInstanceOf[T0]:Boolean"></a> @@ -345,7 +330,7 @@ <span class="name">text</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - + <p class="shortcomment cmt">The text of the comment (not including the <code>#</code>).</p> </li><li name="org.perl8.test.tap.Consumer.Line#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="toString():String"></a> <a id="toString():String"></a> @@ -358,7 +343,7 @@ <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> → AnyRef → Any</dd></dl></div> + <p class="shortcomment cmt">The line itself that was parsed.</p><div class="fullcomment"><div class="comment cmt"><p>The line itself that was parsed.</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> → AnyRef → Any</dd></dl></div> </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="wait():Unit"></a> <a id="wait():Unit"></a> diff --git a/org/perl8/test/tap/Consumer$$Line.html b/org/perl8/test/tap/Consumer$$Line.html index 222c180..04a55f2 100644 --- a/org/perl8/test/tap/Consumer$$Line.html +++ b/org/perl8/test/tap/Consumer$$Line.html @@ -44,7 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>The representation of a parsed line of TAP.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div><div class="toggleContainer block"> @@ -103,7 +103,7 @@ <span class="name">contents</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - + <p class="shortcomment cmt">The meaningful portion of the TAP line.</p> </li><li name="org.perl8.test.tap.Consumer.Line#indent" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> <a id="indent:String"></a> <a id="indent:String"></a> @@ -116,7 +116,7 @@ <span class="name">indent</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - + <p class="shortcomment cmt">The indentation of the TAP line (used in subtests).</p> </li></ol> </div> @@ -361,7 +361,7 @@ <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> → AnyRef → Any</dd></dl></div> + <p class="shortcomment cmt">The line itself that was parsed.</p><div class="fullcomment"><div class="comment cmt"><p>The line itself that was parsed.</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> → AnyRef → Any</dd></dl></div> </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="wait():Unit"></a> <a id="wait():Unit"></a> diff --git a/org/perl8/test/tap/Consumer$$PlanLine.html b/org/perl8/test/tap/Consumer$$PlanLine.html index 7afea28..6f24ff9 100644 --- a/org/perl8/test/tap/Consumer$$PlanLine.html +++ b/org/perl8/test/tap/Consumer$$PlanLine.html @@ -40,11 +40,12 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <span class="name">PlanLine</span><span class="params">(<span name="plan">plan: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span>, <span name="indent">indent: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <span class="name">PlanLine</span><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A parsed TAP line containing a test plan. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -82,23 +83,7 @@ <div id="template"> <div id="allMembers"> - <div id="constructors" class="members"> - <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.Consumer.PlanLine#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="<init>(plan:org.perl8.test.Plan,indent:String):org.perl8.test.tap.Consumer.PlanLine"></a> - <a id="<init>:PlanLine"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">new</span> - </span> - <span class="symbol"> - <span class="name">PlanLine</span><span class="params">(<span name="plan">plan: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span>, <span name="indent">indent: <span class="extype" name="scala.Predef.String">String</span></span>)</span> - </span> - </h4> - - </li></ol> - </div> + @@ -212,7 +197,7 @@ <span class="name">contents</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.PlanLine">PlanLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> + <p class="shortcomment cmt">The meaningful portion of the TAP line.</p><div class="fullcomment"><div class="comment cmt"><p>The meaningful portion of the TAP line.</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.PlanLine">PlanLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="eq(x$1:AnyRef):Boolean"></a> <a id="eq(AnyRef):Boolean"></a> @@ -267,7 +252,7 @@ <span class="name">indent</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.PlanLine">PlanLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> + <p class="shortcomment cmt">The indentation of the TAP line (used in subtests).</p><div class="fullcomment"><div class="comment cmt"><p>The indentation of the TAP line (used in subtests).</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.PlanLine">PlanLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> </li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="isInstanceOf[T0]:Boolean"></a> <a id="isInstanceOf[T0]:Boolean"></a> @@ -332,7 +317,7 @@ <span class="name">plan</span><span class="result">: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span> </span> </h4> - + <p class="shortcomment cmt">The <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a> that this line represents.</p> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> @@ -358,7 +343,7 @@ <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> → AnyRef → Any</dd></dl></div> + <p class="shortcomment cmt">The line itself that was parsed.</p><div class="fullcomment"><div class="comment cmt"><p>The line itself that was parsed.</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> → AnyRef → Any</dd></dl></div> </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="wait():Unit"></a> <a id="wait():Unit"></a> diff --git a/org/perl8/test/tap/Consumer$$ResultLine.html b/org/perl8/test/tap/Consumer$$ResultLine.html index 48d49d0..e06e754 100644 --- a/org/perl8/test/tap/Consumer$$ResultLine.html +++ b/org/perl8/test/tap/Consumer$$ResultLine.html @@ -40,11 +40,12 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <span class="name">ResultLine</span><span class="params">(<span name="result">result: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span>, <span name="indent">indent: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <span class="name">ResultLine</span><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A parsed TAP line containing a test result. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -82,23 +83,7 @@ <div id="template"> <div id="allMembers"> - <div id="constructors" class="members"> - <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.Consumer.ResultLine#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="<init>(result:org.perl8.test.tap.TestResult,indent:String):org.perl8.test.tap.Consumer.ResultLine"></a> - <a id="<init>:ResultLine"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">new</span> - </span> - <span class="symbol"> - <span class="name">ResultLine</span><span class="params">(<span name="result">result: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span>, <span name="indent">indent: <span class="extype" name="scala.Predef.String">String</span></span>)</span> - </span> - </h4> - - </li></ol> - </div> + @@ -212,7 +197,7 @@ <span class="name">contents</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.ResultLine">ResultLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> + <p class="shortcomment cmt">The meaningful portion of the TAP line.</p><div class="fullcomment"><div class="comment cmt"><p>The meaningful portion of the TAP line.</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.ResultLine">ResultLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="eq(x$1:AnyRef):Boolean"></a> <a id="eq(AnyRef):Boolean"></a> @@ -267,7 +252,7 @@ <span class="name">indent</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.ResultLine">ResultLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> + <p class="shortcomment cmt">The indentation of the TAP line (used in subtests).</p><div class="fullcomment"><div class="comment cmt"><p>The indentation of the TAP line (used in subtests).</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Consumer.ResultLine">ResultLine</a> → <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></dd></dl></div> </li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="isInstanceOf[T0]:Boolean"></a> <a id="isInstanceOf[T0]:Boolean"></a> @@ -332,7 +317,8 @@ <span class="name">result</span><span class="result">: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span> </span> </h4> - + <p class="shortcomment cmt">The <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a> that this + line represents.</p> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> @@ -358,7 +344,7 @@ <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> → AnyRef → Any</dd></dl></div> + <p class="shortcomment cmt">The line itself that was parsed.</p><div class="fullcomment"><div class="comment cmt"><p>The line itself that was parsed.</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> → AnyRef → Any</dd></dl></div> </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="wait():Unit"></a> <a id="wait():Unit"></a> diff --git a/org/perl8/test/tap/Consumer$.html b/org/perl8/test/tap/Consumer$.html index 5c7e36e..dee22a0 100644 --- a/org/perl8/test/tap/Consumer$.html +++ b/org/perl8/test/tap/Consumer$.html @@ -44,7 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Contains a method to parse an individual line of TAP.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -95,10 +95,10 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <a href="Consumer$$CommentLine.html"><span class="name">CommentLine</span></a><span class="params">(<span name="text">text: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="indent">indent: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <a href="Consumer$$CommentLine.html"><span class="name">CommentLine</span></a><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">A parsed TAP line containing a comment.</p> </li><li name="org.perl8.test.tap.Consumer.Line" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> <a id="LineextendsObject"></a> <a id="Line:Line"></a> @@ -111,7 +111,7 @@ <a href="Consumer$$Line.html"><span class="name">Line</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> </span> </h4> - + <p class="comment cmt">The representation of a parsed line of TAP.</p> </li><li name="org.perl8.test.tap.Consumer.PlanLine" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="PlanLineextendsConsumer.LinewithProductwithSerializable"></a> <a id="PlanLine:PlanLine"></a> @@ -121,10 +121,10 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <a href="Consumer$$PlanLine.html"><span class="name">PlanLine</span></a><span class="params">(<span name="plan">plan: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span>, <span name="indent">indent: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <a href="Consumer$$PlanLine.html"><span class="name">PlanLine</span></a><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">A parsed TAP line containing a test plan.</p> </li><li name="org.perl8.test.tap.Consumer.ResultLine" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="ResultLineextendsConsumer.LinewithProductwithSerializable"></a> <a id="ResultLine:ResultLine"></a> @@ -134,10 +134,10 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <a href="Consumer$$ResultLine.html"><span class="name">ResultLine</span></a><span class="params">(<span name="result">result: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span>, <span name="indent">indent: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <a href="Consumer$$ResultLine.html"><span class="name">ResultLine</span></a><span class="result"> extends <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">A parsed TAP line containing a test result.</p> </li></ol> </div> @@ -359,7 +359,7 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> - </li><li name="org.perl8.test.tap.Consumer#parseLine" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.Consumer#parseLine" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="parseLine(line:String):org.perl8.test.tap.Consumer.Line"></a> <a id="parseLine(String):Line"></a> <h4 class="signature"> @@ -371,7 +371,10 @@ <span class="name">parseLine</span><span class="params">(<span name="line">line: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></span> </span> </h4> - + <p class="shortcomment cmt">Parses a line of TAP.</p><div class="fullcomment"><div class="comment cmt"><p>Parses a line of TAP. +</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>A <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a> object corresponding + to the parsed line. +</p></dd></dl></div> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> diff --git a/org/perl8/test/tap/Directive.html b/org/perl8/test/tap/Directive.html index d585a90..cf2f232 100644 --- a/org/perl8/test/tap/Directive.html +++ b/org/perl8/test/tap/Directive.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>A modifier associated with a test result. This is indicated by a <code>#</code> at +the end of the result line, followed by the type of directive, and an +optional message. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div><div class="toggleContainer block"> diff --git a/org/perl8/test/tap/EndEvent.html b/org/perl8/test/tap/EndEvent.html index 0fff1ed..76d83ef 100644 --- a/org/perl8/test/tap/EndEvent.html +++ b/org/perl8/test/tap/EndEvent.html @@ -40,11 +40,11 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <span class="name">EndEvent</span><span class="params">(<span name="result">result: <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a></span>)</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <span class="name">EndEvent</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>The end of a TAP stream.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -82,23 +82,7 @@ <div id="template"> <div id="allMembers"> - <div id="constructors" class="members"> - <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.EndEvent#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="<init>(result:org.perl8.test.tap.TAPResult):org.perl8.test.tap.EndEvent"></a> - <a id="<init>:EndEvent"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">new</span> - </span> - <span class="symbol"> - <span class="name">EndEvent</span><span class="params">(<span name="result">result: <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a></span>)</span> - </span> - </h4> - - </li></ol> - </div> + @@ -294,7 +278,7 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> - </li><li name="org.perl8.test.tap.EndEvent#result" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.EndEvent#result" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="result:org.perl8.test.tap.TAPResult"></a> <a id="result:TAPResult"></a> <h4 class="signature"> @@ -306,7 +290,14 @@ <span class="name">result</span><span class="result">: <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a></span> </span> </h4> - + <p class="shortcomment cmt">The <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a> containing + information about all of the tests which just finished + running.</p><div class="fullcomment"><div class="comment cmt"><p>The <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a> containing + information about all of the tests which just finished + running. This will be the same thing that is returned by the + call to <a href="Parser.html" class="extype" name="org.perl8.test.tap.Parser">Parser</a>'s <code>parse</code> + method. +</p></div></div> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> diff --git a/org/perl8/test/tap/Parser.html b/org/perl8/test/tap/Parser.html index 388297c..bc9dc2c 100644 --- a/org/perl8/test/tap/Parser.html +++ b/org/perl8/test/tap/Parser.html @@ -40,13 +40,16 @@ <span class="kind">class</span> </span> <span class="symbol"> - <span class="name">Parser</span><span class="result"> extends <span class="extype" name="scala.util.parsing.combinator.Parsers">Parsers</span></span> + <span class="name">Parser</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>This class parses a TAP stream. It can either parse it all at once (from a +string), or it can be used as a streaming parser, where TAP events are +emitted through a given callback. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> - <div class="superTypes hiddenContent"><span class="extype" name="scala.util.parsing.combinator.Parsers">Parsers</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> + <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -64,7 +67,7 @@ <span class="filtertype">Inherited<br /> </span> <ol id="linearization"> - <li class="in" name="org.perl8.test.tap.Parser"><span>Parser</span></li><li class="in" name="scala.util.parsing.combinator.Parsers"><span>Parsers</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li> + <li class="in" name="org.perl8.test.tap.Parser"><span>Parser</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li> </ol> </div><div id="ancestors"> <span class="filtertype"></span> @@ -84,9 +87,9 @@ <div id="allMembers"> <div id="constructors" class="members"> <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.Parser#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <ol><li name="org.perl8.test.tap.Parser#<init>" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="<init>(cb:org.perl8.test.tap.TAPEvent=>Unit):org.perl8.test.tap.Parser"></a> - <a id="<init>:tap.Parser"></a> + <a id="<init>:Parser"></a> <h4 class="signature"> <span class="modifier_kind"> <span class="modifier"></span> @@ -96,144 +99,15 @@ <span class="name">Parser</span><span class="params">(<span name="cb">cb: (<a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a>) ⇒ <span class="extype" name="scala.Unit">Unit</span> = <span class="symbol">e => ()</span></span>)</span> </span> </h4> - + <p class="shortcomment cmt">Creates a parser instance.</p><div class="fullcomment"><div class="comment cmt"><p>Creates a parser instance.</p></div><dl class="paramcmts block"><dt class="param">cb</dt><dd class="cmt"><p>The event handler callback. It will be called after each + meaningful line of TAP, with a + <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> instance representing + the event that was just parsed. +</p></dd></dl></div> </li></ol> </div> - <div id="types" class="types members"> - <h3>Type Members</h3> - <ol><li name="org.perl8.test.tap.Parser.Elem" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="Elem=org.perl8.test.tap.Consumer.Line"></a> - <a id="Elem:Elem"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">type</span> - </span> - <span class="symbol"> - <span class="name">Elem</span><span class="result"> = <a href="Consumer$$Line.html" class="extype" name="org.perl8.test.tap.Consumer.Line">Line</a></span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.perl8.test.tap.Parser">Parser</a> → Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers.Error" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="ErrorextendsParsers.this.NoSuccesswithProductwithSerializable"></a> - <a id="Error:Error"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">case class</span> - </span> - <span class="symbol"> - <span class="name">Error</span><span class="result"> extends <span class="extype" name="scala.util.parsing.combinator.Parsers.NoSuccess">NoSuccess</span> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers.Failure" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="FailureextendsParsers.this.NoSuccesswithProductwithSerializable"></a> - <a id="Failure:Failure"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">case class</span> - </span> - <span class="symbol"> - <span class="name">Failure</span><span class="result"> extends <span class="extype" name="scala.util.parsing.combinator.Parsers.NoSuccess">NoSuccess</span> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers.Input" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="Input=scala.util.parsing.input.Reader[Parsers.this.Elem]"></a> - <a id="Input:Input"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">type</span> - </span> - <span class="symbol"> - <span class="name">Input</span><span class="result"> = <span class="extype" name="scala.util.parsing.input.Reader">Reader</span>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers.NoSuccess" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped"> - <a id="NoSuccessextendsParsers.this.ParseResult[Nothing]"></a> - <a id="NoSuccess:NoSuccess"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier">sealed abstract </span> - <span class="kind">class</span> - </span> - <span class="symbol"> - <span class="name">NoSuccess</span><span class="result"> extends <span class="extype" name="scala.util.parsing.combinator.Parsers.ParseResult">ParseResult</span>[<span class="extype" name="scala.Nothing">Nothing</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers.OnceParser" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped"> - <a id="OnceParser[+T<:<?>]extendsParsers.this.Parser[T]"></a> - <a id="OnceParser[+T]:OnceParser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">trait</span> - </span> - <span class="symbol"> - <span class="name">OnceParser</span><span class="tparams">[<span name="T">+T</span>]</span><span class="result"> extends <span class="extype" name="scala.util.parsing.combinator.Parsers.Parser">Parser</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.OnceParser.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers.ParseResult" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped"> - <a id="ParseResult[+T]extendsObject"></a> - <a id="ParseResult[+T]:ParseResult[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier">sealed abstract </span> - <span class="kind">class</span> - </span> - <span class="symbol"> - <span class="name">ParseResult</span><span class="tparams">[<span name="T">+T</span>]</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers.Parser" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped"> - <a id="Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]"></a> - <a id="Parser[+T]:Parser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier">abstract </span> - <span class="kind">class</span> - </span> - <span class="symbol"> - <span class="name">Parser</span><span class="tparams">[<span name="T">+T</span>]</span><span class="result"> extends (<span class="extype" name="scala.util.parsing.combinator.Parsers.Input">Input</span>) ⇒ <span class="extype" name="scala.util.parsing.combinator.Parsers.ParseResult">ParseResult</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.Parser.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers.Success" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="Success[+T]extendsParsers.this.ParseResult[T]withProductwithSerializable"></a> - <a id="Success[+T]:Success[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">case class</span> - </span> - <span class="symbol"> - <span class="name">Success</span><span class="tparams">[<span name="T">+T</span>]</span><span class="result"> extends <span class="extype" name="scala.util.parsing.combinator.Parsers.ParseResult">ParseResult</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.Success.T">T</span>] with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers.~" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="~[+a,+b]extendsProductwithSerializable"></a> - <a id="~[+a,+b]:~[a,b]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">case class</span> - </span> - <span class="symbol"> - <span title="gt4s: $tilde" class="name">~</span><span class="tparams">[<span name="a">+a</span>, <span name="b">+b</span>]</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li></ol> - </div> + @@ -304,110 +178,6 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#OnceParser" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="OnceParser[T<:<?>](f:<?>):Parsers.this.Parser[T]withParsers.this.OnceParser[T]"></a> - <a id="OnceParser[T]((Input)⇒ParseResult[T]):Parser[T]withOnceParser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">OnceParser</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="f">f: (<a href="#Input=scala.util.parsing.input.Reader[Parsers.this.Elem]" class="extmbr" name="org.perl8.test.tap.Parser.Input">Input</a>) ⇒ <a href="#ParseResult[+T]extendsObject" class="extmbr" name="org.perl8.test.tap.Parser.ParseResult">ParseResult</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.OnceParser.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.OnceParser.T">T</span>] with <a href="#OnceParser[+T]extendsParsers.this.Parser[T]" class="extmbr" name="org.perl8.test.tap.Parser.OnceParser">OnceParser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.OnceParser.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#Parser" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="Parser[T](f:Parsers.this.Input=>Parsers.this.ParseResult[T]):Parsers.this.Parser[T]"></a> - <a id="Parser[T]((Input)⇒ParseResult[T]):Parser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">Parser</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="f">f: (<a href="#Input=scala.util.parsing.input.Reader[Parsers.this.Elem]" class="extmbr" name="org.perl8.test.tap.Parser.Input">Input</a>) ⇒ <a href="#ParseResult[+T]extendsObject" class="extmbr" name="org.perl8.test.tap.Parser.ParseResult">ParseResult</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.Parser.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.Parser.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#accept" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="accept[U<:<?>](expected:<?>,f:<?>):Parsers.this.Parser[U]"></a> - <a id="accept[U](String,PartialFunction[Elem,U]):Parser[U]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">accept</span><span class="tparams">[<span name="U">U</span>]</span><span class="params">(<span name="expected">expected: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="f">f: <span class="extype" name="scala.PartialFunction">PartialFunction</span>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>, <span class="extype" name="scala.util.parsing.combinator.Parsers.accept.U">U</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.accept.U">U</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#accept" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="accept[ES<:<?>](es:<?>)(implicitevidence$1:<?>):Parsers.this.Parser[List[Parsers.this.Elem]]"></a> - <a id="accept[ES](ES)((ES)⇒List[Elem]):Parser[List[Elem]]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">accept</span><span class="tparams">[<span name="ES">ES</span>]</span><span class="params">(<span name="es">es: <span class="extype" name="scala.util.parsing.combinator.Parsers.accept.ES">ES</span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="arg0">arg0: (<span class="extype" name="scala.util.parsing.combinator.Parsers.accept.ES">ES</span>) ⇒ <span class="extype" name="scala.List">List</span>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.List">List</span>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>]]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#accept" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="accept(e:Parsers.this.Elem):Parsers.this.Parser[Parsers.this.Elem]"></a> - <a id="accept(Elem):Parser[Elem]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier">implicit </span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">accept</span><span class="params">(<span name="e">e: <a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a></span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#acceptIf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="acceptIf(p:<?>)(err:<?>):Parsers.this.Parser[Parsers.this.Elem]"></a> - <a id="acceptIf((Elem)⇒Boolean)((Elem)⇒String):Parser[Elem]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">acceptIf</span><span class="params">(<span name="p">p: (<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>) ⇒ <span class="extype" name="scala.Boolean">Boolean</span></span>)</span><span class="params">(<span name="err">err: (<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>) ⇒ <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#acceptMatch" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="acceptMatch[U<:<?>](expected:<?>,f:<?>):Parsers.this.Parser[U]"></a> - <a id="acceptMatch[U](String,PartialFunction[Elem,U]):Parser[U]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">acceptMatch</span><span class="tparams">[<span name="U">U</span>]</span><span class="params">(<span name="expected">expected: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="f">f: <span class="extype" name="scala.PartialFunction">PartialFunction</span>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>, <span class="extype" name="scala.util.parsing.combinator.Parsers.acceptMatch.U">U</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.acceptMatch.U">U</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#acceptSeq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="acceptSeq[ES<:<?>](es:<?>)(implicitevidence$2:<?>):Parsers.this.Parser[List[Parsers.this.Elem]]"></a> - <a id="acceptSeq[ES](ES)((ES)⇒Iterable[Elem]):Parser[List[Elem]]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">acceptSeq</span><span class="tparams">[<span name="ES">ES</span>]</span><span class="params">(<span name="es">es: <span class="extype" name="scala.util.parsing.combinator.Parsers.acceptSeq.ES">ES</span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="arg0">arg0: (<span class="extype" name="scala.util.parsing.combinator.Parsers.acceptSeq.ES">ES</span>) ⇒ <span class="extype" name="scala.Iterable">Iterable</span>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.List">List</span>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>]]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> </li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="asInstanceOf[T0]:T0"></a> <a id="asInstanceOf[T0]:T0"></a> @@ -421,45 +191,6 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#chainl1" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="chainl1[T<:<?>,U<:<?>](first:<?>,p:<?>,q:<?>):Parsers.this.Parser[T]"></a> - <a id="chainl1[T,U](⇒Parser[T],⇒Parser[U],⇒Parser[(T,U)⇒T]):Parser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">chainl1</span><span class="tparams">[<span name="T">T</span>, <span name="U">U</span>]</span><span class="params">(<span name="first">first: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.T">T</span>]</span>, <span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.U">U</span>]</span>, <span name="q">q: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[(<span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.T">T</span>, <span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.U">U</span>) ⇒ <span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#chainl1" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="chainl1[T<:<?>](p:<?>,q:<?>):Parsers.this.Parser[T]"></a> - <a id="chainl1[T](⇒Parser[T],⇒Parser[(T,T)⇒T]):Parser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">chainl1</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.T">T</span>]</span>, <span name="q">q: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[(<span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.T">T</span>, <span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.T">T</span>) ⇒ <span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.chainl1.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#chainr1" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="chainr1[T<:<?>,U<:<?>](p:<?>,q:<?>,combine:<?>,first:<?>):Parsers.this.Parser[U]"></a> - <a id="chainr1[T,U](⇒Parser[T],⇒Parser[(T,U)⇒U],(T,U)⇒U,U):Parser[U]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">chainr1</span><span class="tparams">[<span name="T">T</span>, <span name="U">U</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.chainr1.T">T</span>]</span>, <span name="q">q: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[(<span class="extype" name="scala.util.parsing.combinator.Parsers.chainr1.T">T</span>, <span class="extype" name="scala.util.parsing.combinator.Parsers.chainr1.U">U</span>) ⇒ <span class="extype" name="scala.util.parsing.combinator.Parsers.chainr1.U">U</span>]</span>, <span name="combine">combine: (<span class="extype" name="scala.util.parsing.combinator.Parsers.chainr1.T">T</span>, <span class="extype" name="scala.util.parsing.combinator.Parsers.chainr1.U">U</span>) ⇒ <span class="extype" name="scala.util.parsing.combinator.Parsers.chainr1.U">U</span></span>, <span name="first">first: <span class="extype" name="scala.util.parsing.combinator.Parsers.chainr1.U">U</span></span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.chainr1.U">U</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> </li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="clone():Object"></a> <a id="clone():AnyRef"></a> @@ -476,45 +207,6 @@ <span class="name">@throws</span><span class="args">()</span> </dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#commit" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="commit[T<:<?>](p:<?>):Parsers.this.Parser[T]"></a> - <a id="commit[T](⇒Parser[T]):Parser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">commit</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.commit.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.commit.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#elem" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="elem(e:<?>):Parsers.this.Parser[Parsers.this.Elem]"></a> - <a id="elem(Elem):Parser[Elem]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">elem</span><span class="params">(<span name="e">e: <a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a></span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#elem" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="elem(kind:<?>,p:<?>):Parsers.this.Parser[Parsers.this.Elem]"></a> - <a id="elem(String,(Elem)⇒Boolean):Parser[Elem]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">elem</span><span class="params">(<span name="kind">kind: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="p">p: (<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>) ⇒ <span class="extype" name="scala.Boolean">Boolean</span></span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<a href="#Elem=org.perl8.test.tap.Consumer.Line" class="extmbr" name="org.perl8.test.tap.Parser.Elem">Elem</a>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="eq(x$1:AnyRef):Boolean"></a> <a id="eq(AnyRef):Boolean"></a> @@ -541,32 +233,6 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#err" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="err(msg:<?>):Parsers.this.Parser[Nothing]"></a> - <a id="err(String):Parser[Nothing]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">err</span><span class="params">(<span name="msg">msg: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.Nothing">Nothing</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#failure" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="failure(msg:<?>):Parsers.this.Parser[Nothing]"></a> - <a id="failure(String):Parser[Nothing]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">failure</span><span class="params">(<span name="msg">msg: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.Nothing">Nothing</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> </li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="finalize():Unit"></a> <a id="finalize():Unit"></a> @@ -596,19 +262,6 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#guard" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="guard[T<:<?>](p:<?>):Parsers.this.Parser[T]"></a> - <a id="guard[T](⇒Parser[T]):Parser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">guard</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.guard.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.guard.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> </li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="hashCode():Int"></a> <a id="hashCode():Int"></a> @@ -635,32 +288,6 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#log" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="log[T<:<?>](p:<?>)(name:<?>):Parsers.this.Parser[T]"></a> - <a id="log[T](⇒Parser[T])(String):Parser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">log</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.log.T">T</span>]</span>)</span><span class="params">(<span name="name">name: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.log.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#mkList" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="mkList[T<:<?>]:Parsers.this.~[T,List[T]]=>List[T]"></a> - <a id="mkList[T]:(~[T,List[T]])⇒List[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">mkList</span><span class="tparams">[<span name="T">T</span>]</span><span class="result">: (<a href="#~[+a,+b]extendsProductwithSerializable" class="extmbr" name="org.perl8.test.tap.Parser.~">~</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.mkList.T">T</span>, <span class="extype" name="scala.List">List</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.mkList.T">T</span>]]) ⇒ <span class="extype" name="scala.collection.immutable.List">List</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.mkList.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> </li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="ne(x$1:AnyRef):Boolean"></a> <a id="ne(AnyRef):Boolean"></a> @@ -674,19 +301,6 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#not" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="not[T<:<?>](p:<?>):Parsers.this.Parser[Unit]"></a> - <a id="not[T](⇒Parser[T]):Parser[Unit]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">not</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.not.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.Unit">Unit</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> </li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="notify():Unit"></a> <a id="notify():Unit"></a> @@ -713,20 +327,7 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#opt" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="opt[T<:<?>](p:<?>):Parsers.this.Parser[Option[T]]"></a> - <a id="opt[T](⇒Parser[T]):Parser[Option[T]]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">opt</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.opt.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.opt.T">T</span>]]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="org.perl8.test.tap.Parser#parse" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.Parser#parse" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="parse(input:java.io.OutputStream):org.perl8.test.tap.TAPResult"></a> <a id="parse(OutputStream):TAPResult"></a> <h4 class="signature"> @@ -738,8 +339,12 @@ <span class="name">parse</span><span class="params">(<span name="input">input: <span class="extype" name="java.io.OutputStream">OutputStream</span></span>)</span><span class="result">: <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a></span> </span> </h4> - - </li><li name="org.perl8.test.tap.Parser#parse" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <p class="shortcomment cmt">Parses TAP from an output stream.</p><div class="fullcomment"><div class="comment cmt"><p>Parses TAP from an output stream. +</p></div><dl class="attributes block"> <dt>To do</dt><dd><span class="cmt"><p>Doesn't currently work as a streaming parser, since it just + collects the entire output as a string and feeds it to the parser + for strings. This could likely be improved. +</p></span></dd></dl></div> + </li><li name="org.perl8.test.tap.Parser#parse" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="parse(input:String):org.perl8.test.tap.TAPResult"></a> <a id="parse(String):TAPResult"></a> <h4 class="signature"> @@ -751,8 +356,11 @@ <span class="name">parse</span><span class="params">(<span name="input">input: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a></span> </span> </h4> - - </li><li name="org.perl8.test.tap.Parser#parse" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <p class="shortcomment cmt">Parses TAP contained in a string.</p><div class="fullcomment"><div class="comment cmt"><p>Parses TAP contained in a string. This isn't useful for incremental +parsing, because the entire input string must be created before +parsing can begin. +</p></div></div> + </li><li name="org.perl8.test.tap.Parser#parse" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="parse(input:java.io.InputStream):org.perl8.test.tap.TAPResult"></a> <a id="parse(InputStream):TAPResult"></a> <h4 class="signature"> @@ -764,127 +372,10 @@ <span class="name">parse</span><span class="params">(<span name="input">input: <span class="extype" name="java.io.InputStream">InputStream</span></span>)</span><span class="result">: <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a></span> </span> </h4> - - </li><li name="scala.util.parsing.combinator.Parsers#phrase" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="phrase[T<:<?>](p:<?>):Parsers.this.Parser[T]"></a> - <a id="phrase[T](Parser[T]):Parser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">phrase</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.phrase.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.phrase.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#positioned" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="positioned[T<:<?>](p:<?>):Parsers.this.Parser[T]"></a> - <a id="positioned[T<:Positional](⇒Parser[T]):Parser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">positioned</span><span class="tparams">[<span name="T">T <: <span class="extype" name="scala.util.parsing.input.Positional">Positional</span></span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.positioned.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.positioned.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#rep" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="rep[T](p:=>Parsers.this.Parser[T]):Parsers.this.Parser[List[T]]"></a> - <a id="rep[T](⇒Parser[T]):Parser[List[T]]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">rep</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.rep.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.List">List</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.rep.T">T</span>]]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#rep1" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="rep1[T<:<?>](first:<?>,p0:<?>):Parsers.this.Parser[List[T]]"></a> - <a id="rep1[T](⇒Parser[T],⇒Parser[T]):Parser[List[T]]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">rep1</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="first">first: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.rep1.T">T</span>]</span>, <span name="p0">p0: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.rep1.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.List">List</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.rep1.T">T</span>]]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd><dt>Annotations</dt><dd> - <span class="name">@migration</span> - - </dd><dt>Migration</dt><dd class="cmt"><p><i>(Changed in version 2.9.0)</i> The <code>p0</code> call-by-name arguments is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.</p></dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#rep1" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="rep1[T<:<?>](p:<?>):Parsers.this.Parser[List[T]]"></a> - <a id="rep1[T](⇒Parser[T]):Parser[List[T]]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">rep1</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.rep1.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.List">List</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.rep1.T">T</span>]]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#rep1sep" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="rep1sep[T<:<?>](p:<?>,q:<?>):Parsers.this.Parser[List[T]]"></a> - <a id="rep1sep[T](⇒Parser[T],⇒Parser[Any]):Parser[List[T]]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">rep1sep</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.rep1sep.T">T</span>]</span>, <span name="q">q: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.Any">Any</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.List">List</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.rep1sep.T">T</span>]]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#repN" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="repN[T<:<?>](num:<?>,p:<?>):Parsers.this.Parser[List[T]]"></a> - <a id="repN[T](Int,⇒Parser[T]):Parser[List[T]]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">repN</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="num">num: <span class="extype" name="scala.Int">Int</span></span>, <span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.repN.T">T</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.List">List</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.repN.T">T</span>]]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#repsep" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="repsep[T<:<?>](p:<?>,q:<?>):Parsers.this.Parser[List[T]]"></a> - <a id="repsep[T](⇒Parser[T],⇒Parser[Any]):Parser[List[T]]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">repsep</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="p">p: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.repsep.T">T</span>]</span>, <span name="q">q: ⇒ <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.Any">Any</span>]</span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.List">List</span>[<span class="extype" name="scala.util.parsing.combinator.Parsers.repsep.T">T</span>]]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#success" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="success[T<:<?>](v:<?>):Parsers.this.Parser[T]"></a> - <a id="success[T](T):Parser[T]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">success</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="v">v: <span class="extype" name="scala.util.parsing.combinator.Parsers.success.T">T</span></span>)</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<span class="extype" name="scala.util.parsing.combinator.Parsers.success.T">T</span>]</span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd></dl></div> + <p class="shortcomment cmt">Parses TAP from an input stream.</p><div class="fullcomment"><div class="comment cmt"><p>Parses TAP from an input stream. This variant will actually parse lines +as they are available to read from the input stream, so this can be used +as a streaming parser. +</p></div></div> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> @@ -898,19 +389,6 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> - </li><li name="org.perl8.test.tap.Parser#tap" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="tap:Parser.this.Parser[org.perl8.test.tap.TAPResult]"></a> - <a id="tap:Parser[TAPResult]"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">tap</span><span class="result">: <a href="#Parser[+T]extendsParsers.this.Input=>Parsers.this.ParseResult[T]" class="extmbr" name="org.perl8.test.tap.Parser.Parser">Parser</a>[<a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a>]</span> - </span> - </h4> - </li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="toString():String"></a> <a id="toString():String"></a> @@ -977,48 +455,11 @@ - <div id="values" class="values members"> - <h3>Deprecated Value Members</h3> - <ol><li name="scala.util.parsing.combinator.Parsers#lastNoSuccess" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="lastNoSuccess:Parsers.this.NoSuccess"></a> - <a id="lastNoSuccess:NoSuccess"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name deprecated" title="Deprecated: (Since version 2.10.0) lastNoSuccess was not thread-safe and will be removed in 2.11.0">lastNoSuccess</span><span class="result">: <a href="#NoSuccessextendsParsers.this.ParseResult[Nothing]" class="extmbr" name="org.perl8.test.tap.Parser.NoSuccess">NoSuccess</a></span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Parsers</dd><dt>Annotations</dt><dd> - <span class="name">@deprecated</span> - - </dd><dt>Deprecated</dt><dd class="cmt"><p><i>(Since version 2.10.0)</i> lastNoSuccess was not thread-safe and will be removed in 2.11.0</p></dd></dl></div> - </li><li name="scala.util.parsing.combinator.Parsers#lastNoSuccess_=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="lastNoSuccess_=(x:<?>):Unit"></a> - <a id="lastNoSuccess_=(NoSuccess):Unit"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span title="gt4s: lastNoSuccess_$eq. Deprecated: (Since version 2.10.0) lastNoSuccess was not thread-safe and will be removed in 2.11.0" class="name deprecated">lastNoSuccess_=</span><span class="params">(<span name="x">x: <a href="#NoSuccessextendsParsers.this.ParseResult[Nothing]" class="extmbr" name="org.perl8.test.tap.Parser.NoSuccess">NoSuccess</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>Definition Classes</dt><dd>Parsers</dd><dt>Annotations</dt><dd> - <span class="name">@deprecated</span> - - </dd><dt>Deprecated</dt><dd class="cmt"><p><i>(Since version 2.10.0)</i> lastNoSuccess was not thread-safe and will be removed in 2.11.0</p></dd></dl></div> - </li></ol> - </div> + </div> <div id="inheritedMembers"> - <div class="parent" name="scala.util.parsing.combinator.Parsers"> - <h3>Inherited from <span class="extype" name="scala.util.parsing.combinator.Parsers">Parsers</span></h3> - </div><div class="parent" name="scala.AnyRef"> + <div class="parent" name="scala.AnyRef"> <h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3> </div><div class="parent" name="scala.Any"> <h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3> diff --git a/org/perl8/test/tap/PlanEvent.html b/org/perl8/test/tap/PlanEvent.html index bccb7c2..24a9379 100644 --- a/org/perl8/test/tap/PlanEvent.html +++ b/org/perl8/test/tap/PlanEvent.html @@ -40,11 +40,11 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <span class="name">PlanEvent</span><span class="params">(<span name="plan">plan: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span>)</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <span class="name">PlanEvent</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A test plan.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -82,23 +82,7 @@ <div id="template"> <div id="allMembers"> - <div id="constructors" class="members"> - <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.PlanEvent#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="<init>(plan:org.perl8.test.Plan):org.perl8.test.tap.PlanEvent"></a> - <a id="<init>:PlanEvent"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">new</span> - </span> - <span class="symbol"> - <span class="name">PlanEvent</span><span class="params">(<span name="plan">plan: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span>)</span> - </span> - </h4> - - </li></ol> - </div> + @@ -306,7 +290,8 @@ <span class="name">plan</span><span class="result">: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span> </span> </h4> - + <p class="shortcomment cmt">The <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a> corresponding to the line that + was parsed.</p> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> diff --git a/org/perl8/test/tap/Producer$.html b/org/perl8/test/tap/Producer$.html index 9ec4f79..0e25017 100644 --- a/org/perl8/test/tap/Producer$.html +++ b/org/perl8/test/tap/Producer$.html @@ -44,7 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Contains functions for producing individual lines of TAP.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -168,7 +168,7 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> - </li><li name="org.perl8.test.tap.Producer#bailOut" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.Producer#bailOut" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="bailOut(message:String):String"></a> <a id="bailOut(String):String"></a> <h4 class="signature"> @@ -180,20 +180,11 @@ <span class="name">bailOut</span><span class="params">(<span name="message">message: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.Producer#bailOut" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="bailOut:String"></a> - <a id="bailOut:String"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">bailOut</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> - </span> - </h4> - + <p class="shortcomment cmt">Returns a bail out with a reason.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a bail out with a reason. +</p></div><dl class="attributes block"> <div class="block">Example: + <ol><li class="cmt"><p><code>Bail out! Not supported on this platform.</code> +</p></li></ol> + </div></dl></div> </li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="clone():Object"></a> <a id="clone():AnyRef"></a> @@ -210,7 +201,7 @@ <span class="name">@throws</span><span class="args">()</span> </dd></dl></div> - </li><li name="org.perl8.test.tap.Producer#comment" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.Producer#comment" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="comment(message:String):String"></a> <a id="comment(String):String"></a> <h4 class="signature"> @@ -222,7 +213,11 @@ <span class="name">comment</span><span class="params">(<span name="message">message: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - + <p class="shortcomment cmt">Returns a comment.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a comment. +</p></div><dl class="attributes block"> <div class="block">Example: + <ol><li class="cmt"><p><code># this is a comment</code> +</p></li></ol> + </div></dl></div> </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="eq(x$1:AnyRef):Boolean"></a> <a id="eq(AnyRef):Boolean"></a> @@ -343,7 +338,7 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> - </li><li name="org.perl8.test.tap.Producer#plan" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.Producer#plan" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="plan(plan:org.perl8.test.Plan):String"></a> <a id="plan(Plan):String"></a> <h4 class="signature"> @@ -355,8 +350,12 @@ <span class="name">plan</span><span class="params">(<span name="plan">plan: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span>)</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.Producer#result" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <p class="shortcomment cmt">Returns a test plan.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a test plan. +</p></div><dl class="attributes block"> <div class="block">Examples: + <ol><li class="cmt"><p><code>1..0 # SKIP don't run this test</code> (<a href="../package$$SkipAll.html" class="extype" name="org.perl8.test.SkipAll">SkipAll</a>) +</p></li>, <li class="cmt"><p><code>1..5</code> (<a href="../package$$NumericPlan.html" class="extype" name="org.perl8.test.NumericPlan">NumericPlan</a>)</p></li></ol> + </div></dl></div> + </li><li name="org.perl8.test.tap.Producer#result" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="result(cond:Boolean,num:Int,desc:String):String"></a> <a id="result(Boolean,Int,String):String"></a> <h4 class="signature"> @@ -368,8 +367,12 @@ <span class="name">result</span><span class="params">(<span name="cond">cond: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="num">num: <span class="extype" name="scala.Int">Int</span></span>, <span name="desc">desc: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.Producer#result" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <p class="shortcomment cmt">Returns a test result that contains a description.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a test result that contains a description. +</p></div><dl class="attributes block"> <div class="block">Example: + <ol><li class="cmt"><p><code>ok 28 - our test succeeded</code> +</p></li></ol> + </div></dl></div> + </li><li name="org.perl8.test.tap.Producer#result" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="result(cond:Boolean,num:Int):String"></a> <a id="result(Boolean,Int):String"></a> <h4 class="signature"> @@ -381,8 +384,12 @@ <span class="name">result</span><span class="params">(<span name="cond">cond: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="num">num: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.Producer#skip" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <p class="shortcomment cmt">Returns a test result.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a test result. +</p></div><dl class="attributes block"> <div class="block">Example: + <ol><li class="cmt"><p><code>ok 4</code> +</p></li></ol> + </div></dl></div> + </li><li name="org.perl8.test.tap.Producer#skip" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="skip(num:Int,reason:String):String"></a> <a id="skip(Int,String):String"></a> <h4 class="signature"> @@ -394,20 +401,11 @@ <span class="name">skip</span><span class="params">(<span name="num">num: <span class="extype" name="scala.Int">Int</span></span>, <span name="reason">reason: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.Producer#skip" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="skip(num:Int):String"></a> - <a id="skip(Int):String"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">skip</span><span class="params">(<span name="num">num: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> - </span> - </h4> - + <p class="shortcomment cmt">Returns a skipped test result with a reason.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a skipped test result with a reason. +</p></div><dl class="attributes block"> <div class="block">Example: + <ol><li class="cmt"><p><code>ok 4 # skip this test won't run here</code> +</p></li></ol> + </div></dl></div> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> @@ -434,7 +432,7 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> - </li><li name="org.perl8.test.tap.Producer#todoResult" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.Producer#todoResult" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="todoResult(cond:Boolean,num:Int,desc:String,todo:String):String"></a> <a id="todoResult(Boolean,Int,String,String):String"></a> <h4 class="signature"> @@ -446,8 +444,12 @@ <span class="name">todoResult</span><span class="params">(<span name="cond">cond: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="num">num: <span class="extype" name="scala.Int">Int</span></span>, <span name="desc">desc: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="todo">todo: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.Producer#todoResult" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <p class="shortcomment cmt">Returns a todo test result that contains a description.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a todo test result that contains a description. +</p></div><dl class="attributes block"> <div class="block">Example: + <ol><li class="cmt"><p><code>not ok 18 - test the feature # TODO can't figure this out</code> +</p></li></ol> + </div></dl></div> + </li><li name="org.perl8.test.tap.Producer#todoResult" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="todoResult(cond:Boolean,num:Int,todo:String):String"></a> <a id="todoResult(Boolean,Int,String):String"></a> <h4 class="signature"> @@ -459,7 +461,11 @@ <span class="name">todoResult</span><span class="params">(<span name="cond">cond: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="num">num: <span class="extype" name="scala.Int">Int</span></span>, <span name="todo">todo: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - + <p class="shortcomment cmt">Returns a todo test result.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a todo test result. +</p></div><dl class="attributes block"> <div class="block">Example: + <ol><li class="cmt"><p><code>not ok 1 # TODO this doesn't work yet</code> +</p></li></ol> + </div></dl></div> </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="wait():Unit"></a> <a id="wait():Unit"></a> diff --git a/org/perl8/test/tap/ResultEvent.html b/org/perl8/test/tap/ResultEvent.html index 8a16579..269ddb3 100644 --- a/org/perl8/test/tap/ResultEvent.html +++ b/org/perl8/test/tap/ResultEvent.html @@ -40,11 +40,11 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <span class="name">ResultEvent</span><span class="params">(<span name="result">result: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span>)</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <span class="name">ResultEvent</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>An individual test result.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -82,23 +82,7 @@ <div id="template"> <div id="allMembers"> - <div id="constructors" class="members"> - <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.ResultEvent#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="<init>(result:org.perl8.test.tap.TestResult):org.perl8.test.tap.ResultEvent"></a> - <a id="<init>:ResultEvent"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">new</span> - </span> - <span class="symbol"> - <span class="name">ResultEvent</span><span class="params">(<span name="result">result: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span>)</span> - </span> - </h4> - - </li></ol> - </div> + @@ -306,7 +290,8 @@ <span class="name">result</span><span class="result">: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span> </span> </h4> - + <p class="shortcomment cmt">The <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a> containing + information about the corresponding test.</p> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> diff --git a/org/perl8/test/tap/SkipDirective.html b/org/perl8/test/tap/SkipDirective.html index c52b3d7..ccacb3f 100644 --- a/org/perl8/test/tap/SkipDirective.html +++ b/org/perl8/test/tap/SkipDirective.html @@ -40,11 +40,11 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <span class="name">SkipDirective</span><span class="params">(<span name="message">message: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result"> extends <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <span class="name">SkipDirective</span><span class="result"> extends <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A directive indicating that this test was skipped.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -82,23 +82,7 @@ <div id="template"> <div id="allMembers"> - <div id="constructors" class="members"> - <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.SkipDirective#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="<init>(message:Option[String]):org.perl8.test.tap.SkipDirective"></a> - <a id="<init>:SkipDirective"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">new</span> - </span> - <span class="symbol"> - <span class="name">SkipDirective</span><span class="params">(<span name="message">message: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span> - </span> - </h4> - - </li></ol> - </div> + diff --git a/org/perl8/test/tap/StartEvent$.html b/org/perl8/test/tap/StartEvent$.html index 8a2ae01..c66af2e 100644 --- a/org/perl8/test/tap/StartEvent$.html +++ b/org/perl8/test/tap/StartEvent$.html @@ -44,7 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>The start of a TAP stream.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> diff --git a/org/perl8/test/tap/SubtestEndEvent.html b/org/perl8/test/tap/SubtestEndEvent.html index 8b4c154..7df3c91 100644 --- a/org/perl8/test/tap/SubtestEndEvent.html +++ b/org/perl8/test/tap/SubtestEndEvent.html @@ -40,11 +40,11 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <span class="name">SubtestEndEvent</span><span class="params">(<span name="result">result: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span>)</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <span class="name">SubtestEndEvent</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>The end of a subtest (currently unused).</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -82,23 +82,7 @@ <div id="template"> <div id="allMembers"> - <div id="constructors" class="members"> - <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.SubtestEndEvent#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="<init>(result:org.perl8.test.tap.TestResult):org.perl8.test.tap.SubtestEndEvent"></a> - <a id="<init>:SubtestEndEvent"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">new</span> - </span> - <span class="symbol"> - <span class="name">SubtestEndEvent</span><span class="params">(<span name="result">result: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span>)</span> - </span> - </h4> - - </li></ol> - </div> + diff --git a/org/perl8/test/tap/SubtestStartEvent$.html b/org/perl8/test/tap/SubtestStartEvent$.html index 7098c2b..d951258 100644 --- a/org/perl8/test/tap/SubtestStartEvent$.html +++ b/org/perl8/test/tap/SubtestStartEvent$.html @@ -44,7 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>The start of a subtest (currently unused).</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> diff --git a/org/perl8/test/tap/TAPEvent.html b/org/perl8/test/tap/TAPEvent.html index 6d81c7f..f192107 100644 --- a/org/perl8/test/tap/TAPEvent.html +++ b/org/perl8/test/tap/TAPEvent.html @@ -44,7 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>An event emitted while parsing a TAP stream.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div><div class="toggleContainer block"> diff --git a/org/perl8/test/tap/TAPResult.html b/org/perl8/test/tap/TAPResult.html index 9daa1c1..7174b17 100644 --- a/org/perl8/test/tap/TAPResult.html +++ b/org/perl8/test/tap/TAPResult.html @@ -44,7 +44,11 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>The summarized results of a TAP stream. Contains the +<a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a> that was given, as well as a list of +<a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResults</a> corresponding to each of the +tests in the stream. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -84,7 +88,7 @@ <div id="allMembers"> <div id="constructors" class="members"> <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.TAPResult#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <ol><li name="org.perl8.test.tap.TAPResult#<init>" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="<init>(plan:org.perl8.test.Plan,results:Seq[org.perl8.test.tap.TestResult]):org.perl8.test.tap.TAPResult"></a> <a id="<init>:TAPResult"></a> <h4 class="signature"> @@ -96,7 +100,9 @@ <span class="name">TAPResult</span><span class="params">(<span name="plan">plan: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span>, <span name="results">results: <span class="extype" name="scala.Seq">Seq</span>[<a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a>]</span>)</span> </span> </h4> - + <p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">plan</dt><dd class="cmt"><p>The <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a> from the TAP stream</p></dd><dt class="param">results</dt><dd class="cmt"><p>The list of <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResults</a> + from the TAP stream +</p></dd></dl></div> </li></ol> </div> @@ -226,7 +232,7 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> - </li><li name="org.perl8.test.tap.TAPResult#exitCode" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.TAPResult#exitCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="exitCode:Int"></a> <a id="exitCode:Int"></a> <h4 class="signature"> @@ -238,7 +244,9 @@ <span class="name">exitCode</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> </span> </h4> - + <p class="shortcomment cmt">Returns the exit code to use if running this test on its own.</p><div class="fullcomment"><div class="comment cmt"><p>Returns the exit code to use if running this test on its own.</p><p>Success is indicated by 0, invalid TAP streams (such as incorrect plans) +by 255, and other kinds of failures by the failure count. +</p></div></div> </li><li name="org.perl8.test.tap.TAPResult#fails" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="fails:Int"></a> <a id="fails:Int"></a> @@ -251,7 +259,7 @@ <span class="name">fails</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> </span> </h4> - + <p class="shortcomment cmt">Returns the number of test failures in the TAP stream.</p> </li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="finalize():Unit"></a> <a id="finalize():Unit"></a> @@ -319,7 +327,8 @@ <span class="name">matchesPlan</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> </span> </h4> - + <p class="shortcomment cmt">Returns true if the number of tests executed was compatible with the +provided test plan.</p> </li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="ne(x$1:AnyRef):Boolean"></a> <a id="ne(AnyRef):Boolean"></a> @@ -371,7 +380,7 @@ <span class="name">plan</span><span class="result">: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span> </span> </h4> - + <p class="shortcomment cmt">The <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a> from the TAP stream</p> </li><li name="org.perl8.test.tap.TAPResult#results" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="results:Seq[org.perl8.test.tap.TestResult]"></a> <a id="results:Seq[TestResult]"></a> @@ -384,8 +393,10 @@ <span class="name">results</span><span class="result">: <span class="extype" name="scala.Seq">Seq</span>[<a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a>]</span> </span> </h4> - - </li><li name="org.perl8.test.tap.TAPResult#success" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <p class="shortcomment cmt">The list of <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResults</a> + from the TAP stream +</p> + </li><li name="org.perl8.test.tap.TAPResult#success" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="success:Boolean"></a> <a id="success:Boolean"></a> <h4 class="signature"> @@ -397,7 +408,9 @@ <span class="name">success</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> </span> </h4> - + <p class="shortcomment cmt">Returns true if the TAP stream overall passed.</p><div class="fullcomment"><div class="comment cmt"><p>Returns true if the TAP stream overall passed.</p><p>Differs from <code>testsPassed</code> in that it also takes into account things +like invalid plans. +</p></div></div> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> @@ -423,7 +436,7 @@ <span class="name">testsPassed</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> </span> </h4> - + <p class="shortcomment cmt">Returns true if all of the tests passed.</p> </li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="toString():String"></a> <a id="toString():String"></a> diff --git a/org/perl8/test/tap/TestBuilder.html b/org/perl8/test/tap/TestBuilder.html index e6b33ed..c3124ca 100644 --- a/org/perl8/test/tap/TestBuilder.html +++ b/org/perl8/test/tap/TestBuilder.html @@ -44,7 +44,13 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>This class provides a convenient yet low level API for generating TAP +streams. Each instance of this class handles a single TAP stream, and +keeps track of things like the current test number for you. All +TAP-producing methods write the TAP lines to <code>Console.out</code> or +<code>Console.err</code>, so you can override those (via <code>Console.withOut</code> or +<code>Console.withErr</code>). +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -84,7 +90,7 @@ <div id="allMembers"> <div id="constructors" class="members"> <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.TestBuilder#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <ol><li name="org.perl8.test.tap.TestBuilder#<init>" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="<init>(plan:org.perl8.test.Plan,terminalInUse:Boolean):org.perl8.test.tap.TestBuilder"></a> <a id="<init>:TestBuilder"></a> <h4 class="signature"> @@ -96,7 +102,15 @@ <span class="name">TestBuilder</span><span class="params">(<span name="plan">plan: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a> = <span class="symbol"><span class="name"><a href="../../../package.html">NoPlan</a></span></span></span>, <span name="terminalInUse">terminalInUse: <span class="extype" name="scala.Boolean">Boolean</span> = <span class="symbol">false</span></span>)</span> </span> </h4> - + <p class="shortcomment cmt">Creates a new builder instance, and emits the corresponding plan line, +unless the plan is not given.</p><div class="fullcomment"><div class="comment cmt"><p>Creates a new builder instance, and emits the corresponding plan line, +unless the plan is not given. +</p></div><dl class="paramcmts block"><dt class="param">plan</dt><dd class="cmt"><p><a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">plan</a> for this test.</p></dd><dt class="param">terminalInUse</dt><dd class="cmt"><p>Whether this test is being run from a harness which + will not just be writing directly to the output. + This will make things written to <code>Console.err</code> have + a newline prepended, so that they always start on + an empty line. +</p></dd></dl></div> </li></ol> </div> @@ -196,20 +210,7 @@ <span class="name">bailOut</span><span class="params">(<span name="message">message: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.TestBuilder#bailOut" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="bailOut:Unit"></a> - <a id="bailOut:Unit"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">bailOut</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - + <p class="shortcomment cmt">Abort the current test, with a message.</p> </li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="clone():Object"></a> <a id="clone():AnyRef"></a> @@ -226,7 +227,7 @@ <span class="name">@throws</span><span class="args">()</span> </dd></dl></div> - </li><li name="org.perl8.test.tap.TestBuilder#cloneForSubtest" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.TestBuilder#cloneForSubtest" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="cloneForSubtest(newPlan:org.perl8.test.Plan):org.perl8.test.tap.TestBuilder"></a> <a id="cloneForSubtest(Plan):TestBuilder"></a> <h4 class="signature"> @@ -238,8 +239,13 @@ <span class="name">cloneForSubtest</span><span class="params">(<span name="newPlan">newPlan: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span>)</span><span class="result">: <a href="" class="extype" name="org.perl8.test.tap.TestBuilder">TestBuilder</a></span> </span> </h4> - - </li><li name="org.perl8.test.tap.TestBuilder#diag" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <p class="shortcomment cmt">Create a new TestBuilder instance, to be used to run a subtest.</p><div class="fullcomment"><div class="comment cmt"><p>Create a new TestBuilder instance, to be used to run a subtest. This new +instance will have all of its lines prefixed by an additional level of +indentation. This instance will still need to have <code>doneTesting</code> +called on it, and the result of the subtest will still need to be +reported as a separate test result through <code>ok</code>. +</p></div></div> + </li><li name="org.perl8.test.tap.TestBuilder#diag" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="diag(message:String):Unit"></a> <a id="diag(String):Unit"></a> <h4 class="signature"> @@ -251,8 +257,11 @@ <span class="name">diag</span><span class="params">(<span name="message">message: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.TestBuilder#doneTesting" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <p class="shortcomment cmt">Writes a comment line to <code>Console.err</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Writes a comment line to <code>Console.err</code>. This will allow it to be +visible in most summarizing harnesses (which consume and parse +everything that goes to <code>Console.out</code>). +</p></div></div> + </li><li name="org.perl8.test.tap.TestBuilder#doneTesting" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="doneTesting:Boolean"></a> <a id="doneTesting:Boolean"></a> <h4 class="signature"> @@ -264,7 +273,11 @@ <span class="name">doneTesting</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> </span> </h4> - + <p class="shortcomment cmt">Finalize the current builder instance.</p><div class="fullcomment"><div class="comment cmt"><p>Finalize the current builder instance. This writes the auto-calculated +plan to <code>Console.out</code> if the plan type was <code>NoPlan</code> and reports a +summary of the test results as a comment to <code>Console.err</code>. +</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>whether or not the test class as a whole passed. +</p></dd></dl></div> </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="eq(x$1:AnyRef):Boolean"></a> <a id="eq(AnyRef):Boolean"></a> @@ -291,7 +304,7 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> - </li><li name="org.perl8.test.tap.TestBuilder#exitCode" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.TestBuilder#exitCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="exitCode:Int"></a> <a id="exitCode:Int"></a> <h4 class="signature"> @@ -303,7 +316,11 @@ <span class="name">exitCode</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> </span> </h4> - + <p class="shortcomment cmt">The exit code to use, in harnesses that run a single test.</p><div class="fullcomment"><div class="comment cmt"><p>The exit code to use, in harnesses that run a single test. Passing tests +return 0, invalid tests (such as running a different number of tests +than planned) return 255, and all others return the number of failed +tests. +</p></div></div> </li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="finalize():Unit"></a> <a id="finalize():Unit"></a> @@ -372,7 +389,7 @@ </span> </h4> <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> - </li><li name="org.perl8.test.tap.TestBuilder#note" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + </li><li name="org.perl8.test.tap.TestBuilder#note" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="note(message:String):Unit"></a> <a id="note(String):Unit"></a> <h4 class="signature"> @@ -384,7 +401,9 @@ <span class="name">note</span><span class="params">(<span name="message">message: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> </span> </h4> - + <p class="shortcomment cmt">Write a comment line to <code>Console.out</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Write a comment line to <code>Console.out</code>. This will typically only be +visible in the raw TAP stream. +</p></div></div> </li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="notify():Unit"></a> <a id="notify():Unit"></a> @@ -423,7 +442,7 @@ <span class="name">ok</span><span class="params">(<span name="test">test: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="description">description: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> </span> </h4> - + <p class="shortcomment cmt">Reports a single test result with description to <code>Console.out</code>.</p> </li><li name="org.perl8.test.tap.TestBuilder#ok" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="ok(test:Boolean):Unit"></a> <a id="ok(Boolean):Unit"></a> @@ -436,85 +455,72 @@ <span class="name">ok</span><span class="params">(<span name="test">test: <span class="extype" name="scala.Boolean">Boolean</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.TestBuilder#okTodo" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="okTodo(test:Boolean,description:String,todo:String):Unit"></a> - <a id="okTodo(Boolean,String,String):Unit"></a> + <p class="shortcomment cmt">Reports a single test result to <code>Console.out</code>.</p> + </li><li name="org.perl8.test.tap.TestBuilder#skip" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <a id="skip(reason:String):Unit"></a> + <a id="skip(String):Unit"></a> <h4 class="signature"> <span class="modifier_kind"> <span class="modifier"></span> <span class="kind">def</span> </span> <span class="symbol"> - <span class="name">okTodo</span><span class="params">(<span name="test">test: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="description">description: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="todo">todo: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + <span class="name">skip</span><span class="params">(<span name="reason">reason: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.TestBuilder#okTodo" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="okTodo(test:Boolean,todo:String):Unit"></a> - <a id="okTodo(Boolean,String):Unit"></a> + <p class="shortcomment cmt">Reports a single skipped test result to <code>Console.out</code>.</p> + </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="synchronized[T0](x$1:=>T0):T0"></a> + <a id="synchronized[T0](⇒T0):T0"></a> <h4 class="signature"> <span class="modifier_kind"> - <span class="modifier"></span> + <span class="modifier">final </span> <span class="kind">def</span> </span> <span class="symbol"> - <span class="name">okTodo</span><span class="params">(<span name="test">test: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="todo">todo: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + <span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.TestBuilder#skip" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="skip(reason:String):Unit"></a> - <a id="skip(String):Unit"></a> + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> + </li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="toString():String"></a> + <a id="toString():String"></a> <h4 class="signature"> <span class="modifier_kind"> <span class="modifier"></span> <span class="kind">def</span> </span> <span class="symbol"> - <span class="name">skip</span><span class="params">(<span name="reason">reason: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> </span> </h4> - - </li><li name="org.perl8.test.tap.TestBuilder#skip" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="skip:Unit"></a> - <a id="skip:Unit"></a> + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> + </li><li name="org.perl8.test.tap.TestBuilder#todo" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <a id="todo(todo:String,test:Boolean,description:String):Unit"></a> + <a id="todo(String,Boolean,String):Unit"></a> <h4 class="signature"> <span class="modifier_kind"> <span class="modifier"></span> <span class="kind">def</span> </span> <span class="symbol"> - <span class="name">skip</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + <span class="name">todo</span><span class="params">(<span name="todo">todo: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="test">test: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="description">description: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> </span> </h4> - - </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="synchronized[T0](x$1:=>T0):T0"></a> - <a id="synchronized[T0](⇒T0):T0"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier">final </span> - <span class="kind">def</span> - </span> - <span class="symbol"> - <span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span> - </span> - </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> - </li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="toString():String"></a> - <a id="toString():String"></a> + <p class="shortcomment cmt">Reports a single TODO test result with description to <code>Console.out</code>.</p> + </li><li name="org.perl8.test.tap.TestBuilder#todo" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <a id="todo(todo:String,test:Boolean):Unit"></a> + <a id="todo(String,Boolean):Unit"></a> <h4 class="signature"> <span class="modifier_kind"> <span class="modifier"></span> <span class="kind">def</span> </span> <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + <span class="name">todo</span><span class="params">(<span name="todo">todo: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="test">test: <span class="extype" name="scala.Boolean">Boolean</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> </span> </h4> - <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> + <p class="shortcomment cmt">Reports a single TODO test result to <code>Console.out</code>.</p> </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="wait():Unit"></a> <a id="wait():Unit"></a> diff --git a/org/perl8/test/tap/TestResult.html b/org/perl8/test/tap/TestResult.html index 183c95a..f93e026 100644 --- a/org/perl8/test/tap/TestResult.html +++ b/org/perl8/test/tap/TestResult.html @@ -44,7 +44,8 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>The result of a single test. +</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -84,7 +85,7 @@ <div id="allMembers"> <div id="constructors" class="members"> <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.TestResult#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <ol><li name="org.perl8.test.tap.TestResult#<init>" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="<init>(passed:Boolean,number:Int,description:String,directive:Option[org.perl8.test.tap.Directive],subtest:Option[org.perl8.test.tap.TAPResult]):org.perl8.test.tap.TestResult"></a> <a id="<init>:TestResult"></a> <h4 class="signature"> @@ -96,7 +97,10 @@ <span class="name">TestResult</span><span class="params">(<span name="passed">passed: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="number">number: <span class="extype" name="scala.Int">Int</span></span>, <span name="description">description: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="directive">directive: <span class="extype" name="scala.Option">Option</span>[<a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a>]</span>, <span name="subtest">subtest: <span class="extype" name="scala.Option">Option</span>[<a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a>]</span>)</span> </span> </h4> - + <p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">passed</dt><dd class="cmt"><p>True if the test passed</p></dd><dt class="param">number</dt><dd class="cmt"><p>The test number in the TAP stream</p></dd><dt class="param">description</dt><dd class="cmt"><p>The test description</p></dd><dt class="param">directive</dt><dd class="cmt"><p>The <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a> (either + skip or todo) that was provided for this test, if any</p></dd><dt class="param">subtest</dt><dd class="cmt"><p>The <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">org.perl8.test.tap.TAPResult</a> for the subtest + that this test corresponds to, if any +</p></dd></dl></div> </li></ol> </div> @@ -212,7 +216,7 @@ <span class="name">description</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> </span> </h4> - + <p class="shortcomment cmt">The test description</p> </li><li name="org.perl8.test.tap.TestResult#directive" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="directive:Option[org.perl8.test.tap.Directive]"></a> <a id="directive:Option[Directive]"></a> @@ -225,7 +229,8 @@ <span class="name">directive</span><span class="result">: <span class="extype" name="scala.Option">Option</span>[<a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a>]</span> </span> </h4> - + <p class="shortcomment cmt">The <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a> (either + skip or todo) that was provided for this test, if any</p> </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="eq(x$1:AnyRef):Boolean"></a> <a id="eq(AnyRef):Boolean"></a> @@ -358,7 +363,7 @@ <span class="name">number</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> </span> </h4> - + <p class="shortcomment cmt">The test number in the TAP stream</p> </li><li name="org.perl8.test.tap.TestResult#passed" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="passed:Boolean"></a> <a id="passed:Boolean"></a> @@ -371,7 +376,7 @@ <span class="name">passed</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> </span> </h4> - + <p class="shortcomment cmt">True if the test passed</p> </li><li name="org.perl8.test.tap.TestResult#subtest" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="subtest:Option[org.perl8.test.tap.TAPResult]"></a> <a id="subtest:Option[TAPResult]"></a> @@ -384,7 +389,9 @@ <span class="name">subtest</span><span class="result">: <span class="extype" name="scala.Option">Option</span>[<a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a>]</span> </span> </h4> - + <p class="shortcomment cmt">The <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">org.perl8.test.tap.TAPResult</a> for the subtest + that this test corresponds to, if any +</p> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> diff --git a/org/perl8/test/tap/TodoDirective.html b/org/perl8/test/tap/TodoDirective.html index 2da6d00..006a36a 100644 --- a/org/perl8/test/tap/TodoDirective.html +++ b/org/perl8/test/tap/TodoDirective.html @@ -40,11 +40,11 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <span class="name">TodoDirective</span><span class="params">(<span name="message">message: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result"> extends <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <span class="name">TodoDirective</span><span class="result"> extends <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A directive indicating that this test is known to fail.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.Product">Product</span>, <span class="extype" name="scala.Equals">Equals</span>, <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -82,23 +82,7 @@ <div id="template"> <div id="allMembers"> - <div id="constructors" class="members"> - <h3>Instance Constructors</h3> - <ol><li name="org.perl8.test.tap.TodoDirective#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="<init>(message:Option[String]):org.perl8.test.tap.TodoDirective"></a> - <a id="<init>:TodoDirective"></a> - <h4 class="signature"> - <span class="modifier_kind"> - <span class="modifier"></span> - <span class="kind">new</span> - </span> - <span class="symbol"> - <span class="name">TodoDirective</span><span class="params">(<span name="message">message: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span> - </span> - </h4> - - </li></ol> - </div> + diff --git a/org/perl8/test/tap/package.html b/org/perl8/test/tap/package.html index 698b12c..b9996c2 100644 --- a/org/perl8/test/tap/package.html +++ b/org/perl8/test/tap/package.html @@ -44,8 +44,7 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Classes for TAP generation and parsing. -</p></div><div class="toggleContainer block"> + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Classes for TAP generation and parsing.</p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> </div></div> @@ -96,10 +95,10 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <a href="CommentEvent.html"><span class="name">CommentEvent</span></a><span class="params">(<span name="text">text: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <a href="CommentEvent.html"><span class="name">CommentEvent</span></a><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">A comment (currently unused).</p> </li><li name="org.perl8.test.tap.Directive" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> <a id="DirectiveextendsObject"></a> <a id="Directive:Directive"></a> @@ -112,7 +111,7 @@ <a href="Directive.html"><span class="name">Directive</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> </span> </h4> - + <p class="comment cmt">A modifier associated with a test result.</p> </li><li name="org.perl8.test.tap.EndEvent" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="EndEventextendsTAPEventwithProductwithSerializable"></a> <a id="EndEvent:EndEvent"></a> @@ -122,10 +121,10 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <a href="EndEvent.html"><span class="name">EndEvent</span></a><span class="params">(<span name="result">result: <a href="TAPResult.html" class="extype" name="org.perl8.test.tap.TAPResult">TAPResult</a></span>)</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <a href="EndEvent.html"><span class="name">EndEvent</span></a><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">The end of a TAP stream.</p> </li><li name="org.perl8.test.tap.ParseException" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="ParseExceptionextendsRuntimeExceptionwithProductwithSerializable"></a> <a id="ParseException:ParseException"></a> @@ -140,7 +139,7 @@ </h4> <p class="comment cmt">Exception representing an error during parsing.</p> </li><li name="org.perl8.test.tap.Parser" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="ParserextendsParsers"></a> + <a id="ParserextendsObject"></a> <a id="Parser:Parser"></a> <h4 class="signature"> <span class="modifier_kind"> @@ -148,10 +147,10 @@ <span class="kind">class</span> </span> <span class="symbol"> - <a href="Parser.html"><span class="name">Parser</span></a><span class="result"> extends <span class="extype" name="scala.util.parsing.combinator.Parsers">Parsers</span></span> + <a href="Parser.html"><span class="name">Parser</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> </span> </h4> - + <p class="comment cmt">This class parses a TAP stream.</p> </li><li name="org.perl8.test.tap.PlanEvent" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="PlanEventextendsTAPEventwithProductwithSerializable"></a> <a id="PlanEvent:PlanEvent"></a> @@ -161,10 +160,10 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <a href="PlanEvent.html"><span class="name">PlanEvent</span></a><span class="params">(<span name="plan">plan: <a href="../package$$Plan.html" class="extype" name="org.perl8.test.Plan">Plan</a></span>)</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <a href="PlanEvent.html"><span class="name">PlanEvent</span></a><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">A test plan.</p> </li><li name="org.perl8.test.tap.ResultEvent" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="ResultEventextendsTAPEventwithProductwithSerializable"></a> <a id="ResultEvent:ResultEvent"></a> @@ -174,10 +173,10 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <a href="ResultEvent.html"><span class="name">ResultEvent</span></a><span class="params">(<span name="result">result: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span>)</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <a href="ResultEvent.html"><span class="name">ResultEvent</span></a><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">An individual test result.</p> </li><li name="org.perl8.test.tap.SkipDirective" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="SkipDirectiveextendsDirectivewithProductwithSerializable"></a> <a id="SkipDirective:SkipDirective"></a> @@ -187,10 +186,10 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <a href="SkipDirective.html"><span class="name">SkipDirective</span></a><span class="params">(<span name="message">message: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result"> extends <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <a href="SkipDirective.html"><span class="name">SkipDirective</span></a><span class="result"> extends <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">A directive indicating that this test was skipped.</p> </li><li name="org.perl8.test.tap.SubtestEndEvent" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="SubtestEndEventextendsTAPEventwithProductwithSerializable"></a> <a id="SubtestEndEvent:SubtestEndEvent"></a> @@ -200,10 +199,10 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <a href="SubtestEndEvent.html"><span class="name">SubtestEndEvent</span></a><span class="params">(<span name="result">result: <a href="TestResult.html" class="extype" name="org.perl8.test.tap.TestResult">TestResult</a></span>)</span><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <a href="SubtestEndEvent.html"><span class="name">SubtestEndEvent</span></a><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">The end of a subtest (currently unused).</p> </li><li name="org.perl8.test.tap.TAPEvent" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> <a id="TAPEventextendsObject"></a> <a id="TAPEvent:TAPEvent"></a> @@ -216,7 +215,7 @@ <a href="TAPEvent.html"><span class="name">TAPEvent</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> </span> </h4> - + <p class="comment cmt">An event emitted while parsing a TAP stream.</p> </li><li name="org.perl8.test.tap.TAPResult" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="TAPResultextendsObject"></a> <a id="TAPResult:TAPResult"></a> @@ -229,7 +228,7 @@ <a href="TAPResult.html"><span class="name">TAPResult</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> </span> </h4> - + <p class="comment cmt">The summarized results of a TAP stream.</p> </li><li name="org.perl8.test.tap.TestBuilder" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="TestBuilderextendsObject"></a> <a id="TestBuilder:TestBuilder"></a> @@ -242,7 +241,8 @@ <a href="TestBuilder.html"><span class="name">TestBuilder</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> </span> </h4> - + <p class="comment cmt">This class provides a convenient yet low level API for generating TAP +streams.</p> </li><li name="org.perl8.test.tap.TestResult" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="TestResultextendsObject"></a> <a id="TestResult:TestResult"></a> @@ -255,7 +255,7 @@ <a href="TestResult.html"><span class="name">TestResult</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> </span> </h4> - + <p class="comment cmt">The result of a single test.</p> </li><li name="org.perl8.test.tap.TodoDirective" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="TodoDirectiveextendsDirectivewithProductwithSerializable"></a> <a id="TodoDirective:TodoDirective"></a> @@ -265,10 +265,10 @@ <span class="kind">case class</span> </span> <span class="symbol"> - <a href="TodoDirective.html"><span class="name">TodoDirective</span></a><span class="params">(<span name="message">message: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result"> extends <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> + <a href="TodoDirective.html"><span class="name">TodoDirective</span></a><span class="result"> extends <a href="Directive.html" class="extype" name="org.perl8.test.tap.Directive">Directive</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">A directive indicating that this test is known to fail.</p> </li></ol> </div> @@ -288,7 +288,7 @@ <a href="Consumer$.html"><span class="name">Consumer</span></a> </span> </h4> - + <p class="comment cmt">Contains a method to parse an individual line of TAP.</p> </li><li name="org.perl8.test.tap.Producer" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="Producer"></a> <a id="Producer:Producer"></a> @@ -301,7 +301,7 @@ <a href="Producer$.html"><span class="name">Producer</span></a> </span> </h4> - + <p class="comment cmt">Contains functions for producing individual lines of TAP.</p> </li><li name="org.perl8.test.tap.StartEvent" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="StartEvent"></a> <a id="StartEvent:StartEvent"></a> @@ -314,7 +314,7 @@ <a href="StartEvent$.html"><span class="name">StartEvent</span></a><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">The start of a TAP stream.</p> </li><li name="org.perl8.test.tap.SubtestStartEvent" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> <a id="SubtestStartEvent"></a> <a id="SubtestStartEvent:SubtestStartEvent"></a> @@ -327,7 +327,7 @@ <a href="SubtestStartEvent$.html"><span class="name">SubtestStartEvent</span></a><span class="result"> extends <a href="TAPEvent.html" class="extype" name="org.perl8.test.tap.TAPEvent">TAPEvent</a> with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> </span> </h4> - + <p class="comment cmt">The start of a subtest (currently unused).</p> </li></ol> </div> |