Initial groundwork to use phpdocumentor.

Added @package and @subpackage tags.
Some cases of define() for SM_PATH were tagged @ignore to reduce the number of phpdocumentor warnings - this may need to be done everywhere else, or removed where I've done it so far.  We'll see.

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

diff --git a/plugins/abook_take/setup.php b/plugins/abook_take/setup.php
index 9bdb840950a6f86c9150e2f8ee9c2243f7c4829d..73ca0a5adce61e614bd497e9dda6325e17bdaef1 100755 (executable)
--- a/plugins/abook_take/setup.php
+++ b/plugins/abook_take/setup.php
@@ -11,8 +11,14 @@
  * message.
  *
  * $Id$
+ * @package plugins
+ * @subpackage abook_take
  */
 
+/**
+ * If SM_PATH isn't defined, define it.  Required to include files.
+ * @ignore
+ */
 if (!defined('SM_PATH'))  {
     define('SM_PATH','../../');
 }
@@ -20,6 +26,9 @@ if (!defined('SM_PATH'))  {
 /* SquirrelMail required files. */
 require_once(SM_PATH . 'functions/url_parser.php');
 
+/**
+ * Initialize the plugin
+ */
 function squirrelmail_plugin_init_abook_take()
 {
     global $squirrelmail_plugin_hooks;

diff --git a/plugins/abook_take/take.php b/plugins/abook_take/take.php
index 6a78d55427f5e2f680e77db24e6af5c917e219a6..8e5e5a88b445e126d3b6a13803b62cfb80eb58f1 100644 (file)
--- a/plugins/abook_take/take.php
+++ b/plugins/abook_take/take.php
@@ -10,9 +10,13 @@
  * the To, Cc, From and Reply-To headers.
  *
  * $Id$
+ * @package plugins
+ * @subpackage abook_take
  */
    
-/* Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/administrator/auth.php b/plugins/administrator/auth.php
index f04aa69fa1467a0fa1218fd1badfc302602a2259..afbd8719e61ede224da6ad5c4d1dc7f7ec2d4890 100644 (file)
--- a/plugins/administrator/auth.php
+++ b/plugins/administrator/auth.php
@@ -1,14 +1,19 @@
 <?php
 
-/*
+/**
  *  This function tell other modules what users have access
  *  to the plugin.
  *  
  *  Philippe Mingo
  *  
  *  $Id$
+ * @package plugins
+ * @subpackage administrator
  */
 
+/**
+*
+*/
 function adm_check_user() {
     global $PHP_SELF;
     require_once(SM_PATH . 'functions/global.php');

diff --git a/plugins/administrator/defines.php b/plugins/administrator/defines.php
index f4ac3dd9388696d06ec303370b88d0e877fd258f..3d7dae322cbadc3c486d20f4b894086809333fba 100644 (file)
--- a/plugins/administrator/defines.php
+++ b/plugins/administrator/defines.php
@@ -9,8 +9,11 @@
  * Philippe Mingo
  *
  * $Id$
+ * @package plugins
+ * @subpackage administrator
  */
 
+/** */
 require_once( SM_PATH . 'functions/constants.php' );
 
 /* Define constants for the various option types. */

diff --git a/plugins/administrator/index.php b/plugins/administrator/index.php
index bd44a24bbe3473245e715e7a305a4c207b5e88d7..a500d24b5221d6120eab2223b2041b6795b370e2 100644 (file)
--- a/plugins/administrator/index.php
+++ b/plugins/administrator/index.php
@@ -9,9 +9,11 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage administrator
     **/
 
    header("Location:../../src/login.php\n\n");
    exit();
 
-?>
\ No newline at end of file
+?>

diff --git a/plugins/administrator/options.php b/plugins/administrator/options.php
index 1198c3551212801a4c84f868e5d7b00a91e2e45a..7f95e5b6831952b10d28e7c05db70b2509888063 100644 (file)
--- a/plugins/administrator/options.php
+++ b/plugins/administrator/options.php
@@ -9,8 +9,13 @@
  * Philippe Mingo
  *
  * $Id$
+ * @package plugins
+ * @subpackage administrator
  */
 
+/**
+ * parse the config file
+ */
 function parseConfig( $cfg_file ) {
 
     global $newcfg;
@@ -195,6 +200,7 @@ function change_to_sm_path($old_path) {
 
 /* ---------------------- main -------------------------- */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/administrator/setup.php b/plugins/administrator/setup.php
index 0beebdb7aec9569d7c7acc5645b0a5751dbdc84c..50d395c59384e1e7c2679e51f0744c4e92851fe7 100644 (file)
--- a/plugins/administrator/setup.php
+++ b/plugins/administrator/setup.php
@@ -9,8 +9,11 @@
  *  Administrator plugin. Allows remote administration.  Philippe Mingo
  *
  * $Id$
+ * @package plugins
+ * @subpackage administrator
  */
 
+/** @ignore */
 require_once(SM_PATH . 'plugins/administrator/auth.php');
 
 function squirrelmail_plugin_init_administrator() {

diff --git a/plugins/bug_report/bug_report.php b/plugins/bug_report/bug_report.php
index a4e997a7fe8d0f61e6ed30303a92f2a0d965bdae..2be94e778bf817efe58a6a19518d74290ba25914 100644 (file)
--- a/plugins/bug_report/bug_report.php
+++ b/plugins/bug_report/bug_report.php
@@ -14,8 +14,13 @@
  * This is a standard Squirrelmail-1.2 API for plugins.
  *
  * $Id$
+ * @package plugins
+ * @subpackage bug_report
  */
 
+/**
+ * @ignore
+ */
 define('SM_PATH','../../');
 
 require_once(SM_PATH . 'include/validate.php');

diff --git a/plugins/bug_report/index.php b/plugins/bug_report/index.php
index cd0f2e854fc4f90805a2ff082b0d9ea5b3ccefca..7c812e604cb6a68f53333259382c29f737125f1b 100644 (file)
--- a/plugins/bug_report/index.php
+++ b/plugins/bug_report/index.php
@@ -9,6 +9,8 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage bug_report
     **/
 
    header("Location:../../src/login.php\n\n");

diff --git a/plugins/bug_report/setup.php b/plugins/bug_report/setup.php
index 3aed195895e1851aec619a595c659ae8f92e4cfa..e36f9becb64dac642333ac88bffa6842a6f5b7f5 100644 (file)
--- a/plugins/bug_report/setup.php
+++ b/plugins/bug_report/setup.php
@@ -9,13 +9,18 @@
  * This is a standard Squirrelmail-1.2 API for plugins.
  *
  * $Id$
+ * @package plugins
+ * @subpackage bug_report
  */
 
 /* This button fills out a form with your setup information already
    gathered -- all you have to do is type. */
 
 
-/* Initialize the bug report plugin */
+/**
+ * Initialize the bug report plugin
+ * @return void
+ */
 function squirrelmail_plugin_init_bug_report() {
     global $squirrelmail_plugin_hooks;
 

diff --git a/plugins/calendar/calendar.php b/plugins/calendar/calendar.php
index 881cd9d692437f053da250daea8f387be27dbf45..8091cf9e00108535d739286c79438fbb70b54e01 100644 (file)
--- a/plugins/calendar/calendar.php
+++ b/plugins/calendar/calendar.php
@@ -11,7 +11,12 @@
  * Displays the main calendar page (month view).
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
  */
+
+/**
+*/
 define('SM_PATH','../../');
 
 /* Calender plugin required files. */

diff --git a/plugins/calendar/calendar_data.php b/plugins/calendar/calendar_data.php
index 053d4891d3aab45f1ac5d4f3782499277d4acea7..705e8a7168adce2782369bc4e57eae664a4ee470 100644 (file)
--- a/plugins/calendar/calendar_data.php
+++ b/plugins/calendar/calendar_data.php
@@ -11,18 +11,22 @@
  * functions to operate on calendar data files.
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
  */
 
-// this is array that contains all events
-// it is three dimensional array with fallowing structure
-// $calendardata[date][time] = array(length,priority,title,message);
+/** this is array that contains all events
+ *  it is three dimensional array with fallowing structure
+ *  $calendardata[date][time] = array(length,priority,title,message); */
 $calendardata = array();
 
-//read events into array
-//data is | delimited, just like addresbook
-//files are structured like this:
-//date|time|length|priority|title|message);
-//files are divide by year for performance increase
+/**
+ * read events into array
+ *
+ * data is | delimited, just like addressbook
+ * files are structured like this:
+ * date|time|length|priority|title|message
+ * files are divided by year for performance increase */
 function readcalendardata() {
     global $calendardata, $username, $data_dir, $year;
 

diff --git a/plugins/calendar/day.php b/plugins/calendar/day.php
index fe911829575ef5da638b2932527c3b9f62e88040..3eff1df7ce9d9b4a5fa4af527f9aec7e9133eb44 100644 (file)
--- a/plugins/calendar/day.php
+++ b/plugins/calendar/day.php
@@ -11,8 +11,11 @@
  * Displays the day page (day view).
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* Calender plugin required files. */

diff --git a/plugins/calendar/event_create.php b/plugins/calendar/event_create.php
index 63b11fa145351923b332bcc884f923dda2ea0697..c10aaed78f79a63d05e6a6a7b4078d51e755034c 100644 (file)
--- a/plugins/calendar/event_create.php
+++ b/plugins/calendar/event_create.php
@@ -11,6 +11,12 @@
  * functions to create a event for calendar.
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
+ */
+
+/**
+ * @ignore
  */
 define('SM_PATH','../../');
 

diff --git a/plugins/calendar/event_delete.php b/plugins/calendar/event_delete.php
index b7908ec1012e650bb586a2bcf688048035c5d3b9..eee5ab0fb8c74d37a97444148bffe810dcb63e4f 100644 (file)
--- a/plugins/calendar/event_delete.php
+++ b/plugins/calendar/event_delete.php
@@ -11,6 +11,12 @@
  * Functions to delete a event. 
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
+ */
+
+/**
+ * @ignore
  */
 define('SM_PATH','../../');
 

diff --git a/plugins/calendar/event_edit.php b/plugins/calendar/event_edit.php
index 533ce66337f47f628d8b771a6fd7be8eaeb14171..9331262cb4f60c5a33ab18b652d8d46b18464d95 100644 (file)
--- a/plugins/calendar/event_edit.php
+++ b/plugins/calendar/event_edit.php
@@ -11,7 +11,11 @@
  * Functions to edit an event.
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
  */
+
+/** @ignore */
 define('SM_PATH','../../');
 
 /* Calender plugin required files. */

diff --git a/plugins/calendar/functions.php b/plugins/calendar/functions.php
index c723f68afc79870583c77694b797a76cb2349f3a..bd83651203754974f0dcde522026887ef622688d 100644 (file)
--- a/plugins/calendar/functions.php
+++ b/plugins/calendar/functions.php
@@ -11,9 +11,13 @@
  * miscelenous functions.
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
  */
 
-
+/**
+ * @return void
+ */
 function calendar_header() {
     //Add Second layer ofCalendar links to upper menu
     global $color,$year,$day,$month;

diff --git a/plugins/calendar/index.php b/plugins/calendar/index.php
index e89499d6dab32b976a43f5162879f2a704fc96cf..35c09e497507ba848b918a325c6c3bceeb74b221 100644 (file)
--- a/plugins/calendar/index.php
+++ b/plugins/calendar/index.php
@@ -9,6 +9,8 @@
  * Redirects to the login page.
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
  */
 
 header("Location:../../src/login.php\n\n");

diff --git a/plugins/calendar/setup.php b/plugins/calendar/setup.php
index 0353361c438775d7fa91efbae20c06771eaf0370..4b30c1b457d739b4ea5689ed521ed3f31c6368ba 100644 (file)
--- a/plugins/calendar/setup.php
+++ b/plugins/calendar/setup.php
@@ -11,8 +11,14 @@
  * init plugin into squirrelmail
  *
  * $Id$ 
+ * @package plugins
+ * @subpackage calendar
  */
 
+/**
+ * Initialize the plugin
+ * @return void
+ */
 function squirrelmail_plugin_init_calendar() {
     global $squirrelmail_plugin_hooks;
     $squirrelmail_plugin_hooks['menuline']['calendar'] = 'calendar';

diff --git a/plugins/delete_move_next/index.php b/plugins/delete_move_next/index.php
index bd44a24bbe3473245e715e7a305a4c207b5e88d7..15a3799fee5f458d6d1ee3d11bd82ca8f53572e6 100644 (file)
--- a/plugins/delete_move_next/index.php
+++ b/plugins/delete_move_next/index.php
@@ -9,9 +9,11 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage delete_move_next
     **/
 
    header("Location:../../src/login.php\n\n");
    exit();
 
-?>
\ No newline at end of file
+?>

diff --git a/plugins/delete_move_next/setup.php b/plugins/delete_move_next/setup.php
index 21376a999fcd8950795c6f0e909cb794af5f5716..8c8c306809dc5f95fba1f4126b3bbedf6b43012a 100644 (file)
--- a/plugins/delete_move_next/setup.php
+++ b/plugins/delete_move_next/setup.php
@@ -11,8 +11,14 @@
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * $Id$
+ * @package plugins
+ * @subpackage delete_move_next
  */
 
+/**
+ * Initialize the plugin
+ * @return void
+ */
 function squirrelmail_plugin_init_delete_move_next() {
     global $squirrelmail_plugin_hooks;
 

diff --git a/plugins/filters/filters.php b/plugins/filters/filters.php
index c4c66cef9dc1e450440aa124a755eb4a6cf388af..d8bd7a201a501b76828850ae870f923f4b11e085 100644 (file)
--- a/plugins/filters/filters.php
+++ b/plugins/filters/filters.php
@@ -23,8 +23,13 @@
  * Also view plugins/README.plugins for more information.
  *
  * $Id$
+ * @package plugins
+ * @subpackage filters
  */
 
+/**
+*
+*/
 function filters_SaveCache () {
     global $data_dir, $SpamFilters_DNScache;
 

diff --git a/plugins/filters/index.php b/plugins/filters/index.php
index cd0f2e854fc4f90805a2ff082b0d9ea5b3ccefca..3fd4f3b3e16fe46b46d66c458c162fa5805ec3ca 100644 (file)
--- a/plugins/filters/index.php
+++ b/plugins/filters/index.php
@@ -9,6 +9,8 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage filters
     **/
 
    header("Location:../../src/login.php\n\n");

diff --git a/plugins/filters/options.php b/plugins/filters/options.php
index 73d03e379cb00fd27722e7e8b96e7611a28e679e..0033ee756cb49a8c8009981b6a15ae33221f1ee2 100644 (file)
--- a/plugins/filters/options.php
+++ b/plugins/filters/options.php
@@ -23,9 +23,11 @@
  * Also view plugins/README.plugins for more information.
  *
  * $Id$
+ * @package plugins
+ * @subpackage filters
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/filters/setup.php b/plugins/filters/setup.php
index cca1963dbb546a7164b2d501c3c1b5f12fb7671b..5773b7e63fe121890632a702163fa8532354d064 100644 (file)
--- a/plugins/filters/setup.php
+++ b/plugins/filters/setup.php
@@ -22,9 +22,11 @@
  * Also view plugins/README.plugins for more information.
  *
  * $Id$
+ * @package plugins
+ * @subpackage filters
  */
 
-/* SquirrelMail required files. */
+/** SquirrelMail required files. */
 require_once(SM_PATH . 'plugins/filters/filters.php');
 
 /*

diff --git a/plugins/filters/spamoptions.php b/plugins/filters/spamoptions.php
index 2fc1706e4d4374883bba717f20e15f4b69230966..97670bafa3d6732813f391df23b9f1127d1918ef 100644 (file)
--- a/plugins/filters/spamoptions.php
+++ b/plugins/filters/spamoptions.php
@@ -22,9 +22,11 @@
  * Also view plugins/README.plugins for more information.
  *
  * $Id$
+ * @package plugins
+ * @subpackage filters
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/fortune/setup.php b/plugins/fortune/setup.php
index ce01ece97d1b9367e7925da94d8085acb0237a02..909ad5122ede104ae39cb0864eda952ab1388533 100644 (file)
--- a/plugins/fortune/setup.php
+++ b/plugins/fortune/setup.php
@@ -12,8 +12,13 @@
  * fortune above the message listing.
  *
  * $Id$
+ * @package plugins
+ * @subpackage fortune
  */
 
+/**
+*
+*/
 function squirrelmail_plugin_init_fortune() {
   global $squirrelmail_plugin_hooks;
   

diff --git a/plugins/index.php b/plugins/index.php
index 269f8987f434e5b7bfc7dfcd13a29ddaeee1663d..a7a4c21cea126217cc13a1d46736b7a12c57ca8b 100644 (file)
--- a/plugins/index.php
+++ b/plugins/index.php
@@ -11,6 +11,7 @@
  * the person is logged or not.
  *
  * $Id$
+ * @package plugins
  */
 
 header("Location:../index.php");

diff --git a/plugins/info/functions.php b/plugins/info/functions.php
index 415123958b71930b2d8e64a8894af672290b0dd9..95c779cf6b42e859891ccc16512ad00d091febe9 100644 (file)
--- a/plugins/info/functions.php
+++ b/plugins/info/functions.php
@@ -1,6 +1,7 @@
 <?PHP
 
-/* functions for info plugin
+/**
+ * functions for info plugin
  * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
@@ -12,13 +13,22 @@
  * by: Jason Munro jason@stdbev.com
  *
  * $Id$ 
- *
+ * @package plugins
+ * @subpackage info
  */
 
+/**
+ * Get the IMAP capabilities
+ * @return array
+ */
 function get_caps($imap_stream) {
     return sqimap_run_command_list($imap_stream, 'CAPABILITY',false, $responses, $message,false);
 }
 
+/**
+ * Run an IMAP test and return the results
+ * @return array Response from the IMAP server
+ */
 function imap_test($imap_stream, $string) {
     global $default_charset;
     print "<TR><TD>".$string."</TD></TR>";
@@ -27,6 +37,9 @@ function imap_test($imap_stream, $string) {
     return $response;
 }
 
+/**
+ * Print the IMAP response to options.php
+ */
 function print_response($response) {
     foreach($response as $index=>$value) {
         if (is_array($value)) {

diff --git a/plugins/info/options.php b/plugins/info/options.php
index 8e400e0a4ea1db412ebb9d9deb41f8427db003e3..9eb2ce69fdb6150fda84bc50b585e222885b5de9 100644 (file)
--- a/plugins/info/options.php
+++ b/plugins/info/options.php
@@ -1,6 +1,7 @@
 <?PHP
 
-/* options page for IMAP info plugin 
+/**
+ * options page for IMAP info plugin 
  * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *   
@@ -10,9 +11,11 @@
  * jason@stdbev.com
  * 
  * $Id$
- * 
+ * @package plugins
+ * @subpackage info
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/info/setup.php b/plugins/info/setup.php
index 6adcf0745e87e62db1763c7fcecd5a46655f9d57..c5476bd54a70bf6b15cbb269d89af40470f9cba5 100644 (file)
--- a/plugins/info/setup.php
+++ b/plugins/info/setup.php
@@ -1,15 +1,17 @@
 <?php
 
-/* setup file for the IMAP server info plugin
+/** setup file for the IMAP server info plugin
  * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *   
  * by: Jason Munro jason@stdbev.com
  * 
  * $Id$
- * 
+ * @package plugins
+ * @subpackage info
  */
 
+/** @ignore */
 require_once (SM_PATH . 'plugins/info/functions.php');
 
 function squirrelmail_plugin_init_info() {

diff --git a/plugins/listcommands/index.php b/plugins/listcommands/index.php
index bd44a24bbe3473245e715e7a305a4c207b5e88d7..b0726dc05e513abc846735225a39d4f9001e9d2f 100644 (file)
--- a/plugins/listcommands/index.php
+++ b/plugins/listcommands/index.php
@@ -9,9 +9,11 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage listcommands
     **/
 
    header("Location:../../src/login.php\n\n");
    exit();
 
-?>
\ No newline at end of file
+?>

diff --git a/plugins/listcommands/mailout.php b/plugins/listcommands/mailout.php
index e505465a8c2a02f6851fb6e8162af185f06c0104..5d08b20b78d992801783f71786dd500c136a5661 100644 (file)
--- a/plugins/listcommands/mailout.php
+++ b/plugins/listcommands/mailout.php
@@ -6,8 +6,11 @@
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * $Id$
+ * @package plugins
+ * @subpackage listcommands
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/listcommands/setup.php b/plugins/listcommands/setup.php
index afb634d3889c96bad1e63553fcf484d9e9b3e608..4a9b73cb14e5c5c5c15de9df4596561e42bc3808 100644 (file)
--- a/plugins/listcommands/setup.php
+++ b/plugins/listcommands/setup.php
@@ -12,8 +12,13 @@
  * commands such as (un)subscribe, help and list archives.
  *
  * $Id$
+ * @package plugins
+ * @subpackage listcommands
  */
 
+/**
+ * Initialize the listcommands plugin
+ */
 function squirrelmail_plugin_init_listcommands () {
     global $squirrelmail_plugin_hooks;
 

diff --git a/plugins/mail_fetch/class.POP3.php b/plugins/mail_fetch/class.POP3.php
index 9b1883ff2ccb974d930ff285c9a816a31841732b..2e2dac4edd2930bb818b52eac7d91d62804015aa 100644 (file)
--- a/plugins/mail_fetch/class.POP3.php
+++ b/plugins/mail_fetch/class.POP3.php
@@ -14,8 +14,13 @@
     * pop3 class
     *
     * $Id$
+    * @package plugins
+    * @subpackage mail_fetch
     */
 
+/**
+ * This is the pop3 class - DOCUMENT ME
+ */
 class POP3 {
     var $ERROR      = '';       //  Error string.
 

diff --git a/plugins/mail_fetch/fetch.php b/plugins/mail_fetch/fetch.php
index 03c9211b52b7f9ea6333999c98ada8651301463a..d2e6eaef5c81e2364689750efd7fb9fb75d5c2c2 100644 (file)
--- a/plugins/mail_fetch/fetch.php
+++ b/plugins/mail_fetch/fetch.php
@@ -9,8 +9,11 @@
  * Fetch code.
  *
  * $Id$
+ * @package plugins
+ * @subpackage mail_fetch
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 require_once(SM_PATH . 'include/validate.php');

diff --git a/plugins/mail_fetch/functions.php b/plugins/mail_fetch/functions.php
index 42d170430883550a7e16649c5abea3bbdf37185c..068ad8282746b6ef25b1788e44b29b18fd9edb48 100644 (file)
--- a/plugins/mail_fetch/functions.php
+++ b/plugins/mail_fetch/functions.php
@@ -13,8 +13,13 @@
     **  Adapted for MailFetch by Philippe Mingo <mingo@rotedic.com>
     **
     **  $Id$
+    * @package plugins
+    * @subpackage mail_fetch
     **/
 
+    /**
+     * hex2bin - document me
+     */
     function hex2bin( $data ) {
 
         /* Original code by josh@superfork.com */

diff --git a/plugins/mail_fetch/index.php b/plugins/mail_fetch/index.php
index bd44a24bbe3473245e715e7a305a4c207b5e88d7..7e744988200117d023665b0084f1562237810a40 100644 (file)
--- a/plugins/mail_fetch/index.php
+++ b/plugins/mail_fetch/index.php
@@ -9,9 +9,11 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage mail_fetch
     **/
 
    header("Location:../../src/login.php\n\n");
    exit();
 
-?>
\ No newline at end of file
+?>

diff --git a/plugins/mail_fetch/options.php b/plugins/mail_fetch/options.php
index eecf16d1896384767581c487d7074f09942965c0..5ac6ae26ac242cf824cfe74a959a6a85dcddd45f 100644 (file)
--- a/plugins/mail_fetch/options.php
+++ b/plugins/mail_fetch/options.php
@@ -9,8 +9,11 @@
  * Setup of the mailfetch plugin.
  *
  * $Id$
+ * @package plugins
+ * @subpackage mail_fetch
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 require_once(SM_PATH . 'include/validate.php');

diff --git a/plugins/mail_fetch/setup.php b/plugins/mail_fetch/setup.php
index 8155251c330d9e70560abffe78790285f2f0991c..cfe8c60671fc79e33b004fb5c03c9849df39a4f0 100644 (file)
--- a/plugins/mail_fetch/setup.php
+++ b/plugins/mail_fetch/setup.php
@@ -9,10 +9,16 @@
     **  Setup of the mailfetch plugin.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage mail_fetch
     **/
-
+    
+    /**  */
     require_once(SM_PATH . 'plugins/mail_fetch/functions.php' );
 
+    /**
+     * Initialize the plugin
+     */
     function squirrelmail_plugin_init_mail_fetch() {
         global $squirrelmail_plugin_hooks;
 

diff --git a/plugins/message_details/message_details_bottom.php b/plugins/message_details/message_details_bottom.php
index b9a5e7b66b2367d61083d73b1a85b3acff6a9f0b..08a8b0e43116474c91a29d0b805c5b892bfc6800 100644 (file)
--- a/plugins/message_details/message_details_bottom.php
+++ b/plugins/message_details/message_details_bottom.php
@@ -8,8 +8,11 @@
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  * 
  * $Id$
+ * @package plugins
+ * @subpackage message_details
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/message_details/message_details_main.php b/plugins/message_details/message_details_main.php
index a89f89e4215fbbed5d043258244c867a94b0cd53..89ed7f3133ccafd6d75f4bd6275b7d916be32c33 100644 (file)
--- a/plugins/message_details/message_details_main.php
+++ b/plugins/message_details/message_details_main.php
@@ -7,9 +7,14 @@
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  * 
  * $Id$
+ * @package plugins
+ * @subpackage message_details
  */
 
-/* Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/message_details/message_details_top.php b/plugins/message_details/message_details_top.php
index 6d4ba5776c8f2cb5c00c0763aa9d6c96d78c75e0..e2808f0ecbaae1f5433fa46b0529309ef08a213c 100644 (file)
--- a/plugins/message_details/message_details_top.php
+++ b/plugins/message_details/message_details_top.php
@@ -8,8 +8,11 @@
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  * 
  * $Id$
+ * @package plugins
+ * @subpackage message_details
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/message_details/setup.php b/plugins/message_details/setup.php
index 9c471c57b04b68cebd9839fe04dcf05c55f5cbf4..7977da8c24cfe140a63a8bdffe0df00646f51f26 100644 (file)
--- a/plugins/message_details/setup.php
+++ b/plugins/message_details/setup.php
@@ -7,9 +7,13 @@
 * Licensed under the GNU GPL. For full terms see the file COPYING.
 * 
 * $Id$
+* @package plugins
+* @subpackage message_details
 **/
 
-
+/**
+ * Initialize the plugin
+ */
 function squirrelmail_plugin_init_message_details()
 {
   global $squirrelmail_plugin_hooks;

diff --git a/plugins/newmail/index.php b/plugins/newmail/index.php
index bd44a24bbe3473245e715e7a305a4c207b5e88d7..62e0c5e1de5f0f529c371c28943d30eafb32caac 100644 (file)
--- a/plugins/newmail/index.php
+++ b/plugins/newmail/index.php
@@ -9,9 +9,11 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage newmail
     **/
 
    header("Location:../../src/login.php\n\n");
    exit();
 
-?>
\ No newline at end of file
+?>

diff --git a/plugins/newmail/newmail.php b/plugins/newmail/newmail.php
index 75f732c26c51635ff1bd0ed9310b6f5120977f14..8a93b11a8890749fccacc9aeab5eba29f41cc46a 100644 (file)
--- a/plugins/newmail/newmail.php
+++ b/plugins/newmail/newmail.php
@@ -8,9 +8,12 @@
  *
  * Displays all options relating to new mail sounds
  *
- * $Id$    
+ * $Id$
+ * @package plugins
+ * @subpackage newmail
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/newmail/newmail_opt.php b/plugins/newmail/newmail_opt.php
index 24924db1f0e39a45ca7590d14a92e1edb4b8751a..edf59b1e2dc8dac4aee8ce37ecad2d7d3bd26221 100644 (file)
--- a/plugins/newmail/newmail_opt.php
+++ b/plugins/newmail/newmail_opt.php
@@ -9,8 +9,11 @@
  * Displays all options relating to new mail sounds
  *
  * $Id$
+ * @package plugins
+ * @subpackage newmail
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/newmail/setup.php b/plugins/newmail/setup.php
index b8a3e65e1e10b6c2e72ec9ab467111d1d5ed919c..f416a7b4889ba6b0d07486c861a03dca8aef91b1 100644 (file)
--- a/plugins/newmail/setup.php
+++ b/plugins/newmail/setup.php
@@ -23,6 +23,11 @@
     * too (with a plugin).
     *
     * $Id$
+    * @package plugins
+    * @subpackage newmail
+    */
+
+    /**
     */
     include_once(SM_PATH . 'functions/display_messages.php');
 

diff --git a/plugins/newmail/testsound.php b/plugins/newmail/testsound.php
index d52b5ba5bbb0c2b6b012554f788d3e0d7c4dbe46..07f8a09799cdb410f5d7637480b92c84bb887d83 100644 (file)
--- a/plugins/newmail/testsound.php
+++ b/plugins/newmail/testsound.php
@@ -7,8 +7,11 @@
  * Licensed under the GNU GPL. For full terms see the file COPYING.        
  *
  * $Id$
+ * @package plugins
+ * @subpackage newmail
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/sent_subfolders/index.php b/plugins/sent_subfolders/index.php
index bd44a24bbe3473245e715e7a305a4c207b5e88d7..d337f4841c12868678564c8ea2a21f388f768c6d 100644 (file)
--- a/plugins/sent_subfolders/index.php
+++ b/plugins/sent_subfolders/index.php
@@ -9,9 +9,11 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage sent_subfolders
     **/
 
    header("Location:../../src/login.php\n\n");
    exit();
 
-?>
\ No newline at end of file
+?>

diff --git a/plugins/sent_subfolders/setup.php b/plugins/sent_subfolders/setup.php
index dafc1035dc9dd93e6e87eb2d2c3e7191bfa191f0..c60abbdfc5541c49b4a2010085fe138e4163aa33 100644 (file)
--- a/plugins/sent_subfolders/setup.php
+++ b/plugins/sent_subfolders/setup.php
@@ -9,8 +9,13 @@
  * This is a standard Squirrelmail-1.2 API for plugins.
  *
  * $Id$
+ * @package plugins
+ * @subpackage sent_subfolders
  */
 
+/** 
+ * 
+ */
 define('SMPREF_SENT_SUBFOLDERS_DISABLED',  0);
 define('SMPREF_SENT_SUBFOLDERS_YEARLY',    1);
 define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);

diff --git a/plugins/spamcop/index.php b/plugins/spamcop/index.php
index bd44a24bbe3473245e715e7a305a4c207b5e88d7..506ac66dcb05c70659ab6835e8ee5f7f939a50b1 100644 (file)
--- a/plugins/spamcop/index.php
+++ b/plugins/spamcop/index.php
@@ -9,9 +9,11 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage spamcop
     **/
 
    header("Location:../../src/login.php\n\n");
    exit();
 
-?>
\ No newline at end of file
+?>

diff --git a/plugins/spamcop/options.php b/plugins/spamcop/options.php
index d264cf933d4e47d232fd020a93012f7df65b9289..1e547dd2bf8f7b9887b2fad36f52230c1c58d0a3 100755 (executable)
--- a/plugins/spamcop/options.php
+++ b/plugins/spamcop/options.php
@@ -7,8 +7,11 @@
     **  Licensed under the GNU GPL. For full terms see the file COPYING.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage spamcop
     **/
 
+/** @ignore */
 define('SM_PATH','../../');
 require_once(SM_PATH . 'include/validate.php');
 

diff --git a/plugins/spamcop/setup.php b/plugins/spamcop/setup.php
index f44a7134577fa8641262f95ae17b996982207769..6c026dd303bd536bc76e232372ef4afe15e0d40a 100755 (executable)
--- a/plugins/spamcop/setup.php
+++ b/plugins/spamcop/setup.php
@@ -5,13 +5,16 @@
     **  Copyright (c) 1999-2003 The SquirrelMail development team
     **  Licensed under the GNU GPL. For full terms see the file COPYING.
     **  
-    **  $Id$                                                         
+    **  $Id$
+    * @package plugins
+    * @subpackage spamcop
     **/
 
+/** @ignore */
 require_once(SM_PATH . 'functions/global.php');
 
 
-/* Initialize the plugin */
+/** Initialize the plugin */
 function squirrelmail_plugin_init_spamcop() {
    global $squirrelmail_plugin_hooks, $data_dir, $username,
       $spamcop_is_composing;

diff --git a/plugins/spamcop/spamcop.php b/plugins/spamcop/spamcop.php
index e9345690a9bbcbd6c69899aa2b4b2bc7a74ca838..c7b1397c6d20b988fe47a28f8d45d2f9c0dbfe49 100644 (file)
--- a/plugins/spamcop/spamcop.php
+++ b/plugins/spamcop/spamcop.php
@@ -5,9 +5,12 @@
     **  Copyright (c) 1999-2003 The SquirrelMail development team
     **  Licensed under the GNU GPL. For full terms see the file COPYING.
     **  
-    **  $Id$                                                         
+    **  $Id$
+    * @package plugins
+    * @subpackage spamcop
     **/
 
+/** @ignore */
 define('SM_PATH','../../');
 
  /* SquirrelMail required files. */

diff --git a/plugins/squirrelspell/doc/index.php b/plugins/squirrelspell/doc/index.php
index b6577825dd2ce2323ee4007c2c206d5fd9a206d5..43e18ff6073c28fcd8df6eddd3de11277dfce941 100644 (file)
--- a/plugins/squirrelspell/doc/index.php
+++ b/plugins/squirrelspell/doc/index.php
@@ -9,6 +9,8 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage squirrelspell
     **/
 
    header("Location:../../../src/login.php\n\n");

diff --git a/plugins/squirrelspell/index.php b/plugins/squirrelspell/index.php
index d22195e079d4717b4eff9c0d7ed33b898349dc29..73f63aa677f8671765dcf9b9cf2c73d50f610576 100644 (file)
--- a/plugins/squirrelspell/index.php
+++ b/plugins/squirrelspell/index.php
@@ -11,6 +11,8 @@
  * the person is logged or not.
  *
  * $Id$
+ * @package plugins
+ * @subpackage squirrelspell
  */
 
 header("Location: ../../index.php");

diff --git a/plugins/squirrelspell/js/index.php b/plugins/squirrelspell/js/index.php
index b6577825dd2ce2323ee4007c2c206d5fd9a206d5..43e18ff6073c28fcd8df6eddd3de11277dfce941 100644 (file)
--- a/plugins/squirrelspell/js/index.php
+++ b/plugins/squirrelspell/js/index.php
@@ -9,6 +9,8 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage squirrelspell
     **/
 
    header("Location:../../../src/login.php\n\n");

diff --git a/plugins/squirrelspell/modules/index.php b/plugins/squirrelspell/modules/index.php
index 5791f65869d290b3192c5166a9aef1105d1ff088..43e18ff6073c28fcd8df6eddd3de11277dfce941 100644 (file)
--- a/plugins/squirrelspell/modules/index.php
+++ b/plugins/squirrelspell/modules/index.php
@@ -9,9 +9,11 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage squirrelspell
     **/
 
    header("Location:../../../src/login.php\n\n");
    exit();
 
-?>
\ No newline at end of file
+?>

diff --git a/plugins/squirrelspell/setup.php b/plugins/squirrelspell/setup.php
index fd049cc2982d22569381bc07766a59dfa0c65f18..be77225218d27da26aae29536ddc8cd90c98ef28 100644 (file)
--- a/plugins/squirrelspell/setup.php
+++ b/plugins/squirrelspell/setup.php
@@ -11,6 +11,8 @@
  *
  * @author Konstantin Riabitsev <icon@duke.edu> ($Author$)
  * @version $Date$
+ * @package plugins
+ * @subpackage squirrelspell
  */
 
 /**

diff --git a/plugins/squirrelspell/sqspell_config.php b/plugins/squirrelspell/sqspell_config.php
index f2a59ca88104c43e8089e6c956da7814b65e2c57..e4ec0f8843d9cb9666d82046621e23dbc42f968b 100644 (file)
--- a/plugins/squirrelspell/sqspell_config.php
+++ b/plugins/squirrelspell/sqspell_config.php
@@ -8,8 +8,11 @@
  *
  *
  * $Id$
+ * @package plugins
+ * @subpackage squirrelspell
  */
 
+/** */
 require_once(SM_PATH . 'functions/prefs.php');
 
 /* Just for poor wretched souls with E_ALL. :) */

diff --git a/plugins/squirrelspell/sqspell_functions.php b/plugins/squirrelspell/sqspell_functions.php
index 23ab2b376b5d01a5fdd094415b45a208e5feecaa..d533d658c844c5594e86a5506fd98b62a7c8b676 100644 (file)
--- a/plugins/squirrelspell/sqspell_functions.php
+++ b/plugins/squirrelspell/sqspell_functions.php
@@ -11,6 +11,8 @@
  *
  * @author Konstantin Riabitsev <icon@duke.edu> ($Author$)
  * @version $Date$
+ * @package plugins
+ * @subpackage squirrelspell
  */
 
 /**

diff --git a/plugins/squirrelspell/sqspell_interface.php b/plugins/squirrelspell/sqspell_interface.php
index 32da3780cb5dfa1ab5dfc7f998d2921ed7dea03e..f0af7b8226776e794cb13bfa55325a2bfac159d0 100644 (file)
--- a/plugins/squirrelspell/sqspell_interface.php
+++ b/plugins/squirrelspell/sqspell_interface.php
@@ -15,6 +15,8 @@
  *
  * @author Konstantin Riabitsev <icon@duke.edu> ($Author$)
  * @version $Date$
+ * @package plugins
+ * @subpackage squirrelspell
  */
 
 /**            
@@ -27,8 +29,8 @@ $SQSPELL_CRYPTO=FALSE;
     
 /**
  * Load the stuff needed from squirrelmail
+ * @ignore
  */
-
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/squirrelspell/sqspell_options.php b/plugins/squirrelspell/sqspell_options.php
index 009f5959e7a0aae12a66b7b6f9e9e4f263878a43..b5984067138835b9adfd2d6a5320ff3724f1eaca 100644 (file)
--- a/plugins/squirrelspell/sqspell_options.php
+++ b/plugins/squirrelspell/sqspell_options.php
@@ -11,6 +11,8 @@
  *
  * @author Konstantin Riabitsev <icon@duke.edu> ($Author$)
  * @version $Date$
+ * @package plugins
+ * @subpackage squirrelspell
  */
 
 /**
@@ -22,6 +24,7 @@ $SQSPELL_CRYPTO=FALSE;
 
 /**
  * Load some necessary stuff from squirrelmail. 
+ * @ignore
  */
 define('SM_PATH','../../');
 

diff --git a/plugins/translate/index.php b/plugins/translate/index.php
index bd44a24bbe3473245e715e7a305a4c207b5e88d7..24deee3df8edc025ec092874b7e6f1d87760eb5d 100644 (file)
--- a/plugins/translate/index.php
+++ b/plugins/translate/index.php
@@ -9,9 +9,11 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage translate
     **/
 
    header("Location:../../src/login.php\n\n");
    exit();
 
-?>
\ No newline at end of file
+?>

diff --git a/plugins/translate/options.php b/plugins/translate/options.php
index 6977c26c635fe3d34055e6b5c0dde9504b3ef50b..ed6170b7b73807a5743ca8652921c217818e31d8 100644 (file)
--- a/plugins/translate/options.php
+++ b/plugins/translate/options.php
@@ -9,9 +9,14 @@
  * Pick your translator to translate the body of incoming mail messages
  *
  * $Id$
+ * @package plugins
+ * @subpackage translate
  */
 
-/* Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */

diff --git a/plugins/translate/setup.php b/plugins/translate/setup.php
index 9aefc853cd43d981a1c8674c49a6b195165e0a1a..af6f7204c840a18c89083dc0d1a849493f9abd32 100644 (file)
--- a/plugins/translate/setup.php
+++ b/plugins/translate/setup.php
@@ -7,6 +7,8 @@
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * $Id$
+ * @package plugins
+ * @subpackage translate
  */
 
 /* Easy plugin that sends the body of the message to a new browser
@@ -31,7 +33,10 @@ outgoing message if you send it to someone in a different country.
 */
 
 
-/* Initialize the translation plugin */
+/**
+ * Initialize the translation plugin
+ * @return void
+ */
 function squirrelmail_plugin_init_translate() {
   global $squirrelmail_plugin_hooks;