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

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

@@ -17 +17 @@
 /**
  * <p>
- * TODO comment
+ * This is a GUI element representing tags in HTML documents. Each tag belongs to a certain
+ * document. Each page element has a tag name and either an id or at least
+ * an index in the list of siblings of the same type.
  * </p>
  * 
@@ -24 +26 @@
 public class HTMLPageElement extends HTMLGUIElement {
 
-    /**  */
+    /**
+     * <p>
+     * default serial version UID
+     * </p>
+     */
     private static final long serialVersionUID = 1L;
 
     /**
      * <p>
-     * TODO: comment
+     * instantiates a page element with it parent (either a document or another page element)
      * </p>
      *
-     * @param specification
-     * @param parent
+     * @param specification the specification of the page element
+     * @param parent        the parent GUI element
      */
     public HTMLPageElement(HTMLPageElementSpec specification, HTMLGUIElement parent) {
@@ -41 +47 @@
     /**
      * <p>
-     * TODO: comment
+     * returns the name of the tag represented by this specification
      * </p>
      *
-     * @param specification
-     * @param parent
-     */
-    public HTMLPageElement(HTMLPageElementSpec specification, HTMLDocument parent) {
-        super(specification, parent);
-    }
-
-    /**
-     * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @return
+     * @return the name of the tag represented by this specification
      */
     public String getTagName() {
@@ -64 +58 @@
     /**
      * <p>
-     * TODO: comment
+     * returns the id of the tag represented by this specification
      * </p>
      *
-     * @return
+     * @return the id of the tag represented by this specification
      */
     public String getHtmlId() {
@@ -75 +69 @@
     /**
      * <p>
-     * TODO: comment
+     * returns the index of the tag
      * </p>
      *
-     * @return
+     * @return the index of the tag
      */
     public int getIndex() {
@@ -94 +88 @@
     }
 
-    /**
-     * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @return
-     */
-    HTMLDocumentSpec getPage() {
-        return ((HTMLPageElementSpec) super.getSpecification()).getPage();
-    }
-
 }