Changeset 1154 for trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/IterationComparisonRule.java

Timestamp:

04/19/13 17:02:50 (11 years ago)

Author:

pharms

Message:

• improved java doc

File:

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

trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/IterationComparisonRule.java

@@ -222 +222 @@
 
     /**
-     * TODO update comment
+     * <p>
+     * compares two tasks with each other by calling the rule manager. If the rule manager returns
+     * identity, then the returned equality is set to lexically equal. The reason is, that
+     * the children of the iterations are compared and that therefore the distinct iterations
+     * can be at most lexically equal.
+     * </p>
+     * 
+     * @param child1 the first task to be compared
+     * @param child2 the second task to be compared
+     * 
+     * @return the determined equality being at most lexical equality.
      */
     private TaskEquality getNodeEquality(ITask child1, ITask child2) {
@@ -243 +253 @@
     /**
      * <p>
-     * compares two tasks. One of them must be a selection, the other one can be any task
-     * tree task. The method returns a task equality that is not <code>NodeEquality.UNEQUAL</code>
+     * compares two tasks. One of them must be a selection, the other one can be any task.
+     * The method returns a task equality that is not <code>NodeEquality.UNEQUAL</code>
      * if the other task is at least semantically equal to the children of the selection. It
      * returns more concrete equalities, if the equality between the other task and the children
@@ -250 +260 @@
      * </p> 
      * 
-     * @param taskTreeNode  the first task to compare
-     * @param taskTreeNode2 the second task to compare
+     * @param task1 the first task to compare
+     * @param task2 the second task to compare
      * 
      * @return as described
@@ -292 +302 @@
     /**
      * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @param child1
-     * @param child2
-     * @param requiredEqualityLevel
-     * @return
+     * used to to call the task equality rule manager for the comparison of the two provided
+     * children. If no required equality level is provided, than the most concrete equality is
+     * returned. Otherwise, the required equality is returned as long as the children are equal
+     * on that level.
+     * </p> 
+     * 
+     * @param child1                the first task to be compared
+     * @param child2                the second task to be compared
+     * @param requiredEqualityLevel the equality level to be checked for
+     * 
+     * @return the determined equality
      */
     private TaskEquality callRuleManager(ITask        child1,