Changeset 1022 for trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServlet.java

Timestamp:

12/14/12 16:16:16 (12 years ago)

Author:

pharms

Message:

• removed todos

File:

• trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServlet.java (modified) (4 diffs)

trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServlet.java

@@ -333 +333 @@
     /**
      * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @param message
-     * @param clientInfos
-     * @return
+     * extracts the GUI structure from the provided JSON object.
+     * </p>
+     *
+     * @param object      the JSON object to extract the GUI structure from
+     * @param clientInfos infos about the client who send the data
+     * 
+     * @return the GUI structure extracted from the JSON object of which the root node is a
+     *         representation of the server of the HTML page that was observed 
      */
     private HtmlPageElement extractHtmlPageElements(JSONObject      object,
@@ -354 +356 @@
     /**
      * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @param clientInfos
-     * @return
+     * instantiates an element of the GUI structure representing the server of the observed
+     * web page
+     * </p>
+     *
+     * @param clientInfos infos about the client who send the data
+     * 
+     * @return as described
      */
     private HtmlPageElement getServerElement(HtmlClientInfos clientInfos) {
@@ -371 +375 @@
     /**
      * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @param clientInfos
+     * instantiates an element of the GUI structure representing the observed web page. Adds
+     * this element to the provided server as child.
+     * </p>
+     *
+     * @param clientInfos infos about the client who send the data
+     * @param server      the server on which the page represented by the return value resists
+     * 
+     * @return as described
      */
     private HtmlPageElement getPageElementRepresentingWebPage(HtmlClientInfos clientInfos,
@@ -395 +403 @@
     /**
      * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @param jsonPageElement
-     * @return
+     * converts a JSON object representing an HTML page element to an HTML page element. Calls
+     * itself recursively to also convert the children of the element, if any.
+     * </p>
+     *
+     * @param jsonPageElement the JSON object to be converted
+     * @param parentPath      the path through the DOM of the parent HTML page element of the
+     *                        converted one
+     *                        
+     * @return as described.
      */
     private HtmlPageElement convert(JSONObject jsonPageElement, String parentPath) {