Ignore:
Timestamp:
07/26/13 09:20:36 (11 years ago)
Author:
pharms
Message:
  • added some Java Docs
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLPageElementSpec.java

    r1264 r1276  
    1919/** 
    2020 * <p> 
    21  * TODO comment 
     21 * This is a GUI element specification for tags in HTML documents. Each tag belongs to a certain 
     22 * document. However, for similarity comparison, two page elements are similar even if they do 
     23 * not belong to the same document. Each page element has a tag name and either an id or at least 
     24 * an index in the list of siblings of the same type. 
    2225 * </p> 
    2326 *  
    … …  
    2629public class HTMLPageElementSpec extends HTMLGUIElementSpec implements IGUIElementSpec { 
    2730 
    28     /**  */ 
     31    /** 
     32     * <p> 
     33     * default serial version UID 
     34     * </p> 
     35     */ 
    2936    private static final long serialVersionUID = 1L; 
    3037     
    31     /** */ 
     38    /** 
     39     * <p> 
     40     * the page to which the represented tag belongs 
     41     * </p> 
     42     */ 
    3243    private HTMLDocumentSpec page; 
    3344     
    34     /** */ 
     45    /** 
     46     * <p> 
     47     * the name of the tag represented by this specification 
     48     * </p> 
     49     */ 
    3550    private String tagName; 
    3651     
    37     /** */ 
     52    /** 
     53     * <p> 
     54     * the id of the tag represented by this specification, i.e., the value of the id attribute 
     55     * of the tag. May be null in the case the id attribute of the tag is not set.  
     56     * </p> 
     57     */ 
    3858    private String htmlId; 
    3959     
    40     /** */ 
     60    /** 
     61     * <p> 
     62     * the index of the tag (0 based) in the list of siblings in the same parent being of the 
     63     * same type. If, e.g., a parent has three li tags as children, the first will have index 0, 
     64     * the second index 1 and the third index2. The indexes are ignored, if the tag have an 
     65     * assigned id.  
     66     * </p> 
     67     */ 
    4168    private int index; 
    4269 
    4370    /** 
    4471     * <p> 
    45      * TODO: comment 
     72     * initializes the specification with the page to which the represented tag belongs, the tags 
     73     * name, its id or its index. 
    4674     * </p> 
    4775     * 
    48      * @param type 
    49      * @param index 
    50      * @param id 
     76     * @param page    the page to which the represented tag belongs 
     77     * @param tagName the name of the tag represented by this specification 
     78     * @param htmlId  the id of the tag represented by this specification 
     79     * @param index   the index of the tag 
     80     *  
     81     * @throws IllegalArgumentException if page and name are null or if neither an id nor an index 
     82     *                                  are provided correctly 
    5183     */ 
    5284    public HTMLPageElementSpec(HTMLDocumentSpec page, String tagName, String htmlId, int index) { 
    … …  
    118150    /** 
    119151     * <p> 
    120      * TODO: comment 
     152     * returns the page to which the represented tag belongs 
    121153     * </p> 
    122154     * 
    123      * @return 
     155     * @return the page to which the represented tag belongs 
    124156     */ 
    125157    HTMLDocumentSpec getPage() { 
    … …  
    129161    /** 
    130162     * <p> 
    131      * TODO: comment 
     163     * returns the name of the tag represented by this specification 
    132164     * </p> 
    133165     * 
    134      * @return 
     166     * @return the name of the tag represented by this specification 
    135167     */ 
    136168    String getTagName() { 
    … …  
    140172    /** 
    141173     * <p> 
    142      * TODO: comment 
     174     * returns the id of the tag represented by this specification 
    143175     * </p> 
    144176     * 
    145      * @return 
     177     * @return the id of the tag represented by this specification 
    146178     */ 
    147179    String getHtmlId() { 
    … …  
    151183    /** 
    152184     * <p> 
    153      * TODO: comment 
     185     * returns the index of the tag 
    154186     * </p> 
    155187     * 
    156      * @return 
     188     * @return the index of the tag 
    157189     */ 
    158190    int getIndex() { 
Note: See TracChangeset for help on using the changeset viewer.