Code cleanup brigage...

[squirrelmail.git] / functions / page_header.php

diff --git a/functions/page_header.php b/functions/page_header.php
index 189eff2cd9f1fc59a22a841368c1cfc53ca10cda..678c039d59e7dd0345070476414c834b7b05452d 100644 (file)
--- a/functions/page_header.php
+++ b/functions/page_header.php
@@ -1,19 +1,35 @@
 <?php
 
-   /**
-    *   page_header.php
-    *
-    *   Copyright (c) 1999-2001 The Squirrelmail Development Team
-    *   Licensed under the GNU GPL. For full terms see the file COPYING.
-    *
-    *   Prints the page header (duh)
-    *
-    *   $Id$
-    */
-
-   // Always set up the language before calling these functions
-
-   function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE ) {
+/**
+ * page_header.php
+ *
+ * Copyright (c) 1999-2001 The Squirrelmail Development Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * Prints the page header (duh)
+ *
+ * $Id$
+ */
+
+/*****************************************************************/
+/*** 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 first line of the function definition 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. ***/
+/*****************************************************************/
+
+// Always set up the language before calling these functions
+function displayHtmlHeader
+    ($title = 'SquirrelMail', $xtra = '', $do_hook = TRUE ) {
 
         global $theme_css;
 
@@ -85,4 +101,4 @@
       // echo "</td></tr></table>";
   }
 
-?>
\ No newline at end of file
+?>