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/HTMLDocumentSpec.java

    r1264 r1276  
    1919/** 
    2020 * <p> 
    21  * TODO comment 
     21 * a GUI element specification of an HTML document, i.e., a page on an HTML server. This is the 
     22 * element for a GUI model of an HTML web site being always and only the children of servers. It 
     23 * is identified through the server on which it resists, its path, a potential query, and a title. 
     24 * Its children are HTML page elements 
    2225 * </p> 
    2326 *  
    … …  
    2629public class HTMLDocumentSpec 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 server on which the document resists 
     41     * </p> 
     42     */ 
    3243    private HTMLServerSpec server; 
    3344     
    34     /** */ 
     45    /** 
     46     * <p> 
     47     * the path in the URL of the document 
     48     * </p> 
     49     */ 
    3550    private String path; 
    3651     
    37     /** */ 
     52    /** 
     53     * <p> 
     54     * the query in the URL of the document 
     55     * </p> 
     56     */ 
    3857    private String query; 
    3958     
    40     /** */ 
     59    /** 
     60     * <p> 
     61     * the title of the document 
     62     * </p> 
     63     */ 
    4164    private String title; 
    4265     
    4366    /** 
    4467     * <p> 
    45      * TODO: comment 
     68     * initializes the document with its server, path, query, and title 
    4669     * </p> 
    4770     * 
    48      * @param server 
    49      * @param pagePath 
    50      * @param pageTitle 
     71     * @param server the server on which the document resists 
     72     * @param path   the path in the URL of the document 
     73     * @param query  the query in the URL of the document 
     74     * @param title  the title of the document 
     75     *  
     76     * @throws IllegalArgumentException if the server or path are invalid, i.e. null 
    5177     */ 
    5278    public HTMLDocumentSpec(HTMLServerSpec server, String path, String query, String title) { 
    … …  
    104130    /** 
    105131     * <p> 
    106      * TODO: comment 
     132     * returns the server on which the document resists 
    107133     * </p> 
    108134     * 
    109      * @return 
     135     * @return the server on which the document resists 
    110136     */ 
    111137    public HTMLServerSpec getServer() { 
    … …  
    115141    /** 
    116142     * <p> 
    117      * TODO: comment 
     143     * returns the path in the URL of the document 
    118144     * </p> 
    119145     * 
    120      * @return 
     146     * @return the path in the URL of the document 
    121147     */ 
    122148    String getPath() { 
    … …  
    126152    /** 
    127153     * <p> 
    128      * TODO: comment 
     154     * returns the query in the URL of the document 
    129155     * </p> 
    130156     * 
    131      * @return 
     157     * @return the query in the URL of the document 
    132158     */ 
    133159    String getQuery() { 
    … …  
    137163    /** 
    138164     * <p> 
    139      * TODO: comment 
     165     * returns the title of the document 
    140166     * </p> 
    141167     * 
    142      * @return 
     168     * @return the title of the document 
    143169     */ 
    144170    String getTitle() { 
Note: See TracChangeset for help on using the changeset viewer.