Code cleanup brigage...

[squirrelmail.git] / functions / gettext.php

diff --git a/functions/gettext.php b/functions/gettext.php
index 6d18d8e54250175724dfffd2fdda88a8fc027010..2bbf221d46c353ce8b584812c203bd7cf9cea27f 100644 (file)
--- a/functions/gettext.php
+++ b/functions/gettext.php
@@ -1,23 +1,39 @@
 <?PHP
 
-   /**
-    *   gettext.php
-    *
-    *   Copyright (c) 1999-2001 The Squirrelmail Development Team
-    *   Licensed under the GNU GPL. For full terms see the file COPYING.
-    *
-    *   Alternate to the system's built-in gettext.
-    *   relies on .po files (can't read .mo easily).
-    *   Uses the session for caching (speed increase)
-    *   Possible use in other PHP scripts?  The only SM-specific thing is
-    *     $sm_language, I think
-    *
-    *  $Id$
-    */
+/**
+ * gettext.php
+ *
+ * Copyright (c) 1999-2001 The SquirrelMail Development Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * Alternate to the system's built-in gettext.
+ * relies on .po files (can't read .mo easily).
+ * Uses the session for caching (speed increase)
+ * Possible use in other PHP scripts?  The only SM-specific thing is
+ *   $sm_language, I think
+ *
+ * $Id$
+ */
 
-   global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
-      $gettext_php_translateStrings, $gettext_php_loaded_language,
-      $gettext_php_short_circuit;
+/*****************************************************************/
+/*** 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 global 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. ***/
+/*****************************************************************/
+
+global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
+       $gettext_php_translateStrings, $gettext_php_loaded_language,
+       $gettext_php_short_circuit;
    
    if (! isset($gettext_php_loaded)) {
       $gettext_php_loaded = false;