Changeset 1215 for trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/MarkingTemporalRelationship.java

Timestamp:

05/27/13 15:24:09 (11 years ago)

Author:

pharms

Message:

• improved java doc

File:

• trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/MarkingTemporalRelationship.java (modified) (4 diffs)

trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/MarkingTemporalRelationship.java

@@ -20 +20 @@
 /**
  * <p>
- * TODO comment
+ * this is the default implementation of the interface {@link IMarkingTemporalRelationship}. It
+ * does not do anything fancy except implementing the interface.
  * </p>
  * 
@@ -29 +30 @@
 {
 
-    /**  */
+    /**
+     * <p>
+     * default serial version UID
+     * </p>
+     */
     private static final long serialVersionUID = 1L;
 
     /**
-     * 
+     * <p>
+     * the task marked through this marking temporal relationship
+     * </p>
      */
     private ITask markedTask;
     
     /**
-     * 
+     * <p>
+     * a human readable name for this temporal relationship
+     * </p>
      */
     private String relationshipType;
@@ -44 +53 @@
     /**
      * <p>
-     * TODO: comment
+     * initializes this temporal relationship with a human readable name
      * </p>
      *
-     * @param description
+     * @param relationshipType the human readable name of this temporal relationship
      */
     MarkingTemporalRelationship(String relationshipType) {
@@ -83 +92 @@
 
     /**
-     * @param markedTask the markedTask to set
+     * <p>
+     * used to set the marked task
+     * </p>
+     * 
+     * @param markedTask the marked task to set
      */
     protected void setMarkedTask(ITask markedTask) {