Ignore:
Timestamp:
11/29/17 14:55:48 (7 years ago)
Author:
pharms
Message:
  • java doc issues removal
Location:
trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/Event.java

    r1873 r2218  
    3030 * @version 1.0 
    3131 *  
    32  * @param <T> 
    33  *            Can be used to declare that events belong to a specific platform without subclassing. 
    3432 */ 
    3533public final class Event implements Serializable { 
    … …  
    8684     * <p> 
    8785     * List of {@link IReplayable}s of type T that describes the replay of an event. The 
    88      * {@link IReplayable}s can be interpreted as <it>sub-events</it> on the platform level that 
     86     * {@link IReplayable}s can be interpreted as sub-events on the platform level that 
    8987     * make up the abstract event. 
    9088     * </p> 

  • trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/HierarchicalEventTargetTree.java

    r2156 r2218  
    2525/** 
    2626 * <p> 
    27  * This class provides the interfaces for GUI element trees. 
     27 * This class provides the interfaces for hierarchical event target trees. 
    2828 * </p> 
    2929 * <p> 
    30  * The GUIElementTree represents the hierarchical structure of the GUI elements "as it is" 
    31  * currently during a session. It may change during the session due to creation and destruction 
    32  * of GUI elements. The parameter T represents the id type of the GUI elements that are handled 
    33  * internally. 
     30 * The HierarchicalEventTargetTree represents the hierarchical structure of the event targets 
     31 * "as it is" currently during a session. It may change during the session due to creation and 
     32 * destruction of event targets. The parameter ID represents the id type of the event targets 
     33 * that are handled internally. The other type parameters specify the concrete target type. 
    3434 * </p> 
    3535 *  
    … …  
    4444    /** 
    4545     * <p> 
    46      * Map of all GUI elements that are part of the tree for efficient searching. The keys of the 
    47      * map are the ids of the GUI elements. 
     46     * Map of all event targets that are part of the tree for efficient searching. The keys of the 
     47     * map are the ids of the event targets. 
    4848     * </p> 
    4949     */ 
    … …  
    5252    /** 
    5353     * <p> 
    54      * Map of all GUI element specifications that are part of the tree for efficient searching. The 
    55      * keys of the map are the ids of the GUI elements. 
     54     * Map of all event target specifications that are part of the tree for efficient searching. The 
     55     * keys of the map are the ids of the event targets. 
    5656     * </p> 
    5757     */ 
    … …  
    6060    /** 
    6161     * <p> 
    62      * Map of all children of GUI elements that are part of the tree. The keys of the map are the 
    63      * ids of the parent GUI elements. 
     62     * Map of all children of event targets that are part of the tree. The keys of the map are the 
     63     * ids of the parent event targets. 
    6464     * </p> 
    6565     */ 
    … …  
    6868    /** 
    6969     * <p> 
    70      * Map of all parents of GUI elements that are part of the tree. The keys of the map are the 
    71      * ids of the child GUI elements. 
     70     * Map of all parents of event targets that are part of the tree. The keys of the map are the 
     71     * ids of the child event targets. 
    7272     * </p> 
    7373     */ 
    … …  
    8383    /** 
    8484     * <p> 
    85      * the GUI element factory used in the model 
     85     * the event target factory used in the model 
    8686     * </p> 
    8787     */ 
    … …  
    106106    /** 
    107107     * <p> 
    108      * Adds a new GUI element to the tree. 
     108     * Adds a new event target to the tree. 
    109109     * </p> 
    110110     *  
    111111     * @param eventTargetID 
    112      *            id of the GUI element to be created 
     112     *            id of the event target to be created 
    113113     * @param parentID 
    114      *            id of the parent GUI element  
     114     *            id of the parent event target  
    115115     * @param eventTargetSpec 
    116      *            the GUI element specification 
     116     *            the event target specification 
    117117     *             
    118      * @throws EventTargetModelException if the GUI element can not be added to the underlying GUI model 
     118     * @throws EventTargetModelException if the event target can not be added to the underlying GUI model 
    119119     */ 
    120120    public void add(ID               eventTargetID, 
    … …  
    159159    /** 
    160160     * <p> 
    161      * Searches the tree for a GUI element with the specified id and returns its 
     161     * Searches the tree for a event target with the specified id and returns its 
    162162     * {@link IGUIElement} . 
    163163     * </p> 
    … …  
    165165     * @param id 
    166166     *            id that is looked for 
    167      * @return {@link IGUIElementSpec} of the GUI element with the given id if found, null otherwise 
     167     * @return {@link IEventTargetSpec} of the event target with the given id if found, null otherwise 
    168168     */ 
    169169    public TARGET_TYPE find(ID id) { 
    … …  
    173173    /** 
    174174     * <p> 
    175      * Returns the id of the provided {@link IGUIElement}. The comparison is performed using the 
    176      * equals method of the GUI element. 
     175     * Returns the id of the provided {@link IHierachicalEventTarget}. The comparison is performed using the 
     176     * equals method of the event target. 
    177177     * </p> 
    178178     *  
    179179     * @param eventTarget 
    180180     *            guiElement that is looked for 
    181      * @return the id of the GUI element, null if the GUI element can not be found 
     181     * @return the id of the event target, null if the event target can not be found 
    182182     */ 
    183183    public ID find(TARGET_TYPE eventTarget) { 
    … …  
    193193    /** 
    194194     * <p> 
    195      * Removes a GUI element (defined by its id) from the tree. All children of the GUI element will be 
     195     * Removes a event target (defined by its id) from the tree. All children of the event target will be 
    196196     * removed recursively. 
    197197     * </p> 
    198198     *  
    199199     * @param id 
    200      *            id of the GUI element to be removed 
    201      * @return number of GUI elements that were removed 
     200     *            id of the event target to be removed 
     201     * @return number of event targets that were removed 
    202202     */ 
    203203    public int remove(ID id) { 

  • trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/IReplayable.java

    r927 r2218  
    2121/** 
    2222 * <p> 
    23  * This interface is used by {@link ReplayableEvent}to describe how events can 
     23 * This interface is used by replayable events to describe how events can 
    2424 * be replayed. It can be used to define a sequence of fine-grained platform 
    2525 * events that make up an abstract event. 

  • trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/gui/KeyInteractionCorrector.java

    r927 r2218  
    3030 * This class provides the functionality to sort and clean up all key interactions in a log. In 
    3131 * particular: 
     32 * </p> 
    3233 * <ol> 
    3334 * <li>In case a combination key (e.g., shift, alt, control) is held down, multiple 
    … …  
    4849 * events for all combination keys.</li> 
    4950 * </ol> 
    50  * </p> 
    5151 *  
    5252 * @version 1.0 

  • trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/guimodel/GUIElementGroup.java

    r2146 r2218  
    4141     * </p> 
    4242     * 
    43      * @param groupName        the name of the GUI element group 
    44      * @param parent           the optional parent GUI element of the group 
    45      * @param eventTargetModel the GUI model to which the group will belong 
     43     * @param groupName  the name of the GUI element group 
     44     * @param parent     the optional parent GUI element of the group 
     45     * @param guiModel  the GUI model to which the group will belong 
    4646     */ 
    4747    public GUIElementGroup(String      groupName, 

  • trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/guimodel/GUIModel.java

    r2146 r2218  
    2222/** 
    2323 * <p> 
    24  * A GUI model is a tree of {@link IGUIElements} and represents a complete GUI of a software. It is 
     24 * A GUI model is a tree of {@link IGUIElement}s and represents a complete GUI of a software. It is 
    2525 * platform independent. It may have several root nodes, as some GUIs are made up of several Frames 
    2626 * being independent from each other. The GUI model is filled using the 

  • trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/guimodel/IGUIElement.java

    r2146 r2218  
    107107     * </p> 
    108108     *  
    109      * @param guiElement 
     109     * @param otherElement 
    110110     *            the GUI element to measure the distance for 
    111111     */ 
Note: See TracChangeset for help on using the changeset viewer.