Fix some more javadoc error and warnings (#396)

- fix some reference errors
- simplify constructor

Author: dr0i

metafacture-commons/src/main/java/org/metafacture/commons/TimeUtil.java

@@ -40,8 +40,7 @@ private TimeUtil() {
     }
 
     /**
-     * Formats a duration to human readable abbrevations. See {@link TimeUtilTest}
-     * how to use it.
+     * Formats a duration to human readable abbrevations.
      *
      * @param duration a long value of the duration
      * @return a human readable format of the duration

metafacture-html/src/main/java/org/metafacture/html/HtmlDecoder.java

@@ -124,7 +124,7 @@ private boolean handleAttributeValuesAsSubfields(final StreamReceiver receiver,
     }
 
     /**
-     * Sets attribute values as subfields. If the value(s) start with an `&` they
+     * Sets attribute values as subfields. If the value(s) start with an `&` they
      * are appended to {@link #DEFAULT_ATTR_VALS_AS_SUBFIELDS}.
      *
      * @param mapString the attributes to be added as subfields

metafacture-triples/src/main/java/org/metafacture/triples/SortedTripleFileFacade.java

@@ -42,7 +42,7 @@ public final class SortedTripleFileFacade {
      * file.
      *
      * @param file the File to load a Triple from
-     * @throws IOException
+     * @throws IOException if Triple can't be loaded
      */
     public SortedTripleFileFacade(final File file) throws IOException {
         this.file = file;
@@ -66,7 +66,7 @@ private void next() throws IOException {
     }
 
     /**
-     * Closes the {@link #ObjectInputStream} and deletes the {@value #file} it if it
+     * Closes the {@link ObjectInputStream} and deletes the {@link #file} it if it
      * exists.
      */
     public void close() {
@@ -97,7 +97,7 @@ public Triple peek() {
      * Pops a Triple from the stack.
      *
      * @return the Triple at the top of the stack.
-     * @throws IOException
+     * @throws IOException if the Triple can't be loaded
      */
     public Triple pop() throws IOException {
         final Triple nextTriple = peek();

metafacture-yaml/src/main/java/org/metafacture/yaml/YamlDecoder.java

@@ -56,17 +56,12 @@ public final class YamlDecoder extends DefaultObjectPipe<String, StreamReceiver>
     private final YAMLFactory yamlFactory = new YAMLFactory();
 
     private YAMLParser yamlParser;
-    private String arrayMarker;
-    private String arrayName;
-    private String recordId;
+    private String arrayMarker = DEFAULT_ARRAY_MARKER;
+    private String arrayName = DEFAULT_ARRAY_NAME;
+    private String recordId = DEFAULT_RECORD_ID;
     private int recordCount;
 
     public YamlDecoder() {
-        setArrayMarker(DEFAULT_ARRAY_MARKER);
-        setArrayName(DEFAULT_ARRAY_NAME);
-        setRecordId(DEFAULT_RECORD_ID);
-
-        resetRecordCount();
     }
 
     public void setArrayMarker(final String arrayMarker) {

metafacture-yaml/src/main/java/org/metafacture/yaml/YamlEncoder.java

@@ -63,6 +63,9 @@ public final class YamlEncoder extends DefaultStreamPipe<ObjectReceiver<String>>
 
     private String arrayMarker = ARRAY_MARKER;
 
+    /**
+     * Constructs a YamlEncoder if no IOException occurs.
+     */
     public YamlEncoder() {
         try {
             yamlGenerator = new YAMLFactory().createGenerator(writer);

metamorph-api/src/main/java/org/metafacture/metamorph/api/helpers/AbstractFunction.java

@@ -50,7 +50,7 @@ public final String getMapName() {
     }
 
     /**
-     * Gets the {@value #localMap} or a Map with the name of {@value #mapName}.
+     * Gets the {@link #localMap} or a Map with the name of {@link #mapName}.
      *
      * @return the Map
      */

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

@@ -45,7 +45,7 @@ public final class MetamorphTestSuite extends ParentRunner<Runner> {
      * to a class.
      *
      * @param suiteRoot the {@code @TestClass}
-     * @throws InitializationError
+     * @throws InitializationError if definitions couldn't be loaded
      */
     public MetamorphTestSuite(final Class<?> suiteRoot)
             throws InitializationError {

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

@@ -36,7 +36,7 @@ public MultiFormatReader(final String format) {
     }
 
     /**
-     * Sets the format of {@value #currentReader} if the {@value #READER_FACTORY}
+     * Sets the format of {@link #currentReader} if the {@link #READER_FACTORY}
      * contains that format.
      *
      * @param format the format

metamorph/src/main/java/org/metafacture/metamorph/functions/Case.java

@@ -59,7 +59,7 @@ public void setTo(final String string) {
     }
 
     /**
-     * Sets the language if it's present in {@value #SUPPORTED_LANGUAGES}.
+     * Sets the language if it's present in {@link #LANGUAGES}.
      *
      * @param language the language
      */

metamorph/src/main/java/org/metafacture/metamorph/functions/DateFormat.java

@@ -179,7 +179,7 @@ public final void setRemoveLeadingZeros(final boolean removeLeadingZeros) {
     }
 
     /**
-     * Sets the language if it's present in {@value #SUPPORTED_LANGUAGES}.
+     * Sets the language if it's present in {@link #SUPPORTED_LANGUAGES}.
      *
      * @param language the language
      */