Changeset 1276 for trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLServer.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/HTMLServer.java (modified) (4 diffs)

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

@@ -19 +19 @@
 /**
  * <p>
- * TODO comment
+ * a GUI element representing an HTML server. This is the root element for a GUI model of
+ * an HTML web site. It is identified through a host and a port. Its children are documents.
  * </p>
  * 
@@ -26 +27 @@
 public class HTMLServer extends HTMLGUIElement implements IFrame {
 
-    /**  */
+    /**
+     * <p>
+     * default serial version UID
+     * </p>
+     */
     private static final long serialVersionUID = 1L;
 
     /**
      * <p>
-     * TODO: comment
+     * instantiates the server with an appropriate specification
      * </p>
      *
-     * @param specification
-     * @param parent
+     * @param specification the server specification
+     * @param parent        the parent of the server --> must always be null. Just included as
+     *                      required by the automatic instantiation mechanism
+     *                      
+     * @throws IllegalArgumentException if the provided parent is not null
      */
     public HTMLServer(HTMLServerSpec specification, HTMLGUIElement parent) {
@@ -58 +66 @@
     /**
      * <p>
-     * TODO: comment
+     * returns the host of the represented server
      * </p>
      *
-     * @return
+     * @return the host
      */
     public String getHost() {
@@ -69 +77 @@
     /**
      * <p>
-     * TODO: comment
+     * returns the port of the represented server
      * </p>
      *
-     * @return
+     * @return the port
      */
     public int getPort() {