Changeset 1276 for trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLDocument.java

Timestamp:

07/26/13 09:20:36 (11 years ago)

Author:

pharms

Message:

• added some Java Docs

File:

• trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLDocument.java (modified) (4 diffs)

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

@@ -19 +19 @@
 /**
  * <p>
- * TODO comment
+ * a GUI element representing an HTML document, i.e., a page on an HTML server. This is the
+ * element for a GUI model of an HTML web site being always and only the children of servers. It
+ * is identified through the server on which it resists, its path, a potential query, and a title.
+ * Its children are HTML page elements
  * </p>
  * 
@@ -26 +29 @@
 public class HTMLDocument extends HTMLGUIElement implements IDialog {
 
-    /**  */
+    /**
+     * <p>
+     * default serial version UID
+     * </p> 
+     */
     private static final long serialVersionUID = 1L;
 
     /**
      * <p>
-     * TODO: comment
+     * instantiates the document with it specification and its parent, which is always a server
      * </p>
      *
-     * @param specification
-     * @param parent
+     * @param specification the specification of the document
+     * @param parent        the server on which the document resists
      */
     public HTMLDocument(HTMLDocumentSpec specification, HTMLServer parent) {
@@ -43 +50 @@
     /**
      * <p>
-     * TODO: comment
+     * returns the path in the URL of the document
      * </p>
      *
-     * @return
+     * @return the path in the URL of the document
      */
     public String getPath() {
@@ -64 +71 @@
     /**
      * <p>
-     * TODO: comment
+     * returns the server on which the document resists
      * </p>
      *
-     * @return
+     * @return the server on which the document resists
      */
-    HTMLServerSpec getServer() {
-        return ((HTMLDocumentSpec) super.getSpecification()).getServer();
+    HTMLServer getServer() {
+        return (HTMLServer) super.getParent();
     }
 
     /**
      * <p>
-     * TODO: comment
+     * returns the title of the document
      * </p>
      *
-     * @return
+     * @return the title of the document
      */
     String getTitle() {