aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/scala/org/perl8/test/harness/MultiTestReporter.scala
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/scala/org/perl8/test/harness/MultiTestReporter.scala')
-rw-r--r--src/main/scala/org/perl8/test/harness/MultiTestReporter.scala11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/main/scala/org/perl8/test/harness/MultiTestReporter.scala b/src/main/scala/org/perl8/test/harness/MultiTestReporter.scala
index b0548e4..8d50528 100644
--- a/src/main/scala/org/perl8/test/harness/MultiTestReporter.scala
+++ b/src/main/scala/org/perl8/test/harness/MultiTestReporter.scala
@@ -1,5 +1,16 @@
package org.perl8.test.harness
+/** Classes that implement `MultiTestReporter` are capable of running a group
+ * of test classes, given their names. This typically involves some sort of
+ * summarization.
+ *
+ * See also: [[org.perl8.test.harness.MultiTestReporter]].
+ */
trait MultiTestReporter {
+ /** Runs the test classes identifed by the list of fully qualified class
+ * names `testNames`.
+ *
+ * @return The exit code for the harness to use. Will be 0 on success.
+ */
def run (testNames: Seq[String]): Int
}