Initial groundwork to use phpdocumentor.
authortassium <tassium@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Mon, 27 Oct 2003 22:24:41 +0000 (22:24 +0000)
committertassium <tassium@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Mon, 27 Oct 2003 22:24:41 +0000 (22:24 +0000)
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

67 files changed:
plugins/abook_take/setup.php
plugins/abook_take/take.php
plugins/administrator/auth.php
plugins/administrator/defines.php
plugins/administrator/index.php
plugins/administrator/options.php
plugins/administrator/setup.php
plugins/bug_report/bug_report.php
plugins/bug_report/index.php
plugins/bug_report/setup.php
plugins/calendar/calendar.php
plugins/calendar/calendar_data.php
plugins/calendar/day.php
plugins/calendar/event_create.php
plugins/calendar/event_delete.php
plugins/calendar/event_edit.php
plugins/calendar/functions.php
plugins/calendar/index.php
plugins/calendar/setup.php
plugins/delete_move_next/index.php
plugins/delete_move_next/setup.php
plugins/filters/filters.php
plugins/filters/index.php
plugins/filters/options.php
plugins/filters/setup.php
plugins/filters/spamoptions.php
plugins/fortune/setup.php
plugins/index.php
plugins/info/functions.php
plugins/info/options.php
plugins/info/setup.php
plugins/listcommands/index.php
plugins/listcommands/mailout.php
plugins/listcommands/setup.php
plugins/mail_fetch/class.POP3.php
plugins/mail_fetch/fetch.php
plugins/mail_fetch/functions.php
plugins/mail_fetch/index.php
plugins/mail_fetch/options.php
plugins/mail_fetch/setup.php
plugins/message_details/message_details_bottom.php
plugins/message_details/message_details_main.php
plugins/message_details/message_details_top.php
plugins/message_details/setup.php
plugins/newmail/index.php
plugins/newmail/newmail.php
plugins/newmail/newmail_opt.php
plugins/newmail/setup.php
plugins/newmail/testsound.php
plugins/sent_subfolders/index.php
plugins/sent_subfolders/setup.php
plugins/spamcop/index.php
plugins/spamcop/options.php
plugins/spamcop/setup.php
plugins/spamcop/spamcop.php
plugins/squirrelspell/doc/index.php
plugins/squirrelspell/index.php
plugins/squirrelspell/js/index.php
plugins/squirrelspell/modules/index.php
plugins/squirrelspell/setup.php
plugins/squirrelspell/sqspell_config.php
plugins/squirrelspell/sqspell_functions.php
plugins/squirrelspell/sqspell_interface.php
plugins/squirrelspell/sqspell_options.php
plugins/translate/index.php
plugins/translate/options.php
plugins/translate/setup.php

index 9bdb840..73ca0a5 100755 (executable)
  * 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;
index 6a78d55..8e5e5a8 100644 (file)
  * 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. */
index f04aa69..afbd871 100644 (file)
@@ -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');
index f4ac3dd..3d7dae3 100644 (file)
@@ -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. */
index bd44a24..a500d24 100644 (file)
@@ -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
+?>
index 1198c35..7f95e5b 100644 (file)
@@ -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. */
index 0beebdb..50d395c 100644 (file)
@@ -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() {
index a4e997a..2be94e7 100644 (file)
  * 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');
index cd0f2e8..7c812e6 100644 (file)
@@ -9,6 +9,8 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage bug_report
     **/
 
    header("Location:../../src/login.php\n\n");
index 3aed195..e36f9be 100644 (file)
@@ -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;
 
index 881cd9d..8091cf9 100644 (file)
  * Displays the main calendar page (month view).
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
  */
+
+/**
+*/
 define('SM_PATH','../../');
 
 /* Calender plugin required files. */
index 053d489..705e8a7 100644 (file)
  * 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;
 
index fe91182..3eff1df 100644 (file)
  * Displays the day page (day view).
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* Calender plugin required files. */
index 63b11fa..c10aaed 100644 (file)
  * functions to create a event for calendar.
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
+ */
+
+/**
+ * @ignore
  */
 define('SM_PATH','../../');
 
index b7908ec..eee5ab0 100644 (file)
  * Functions to delete a event. 
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
+ */
+
+/**
+ * @ignore
  */
 define('SM_PATH','../../');
 
index 533ce66..9331262 100644 (file)
  * Functions to edit an event.
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
  */
+
+/** @ignore */
 define('SM_PATH','../../');
 
 /* Calender plugin required files. */
index c723f68..bd83651 100644 (file)
  * 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;
index e89499d..35c09e4 100644 (file)
@@ -9,6 +9,8 @@
  * Redirects to the login page.
  *
  * $Id$
+ * @package plugins
+ * @subpackage calendar
  */
 
 header("Location:../../src/login.php\n\n");
index 0353361..4b30c1b 100644 (file)
  * 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';
index bd44a24..15a3799 100644 (file)
@@ -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
+?>
index 21376a9..8c8c306 100644 (file)
  * 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;
 
index c4c66ce..d8bd7a2 100644 (file)
  * Also view plugins/README.plugins for more information.
  *
  * $Id$
+ * @package plugins
+ * @subpackage filters
  */
 
+/**
+*
+*/
 function filters_SaveCache () {
     global $data_dir, $SpamFilters_DNScache;
 
index cd0f2e8..3fd4f3b 100644 (file)
@@ -9,6 +9,8 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage filters
     **/
 
    header("Location:../../src/login.php\n\n");
index 73d03e3..0033ee7 100644 (file)
  * 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. */
index cca1963..5773b7e 100644 (file)
  * 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');
 
 /*
index 2fc1706..97670ba 100644 (file)
  * 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. */
index ce01ece..909ad51 100644 (file)
  * fortune above the message listing.
  *
  * $Id$
+ * @package plugins
+ * @subpackage fortune
  */
 
+/**
+*
+*/
 function squirrelmail_plugin_init_fortune() {
   global $squirrelmail_plugin_hooks;
   
index 269f898..a7a4c21 100644 (file)
@@ -11,6 +11,7 @@
  * the person is logged or not.
  *
  * $Id$
+ * @package plugins
  */
 
 header("Location:../index.php");
index 4151239..95c779c 100644 (file)
@@ -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.
  *
  * 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)) {
index 8e400e0..9eb2ce6 100644 (file)
@@ -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.
  *   
  * jason@stdbev.com
  * 
  * $Id$
- * 
+ * @package plugins
+ * @subpackage info
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */
index 6adcf07..c5476bd 100644 (file)
@@ -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() {
index bd44a24..b0726dc 100644 (file)
@@ -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
+?>
index e505465..5d08b20 100644 (file)
@@ -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. */
index afb634d..4a9b73c 100644 (file)
  * 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;
 
index 9b1883f..2e2dac4 100644 (file)
     * pop3 class
     *
     * $Id$
+    * @package plugins
+    * @subpackage mail_fetch
     */
 
+/**
+ * This is the pop3 class - DOCUMENT ME
+ */
 class POP3 {
     var $ERROR      = '';       //  Error string.
 
index 03c9211..d2e6eae 100644 (file)
@@ -9,8 +9,11 @@
  * Fetch code.
  *
  * $Id$
+ * @package plugins
+ * @subpackage mail_fetch
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 require_once(SM_PATH . 'include/validate.php');
index 42d1704..068ad82 100644 (file)
     **  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 */
index bd44a24..7e74498 100644 (file)
@@ -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
+?>
index eecf16d..5ac6ae2 100644 (file)
@@ -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');
index 8155251..cfe8c60 100644 (file)
@@ -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;
 
index b9a5e7b..08a8b0e 100644 (file)
@@ -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. */
index a89f89e..89ed7f3 100644 (file)
@@ -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. */
index 6d4ba57..e2808f0 100644 (file)
@@ -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. */
index 9c471c5..7977da8 100644 (file)
@@ -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;
index bd44a24..62e0c5e 100644 (file)
@@ -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
+?>
index 75f732c..8a93b11 100644 (file)
@@ -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. */
index 24924db..edf59b1 100644 (file)
@@ -9,8 +9,11 @@
  * Displays all options relating to new mail sounds
  *
  * $Id$
+ * @package plugins
+ * @subpackage newmail
  */
 
+/** @ignore */
 define('SM_PATH','../../');
 
 /* SquirrelMail required files. */
index b8a3e65..f416a7b 100644 (file)
     * too (with a plugin).
     *
     * $Id$
+    * @package plugins
+    * @subpackage newmail
+    */
+
+    /**
     */
     include_once(SM_PATH . 'functions/display_messages.php');
 
index d52b5ba..07f8a09 100644 (file)
@@ -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. */
index bd44a24..d337f48 100644 (file)
@@ -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
+?>
index dafc103..c60abbd 100644 (file)
@@ -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);
index bd44a24..506ac66 100644 (file)
@@ -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
+?>
index d264cf9..1e547dd 100755 (executable)
@@ -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');
 
index f44a713..6c026dd 100755 (executable)
@@ -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;
index e934569..c7b1397 100644 (file)
@@ -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. */
index b657782..43e18ff 100644 (file)
@@ -9,6 +9,8 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage squirrelspell
     **/
 
    header("Location:../../../src/login.php\n\n");
index d22195e..73f63aa 100644 (file)
@@ -11,6 +11,8 @@
  * the person is logged or not.
  *
  * $Id$
+ * @package plugins
+ * @subpackage squirrelspell
  */
 
 header("Location: ../../index.php");
index b657782..43e18ff 100644 (file)
@@ -9,6 +9,8 @@
     **  Redirects to the login page.
     **
     **  $Id$
+    * @package plugins
+    * @subpackage squirrelspell
     **/
 
    header("Location:../../../src/login.php\n\n");
index 5791f65..43e18ff 100644 (file)
@@ -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
+?>
index fd049cc..be77225 100644 (file)
@@ -11,6 +11,8 @@
  *
  * @author Konstantin Riabitsev <icon@duke.edu> ($Author$)
  * @version $Date$
+ * @package plugins
+ * @subpackage squirrelspell
  */
 
 /**
index f2a59ca..e4ec0f8 100644 (file)
@@ -8,8 +8,11 @@
  *
  *
  * $Id$
+ * @package plugins
+ * @subpackage squirrelspell
  */
 
+/** */
 require_once(SM_PATH . 'functions/prefs.php');
 
 /* Just for poor wretched souls with E_ALL. :) */
index 23ab2b3..d533d65 100644 (file)
@@ -11,6 +11,8 @@
  *
  * @author Konstantin Riabitsev <icon@duke.edu> ($Author$)
  * @version $Date$
+ * @package plugins
+ * @subpackage squirrelspell
  */
 
 /**
index 32da378..f0af7b8 100644 (file)
@@ -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. */
index 009f595..b598406 100644 (file)
@@ -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','../../');
 
index bd44a24..24deee3 100644 (file)
@@ -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
+?>
index 6977c26..ed6170b 100644 (file)
@@ -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. */
index 9aefc85..af6f720 100644 (file)
@@ -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;