Ignore:
Timestamp:
04/19/13 17:02:50 (11 years ago)
Author:
pharms
Message:
  • improved java doc
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/GUIEventTaskComparisonRule.java

    r1146 r1154  
    133133     * returns lexical equality. 
    134134     * </p> 
    135      * 
    136      * @param interaction1 the first interaction to compare 
    137      * @param interaction2 the second interaction to compare 
    138      * @param eventTarget  the event target on which the interactions happened (used within 
    139      *                     special comparisons like mouse clicks on buttons, where the coordinates 
    140      *                     can be ignored) 
     135     * <p> 
     136     * The provided equality level can be used to restrict the quality check to the given level. 
     137     * This is done for optimization purposes. The returned equality level can be at most as 
     138     * concrete as the provided one. If the provided one is null, it is expected to be lexical 
     139     * equality. 
     140     * </p> 
     141     * 
     142     * @param interaction1  the first interaction to compare 
     143     * @param interaction2  the second interaction to compare 
     144     * @param eventTarget   the event target on which the interactions happened (used within 
     145     *                      special comparisons like mouse clicks on buttons, where the coordinates 
     146     *                      can be ignored) 
     147     * @param equalityLevel the equality level to be checked for 
    141148     *  
    142149     * @return as described 
     
    192199    /** 
    193200     * <p> 
    194      * TODO: comment 
    195      * </p> 
    196      * 
    197      * @param interaction1 
    198      * @param interaction2 
    199      * @param eventTarget 
    200      * @param level 
    201      * @return 
     201     * compares two key interactions. If both are of the same type and if both have the 
     202     * same key, they are lexically equal. If both are only of the same type, they are 
     203     * semantically equal. Otherwise, they are unequal. 
     204     * </p> 
     205     * <p> 
     206     * The provided equality level can be used to restrict the quality check to the given level. 
     207     * This is done for optimization purposes. The returned equality level is as concrete as 
     208     * the provided one. It may be more concrete if there is no difference regarding the 
     209     * comparison on the levels. 
     210     * </p> 
     211     * 
     212     * @param interaction1  the first key interaction 
     213     * @param interaction2  the second key interaction 
     214     * @param equalityLevel the equality level to be checked for 
     215     *  
     216     * @return as described 
    202217     */ 
    203218    private TaskEquality compareKeyInteractions(KeyInteraction interaction1, 
     
    227242     * coordinates, they are lexically equal. Otherwise, they are semantically equal. 
    228243     * </p> 
    229      * 
    230      * @param interaction1 the first mouse drag and drop to compare 
    231      * @param interaction2 the second mouse drag and drop to compare 
     244     * <p> 
     245     * The provided equality level can be used to restrict the quality check to the given level. 
     246     * This is done for optimization purposes. The returned equality level is as concrete as 
     247     * the provided one. It may be more concrete if there is no difference regarding the 
     248     * comparison on the levels. 
     249     * </p> 
     250     * 
     251     * @param interaction1  the first mouse drag and drop to compare 
     252     * @param interaction2  the second mouse drag and drop to compare 
     253     * @param equalityLevel the equality level to be checked for 
    232254     *  
    233255     * @return as described 
     
    267289     * lexically equal. 
    268290     * </p> 
    269      * 
    270      * @param interaction1 the first mouse button interaction to compare 
    271      * @param interaction2 the second mouse button interaction to compare 
    272      * @param eventTarget  the event target on which the interactions happened (used within 
    273      *                     special comparisons like mouse clicks on buttons, where the coordinates 
    274      *                     can be ignored) 
     291     * <p> 
     292     * The provided equality level can be used to restrict the quality check to the given level. 
     293     * This is done for optimization purposes. The returned equality level is as concrete as 
     294     * the provided one. It may be more concrete if there is no difference regarding the 
     295     * comparison on the levels. 
     296     * </p> 
     297     * 
     298     * @param interaction1  the first mouse button interaction to compare 
     299     * @param interaction2  the second mouse button interaction to compare 
     300     * @param eventTarget   the event target on which the interactions happened (used within 
     301     *                      special comparisons like mouse clicks on buttons, where the coordinates 
     302     *                      can be ignored) 
     303     * @param equalityLevel the equality level to be checked for 
    275304     *  
    276305     * @return as described 
     
    334363     * lexically equal. 
    335364     * </p> 
    336      * 
    337      * @param interaction1 the first mouse button interaction to compare 
    338      * @param interaction2 the second mouse button interaction to compare 
    339      * @param eventTarget  the event target on which the interactions happened (used within 
    340      *                     special comparisons like mouse clicks on buttons, where the coordinates 
    341      *                     can be ignored) 
     365     * <p> 
     366     * The provided equality level can be used to restrict the quality check to the given level. 
     367     * This is done for optimization purposes. The returned equality level is as concrete as 
     368     * the provided one. It may be more concrete if there is no difference regarding the 
     369     * comparison on the levels. 
     370     * </p> 
     371     * 
     372     * @param interaction1  the first mouse button interaction to compare 
     373     * @param interaction2  the second mouse button interaction to compare 
     374     * @param eventTarget   the event target on which the interactions happened (used within 
     375     *                      special comparisons like mouse clicks on buttons, where the coordinates 
     376     *                      can be ignored) 
     377     * @param equalityLevel the equality level to be checked for 
    342378     *  
    343379     * @return as described 
     
    368404     * (the equality of the event targets is checked beforehand). 
    369405     * </p> 
    370      * 
    371      * @param interaction1 the first text input to compare 
    372      * @param interaction2 the second text input to compare 
     406     * <p> 
     407     * The provided equality level can be used to restrict the quality check to the given level. 
     408     * This is done for optimization purposes. The returned equality level is as concrete as 
     409     * the provided one. It may be more concrete if there is no difference regarding the 
     410     * comparison on the levels. 
     411     * </p> 
     412     * 
     413     * @param interaction1  the first text input to compare 
     414     * @param interaction2  the second text input to compare 
     415     * @param equalityLevel the equality level to be checked for 
    373416     *  
    374417     * @return as described 
     
    402445     * (the equality of the event targets is checked beforehand). 
    403446     * </p> 
    404      * 
    405      * @param interaction1 the first value selection to compare 
    406      * @param interaction2 the second value selection to compare 
     447     * <p> 
     448     * The provided equality level can be used to restrict the quality check to the given level. 
     449     * This is done for optimization purposes. The returned equality level is as concrete as 
     450     * the provided one. It may be more concrete if there is no difference regarding the 
     451     * comparison on the levels. 
     452     * </p> 
     453     * 
     454     * @param interaction1  the first value selection to compare 
     455     * @param interaction2  the second value selection to compare 
     456     * @param equalityLevel the equality level to be checked for 
    407457     *  
    408458     * @return as described 
Note: See TracChangeset for help on using the changeset viewer.