Changeset 1022 for trunk/autoquest-htmlmonitor/src/main/js/autoquest-htmlmonitor.js

Timestamp:

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

Author:

pharms

Message:

• removed todos

File:

• trunk/autoquest-htmlmonitor/src/main/js/autoquest-htmlmonitor.js (modified) (4 diffs)

trunk/autoquest-htmlmonitor/src/main/js/autoquest-htmlmonitor.js

@@ -342 +342 @@
 
 /**
- * TODO comment
+ * adds event handling functionality to the provided node. Calls
+ * {@link #addEventHandlingWithJQuery(node,parentPath)} or
+ * {@link #addEventHandlingWithoutJQuery(node,parentPath)} depending on the fact if jQuery is
+ * available and must therefore be used, or not.
+ * 
+ * @param node       the node of the DOM structure that shall be equipped with event handling
+ * @param parentPath the path to the parent node of the provided node within the DOM-structure of
+ *                   the HTML-site
  */
 function addEventHandling(node, parentPath) {
@@ -354 +361 @@
 
 /**
- * TODO comment
+ * adds event handling functionality to the provided node using onxxx attributes
+ * 
+ * @param node       the node of the DOM structure that shall be equipped with event handling
+ * @param parentPath the path to the parent node of the provided node within the DOM-structure of
+ *                   the HTML-site
  */
 function addEventHandlingWithoutJQuery(node, parentPath) {
@@ -372 +383 @@
 
 /**
- * TODO comment
+ * adds event handling functionality to the provided node using jQuery attributes. If the node
+ * already used onxxx attributes, these are extended instead of using jQuery.
+ * 
+ * @param node       the node of the DOM structure that shall be equipped with event handling
+ * @param parentPath the path to the parent node of the provided node within the DOM-structure of
+ *                   the HTML-site
  */
 function addEventHandlingWithJQuery(node, parentPath) {
@@ -406 +422 @@
 
 /**
- * TODO comment
+ * adapts the event handling attributed provided by the action parameter so that it calls
+ * the {@link #handleEvent(node, action, path, even)} function in the case the event occurs.
+ * Either the method creates an appropriate onxxx attribute on the node if there is none, or it
+ * adds a call to the function as first thing called by the onxxx attribute.
+ * 
+ * @param node     the node of the DOM structure that shall be equipped with event handling
+ * @param nodePath the path to node within the DOM-structure of the HTML-site
+ * @param action   the event for which event handling shall be enabled
  */
 function adaptEventHandlingAttribute(node, nodePath, action) {