Changeset 1414 for trunk/autoquest-core-tasktrees

Timestamp:

02/27/14 17:21:20 (11 years ago)

Author:

pharms

Message:

• added/corrected some JavaDoc? comments

Location:

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

Files:

• EventTaskInstance.java (modified) (2 diffs)
• IterationInstance.java (modified) (3 diffs)
• OptionalInstance.java (modified) (3 diffs)
• SelectionInstance.java (modified) (2 diffs)
• SequenceInstance.java (modified) (4 diffs)

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

@@ -21 +21 @@
 /**
  * <p>
- * TODO comment
+ * Default implementation of {@link IEventTaskInstance}.
  * </p>
  * 
@@ -44 +44 @@
     /**
      * <p>
-     * TODO: comment
+     * initializes this instance with the respective task model and the represented event
      * </p>
      *
-     * @param task
-     * @param event
+     * @param task  the task of which this is an instance
+     * @param event the event represented by this instance
      */
     EventTaskInstance(IEventTask task, Event event) {

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

@@ -26 +26 @@
 /**
  * <p>
- * TODO comment
+ * Default implementation of {@link IIterationInstance}.
  * </p>
  * 
@@ -49 +49 @@
     /**
      * <p>
-     * TODO: comment
+     * initializes this instance with the respective task model
      * </p>
      *
-     * @param task
+     * @param task  the task of which this is an instance
      */
     IterationInstance(IIteration task) {
@@ -167 +167 @@
      * @param index the position of the child to be removed
      * 
-     * @return the child remove from the children of this instance
+     * @return the child removed from the children of this instance
      */
     synchronized ITaskInstance removeChild(int index) {

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

@@ -22 +22 @@
 /**
  * <p>
- * TODO comment
+ * Default implementation of {@link IOptionalInstance}.
  * </p>
  * 
@@ -38 +38 @@
     /**
      * <p>
-     * the child of this task instance
+     * the child of this task instance if any
      * </p>
      */
@@ -45 +45 @@
     /**
      * <p>
-     * TODO: comment
+     * initializes this instance with the respective task model
      * </p>
      *
-     * @param task
+     * @param task  the task of which this is an instance
      */
     OptionalInstance(ITask task) {

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

@@ -22 +22 @@
 /**
  * <p>
- * TODO comment
+ * Default implementation of {@link ISelectionInstance}.
  * </p>
  * 
@@ -45 +45 @@
     /**
      * <p>
-     * TODO: comment
+     * initializes this instance with the respective task model
      * </p>
      *
-     * @param task
+     * @param task  the task of which this is an instance
      */
     SelectionInstance(ITask task) {

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

@@ -20 +20 @@
 import java.util.List;
 
+import de.ugoe.cs.autoquest.tasktrees.treeifc.IIterationInstance;
 import de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence;
 import de.ugoe.cs.autoquest.tasktrees.treeifc.ISequenceInstance;
@@ -26 +27 @@
 /**
  * <p>
- * TODO comment
+ * Default implementation of {@link IIterationInstance}.
  * </p>
  * 
@@ -49 +50 @@
     /**
      * <p>
-     * TODO: comment
+     * initializes this instance with the respective task model
      * </p>
      *
-     * @param task
+     * @param task  the task of which this is an instance
      */
     SequenceInstance(ISequence task) {
@@ -167 +168 @@
      * @param index the position of the child to be removed
      * 
-     * @return the child remove from the children of this instance
+     * @return the child removed from the children of this instance
      */
     synchronized ITaskInstance removeChild(int index) {