X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=include%2Foptions%2Ffolder.php;h=e9a3b51ca2504795804938940d308c41a9d83696;hp=38f5bd130b72e70d632c3f17955651884f4aa972;hb=eceefdfed797ee39e825dba232c03bfd894b8f18;hpb=ebbf2fd0119499b946ce492b2488b85de4d56c26

diff --git a/include/options/folder.php b/include/options/folder.php
index 38f5bd13..e9a3b51c 100644
--- a/include/options/folder.php
+++ b/include/options/folder.php
@@ -3,15 +3,16 @@
 /**
  * options_folder.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * Displays all options relating to folders
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* SquirrelMail required files. */
+/** SquirrelMail required files. */
 require_once(SM_PATH . 'functions/imap.php');
 require_once(SM_PATH . 'functions/imap_general.php');
 
@@ -20,7 +21,19 @@ define('SMOPT_GRP_SPCFOLDER', 0);
 define('SMOPT_GRP_FOLDERLIST', 1);
 define('SMOPT_GRP_FOLDERSELECT', 2);
 
-/* Define the optpage load function for the folder options page. */
+/**
+ * This function builds an array with all the information about
+ * the options available to the user, and returns it. The options
+ * are grouped by the groups in which they are displayed.
+ * For each option, the following information is stored:
+ * - name: the internal (variable) name
+ * - caption: the description of the option in the UI
+ * - type: one of SMOPT_TYPE_*
+ * - refresh: one of SMOPT_REFRESH_*
+ * - size: one of SMOPT_SIZE_*
+ * - save: the name of a function to call when saving this option
+ * @return array all option information
+ */
 function load_optpage_data_folder() {
     global $username, $key, $imapServerAddress, $imapPort;
     global $folder_prefix, $default_folder_prefix, $show_prefix_option;
@@ -171,9 +184,9 @@ function load_optpage_data_folder() {
         'refresh' => SMOPT_REFRESH_FOLDERLIST,
         'posvals' => array( '1' => 'MM/DD/YY HH:MM',
                             '2' => 'DD/MM/YY HH:MM',
-                            '3' => 'DDD, HH:MM',
-                            '4' => 'HH:MM:SS',
-                            '5' => 'HH:MM',
+                            '3' => _("Show weekday and time"),
+                            '4' => _("Show time with seconds"),
+                            '5' => _("Show time"),
                             '6' => _("No Clock")),
     );
 
@@ -214,9 +227,9 @@ function load_optpage_data_folder() {
         'caption' => _("Selection List Style"),
         'type'    => SMOPT_TYPE_STRLIST,
         'refresh' => SMOPT_REFRESH_NONE,
-        'posvals' => array( 0 => _("Long: ") . '"Folder' . $delim . 'Subfolder"',
-                            1 => _("Indented: ") .  '"    ' . 'Subfolder"',
-                            2 => _("Delimited: ") . '". ' . 'Subfolder"')
+        'posvals' => array( 0 => _("Long: ") . '"' . _("Folder") . $delim . _("Subfolder") . '"',
+                            1 => _("Indented: ") .  '"    ' . _("Subfolder") . '"',
+                            2 => _("Delimited: ") . '". ' . _("Subfolder") . '"')
     );
 
     /* Assemble all this together and return it as our result. */
@@ -231,6 +244,10 @@ function load_optpage_data_folder() {
 /******************************************************************/
 /** Define any specialized save functions for this option page. ***/
 /******************************************************************/
+
+/**
+ * Saves the trash folder option.
+ */
 function save_option_trash_folder($option) {
     global $data_dir, $username;
 
@@ -242,6 +259,9 @@ function save_option_trash_folder($option) {
     save_option($option);
 }
 
+/**
+ * Saves the sent folder option.
+ */
 function save_option_sent_folder($option) {
     global $data_dir, $username;
 
@@ -253,6 +273,9 @@ function save_option_sent_folder($option) {
     save_option($option);
 }
 
+/**
+ * Saves the draft folder option.
+ */
 function save_option_draft_folder($option) {
     global $data_dir, $username;