Changeset 1167 for trunk/autoquest-core-tasktrees/src/main/java

Timestamp:

04/19/13 19:53:04 (12 years ago)

Author:

pharms

Message:

• improved java doc

Location:

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

Files:

• IEventTask.java (modified) (1 diff)
• ITask.java (modified) (2 diffs)

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

@@ -19 +19 @@
 
 /**
- * TODO comment
+ * <p>
+ * Event tasks represent events. They have no children and are therefore the leaf nodes of the
+ * task tree. They provide information about the event they represent. This includes the event
+ * type and the target.
+ * </p>
  * 
- * @version $Revision: $ $Date: $
- * @author 2011, last modified by $Author: $
+ * @author Patrick Harms
  */
 public interface IEventTask extends ITask {
     
     /**
-     * @return Returns the event type.
+     * <p>
+     * return the type of the event represented by this task
+     * </p>
+     * 
+     * @return as described
      */
     public IEventType getEventType();
 
     /**
-     * @return Returns the event target.
+     * <p>
+     * return the target of the event represented by this task
+     * </p>
+     * 
+     * @return as described
      */
     public IEventTarget getEventTarget();
 
     /**
-     *
+     * <p>
+     * returns a clone of this task, i.e. another event task being identical to this. The event
+     * type and target are not cloned but reused.
+     * </p>
+     * 
+     * @return as described
      */
     public IEventTask clone();

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

@@ -19 +19 @@
 /**
  * <p>
- * TODO comment
+ * A task represents a model for events that occur if the user interacts with a software for
+ * achieving a specific goal. A task can be a single event or a complex structure of events
+ * and temporal relationships defining the event order. Tasks may especially refer to other tasks
+ * to create task structures similar to trees. These structures fully define in which ways the
+ * events that form the task can occur.
  * </p>
  * 
@@ -27 +31 @@
 
     /**
-     *
+     * <p>
+     * every task is assigned a unique id which is returned by this method. The id is unique for
+     * the current runtime.
+     * </p>
+     * 
+     * @return as described
      */
     public int getId();
 
     /**
-     *
+     * <p>
+     * returns a human readable description for task. 
+     * </p>
+     * 
+     * @return as described
      */
     public String getDescription();
 
     /**
-     *
+     * <p>
+     * checks whether this task is equal to another one. Task equality is only given, if two
+     * tasks have the same id. This means, that this method must only return true if the other
+     * task is either the same object or a clone of it. 
+     * </p>
+     * 
+     * @return as described
      */
     public boolean equals(ITask task);
 
     /**
-     *
+     * <p>
+     * returns a hash code for the task, which is usually the id returned by {@link #getId()}.
+     * </p>
+     * 
+     * @return as described
      */
     public int hashCode();
 
     /**
-     *
+     * <p>
+     * returns an exact copy of this task. The clone has the same id. If the task has
+     * children, they are cloned as well. A call on the method {@link #equals(ITask)} with the
+     * result of this method must return true.
+     * </p>
+     * 
+     * @return as described
      */
     public ITask clone();
     
     /**
-     *
+     * <p>
+     * implements the visitor pattern to be able to process tasks and their children.
+     * </p>
+     * 
+     * @param visitor the visitor used to process the task
      */
-   public void accept(ITaskVisitor visitor);
+    public void accept(ITaskVisitor visitor);
     
 }