aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2013-03-01 17:23:14 -0600
committerJesse Luehrs <doy@tozt.net>2013-03-01 17:23:14 -0600
commit09b4f8838a819a6eea9e941bf8162458690540ce (patch)
tree69674ba2956d7b370d71a00497c2b3993714ffac
parent182b2cebe6a8482cebf459ca2341bae8a68e3ffc (diff)
downloadscala-test-more-09b4f8838a819a6eea9e941bf8162458690540ce.tar.gz
scala-test-more-09b4f8838a819a6eea9e941bf8162458690540ce.zip
some cleanups
-rw-r--r--src/main/scala/org/perl8/test/harness/MultiTestReporter.scala2
-rw-r--r--src/main/scala/org/perl8/test/harness/Reporter.scala2
-rw-r--r--src/main/scala/org/perl8/test/harness/package.scala5
-rw-r--r--src/main/scala/org/perl8/test/package.scala9
-rw-r--r--src/main/scala/org/perl8/test/sbt/SBTReporter.scala3
-rw-r--r--src/main/scala/org/perl8/test/sbt/package.scala3
-rw-r--r--src/main/scala/org/perl8/test/tap/Producer.scala3
-rw-r--r--src/main/scala/org/perl8/test/tap/package.scala3
8 files changed, 11 insertions, 19 deletions
diff --git a/src/main/scala/org/perl8/test/harness/MultiTestReporter.scala b/src/main/scala/org/perl8/test/harness/MultiTestReporter.scala
index 8d50528..8437c4a 100644
--- a/src/main/scala/org/perl8/test/harness/MultiTestReporter.scala
+++ b/src/main/scala/org/perl8/test/harness/MultiTestReporter.scala
@@ -4,7 +4,7 @@ package org.perl8.test.harness
* of test classes, given their names. This typically involves some sort of
* summarization.
*
- * See also: [[org.perl8.test.harness.MultiTestReporter]].
+ * @see [[org.perl8.test.harness.Reporter Reporter]].
*/
trait MultiTestReporter {
/** Runs the test classes identifed by the list of fully qualified class
diff --git a/src/main/scala/org/perl8/test/harness/Reporter.scala b/src/main/scala/org/perl8/test/harness/Reporter.scala
index 749cb30..bf818db 100644
--- a/src/main/scala/org/perl8/test/harness/Reporter.scala
+++ b/src/main/scala/org/perl8/test/harness/Reporter.scala
@@ -3,7 +3,7 @@ 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]].
+ * @see [[org.perl8.test.harness.MultiTestReporter MultiTestReporter]].
*/
trait Reporter {
/** Runs the test class identifed by the fully qualified class name
diff --git a/src/main/scala/org/perl8/test/harness/package.scala b/src/main/scala/org/perl8/test/harness/package.scala
index fbebf07..919abc2 100644
--- a/src/main/scala/org/perl8/test/harness/package.scala
+++ b/src/main/scala/org/perl8/test/harness/package.scala
@@ -1,12 +1,11 @@
package org.perl8.test
-/** Classes to handle running test instances and providing output.
- */
+/** Classes to handle running test instances and providing output. */
package object harness {
import scala.reflect.{ClassTag,classTag}
/** Loads `className`, returning the
- * [[http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html java.lang.Class]]
+ * [[http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html Class]]
* instance.
*/
def loadClass[T: ClassTag] (className: String): Class[_] =
diff --git a/src/main/scala/org/perl8/test/package.scala b/src/main/scala/org/perl8/test/package.scala
index d532aef..5b9edbb 100644
--- a/src/main/scala/org/perl8/test/package.scala
+++ b/src/main/scala/org/perl8/test/package.scala
@@ -14,8 +14,7 @@ package object test {
* will be run.
*/
sealed trait Plan {
- /** How many tests will be run.
- */
+ /** How many tests will be run. */
val plan: Int
/** Whether this test was skipped. It should contain `Some(message)` if
* the test is skipped, and `None` otherwise.
@@ -23,8 +22,7 @@ package object test {
val skipAll: Option[String]
}
- /** An explicit plan number. Corresponds to `1..5` in TAP.
- */
+ /** An explicit plan number. Corresponds to `1..5` in TAP. */
case class NumericPlan (plan: Int) extends Plan {
/** @inheritdoc
*
@@ -33,8 +31,7 @@ package object test {
val skipAll = None
}
- /** A test which did not declare a plan yet.
- */
+ /** A test which did not declare a plan yet. */
case object NoPlan extends Plan {
/** @inheritdoc
*
diff --git a/src/main/scala/org/perl8/test/sbt/SBTReporter.scala b/src/main/scala/org/perl8/test/sbt/SBTReporter.scala
index 5277904..9671f8e 100644
--- a/src/main/scala/org/perl8/test/sbt/SBTReporter.scala
+++ b/src/main/scala/org/perl8/test/sbt/SBTReporter.scala
@@ -6,8 +6,7 @@ import org.perl8.test.harness.{Reporter,SummarizedTests}
import org.perl8.test.tap.{TAPEvent,ResultEvent,EndEvent}
import org.perl8.test.Test
-/** Runs a single test under the SBT test harness.
- */
+/** Runs a single test under the SBT test harness. */
class SBTReporter (
loader: ClassLoader,
loggers: Array[testing.Logger],
diff --git a/src/main/scala/org/perl8/test/sbt/package.scala b/src/main/scala/org/perl8/test/sbt/package.scala
index ce3652a..2f97e65 100644
--- a/src/main/scala/org/perl8/test/sbt/package.scala
+++ b/src/main/scala/org/perl8/test/sbt/package.scala
@@ -1,5 +1,4 @@
package org.perl8.test
-/** Classes for interoperating with `sbt test`.
- */
+/** Classes for interoperating with `sbt test`. */
package object sbt
diff --git a/src/main/scala/org/perl8/test/tap/Producer.scala b/src/main/scala/org/perl8/test/tap/Producer.scala
index 21997ad..2b919af 100644
--- a/src/main/scala/org/perl8/test/tap/Producer.scala
+++ b/src/main/scala/org/perl8/test/tap/Producer.scala
@@ -1,7 +1,6 @@
package org.perl8.test.tap
-/** Contains functions for producing individual lines of TAP.
- */
+/** Contains functions for producing individual lines of TAP. */
object Producer {
import org.perl8.test.Plan
diff --git a/src/main/scala/org/perl8/test/tap/package.scala b/src/main/scala/org/perl8/test/tap/package.scala
index 434497d..7721d7f 100644
--- a/src/main/scala/org/perl8/test/tap/package.scala
+++ b/src/main/scala/org/perl8/test/tap/package.scala
@@ -1,7 +1,6 @@
package org.perl8.test
-/** Classes for TAP generation and parsing.
- */
+/** Classes for TAP generation and parsing. */
package object tap {
/** Exception representing an error during parsing. It is thrown when a TAP
* line isn't recognized.