Changeset 831 for trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/guimodel/GUIModel.java

Timestamp:

09/20/12 09:40:26 (12 years ago)

Author:

sherbold

Message:

• code documentation and clean-up

File:

• trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/guimodel/GUIModel.java (modified) (8 diffs)

trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/guimodel/GUIModel.java

@@ -27 +27 @@
     /**
      * <p>
-     * the root node of the tree not provided externally.
+     * The root node of the tree not provided externally.
      * </p>
      */
@@ -34 +34 @@
     /**
      * <p>
-     * a list with all nodes currently known
+     * A list with all nodes currently known
      * </p>
      */
@@ -277 +277 @@
      * is returned.
      * </p>
+     * 
+     * @param parentNode
+     *            parent node whose children are searched
+     * @param specToMatch
+     *            specification that is searched for
+     * @return matching child node or null if no child matches
      */
     private TreeNode findEqualChild(TreeNode parentNode, IGUIElementSpec specToMatch) {
@@ -302 +308 @@
      * can merge the children, too.
      * </p>
+     * 
+     * @param subTreeRoot
+     *            root node of the sub-tree that is merged
      */
     private void mergeSubTree(TreeNode subTreeRoot) {
@@ -346 +355 @@
      * </p>
      * 
+     * @param treeNode1
+     *            the first of the two nodes to be merged
+     * @param treeNode2
+     *            the second of the two nodes to be merged
      * @return a tree node being the merge of the two provided nodes.
      */
@@ -389 +402 @@
      * element as well as a indented list of its children surrounded by braces.
      * </p>
+     * 
+     * @param out
+     *            {@link PrintStream} where the guiElement is dumped to
+     * @param guiElement
+     *            the guiElement whos string represenation is dumped
+     * @param indent
+     *            indent string of the dumping
      */
     private void dumpGUIElement(PrintStream out, IGUIElement guiElement, String indent) {
@@ -412 +432 @@
     /**
      * <p>
-     * used internally for building up the tree of GUI elements.
-     * </p>
+     * Used internally for building up the tree of GUI elements.
+     * </p>
+     * 
+     * @version 1.0
+     * @author Patrick Harms, Steffen Herbold
      */
     private class TreeNode {
-        /** */
-        private IGUIElement guiElement;
-
-        /** */
-        private List<TreeNode> children;
 
         /**
          * <p>
-         * adds a child to the current node while keeping all lists of nodes up to date
+         * GUI element associated with the TreeNode.
          * </p>
+         */
+        private IGUIElement guiElement;
+
+        /**
+         * <p>
+         * Children of the TreeNode.
+         * </p>
+         */
+        private List<TreeNode> children;
+
+        /**
+         * <p>
+         * Adds a child to the current node while keeping all lists of nodes up to date
+         * </p>
+         * 
+         * @param guiElement
+         *            GUI element that will be associated with the new child
+         * @return the added child
          */
         private TreeNode addChild(IGUIElement guiElement) {
@@ -446 +482 @@
          * Adds a TreeNode as child to the current node. This way, the whole sub-tree is added.
          * </p>
+         * 
+         * @param node
+         *            child node that is added
+         * @return node that has been added
          */
         private TreeNode addChildNode(TreeNode node) {