From ea5f4b8eaf805c4cc4e9533e87d057300a7fe666 Mon Sep 17 00:00:00 2001 From: tassium Date: Mon, 27 Oct 2003 22:24:41 +0000 Subject: [PATCH] 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 --- plugins/abook_take/setup.php | 9 +++++++++ plugins/abook_take/take.php | 6 +++++- plugins/administrator/auth.php | 7 ++++++- plugins/administrator/defines.php | 3 +++ plugins/administrator/index.php | 4 +++- plugins/administrator/options.php | 6 ++++++ plugins/administrator/setup.php | 3 +++ plugins/bug_report/bug_report.php | 5 +++++ plugins/bug_report/index.php | 2 ++ plugins/bug_report/setup.php | 7 ++++++- plugins/calendar/calendar.php | 5 +++++ plugins/calendar/calendar_data.php | 20 +++++++++++-------- plugins/calendar/day.php | 3 +++ plugins/calendar/event_create.php | 6 ++++++ plugins/calendar/event_delete.php | 6 ++++++ plugins/calendar/event_edit.php | 4 ++++ plugins/calendar/functions.php | 6 +++++- plugins/calendar/index.php | 2 ++ plugins/calendar/setup.php | 6 ++++++ plugins/delete_move_next/index.php | 4 +++- plugins/delete_move_next/setup.php | 6 ++++++ plugins/filters/filters.php | 5 +++++ plugins/filters/index.php | 2 ++ plugins/filters/options.php | 4 +++- plugins/filters/setup.php | 4 +++- plugins/filters/spamoptions.php | 4 +++- plugins/fortune/setup.php | 5 +++++ plugins/index.php | 1 + plugins/info/functions.php | 17 ++++++++++++++-- plugins/info/options.php | 7 +++++-- plugins/info/setup.php | 6 ++++-- plugins/listcommands/index.php | 4 +++- plugins/listcommands/mailout.php | 3 +++ plugins/listcommands/setup.php | 5 +++++ plugins/mail_fetch/class.POP3.php | 5 +++++ plugins/mail_fetch/fetch.php | 3 +++ plugins/mail_fetch/functions.php | 5 +++++ plugins/mail_fetch/index.php | 4 +++- plugins/mail_fetch/options.php | 3 +++ plugins/mail_fetch/setup.php | 8 +++++++- .../message_details_bottom.php | 3 +++ .../message_details/message_details_main.php | 7 ++++++- .../message_details/message_details_top.php | 3 +++ plugins/message_details/setup.php | 6 +++++- plugins/newmail/index.php | 4 +++- plugins/newmail/newmail.php | 5 ++++- plugins/newmail/newmail_opt.php | 3 +++ plugins/newmail/setup.php | 5 +++++ plugins/newmail/testsound.php | 3 +++ plugins/sent_subfolders/index.php | 4 +++- plugins/sent_subfolders/setup.php | 5 +++++ plugins/spamcop/index.php | 4 +++- plugins/spamcop/options.php | 3 +++ plugins/spamcop/setup.php | 7 +++++-- plugins/spamcop/spamcop.php | 5 ++++- plugins/squirrelspell/doc/index.php | 2 ++ plugins/squirrelspell/index.php | 2 ++ plugins/squirrelspell/js/index.php | 2 ++ plugins/squirrelspell/modules/index.php | 4 +++- plugins/squirrelspell/setup.php | 2 ++ plugins/squirrelspell/sqspell_config.php | 3 +++ plugins/squirrelspell/sqspell_functions.php | 2 ++ plugins/squirrelspell/sqspell_interface.php | 4 +++- plugins/squirrelspell/sqspell_options.php | 3 +++ plugins/translate/index.php | 4 +++- plugins/translate/options.php | 7 ++++++- plugins/translate/setup.php | 7 ++++++- 67 files changed, 284 insertions(+), 40 deletions(-) diff --git a/plugins/abook_take/setup.php b/plugins/abook_take/setup.php index 9bdb8409..73ca0a5a 100755 --- 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 6a78d554..8e5e5a88 100644 --- 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 f04aa69f..afbd8719 100644 --- a/plugins/administrator/auth.php +++ b/plugins/administrator/auth.php @@ -1,14 +1,19 @@ \ No newline at end of file +?> diff --git a/plugins/administrator/options.php b/plugins/administrator/options.php index 1198c355..7f95e5b6 100644 --- 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 0beebdb7..50d395c5 100644 --- 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 a4e997a7..2be94e77 100644 --- 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 cd0f2e85..7c812e60 100644 --- 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 3aed1958..e36f9bec 100644 --- 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 881cd9d6..8091cf9e 100644 --- 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 053d4891..705e8a71 100644 --- 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 fe911829..3eff1df7 100644 --- 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 63b11fa1..c10aaed7 100644 --- 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 b7908ec1..eee5ab0f 100644 --- 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 533ce663..9331262c 100644 --- 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 c723f68a..bd836512 100644 --- 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 e89499d6..35c09e49 100644 --- 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 0353361c..4b30c1b4 100644 --- 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 bd44a24b..15a3799f 100644 --- 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 21376a99..8c8c3068 100644 --- 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 c4c66cef..d8bd7a20 100644 --- 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 cd0f2e85..3fd4f3b3 100644 --- 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 73d03e37..0033ee75 100644 --- 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 cca1963d..5773b7e6 100644 --- 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 2fc1706e..97670baf 100644 --- 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 ce01ece9..909ad512 100644 --- 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 269f8987..a7a4c21c 100644 --- 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 41512395..95c779cf 100644 --- a/plugins/info/functions.php +++ b/plugins/info/functions.php @@ -1,6 +1,7 @@ ".$string.""; @@ -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 8e400e0a..9eb2ce69 100644 --- a/plugins/info/options.php +++ b/plugins/info/options.php @@ -1,6 +1,7 @@ \ No newline at end of file +?> diff --git a/plugins/listcommands/mailout.php b/plugins/listcommands/mailout.php index e505465a..5d08b20b 100644 --- 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 afb634d3..4a9b73cb 100644 --- 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 9b1883ff..2e2dac4e 100644 --- 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 03c9211b..d2e6eaef 100644 --- 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 42d17043..068ad828 100644 --- a/plugins/mail_fetch/functions.php +++ b/plugins/mail_fetch/functions.php @@ -13,8 +13,13 @@ ** Adapted for MailFetch by Philippe Mingo ** ** $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 bd44a24b..7e744988 100644 --- 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 eecf16d1..5ac6ae26 100644 --- 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 8155251c..cfe8c606 100644 --- 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 b9a5e7b6..08a8b0e4 100644 --- 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 a89f89e4..89ed7f31 100644 --- 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 6d4ba577..e2808f0e 100644 --- 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 9c471c57..7977da8c 100644 --- 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 bd44a24b..62e0c5e1 100644 --- 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 75f732c2..8a93b11a 100644 --- 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 24924db1..edf59b1e 100644 --- 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 b8a3e65e..f416a7b4 100644 --- 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 d52b5ba5..07f8a097 100644 --- 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 bd44a24b..d337f484 100644 --- 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 dafc1035..c60abbdf 100644 --- 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 bd44a24b..506ac66d 100644 --- 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 d264cf93..1e547dd2 100755 --- 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 f44a7134..6c026dd3 100755 --- 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 e9345690..c7b1397c 100644 --- 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 b6577825..43e18ff6 100644 --- 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 d22195e0..73f63aa6 100644 --- 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 b6577825..43e18ff6 100644 --- 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 5791f658..43e18ff6 100644 --- 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 fd049cc2..be772252 100644 --- a/plugins/squirrelspell/setup.php +++ b/plugins/squirrelspell/setup.php @@ -11,6 +11,8 @@ * * @author Konstantin Riabitsev ($Author$) * @version $Date$ + * @package plugins + * @subpackage squirrelspell */ /** diff --git a/plugins/squirrelspell/sqspell_config.php b/plugins/squirrelspell/sqspell_config.php index f2a59ca8..e4ec0f88 100644 --- 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 23ab2b37..d533d658 100644 --- a/plugins/squirrelspell/sqspell_functions.php +++ b/plugins/squirrelspell/sqspell_functions.php @@ -11,6 +11,8 @@ * * @author Konstantin Riabitsev ($Author$) * @version $Date$ + * @package plugins + * @subpackage squirrelspell */ /** diff --git a/plugins/squirrelspell/sqspell_interface.php b/plugins/squirrelspell/sqspell_interface.php index 32da3780..f0af7b82 100644 --- a/plugins/squirrelspell/sqspell_interface.php +++ b/plugins/squirrelspell/sqspell_interface.php @@ -15,6 +15,8 @@ * * @author Konstantin Riabitsev ($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 009f5959..b5984067 100644 --- a/plugins/squirrelspell/sqspell_options.php +++ b/plugins/squirrelspell/sqspell_options.php @@ -11,6 +11,8 @@ * * @author Konstantin Riabitsev ($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 bd44a24b..24deee3d 100644 --- 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 6977c26c..ed6170b7 100644 --- 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 9aefc853..af6f7204 100644 --- 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; -- 2.25.1