phpdocumentor preparation and a few corrections to earlier phpdocumentor work

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

diff --git a/functions/abook_local_file.php b/functions/abook_local_file.php
index 49f82845ad31d39e1235666382d08cb2a48f85ff..da36e8496beed484819d1f1932fdd17a9bd650b6 100644 (file)
--- a/functions/abook_local_file.php
+++ b/functions/abook_local_file.php
@@ -24,6 +24,7 @@
 
 /**
  * Store the addressbook in a local file
 
 /**
  * Store the addressbook in a local file

+ * @package squirrelmail

  */
 class abook_local_file extends addressbook_backend {
     var $btype = 'local';
  */
 class abook_local_file extends addressbook_backend {
     var $btype = 'local';

diff --git a/functions/addressbook.php b/functions/addressbook.php
index dcafc36a68231d9a7020703676b4dfca498ef8f4..ccef55084c187927e1deae3af6c31f766a400301 100644 (file)
--- a/functions/addressbook.php
+++ b/functions/addressbook.php
@@ -123,10 +123,10 @@ function addressbook_cmp($a,$b) {
 }
 
 
 }
 
 

-/*
+/**

  * This is the main address book class that connect all the
  * backends and provide services to the functions above.
  * This is the main address book class that connect all the
  * backends and provide services to the functions above.

- *
+ * @package squirrelmail

  */
 
 class AddressBook {
  */
 
 class AddressBook {


@@ -462,8 +462,9 @@ class AddressBook {
     
 } /* End of class Addressbook */
 
     
 } /* End of class Addressbook */
 

-/*
+/**

  * Generic backend that all other backends extend
  * Generic backend that all other backends extend

+ * @package squirrelmail

  */
 class addressbook_backend {
 
  */
 class addressbook_backend {
 

diff --git a/functions/options.php b/functions/options.php
index b516e45d81b113ae2fe17ef4b83b754ad2edfccf..cc2aecb8e177f28152e92550523cb2c9e2581229 100644 (file)
--- a/functions/options.php
+++ b/functions/options.php
@@ -53,6 +53,7 @@ define('SMOPT_SAVE_NOOP', 'save_option_noop');
  * Also, I'd like to ask that people leave this alone (mostly :) until
  * I get it a little further along. That should only be a day or two or
  * three. I will remove this message when it is ready for primetime usage.
  * Also, I'd like to ask that people leave this alone (mostly :) until
  * I get it a little further along. That should only be a day or two or
  * three. I will remove this message when it is ready for primetime usage.

+ * @package squirrelmail

  */
 class SquirrelOption {
     /* The basic stuff. */
  */
 class SquirrelOption {
     /* The basic stuff. */

diff --git a/src/addrbook_popup.php b/src/addrbook_popup.php
index 9db01ee068a7e88d128089872c9ab90792e7b3fa..fc264cf3efde90e69b403eb70b526b5f2ed993df 100644 (file)
--- a/src/addrbook_popup.php
+++ b/src/addrbook_popup.php
@@ -9,12 +9,13 @@
  * Frameset for the JavaScript version of the address book.
  *
  * $Id$
  * Frameset for the JavaScript version of the address book.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 define('SM_PATH','../');
 

-/* SquirrelMail required files. */
+/** SquirrelMail required files. */

 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/addressbook.php');
    
 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/addressbook.php');
    

diff --git a/src/addrbook_search.php b/src/addrbook_search.php
index 4e914beef1ef4f28c5297d4665e19f6148e3510e..b1bc299e16534a3efc54d4149f59bd36f0fdaafd 100644 (file)
--- a/src/addrbook_search.php
+++ b/src/addrbook_search.php
@@ -12,19 +12,22 @@
  *       addrbook_search_html.html -- If you change one,
  *       change the other one too!
  *
  *       addrbook_search_html.html -- If you change one,
  *       change the other one too!
  *

- * $Id$
+ * $Id$ 
+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ */

 define('SM_PATH','../');
 
 define('SM_PATH','../');
 

-/* SquirrelMail required files. */
+/** SquirrelMail required files. */

 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/strings.php');
 require_once(SM_PATH . 'functions/global.php');
 require_once(SM_PATH . 'functions/html.php');
 
 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/strings.php');
 require_once(SM_PATH . 'functions/global.php');
 require_once(SM_PATH . 'functions/html.php');
 

-/* lets get the global vars we may need */
+/** lets get the global vars we may need */

 sqgetGlobalVar('key',       $key,           SQ_COOKIE);
 sqgetGlobalVar('username',  $username,      SQ_SESSION);
 sqgetGlobalVar('onetimepad',$onetimepad,    SQ_SESSION);
 sqgetGlobalVar('key',       $key,           SQ_COOKIE);
 sqgetGlobalVar('username',  $username,      SQ_SESSION);
 sqgetGlobalVar('onetimepad',$onetimepad,    SQ_SESSION);


@@ -35,7 +38,10 @@ sqgetGlobalVar('query',   $query,   SQ_POST);
 sqgetGlobalVar('listall', $listall, SQ_POST);
 sqgetGlobalVar('backend', $backend, SQ_POST);
 
 sqgetGlobalVar('listall', $listall, SQ_POST);
 sqgetGlobalVar('backend', $backend, SQ_POST);
 

-/* Function to include JavaScript code */
+/**
+ * Function to include JavaScript code
+ * @return void
+ */

 function insert_javascript() {
     ?>
     <SCRIPT LANGUAGE="Javascript"><!--
 function insert_javascript() {
     ?>
     <SCRIPT LANGUAGE="Javascript"><!--


@@ -101,7 +107,12 @@ function insert_javascript() {
 } /* End of included JavaScript */
 
 
 } /* End of included JavaScript */
 
 

-/* List search results */
+/**
+ * List search results
+ * @param array $res Array of search results
+ * @param bool $includesource [Default=true]
+ * @return void
+ */

 function display_result($res, $includesource = true) {
     global $color;
         
 function display_result($res, $includesource = true) {
     global $color;
         

diff --git a/src/addrbook_search_html.php b/src/addrbook_search_html.php
index 0150e815dbf3de45d693a9db56f81f90c2522bab..887c93703cfb0275756444a484c92413e5a5c80c 100644 (file)
--- a/src/addrbook_search_html.php
+++ b/src/addrbook_search_html.php
@@ -11,14 +11,15 @@
  * This file is included from compose.php
  *
  * $Id$
  * This file is included from compose.php
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 if (! defined('SM_PATH') ) {
        define('SM_PATH','../');
 }
 
 if (! defined('SM_PATH') ) {
        define('SM_PATH','../');
 }
 

-/* SquirrelMail required files. */
+/** SquirrelMail required files. */

 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/global.php');
 require_once(SM_PATH . 'functions/date.php');
 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/global.php');
 require_once(SM_PATH . 'functions/date.php');


@@ -34,7 +35,9 @@ sqgetGlobalVar('addrquery', $addrquery, SQ_POST);
 sqgetGlobalVar('listall',   $listall,   SQ_POST);
 sqgetGlobalVar('backend',   $backend,   SQ_POST);
 
 sqgetGlobalVar('listall',   $listall,   SQ_POST);
 sqgetGlobalVar('backend',   $backend,   SQ_POST);
 

-/* Insert hidden data */
+/**
+ * Insert hidden data
+ */

 function addr_insert_hidden() {
     global $body, $subject, $send_to, $send_to_cc, $send_to_bcc, $mailbox,
            $identity, $session;
 function addr_insert_hidden() {
     global $body, $subject, $send_to, $send_to_cc, $send_to_bcc, $mailbox,
            $identity, $session;


@@ -61,7 +64,11 @@ function addr_insert_hidden() {
    }
 
 
    }
 
 

-/* List search results */
+/**
+ * List search results
+ * @param array $res Array containing results of search
+ * @param bool $includesource UNDOCUMENTED [Default=true]
+ */

 function addr_display_result($res, $includesource = true) {
     global $color, $javascript_on, $PHP_SELF, $squirrelmail_language;
 
 function addr_display_result($res, $includesource = true) {
     global $color, $javascript_on, $PHP_SELF, $squirrelmail_language;
 

diff --git a/src/addressbook.php b/src/addressbook.php
index 8d4c80ff719b6b03b327b02211ae759deb00a2bc..e4ceed557e09549856519a5a274b3fec7fbe49fd 100644 (file)
--- a/src/addressbook.php
+++ b/src/addressbook.php
@@ -9,12 +9,13 @@
  * Manage personal address book.
  *
  * $Id$
  * Manage personal address book.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 define('SM_PATH','../');
 

-/* SquirrelMail required files. */
+/** SquirrelMail required files. */

 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/global.php');
 require_once(SM_PATH . 'functions/display_messages.php');
 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/global.php');
 require_once(SM_PATH . 'functions/display_messages.php');


@@ -22,7 +23,7 @@ require_once(SM_PATH . 'functions/addressbook.php');
 require_once(SM_PATH . 'functions/strings.php');
 require_once(SM_PATH . 'functions/html.php');
 
 require_once(SM_PATH . 'functions/strings.php');
 require_once(SM_PATH . 'functions/html.php');
 

-/* lets get the global vars we may need */
+/** lets get the global vars we may need */

 sqgetGlobalVar('key',       $key,           SQ_COOKIE);
 
 sqgetGlobalVar('username',  $username,      SQ_SESSION);
 sqgetGlobalVar('key',       $key,           SQ_COOKIE);
 
 sqgetGlobalVar('username',  $username,      SQ_SESSION);


@@ -39,7 +40,15 @@ sqgetGlobalVar('oldnick',   $oldnick,   SQ_POST);
 sqgetGlobalVar('backend',   $backend,   SQ_POST);
 sqgetGlobalVar('doedit',    $doedit,    SQ_POST); 
 
 sqgetGlobalVar('backend',   $backend,   SQ_POST);
 sqgetGlobalVar('doedit',    $doedit,    SQ_POST); 
 

-/* Make an input field */
+/**
+ * Make an input field
+ * @param string $label
+ * @param string $field
+ * @param string $name
+ * @param string $size
+ * @param array $values
+ * @param string $add
+ */

 function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
     global $color;
     $td_str = '<INPUT NAME="' . $name . '[' . $field . ']" SIZE="' . $size . '" VALUE="';
 function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
     global $color;
     $td_str = '<INPUT NAME="' . $name . '[' . $field . ']" SIZE="' . $size . '" VALUE="';


@@ -54,7 +63,9 @@ function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
     . "\n";
 }
 
     . "\n";
 }
 

-/* Output form to add and modify address data */
+/**
+ * Output form to add and modify address data
+ */

 function address_form($name, $submittext, $values = array()) {
     global $color, $squirrelmail_language;
     
 function address_form($name, $submittext, $values = array()) {
     global $color, $squirrelmail_language;
     

diff --git a/src/compose.php b/src/compose.php
index 752aa3cfb04e424172deecbd554d39bfdd724b8b..466bbfa1337289a113a9fe2645980cfd82a31a2c 100644 (file)
--- a/src/compose.php
+++ b/src/compose.php
@@ -15,9 +15,10 @@
  *    - Save As Draft
  *
  * $Id$
  *    - Save As Draft
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/delete_message.php b/src/delete_message.php
index 09c2fef64e30faaac62ee09b30ec143c63707436..f8400834709fea80a8a96bff141605363b4d8f9c 100644 (file)
--- a/src/delete_message.php
+++ b/src/delete_message.php
@@ -9,9 +9,10 @@
  * Deletes a meesage from the IMAP server
  *
  * $Id$
  * Deletes a meesage from the IMAP server
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/empty_trash.php b/src/empty_trash.php
index 43378334e3c5cf437257f8a4a179cf95b7d2de3b..b34af88cd656199bc4d94d6d4efe57e31f7fb10a 100644 (file)
--- a/src/empty_trash.php
+++ b/src/empty_trash.php
@@ -10,9 +10,10 @@
  * deleting subfolders.
  *
  * $Id$
  * deleting subfolders.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/folders.php b/src/folders.php
index 73aa9eced00f28c73d57b399fa7ba5cbe64275ff..7e4966eeba582d437c50f5c709e29b972a0eac4c 100644 (file)
--- a/src/folders.php
+++ b/src/folders.php
@@ -11,9 +11,10 @@
  * Folders.
  *
  * $Id$
  * Folders.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/folders_create.php b/src/folders_create.php
index 08bc1928b581c670faeb10856c9bcb3b64870823..07075725deb409e04fa8aa8d12195d5f2fffb019 100644 (file)
--- a/src/folders_create.php
+++ b/src/folders_create.php
@@ -10,9 +10,10 @@
  * Called from folders.php
  *
  * $Id$
  * Called from folders.php
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/folders_delete.php b/src/folders_delete.php
index de76a699b9f76d135b0c7a717f63058987e25250..3b450048b322f0e8022d9e36c349a011ef9d139d 100644 (file)
--- a/src/folders_delete.php
+++ b/src/folders_delete.php
@@ -10,9 +10,10 @@
  * Called from the folders.php
  *
  * $Id$
  * Called from the folders.php
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/folders_rename_do.php b/src/folders_rename_do.php
index c6eb206150270ed68f8536df47595d2e52633cbb..c11c2123f63bfcd95dfff54315e32a627fcdf0af 100644 (file)
--- a/src/folders_rename_do.php
+++ b/src/folders_rename_do.php
@@ -10,9 +10,10 @@
  * Called from the folders.php
  *
  * $Id$
  * Called from the folders.php
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/folders_rename_getname.php b/src/folders_rename_getname.php
index f7c5b8b5ad7233830e4052b1a7cfd5eba8024e51..6471f3923b8e910becb6800c598b3ad1491da827 100644 (file)
--- a/src/folders_rename_getname.php
+++ b/src/folders_rename_getname.php
@@ -10,9 +10,10 @@
  * Called from folders.php
  *
  * $Id$
  * Called from folders.php
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/folders_subscribe.php b/src/folders_subscribe.php
index dbf1b3a7e8c6abdc9e88bfc723fa5bf79ced4491..c5b78485d6868ad4baa4f440117333f551e3e212 100644 (file)
--- a/src/folders_subscribe.php
+++ b/src/folders_subscribe.php
@@ -10,9 +10,10 @@
  * Called from folders.php
  *
  * $Id$
  * Called from folders.php
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/help.php b/src/help.php
index 6318037d9e2df60e5e41c37c097405ae354a7052..dcf31c68d535be839bba0d8c5746d3757c57c48a 100644 (file)
--- a/src/help.php
+++ b/src/help.php
@@ -9,9 +9,10 @@
  * Displays help for the user
  *
  * $Id$
  * Displays help for the user
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/image.php b/src/image.php
index 574c9adc427cac5870da3bb3fef49721ae7c73c0..a91f96a48da4ae8a321131533b09de0fb11d0efe 100644 (file)
--- a/src/image.php
+++ b/src/image.php
@@ -9,9 +9,10 @@
  * This file shows an attached image
  *
  * $Id$
  * This file shows an attached image
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/index.php b/src/index.php
index 269f8987f434e5b7bfc7dfcd13a29ddaeee1663d..68a04989042e989049dfc194a3cc6a41650e04b4 100644 (file)
--- a/src/index.php
+++ b/src/index.php
@@ -11,6 +11,7 @@
  * the person is logged or not.
  *
  * $Id$
  * the person is logged or not.
  *
  * $Id$

+ * @package squirrelmail

  */
 
 header("Location:../index.php");
  */
 
 header("Location:../index.php");

diff --git a/src/left_main.php b/src/left_main.php
index 0f13c1d5ccf9c4d24559113cee1f04fcaaa8ee53..4282f5d802ffee297fa82161b17cb1d18bb31c45 100644 (file)
--- a/src/left_main.php
+++ b/src/left_main.php
@@ -10,9 +10,10 @@
  * available, and has cookie information.
  *
  * $Id$
  * available, and has cookie information.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */


@@ -196,8 +197,7 @@ function create_collapse_link($boxnum) {
  * @param string $boxName name of the current mailbox
  * @param array $boxArray array for the current mailbox
  * @param $imapConnection current imap connection in use
  * @param string $boxName name of the current mailbox
  * @param array $boxArray array for the current mailbox
  * @param $imapConnection current imap connection in use

- * @return array[0] unseen message string (for display)
- * @return array[1] unseen message count
+ * @return array unseen message string (for display), unseen message count

  */
 function create_unseen_string($boxName, $boxArray, $imapConnection, $unseen_type) {
     global $boxes, $unseen_type, $color, $unseen_cum;
  */
 function create_unseen_string($boxName, $boxArray, $imapConnection, $unseen_type) {
     global $boxes, $unseen_type, $color, $unseen_cum;

diff --git a/src/login.php b/src/login.php
index ac9b981590a03105eb5c9d36473fcf5caa144e53..10584e2002ae24c2d419f776a0ed14886e2854bd 100644 (file)
--- a/src/login.php
+++ b/src/login.php
@@ -10,9 +10,10 @@
  * cookies and find language.
  *
  * $Id$
  * cookies and find language.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */


@@ -26,7 +27,7 @@ require_once(SM_PATH . 'functions/html.php');
 require_once(SM_PATH . 'functions/global.php');
 require_once(SM_PATH . 'functions/imap_general.php');
 
 require_once(SM_PATH . 'functions/global.php');
 require_once(SM_PATH . 'functions/imap_general.php');
 

-/*
+/**

  * $squirrelmail_language is set by a cookie when the user selects
  * language and logs out
  */
  * $squirrelmail_language is set by a cookie when the user selects
  * language and logs out
  */


@@ -49,6 +50,11 @@ sqsession_destroy();
  
 header('Pragma: no-cache');
 
  
 header('Pragma: no-cache');
 

+/**
+ * This detects if the IMAP server has logins disabled, and if so, 
+ * squelches the display of the login form and puts up a message
+ * explaining the situation.
+ */

 $imap = sqimap_create_stream($imapServerAddress, $imapPort, $use_imap_tls);
 $logindisabled = sqimap_capability($imap,'LOGINDISABLED');
 sqimap_logout($imap);
 $imap = sqimap_create_stream($imapServerAddress, $imapPort, $use_imap_tls);
 $logindisabled = sqimap_capability($imap,'LOGINDISABLED');
 sqimap_logout($imap);

diff --git a/src/mailto.php b/src/mailto.php
index 1a4098487a9171562e63b03a501de36eb362a9bb..a89c45a51e7c4506b132c6655b537517ede6dfc1 100644 (file)
--- a/src/mailto.php
+++ b/src/mailto.php
@@ -14,9 +14,10 @@
  * Use the following url to use mailto:
  * http://<your server>/<squirrelmail base dir>/src/mailto.php?emailaddress="%1"
  * see ../contrib/squirrelmail.mailto.reg for a Windows Registry file
  * Use the following url to use mailto:
  * http://<your server>/<squirrelmail base dir>/src/mailto.php?emailaddress="%1"
  * see ../contrib/squirrelmail.mailto.reg for a Windows Registry file

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/move_messages.php b/src/move_messages.php
index 4fe2994ada578f85034705b26dc9ea70972a4108..7a2ba7e12ef8c54321528418be29384b98b9753c 100644 (file)
--- a/src/move_messages.php
+++ b/src/move_messages.php
@@ -9,9 +9,10 @@
  * Enables message moving between folders on the IMAP server.
  *
  * $Id$
  * Enables message moving between folders on the IMAP server.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/options.php b/src/options.php
index 808f69cc1eebc65f84bf012079e2009ad2dd4afb..a999a3ecc9f6ebc08ffbc3af02c7cc056e915a49 100644 (file)
--- a/src/options.php
+++ b/src/options.php
@@ -10,9 +10,10 @@
  * and config.php. Displays preferences as selected and other options.
  *
  * $Id$
  * and config.php. Displays preferences as selected and other options.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/options_highlight.php b/src/options_highlight.php
index 381a4322b749b3d2cbe8af721e5300eb1f93cce3..93d872ca2f0852b1fcfc9ad23a4ec9c193db15cc 100644 (file)
--- a/src/options_highlight.php
+++ b/src/options_highlight.php
@@ -9,9 +9,10 @@
  * Displays message highlighting options
  *
  * $Id$
  * Displays message highlighting options
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/options_identities.php b/src/options_identities.php
index d2dfd035924558a7fd5d61bfa78c8991d3439b16..91744c7964225302cc6372fd37878669b17bfeff 100644 (file)
--- a/src/options_identities.php
+++ b/src/options_identities.php
@@ -9,9 +9,10 @@
  * Display Identities Options
  *
  * $Id$
  * Display Identities Options
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/options_order.php b/src/options_order.php
index 7309da7b3a31423077d919e4ec820285a508cddb..20805e3dafdddd59e1898bd7ab9d957fb3c209de 100644 (file)
--- a/src/options_order.php
+++ b/src/options_order.php
@@ -9,9 +9,10 @@
  * Displays messagelist column order options
  *
  * $Id$
  * Displays messagelist column order options
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/printer_friendly_bottom.php b/src/printer_friendly_bottom.php
index 5f3721c07b994944a7d2f9e4a5e624ff86b7ce4b..a9a76830a64fd1e44a793a2d739d154a12486e86 100644 (file)
--- a/src/printer_friendly_bottom.php
+++ b/src/printer_friendly_bottom.php
@@ -12,9 +12,10 @@
  * - this is the page that does all the work, really.
  *
  * $Id$
  * - this is the page that does all the work, really.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/printer_friendly_main.php b/src/printer_friendly_main.php
index 24d10e222b8f6384e9d58fb7dc9da7d535bfc567..f7339257a7be3b71b9c5b000cc3b031053a1c84b 100644 (file)
--- a/src/printer_friendly_main.php
+++ b/src/printer_friendly_main.php
@@ -7,9 +7,10 @@
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * $Id$
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/printer_friendly_top.php b/src/printer_friendly_top.php
index 127a9dfc65e3445772d56ef6bcdbc78925c0035f..c6fc05c7b269b45812d6811c4e100230bfcafddb 100644 (file)
--- a/src/printer_friendly_top.php
+++ b/src/printer_friendly_top.php
@@ -10,9 +10,10 @@
  * displays some javascript buttons for printing & closing
  *
  * $Id$
  * displays some javascript buttons for printing & closing
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/read_body.php b/src/read_body.php
index cb6c5614f7ce5f8dc80ec2c76cbc1fc9ca0aeaea..254ab767844d51a57cb048b3d9aaff9c80026928 100644 (file)
--- a/src/read_body.php
+++ b/src/read_body.php
@@ -10,9 +10,10 @@
  * the resulting emails in the right frame.
  *
  * $Id$
  * the resulting emails in the right frame.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/redirect.php b/src/redirect.php
index 6bdff659d75063eb6e04219530f93e52df14992e..4ffa1bae6aaf3a2db4ff8bf965c11541f1f2cbd0 100644 (file)
--- a/src/redirect.php
+++ b/src/redirect.php
@@ -10,9 +10,10 @@
 * Prevents users from reposting their form data after a successful logout.
 *
 * $Id$
 * Prevents users from reposting their form data after a successful logout.
 *
 * $Id$

+* @package squirrelmail

 */
 
 */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/right_main.php b/src/right_main.php
index 7223cacf8a9f1cf3ae42d778247080076a9466cd..1d3ef5e53f0001beda0be67ca1edb1e5aa5d88af 100644 (file)
--- a/src/right_main.php
+++ b/src/right_main.php
@@ -10,9 +10,10 @@
  * goes on in SquirrelMail.
  *
  * $Id$
  * goes on in SquirrelMail.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/search.php b/src/search.php
index fd7199b461cd52cf602a8bbe7e726c39edf200e2..a7f2f004957b0ec1b9ab1b4dc9a9f162eaa5d3ec 100644 (file)
--- a/src/search.php
+++ b/src/search.php
@@ -6,10 +6,11 @@
  * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *

- * Originally by Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
+ * @author Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */


@@ -939,4 +940,4 @@ do_hook('search_bottom');
 sqimap_logout($imapConnection);
 echo '</body></html>';
 
 sqimap_logout($imapConnection);
 echo '</body></html>';
 

-?>
\ No newline at end of file
+?>

diff --git a/src/signout.php b/src/signout.php
index ea3b95e0a4bb80832295ca260bc8b4edf4c2ff34..7f7d71f73d3bb85849f36f873329f370b8228176 100644 (file)
--- a/src/signout.php
+++ b/src/signout.php
@@ -9,9 +9,10 @@
  *  Cleans up after the user. Resets cookies and terminates session.
  *
  * $Id$
  *  Cleans up after the user. Resets cookies and terminates session.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/vcard.php b/src/vcard.php
index 401e12087b3e2ac6a641e1237a4d9601ec03b951..c6f3d112afa83cc1d14c6cd370986962c2fdfb05 100644 (file)
--- a/src/vcard.php
+++ b/src/vcard.php
@@ -9,9 +9,10 @@
  * This file shows an attched vcard
  *
  * $Id$
  * This file shows an attched vcard
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 Define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 Define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/view_header.php b/src/view_header.php
index 81b16c088d6389a03bf576dc8db69778f6fd28ce..4f86662d13072bb75da76615c82486b52f3ec6e4 100644 (file)
--- a/src/view_header.php
+++ b/src/view_header.php
@@ -9,9 +9,10 @@
  * This is the code to view the message header.
  *
  * $Id$
  * This is the code to view the message header.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/view_text.php b/src/view_text.php
index e9f6acc0b069f7df39020f562679ca0c537ffa47..88210f1cc763f871c2c2f153654754479b7048f3 100644 (file)
--- a/src/view_text.php
+++ b/src/view_text.php
@@ -11,9 +11,10 @@
  * be very ashamed.
  *
  * $Id$
  * be very ashamed.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

diff --git a/src/webmail.php b/src/webmail.php
index 565c5c079e9db88c9f2d8f50755fcbb5ffc4a2c0..9825da3d2adf59b1e9dc8ad43d0b7c548ac695e1 100644 (file)
--- a/src/webmail.php
+++ b/src/webmail.php
@@ -11,9 +11,10 @@
  * this file will verify username and password.
  *
  * $Id$
  * this file will verify username and password.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */