aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/scala/org/perl8/test/harness/Reporter.scala
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/scala/org/perl8/test/harness/Reporter.scala')
-rw-r--r--src/main/scala/org/perl8/test/harness/Reporter.scala10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/main/scala/org/perl8/test/harness/Reporter.scala b/src/main/scala/org/perl8/test/harness/Reporter.scala
index 536636f..749cb30 100644
--- a/src/main/scala/org/perl8/test/harness/Reporter.scala
+++ b/src/main/scala/org/perl8/test/harness/Reporter.scala
@@ -1,5 +1,15 @@
package org.perl8.test.harness
+/** Classes that implement `Reporter` are capable of running a test class,
+ * given its name.
+ *
+ * See also: [[org.perl8.test.harness.MultiTestReporter]].
+ */
trait Reporter {
+ /** Runs the test class identifed by the fully qualified class name
+ * `testName`.
+ *
+ * @return The exit code for the harness to use. Will be 0 on success.
+ */
def run (testName: String): Int
}