documentation added

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@275 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/functions/tree.php b/functions/tree.php
index 7abcc2d0106d09c3bcd10616b743f7b39f3315a3..25c3ed99f706955ec5d78716ab01bfb2eed395d9 100644 (file)
--- a/functions/tree.php
+++ b/functions/tree.php
@@ -4,18 +4,24 @@
    if (!isset($imap_php))
       include("../functions/imap.php");
 
+   // Recursive function to find the correct parent for a new node
    function findParentForChild($value, $treeIndexToStart, $tree) {
+      // is $value in $tree[$treeIndexToStart]["value"]
       if ((isset($tree[$treeIndexToStart])) && (strstr($value, $tree[$treeIndexToStart]["value"]))) {
+         // do I have children, if not then must be a childnode of the current node
          if ($tree[$treeIndexToStart]["doIHaveChildren"]) {
+            // loop through each subNode checking to see if we are a subNode of one of them
             for ($i=0;$i< count($tree[$treeIndexToStart]["subNodes"]);$i++) {
                $result = findParentForChild($value, $tree[$treeIndexToStart]["subNodes"][$i], $tree);
                if ($result > -1)
                   return $result;
             }
+            // if we aren't a child of one of the subNodes, must be a child of current node
             return $treeIndexToStart;
          } else
             return $treeIndexToStart;
       } else {
+         // we aren't a child of this node at all
          return -1;
       }
    }