Fix javadoc for module "framework"

See #396.

Author: dr0i

metafacture-framework/src/main/java/org/metafacture/framework/annotations/Description.java

@@ -22,14 +22,19 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-
 /**
- * @author Markus Michael Geipel
  * Metadata for pipe elements
+ *
+ * @author Markus Michael Geipel
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface Description {
+    /**
+     * Returns the description of the class.
+     *
+     * @return the description as String
+     */
     String value();
 }

metafacture-framework/src/main/java/org/metafacture/framework/annotations/In.java

@@ -22,14 +22,19 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-
 /**
- * @author Markus Michael Geipel
  * Metadata for pipe elements
+ *
+ * @author Markus Michael Geipel
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface In {
+    /**
+     * Returns the class used as input to when using the class in a pipe.
+     *
+     * @return the Class
+     */
     Class<?> value();
 }

metafacture-framework/src/main/java/org/metafacture/framework/annotations/Out.java

@@ -22,14 +22,19 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-
 /**
+ * Metadata for pipe elements.
+ *
  * @author Markus Michael Geipel
- * Metadata for pipe elements
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface Out {
+    /**
+     * Returns the class used as output when using this class in a pipe.
+     *
+     * @return the Class
+     */
     Class<?> value();
 }

metafacture-framework/src/main/java/org/metafacture/framework/objects/Triple.java

@@ -40,6 +40,14 @@ public Triple(final String subject, final String predicate,
         this(subject, predicate, object, ObjectType.STRING);
     }
 
+    /**
+     * Constructs a Triple.
+     *
+     * @param subject    the subject
+     * @param predicate  the predicate
+     * @param object     the object
+     * @param objectType the ObjectType
+     */
     public Triple(final String subject, final String predicate,
             final String object, final ObjectType objectType) {
         this.subject = subject;
@@ -69,6 +77,13 @@ public ObjectType getObjectType() {
         return objectType;
     }
 
+    /**
+     * Reads an ObjectInputStream as Triple and returns it.
+     *
+     * @param in the ObjectInputStream
+     * @return the Triple
+     * @throws IOException
+     */
     public static Triple read(final ObjectInputStream in) throws IOException {
         try {
             return new Triple(in.readUTF(), in.readUTF(), in.readUTF(),
@@ -79,6 +94,12 @@ public static Triple read(final ObjectInputStream in) throws IOException {
         }
     }
 
+    /**
+     * Writes the Triple to an ObjectOutputStream.
+     *
+     * @param out the ObjectOutputStream.
+     * @throws IOException
+     */
     public void write(final ObjectOutputStream out) throws IOException {
         out.writeUTF(subject);
         out.writeUTF(predicate);