From 8f6f9ba5df6491d396aa690dcf3e5b9070a565ca Mon Sep 17 00:00:00 2001
From: tassium <tassium@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Date: Wed, 29 Oct 2003 15:25:12 +0000
Subject: [PATCH] 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
---
 functions/abook_local_file.php  |  1 +
 functions/addressbook.php       |  7 ++++---
 functions/options.php           |  1 +
 src/addrbook_popup.php          |  5 +++--
 src/addrbook_search.php         | 23 +++++++++++++++++------
 src/addrbook_search_html.php    | 15 +++++++++++----
 src/addressbook.php             | 21 ++++++++++++++++-----
 src/compose.php                 |  3 ++-
 src/delete_message.php          |  3 ++-
 src/empty_trash.php             |  3 ++-
 src/folders.php                 |  3 ++-
 src/folders_create.php          |  3 ++-
 src/folders_delete.php          |  3 ++-
 src/folders_rename_do.php       |  3 ++-
 src/folders_rename_getname.php  |  3 ++-
 src/folders_subscribe.php       |  3 ++-
 src/help.php                    |  3 ++-
 src/image.php                   |  3 ++-
 src/index.php                   |  1 +
 src/left_main.php               |  6 +++---
 src/login.php                   | 10 ++++++++--
 src/mailto.php                  |  3 ++-
 src/move_messages.php           |  3 ++-
 src/options.php                 |  3 ++-
 src/options_highlight.php       |  3 ++-
 src/options_identities.php      |  3 ++-
 src/options_order.php           |  3 ++-
 src/printer_friendly_bottom.php |  3 ++-
 src/printer_friendly_main.php   |  3 ++-
 src/printer_friendly_top.php    |  3 ++-
 src/read_body.php               |  3 ++-
 src/redirect.php                |  3 ++-
 src/right_main.php              |  3 ++-
 src/search.php                  |  7 ++++---
 src/signout.php                 |  3 ++-
 src/vcard.php                   |  3 ++-
 src/view_header.php             |  3 ++-
 src/view_text.php               |  3 ++-
 src/webmail.php                 |  3 ++-
 39 files changed, 125 insertions(+), 56 deletions(-)

diff --git a/functions/abook_local_file.php b/functions/abook_local_file.php
index 49f82845..da36e849 100644
--- a/functions/abook_local_file.php
+++ b/functions/abook_local_file.php
@@ -24,6 +24,7 @@
 
 /**
  * Store the addressbook in a local file
+ * @package squirrelmail
  */
 class abook_local_file extends addressbook_backend {
     var $btype = 'local';
diff --git a/functions/addressbook.php b/functions/addressbook.php
index dcafc36a..ccef5508 100644
--- 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.
- *
+ * @package squirrelmail
  */
 
 class AddressBook {
@@ -462,8 +462,9 @@ class AddressBook {
     
 } /* End of class Addressbook */
 
-/*
+/**
  * Generic backend that all other backends extend
+ * @package squirrelmail
  */
 class addressbook_backend {
 
diff --git a/functions/options.php b/functions/options.php
index b516e45d..cc2aecb8 100644
--- 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.
+ * @package squirrelmail
  */
 class SquirrelOption {
     /* The basic stuff. */
diff --git a/src/addrbook_popup.php b/src/addrbook_popup.php
index 9db01ee0..fc264cf3 100644
--- a/src/addrbook_popup.php
+++ b/src/addrbook_popup.php
@@ -9,12 +9,13 @@
  * 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','../');
 
-/* SquirrelMail required files. */
+/** SquirrelMail required files. */
 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 4e914bee..b1bc299e 100644
--- 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!
  *
- * $Id$
+ * $Id$ 
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ */
 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');
 
-/* 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);
@@ -35,7 +38,10 @@ sqgetGlobalVar('query',   $query,   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"><!--
@@ -101,7 +107,12 @@ function insert_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;
         
diff --git a/src/addrbook_search_html.php b/src/addrbook_search_html.php
index 0150e815..887c9370 100644
--- a/src/addrbook_search_html.php
+++ b/src/addrbook_search_html.php
@@ -11,14 +11,15 @@
  * 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','../');
 }
 
-/* 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');
@@ -34,7 +35,9 @@ sqgetGlobalVar('addrquery', $addrquery, 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;
@@ -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;
 
diff --git a/src/addressbook.php b/src/addressbook.php
index 8d4c80ff..e4ceed55 100644
--- a/src/addressbook.php
+++ b/src/addressbook.php
@@ -9,12 +9,13 @@
  * Manage personal address book.
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 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');
@@ -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');
 
-/* 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);
@@ -39,7 +40,15 @@ sqgetGlobalVar('oldnick',   $oldnick,   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="';
@@ -54,7 +63,9 @@ function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
     . "\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;
     
diff --git a/src/compose.php b/src/compose.php
index 752aa3cf..466bbfa1 100644
--- a/src/compose.php
+++ b/src/compose.php
@@ -15,9 +15,10 @@
  *    - Save As Draft
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/delete_message.php b/src/delete_message.php
index 09c2fef6..f8400834 100644
--- a/src/delete_message.php
+++ b/src/delete_message.php
@@ -9,9 +9,10 @@
  * 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. */
diff --git a/src/empty_trash.php b/src/empty_trash.php
index 43378334..b34af88c 100644
--- a/src/empty_trash.php
+++ b/src/empty_trash.php
@@ -10,9 +10,10 @@
  * deleting subfolders.
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/folders.php b/src/folders.php
index 73aa9ece..7e4966ee 100644
--- a/src/folders.php
+++ b/src/folders.php
@@ -11,9 +11,10 @@
  * Folders.
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/folders_create.php b/src/folders_create.php
index 08bc1928..07075725 100644
--- a/src/folders_create.php
+++ b/src/folders_create.php
@@ -10,9 +10,10 @@
  * Called from folders.php
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/folders_delete.php b/src/folders_delete.php
index de76a699..3b450048 100644
--- a/src/folders_delete.php
+++ b/src/folders_delete.php
@@ -10,9 +10,10 @@
  * Called from the folders.php
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/folders_rename_do.php b/src/folders_rename_do.php
index c6eb2061..c11c2123 100644
--- a/src/folders_rename_do.php
+++ b/src/folders_rename_do.php
@@ -10,9 +10,10 @@
  * Called from the folders.php
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/folders_rename_getname.php b/src/folders_rename_getname.php
index f7c5b8b5..6471f392 100644
--- a/src/folders_rename_getname.php
+++ b/src/folders_rename_getname.php
@@ -10,9 +10,10 @@
  * Called from folders.php
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/folders_subscribe.php b/src/folders_subscribe.php
index dbf1b3a7..c5b78485 100644
--- a/src/folders_subscribe.php
+++ b/src/folders_subscribe.php
@@ -10,9 +10,10 @@
  * Called from folders.php
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/help.php b/src/help.php
index 6318037d..dcf31c68 100644
--- a/src/help.php
+++ b/src/help.php
@@ -9,9 +9,10 @@
  * Displays help for the user
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/image.php b/src/image.php
index 574c9adc..a91f96a4 100644
--- a/src/image.php
+++ b/src/image.php
@@ -9,9 +9,10 @@
  * 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. */
diff --git a/src/index.php b/src/index.php
index 269f8987..68a04989 100644
--- a/src/index.php
+++ b/src/index.php
@@ -11,6 +11,7 @@
  * the person is logged or not.
  *
  * $Id$
+ * @package squirrelmail
  */
 
 header("Location:../index.php");
diff --git a/src/left_main.php b/src/left_main.php
index 0f13c1d5..4282f5d8 100644
--- a/src/left_main.php
+++ b/src/left_main.php
@@ -10,9 +10,10 @@
  * available, and has cookie information.
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for 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
- * @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;
diff --git a/src/login.php b/src/login.php
index ac9b9815..10584e20 100644
--- a/src/login.php
+++ b/src/login.php
@@ -10,9 +10,10 @@
  * cookies and find language.
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for 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');
 
-/*
+/**
  * $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');
 
+/**
+ * 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);
diff --git a/src/mailto.php b/src/mailto.php
index 1a409848..a89c45a5 100644
--- 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
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/move_messages.php b/src/move_messages.php
index 4fe2994a..7a2ba7e1 100644
--- a/src/move_messages.php
+++ b/src/move_messages.php
@@ -9,9 +9,10 @@
  * 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. */
diff --git a/src/options.php b/src/options.php
index 808f69cc..a999a3ec 100644
--- a/src/options.php
+++ b/src/options.php
@@ -10,9 +10,10 @@
  * 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. */
diff --git a/src/options_highlight.php b/src/options_highlight.php
index 381a4322..93d872ca 100644
--- a/src/options_highlight.php
+++ b/src/options_highlight.php
@@ -9,9 +9,10 @@
  * Displays message highlighting options
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/options_identities.php b/src/options_identities.php
index d2dfd035..91744c79 100644
--- a/src/options_identities.php
+++ b/src/options_identities.php
@@ -9,9 +9,10 @@
  * Display Identities Options
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/options_order.php b/src/options_order.php
index 7309da7b..20805e3d 100644
--- a/src/options_order.php
+++ b/src/options_order.php
@@ -9,9 +9,10 @@
  * Displays messagelist column order options
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/printer_friendly_bottom.php b/src/printer_friendly_bottom.php
index 5f3721c0..a9a76830 100644
--- 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$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/printer_friendly_main.php b/src/printer_friendly_main.php
index 24d10e22..f7339257 100644
--- 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$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/printer_friendly_top.php b/src/printer_friendly_top.php
index 127a9dfc..c6fc05c7 100644
--- a/src/printer_friendly_top.php
+++ b/src/printer_friendly_top.php
@@ -10,9 +10,10 @@
  * 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. */
diff --git a/src/read_body.php b/src/read_body.php
index cb6c5614..254ab767 100644
--- a/src/read_body.php
+++ b/src/read_body.php
@@ -10,9 +10,10 @@
  * 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. */
diff --git a/src/redirect.php b/src/redirect.php
index 6bdff659..4ffa1bae 100644
--- a/src/redirect.php
+++ b/src/redirect.php
@@ -10,9 +10,10 @@
 * 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. */
diff --git a/src/right_main.php b/src/right_main.php
index 7223cacf..1d3ef5e5 100644
--- a/src/right_main.php
+++ b/src/right_main.php
@@ -10,9 +10,10 @@
  * goes on in SquirrelMail.
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/search.php b/src/search.php
index fd7199b4..a7f2f004 100644
--- 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.
  *
- * 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. */
@@ -939,4 +940,4 @@ do_hook('search_bottom');
 sqimap_logout($imapConnection);
 echo '</body></html>';
 
-?>
\ No newline at end of file
+?>
diff --git a/src/signout.php b/src/signout.php
index ea3b95e0..7f7d71f7 100644
--- a/src/signout.php
+++ b/src/signout.php
@@ -9,9 +9,10 @@
  *  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. */
diff --git a/src/vcard.php b/src/vcard.php
index 401e1208..c6f3d112 100644
--- a/src/vcard.php
+++ b/src/vcard.php
@@ -9,9 +9,10 @@
  * 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. */
diff --git a/src/view_header.php b/src/view_header.php
index 81b16c08..4f86662d 100644
--- a/src/view_header.php
+++ b/src/view_header.php
@@ -9,9 +9,10 @@
  * 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. */
diff --git a/src/view_text.php b/src/view_text.php
index e9f6acc0..88210f1c 100644
--- a/src/view_text.php
+++ b/src/view_text.php
@@ -11,9 +11,10 @@
  * be very ashamed.
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
diff --git a/src/webmail.php b/src/webmail.php
index 565c5c07..9825da3d 100644
--- a/src/webmail.php
+++ b/src/webmail.php
@@ -11,9 +11,10 @@
  * 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. */
-- 
2.25.1