Changeset 1177 for trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstanceList.java

Timestamp:

04/25/13 16:59:20 (11 years ago)

Author:

pharms

Message:

• improved java doc

File:

• trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstanceList.java (modified) (2 diffs)

trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstanceList.java

@@ -19 +19 @@
 /**
  * <p>
- * TODO comment
+ * represents a serializable, clonable, iterable representation of a read only list of task
+ * instances. The list is ordered. It does not provide methods for changing it.
  * </p>
  * 
@@ -27 +28 @@
 
     /**
-     *
+     * <p>
+     * returns the task instance at the position with the given index. May throw an exception
+     * if the index is invalid.
+     * </p>
+     * 
+     * @param index the index of the task instance to be returned
+     * 
+     * @return the task instance at the given index
      */
     public ITaskInstance get(int index);
 
     /**
-     *
+     * <p>
+     * returns the size of the list, i.e. the number of task instances in the list
+     * </p>
+     * 
+     * @return as described
      */
     public int size();
 
     /**
-     *
+     * <p>
+     * clones a task instance list by creating exact clones of each contained instance in their
+     * order
+     * </p>
+     * 
+     * @return a clone of the task instance list
      */
     public ITaskInstanceList clone();