Changeset 2218 for trunk/autoquest-core-tasktrees

Timestamp:

11/29/17 14:55:48 (7 years ago)

Author:

pharms

Message:

• java doc issues removal

Location:

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

Files:

• taskequality/TaskEquality.java (modified) (2 diffs)
• taskequality/TaskEqualityRuleManager.java (modified) (12 diffs)
• temporalrelation/TaskSymbolBucketedMap.java (modified) (1 diff)
• temporalrelation/TemporalRelationshipRuleManager.java (modified) (3 diffs)
• treeifc/ITaskBuilder.java (modified) (1 diff)

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

@@ -19 +19 @@
  * A task equality denotes, how equal two tasks are. There are different equality levels
  * which are similar to the usual design levels of GUI design. These levels are
+ * </p>
  * <ul>
  *   <li>conceptual design: defines the concepts to be edited using a GUI</li>
@@ -26 +27 @@
  *       can be performed</li>
  * </ul>
+ * <p>
  * It is not possible to compare two tasks conceptually. But the other design levels can be
  * identified and compared.

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

@@ -92 +92 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public TaskEquality compare(ITask task1, ITask task2)
@@ -132 +131 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public boolean areAtLeastEqual(ITask task1, ITask task2, TaskEquality equalityLevel) {
@@ -168 +166 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public boolean areIdentical(ITask task1, ITask task2) {
@@ -197 +194 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public boolean areLexicallyEqual(ITask task1, ITask task2) {
@@ -226 +222 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public boolean areSyntacticallyEqual(ITask task1, ITask task2) {
@@ -255 +250 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public boolean areSemanticallyEqual(ITask task1, ITask task2) {
@@ -285 +279 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2)
@@ -325 +318 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public boolean areAtLeastEqual(ITaskInstance        instance1,
@@ -364 +356 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public boolean areIdentical(ITaskInstance instance1, ITaskInstance instance2) {
@@ -395 +386 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2) {
@@ -426 +416 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2) {
@@ -457 +446 @@
      * @return as described
      * 
-     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the
-     *                               manager before a call to this method.
+     * @throws IllegalStateException in the case, the object is not correctly initialized
      */
     public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2) {

trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskSymbolBucketedMap.java

@@ -54 +54 @@
  * </p>
  * 
- * @see SymbolComparator
+ * @see TaskComparator
  * 
  * @author Patrick Harms

trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TemporalRelationshipRuleManager.java

@@ -40 +40 @@
  * </p>
  * <p>The class holds references to the appropriate {@link ITaskInstanceScopeRule}s and calls
- * their {@link ITaskInstanceScopeRule#apply(ITask, ITaskBuilder, ITaskFactory, boolean)}
+ * their {@link ITaskInstanceScopeRule#apply(de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance)}
  * method for each task in the task tree it is needed for. The general behavior of this class is
  * the following:
+ * </p>
  * <ol>
  *   <li>
@@ -49 +50 @@
  *   </li>
  *   <li>
- *     then the {@link #applyRules(ITask, ITaskBuilder, ITaskFactory, boolean)}
+ *     then the {@link #applyTaskDetectionRule(List, TaskEquality, int)}
  *     method is called for a so far unstructured task
  *   </li>
@@ -77 +78 @@
  *   </li>
  * </ol>
+ * <p>
  * Through this, all rules are tried to be applied at least once to the provided parent task and
  * all parent tasks created during the rule application.

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

@@ -252 +252 @@
      * @param oldChild the child to replace
      * @param newChild the replacement for the child
-     * 
-     * @throws as described
      */
     void replaceChild(ISelection parent, ITask oldChild, ITask newChild);