Fix javadoc for module "test" (#396)

Author: dr0i

metamorph-test/src/main/java/org/metafacture/metamorph/test/MetamorphTestSuite.java

@@ -40,6 +40,13 @@ public final class MetamorphTestSuite extends ParentRunner<Runner> {
 
     private final List<Runner> runners;
 
+    /**
+     * Constructs a MetamorphTestSuite by binding a list of Metamorph-Test resources
+     * to a class.
+     *
+     * @param suiteRoot the {@code @TestClass}
+     * @throws InitializationError
+     */
     public MetamorphTestSuite(final Class<?> suiteRoot)
             throws InitializationError {
         super(suiteRoot);

metamorph-test/src/main/java/org/metafacture/metamorph/test/reader/MultiFormatReader.java

@@ -35,6 +35,12 @@ public MultiFormatReader(final String format) {
         setFormat(format);
     }
 
+    /**
+     * Sets the format of {@value #currentReader} if the {@value #READER_FACTORY}
+     * contains that format.
+     *
+     * @param format the format
+     */
     public void setFormat(final String format) {
         if (!READER_FACTORY.containsKey(format)) {
             throw new IllegalArgumentException("Format '" + format + "' not regognized");

metamorph-test/src/main/java/org/metafacture/metamorph/test/validators/StreamValidator.java

@@ -70,6 +70,14 @@ public final class StreamValidator implements StreamReceiver {
 
     private final WellformednessChecker wellformednessChecker = new WellformednessChecker();
 
+    /**
+     * Constructs a StreamValidator with a List of {@link Event}s. Validates this
+     * stream of events using that list of expected stream events. If the stream is
+     * invalid, the error handler set via {@link #setErrorHandler(Consumer)} is
+     * called. Checks for wellformedness and resets the stream.
+     *
+     * @param expectedStream the List of expected stream events
+     */
     public StreamValidator(final List<Event> expectedStream) {
         this.eventStream = new EventNode(null, null);
         foldEventStream(this.eventStream, expectedStream.iterator());
@@ -100,6 +108,12 @@ public boolean isStrictRecordOrder() {
         return strictRecordOrder;
     }
 
+    /**
+     * Sets strict record order.
+     *
+     * @param strictRecordOrder "true" if the record order shall be strict or
+     *                          "false" otherwise
+     */
     public void setStrictRecordOrder(final boolean strictRecordOrder) {
         if (validating) {
             throw new IllegalStateException(CANNOT_CHANGE_OPTIONS);
@@ -112,6 +126,11 @@ public boolean isStrictKeyOrder() {
         return strictKeyOrder;
     }
 
+    /**
+     * Sets strict key order.
+     *
+     * @param strictKeyOrder "true" if key order should be strict, otherwise "false"
+     */
     public void setStrictKeyOrder(final boolean strictKeyOrder) {
         if (validating) {
             throw new IllegalStateException(CANNOT_CHANGE_OPTIONS);
@@ -124,6 +143,12 @@ public boolean isStrictValueOrder() {
         return strictValueOrder;
     }
 
+    /**
+     * Sets strict value order.
+     *
+     * @param strictValueOrder "true" if value order should be strict, otherwise
+     *                         "false"
+     */
     public void setStrictValueOrder(final boolean strictValueOrder) {
         if (validating) {
             throw new IllegalStateException(CANNOT_CHANGE_OPTIONS);