Michal Szczotka <michal@tuxy.org> Calendar plugin.

[squirrelmail.git] / functions / tree.php

diff --git a/functions/tree.php b/functions/tree.php
index d218e29b71a76ec666da324fdbea82cae16727ec..5d9657943c8db0cc2e1955194da26d71f56ae00c 100644 (file)
--- a/functions/tree.php
+++ b/functions/tree.php
@@ -1,14 +1,41 @@
 <?php
 
-   /* $Id$ */
+/**
+ * tree.php
+ *
+ * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * This code provides various string manipulation functions that are
+ * used by the rest of the Squirrelmail code.
+ *
+ * $Id$
+ */
 
-   if (defined('tree_php'))
-       return;
-   define('tree_php', true);
+/*****************************************************************/
+/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!!           ***/
+/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION.             ***/
+/***    + Base level indent should begin at left margin, as    ***/
+/***      the require_once below.                              ***/
+/***    + All identation should consist of four space blocks   ***/
+/***    + Tab characters are evil.                             ***/
+/***    + all comments should use "slash-star ... star-slash"  ***/
+/***      style -- no pound characters, no slash-slash style   ***/
+/***    + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD      ***/
+/***      ALWAYS USE { AND } CHARACTERS!!!                     ***/
+/***    + Please use ' instead of ", when possible. Note "     ***/
+/***      should always be used in _( ) function calls.        ***/
+/*** Thank you for your help making the SM code more readable. ***/
+/*****************************************************************/
 
-   require_once('../functions/imap.php');
+require_once('../functions/imap.php');
+
+/**
+ * findParentForChild
+ *
+ * Recursive function to find the correct parent for a new node
+ */
 
-   // 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']))) {