Fix javadoc for module "io" (#396)

Author: dr0i

metafacture-io/src/main/java/org/metafacture/io/LineReader.java

@@ -52,6 +52,13 @@ public void process(final Reader reader) {
         process(reader, getReceiver());
     }
 
+    /**
+     * Processes input from a reader line by line and pass them line by line to a
+     * receiver.
+     *
+     * @param reader   the Reader
+     * @param receiver the ObjectReceiver
+     */
     public static void process(final Reader reader, final ObjectReceiver<String> receiver) {
         final BufferedReader lineReader = new BufferedReader(reader, BUFFER_SIZE);
         try {

metafacture-io/src/main/java/org/metafacture/io/ObjectFileWriter.java

@@ -52,6 +52,11 @@ public final class ObjectFileWriter<T> extends AbstractObjectWriter<T>  {
     private String encoding = "UTF-8";
     private FileCompression compression = FileCompression.AUTO;
 
+    /**
+     * Sets the destination of a file to write objects to.
+     *
+     * @param path the path to be written to
+     */
     public ObjectFileWriter(final String path) {
         this.path = path;
         startNewFile();

metafacture-io/src/main/java/org/metafacture/io/ObjectJavaIoWriter.java

@@ -36,11 +36,20 @@ public final class ObjectJavaIoWriter<T> implements ObjectReceiver<T> {
     private boolean closed;
     private final IoWriterFactory writerFactory;
 
+    /**
+     * Deprecated.
+     * @param writer the Writer
+     */
     public ObjectJavaIoWriter(final Writer writer) {
         this.writer = writer;
         writerFactory = null;
     }
 
+    /**
+     * Deprecated.
+     *
+     * @param writerFactory the IoWriterFactory
+     */
     public ObjectJavaIoWriter(final IoWriterFactory writerFactory) {
         this.writerFactory = writerFactory;
         this.writer = writerFactory.createWriter();

metafacture-io/src/main/java/org/metafacture/io/ObjectWriter.java

@@ -45,6 +45,14 @@ public final class ObjectWriter<T> implements ConfigurableObjectWriter<T> {
 
     private final ConfigurableObjectWriter<T> objectWriter;
 
+    /**
+     * Sets the destination to write objects to. If destination is set to
+     * {@value #STDOUT} the object is written to standard out. Else it's written to
+     * a file.
+     *
+     * @param destination the path to be written to or standard out if it's
+     *                    {@value #STDOUT}
+     */
     public ObjectWriter(final String destination) {
         if (STDOUT.equals(destination)) {
             objectWriter = new ObjectStdoutWriter<T>();

metafacture-io/src/main/java/org/metafacture/io/RecordReader.java

@@ -56,6 +56,11 @@ public final class RecordReader extends DefaultObjectPipe<Reader, ObjectReceiver
     public RecordReader() {
     }
 
+    /**
+     * Sets the separator. The default is the global separator character (0x001d).
+     *
+     * @param separator the separator
+     */
     public void setSeparator(final String separator) {
         if (separator.length() >= 1) {
             this.separator = separator.charAt(0);