summaryrefslogtreecommitdiffstats
path: root/org/perl8/test/tap/package.html
diff options
context:
space:
mode:
Diffstat (limited to 'org/perl8/test/tap/package.html')
-rw-r--r--org/perl8/test/tap/package.html56
1 files changed, 28 insertions, 28 deletions
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>