Merge #396 from 'fixJavadoc' of https://github.com/metafacture/metafacture-core

Author: dr0i

build.gradle

@@ -58,6 +58,7 @@ subprojects {
   apply plugin: 'checkstyle'
 
   check.dependsOn(editorconfigCheck)
+  check.dependsOn(javadoc)
 
   sourceCompatibility = 1.8
   targetCompatibility = 1.8
@@ -81,6 +82,12 @@ subprojects {
     group 'build'
   }
 
+  javadoc {
+    options {
+      addBooleanOption 'Xwerror', true
+    }
+  }
+
   artifacts {
     archives sourceJar
     archives javadocJar

config/checkstyle/checkstyle.xml

@@ -68,6 +68,7 @@
         <module name="InterfaceIsType"/>
         <module name="InterfaceTypeParameterName"/>
         <module name="JavaNCSS"/>
+        <module name="JavadocMethod"/>
         <module name="JavadocType"/>
         <module name="LambdaParameterName"/>
         <module name="LeftCurly"/>
@@ -81,6 +82,7 @@
         <module name="MethodTypeParameterName"/>
         <module name="MissingCtor"/>
         <module name="MissingDeprecated"/>
+        <module name="MissingJavadocMethod"/>
         <module name="MissingOverride"/>
         <module name="MissingSwitchDefault"/>
         <module name="ModifiedControlVariable"/>
@@ -97,6 +99,7 @@
         <module name="NoClone"/>
         <module name="NoEnumTrailingComma"/>
         <module name="NoFinalizer"/>
+        <module name="NonEmptyAtclauseDescription"/>
         <module name="NoWhitespaceAfter"/>
         <module name="NoWhitespaceBefore"/>
         <module name="OneStatementPerLine">

metafacture-biblio/src/main/java/org/metafacture/biblio/AlephMabXmlHandler.java

@@ -50,6 +50,9 @@ public final class AlephMabXmlHandler extends DefaultXmlPipe<StreamReceiver> {
     private String currentTag = "";
     private StringBuilder builder = new StringBuilder();
 
+    /**
+     * Creates instance of {@link AlephMabXmlHandler}.
+     */
     public AlephMabXmlHandler() {
     }
 

metafacture-biblio/src/main/java/org/metafacture/biblio/AseqDecoder.java

@@ -42,6 +42,9 @@ public final class AseqDecoder extends DefaultObjectPipe<String, StreamReceiver>
     private static final int RECORD_IDENTIFIER_BEGIN = 0;
     private static final int RECORD_IDENTIFIER_END = 9;
 
+    /**
+     * Creates an instance of {@link AseqDecoder}.
+     */
     public AseqDecoder() {
     }
 

metafacture-biblio/src/main/java/org/metafacture/biblio/ComarcXmlHandler.java

@@ -63,6 +63,9 @@ public class ComarcXmlHandler extends DefaultXmlPipe<StreamReceiver> {
     private String currentTag = "";
     private StringBuilder builder = new StringBuilder();
 
+    /**
+     * Creates an instance of {@link ComarcXmlHandler}.
+     */
     public ComarcXmlHandler() {
     }
 

metafacture-biblio/src/main/java/org/metafacture/biblio/MabDecoder.java

@@ -57,6 +57,9 @@ public final class MabDecoder extends DefaultObjectPipe<String, StreamReceiver>
     private static final String ID_TAG = "001 ";
     private static final int TAG_LENGTH = 4;
 
+    /**
+     * Creates an instance of {@link MabDecoder}.
+     */
     public MabDecoder() {
     }
 

metafacture-biblio/src/main/java/org/metafacture/biblio/iso2709/FieldHandler.java

@@ -24,14 +24,42 @@
  */
 public interface FieldHandler {
 
+    /**
+     * Reference a field.
+     *
+     * @param tag             the tag
+     * @param implDefinedPart the impl defined part
+     * @param value           the value
+     */
     void referenceField(char[] tag, char[] implDefinedPart, String value);
 
+    /**
+     * Starts a data field.
+     *
+     * @param tag             the tag
+     * @param implDefinedPart the impl defined part
+     * @param indicators      the indicators
+     */
     void startDataField(char[] tag, char[] implDefinedPart, char[] indicators);
 
+    /**
+     * Ends the data field.
+     */
     void endDataField();
 
+    /**
+     * Sets the impl defined part.
+     *
+     * @param implDefinedPart he impl defined part
+     */
     void additionalImplDefinedPart(char[] implDefinedPart);
 
+    /**
+     * Sets the identifier to a value.
+     *
+     * @param identifier the identifier
+     * @param value      the value
+     */
     void data(char[] identifier, String value);
 
 }

metafacture-biblio/src/main/java/org/metafacture/biblio/iso2709/Label.java

@@ -17,7 +17,7 @@
 package org.metafacture.biblio.iso2709;
 
 /**
- * Provides read access to the record label of a ISO 2709:2008 formatted
+ * Provides read access to the record label of an ISO 2709:2008 formatted
  * record. The record label consists of the first 24 octets of the record.
  * <p>
  * Use {@link LabelBuilder} if write access to the label is required.

metafacture-biblio/src/main/java/org/metafacture/biblio/iso2709/Record.java

@@ -91,22 +91,47 @@ private int findRecordIdFieldStart() {
         return RECORD_ID_MISSING;
     }
 
+    /**
+     * Gets the record format of the Label.
+     *
+     * @return the record format of the Label
+     */
     public RecordFormat getRecordFormat() {
         return label.getRecordFormat();
     }
 
+    /**
+     * Gets the record status of the Label.
+     *
+     * @return the record status of the Label
+     */
     public char getRecordStatus() {
         return label.getRecordStatus();
     }
 
+    /**
+     * Gets the impl codes.
+     *
+     * @return the impl codes
+     */
     public char[] getImplCodes() {
         return label.getImplCodes();
     }
 
+    /**
+     * Gets the systems chars of the Label.
+     *
+     * @return the system chars
+     */
     public char[] getSystemChars() {
         return label.getSystemChars();
     }
 
+    /**
+     * Gets the reserved char of the Label.
+     *
+     * @return the reserved char
+     */
     public char getReservedChar() {
         return label.getReservedChar();
     }