Define @package and @subpackage of Framework classes

42 files changed, 108 insertions, 72 deletions

diff --git a/program/include/html.php b/program/include/html.php
index 0f93e969d..8ff685a84 100644
--- a/program/include/html.php
+++ b/program/include/html.php
@@ -23,7 +23,8 @@
 /**
  * Class for HTML code creation
  *
- * @package HTML
+ * @package    Framework
+ * @subpackage HTML
  */
 class html
 {
diff --git a/program/include/rcube_addressbook.php b/program/include/rcube_addressbook.php
index 892ae263a..b5fb8cf43 100644
--- a/program/include/rcube_addressbook.php
+++ b/program/include/rcube_addressbook.php
@@ -23,7 +23,8 @@
 /**
  * Abstract skeleton of an address book/repository
  *
- * @package Addressbook
+ * @package    Framework
+ * @subpackage Addressbook
  */
 abstract class rcube_addressbook
 {
diff --git a/program/include/rcube_base_replacer.php b/program/include/rcube_base_replacer.php
index 4ec367552..b2a0fc13c 100644
--- a/program/include/rcube_base_replacer.php
+++ b/program/include/rcube_base_replacer.php
@@ -23,8 +23,9 @@
  * Helper class to turn relative urls into absolute ones
  * using a predefined base
  *
- * @package Core
- * @author Thomas Bruederli <roundcube@gmail.com>
+ * @package    Framework
+ * @subpackage Core
+ * @author     Thomas Bruederli <roundcube@gmail.com>
  */
 class rcube_base_replacer
 {
diff --git a/program/include/rcube_browser.php b/program/include/rcube_browser.php
index 7cfae709d..154e7ef4e 100644
--- a/program/include/rcube_browser.php
+++ b/program/include/rcube_browser.php
@@ -22,7 +22,8 @@
 /**
  * Provide details about the client's browser based on the User-Agent header
  *
- * @package Core
+ * @package    Framework
+ * @subpackage Core
  */
 class rcube_browser
 {
diff --git a/program/include/rcube_cache.php b/program/include/rcube_cache.php
index 4e60deaff..3e1ce4fc8 100644
--- a/program/include/rcube_cache.php
+++ b/program/include/rcube_cache.php
@@ -25,10 +25,10 @@
 /**
  * Interface class for accessing Roundcube cache
  *
- * @package    Cache
+ * @package    Framework
+ * @subpackage Cache
  * @author     Thomas Bruederli <roundcube@gmail.com>
  * @author     Aleksander Machniak <alec@alec.pl>
- * @version    1.1
  */
 class rcube_cache
 {
diff --git a/program/include/rcube_charset.php b/program/include/rcube_charset.php
index 4d24ed135..e8cce00e3 100644
--- a/program/include/rcube_charset.php
+++ b/program/include/rcube_charset.php
@@ -25,10 +25,11 @@
 /**
  * Character sets conversion functionality
  *
- * @package Core
- * @author Thomas Bruederli <roundcube@gmail.com>
- * @author Aleksander Machniak <alec@alec.pl>
- * @author Edmund Grimley Evans <edmundo@rano.org>
+ * @package    Framework
+ * @subpackage Core
+ * @author     Thomas Bruederli <roundcube@gmail.com>
+ * @author     Aleksander Machniak <alec@alec.pl>
+ * @author     Edmund Grimley Evans <edmundo@rano.org>
  */
 class rcube_charset
 {
diff --git a/program/include/rcube_config.php b/program/include/rcube_config.php
index bbc3e9c6e..dab539412 100644
--- a/program/include/rcube_config.php
+++ b/program/include/rcube_config.php
@@ -22,7 +22,8 @@
 /**
  * Configuration class for Roundcube
  *
- * @package Core
+ * @package    Framework
+ * @subpackage Core
  */
 class rcube_config
 {
diff --git a/program/include/rcube_contacts.php b/program/include/rcube_contacts.php
index 534a65cb9..e4500c744 100644
--- a/program/include/rcube_contacts.php
+++ b/program/include/rcube_contacts.php
@@ -23,7 +23,8 @@
 /**
  * Model class for the local address book database
  *
- * @package Addressbook
+ * @package    Framework
+ * @subpackage Addressbook
  */
 class rcube_contacts extends rcube_addressbook
 {
diff --git a/program/include/rcube_content_filter.php b/program/include/rcube_content_filter.php
index 36e61a271..99916a300 100644
--- a/program/include/rcube_content_filter.php
+++ b/program/include/rcube_content_filter.php
@@ -21,6 +21,9 @@
 
 /**
  * PHP stream filter to detect html/javascript code in attachments
+ *
+ * @package    Framework
+ * @subpackage Core
  */
 class rcube_content_filter extends php_user_filter
 {
diff --git a/program/include/rcube_csv2vcard.php b/program/include/rcube_csv2vcard.php
index 6ec2158be..114d36d85 100644
--- a/program/include/rcube_csv2vcard.php
+++ b/program/include/rcube_csv2vcard.php
@@ -21,8 +21,9 @@
 /**
  * CSV to vCard data converter
  *
- * @package Roundcube Framework
- * @author  Aleksander Machniak <alec@alec.pl>
+ * @package    Framework
+ * @subpackage Addressbook
+ * @author     Aleksander Machniak <alec@alec.pl>
  */
 class rcube_csv2vcard
 {
diff --git a/program/include/rcube_db.php b/program/include/rcube_db.php
index b066101b3..5d8c4a534 100644
--- a/program/include/rcube_db.php
+++ b/program/include/rcube_db.php
@@ -21,12 +21,11 @@
 
 
 /**
- * Database independent query interface
+ * Database independent query interface.
+ * This is a wrapper for the PHP PDO.
  *
- * This is a wrapper for the PHP PDO
- *
- * @package Database
- * @version 1.0
+ * @package   Framework
+ * @sbpackage Database
  */
 class rcube_db
 {
diff --git a/program/include/rcube_db_mssql.php b/program/include/rcube_db_mssql.php
index 119647d95..c95663c74 100644
--- a/program/include/rcube_db_mssql.php
+++ b/program/include/rcube_db_mssql.php
@@ -23,11 +23,10 @@
 
 /**
  * Database independent query interface
- *
  * This is a wrapper for the PHP PDO
  *
- * @package Database
- * @version 1.0
+ * @package    Framework
+ * @subpackage Database
  */
 class rcube_db_mssql extends rcube_db
 {
diff --git a/program/include/rcube_db_mysql.php b/program/include/rcube_db_mysql.php
index 6f0acba54..1c5ba1de7 100644
--- a/program/include/rcube_db_mysql.php
+++ b/program/include/rcube_db_mysql.php
@@ -26,8 +26,8 @@
  *
  * This is a wrapper for the PHP PDO
  *
- * @package Database
- * @version 1.0
+ * @package    Framework
+ * @subpackage Database
  */
 class rcube_db_mysql extends rcube_db
 {
diff --git a/program/include/rcube_db_pgsql.php b/program/include/rcube_db_pgsql.php
index 0d0caadde..797860a84 100644
--- a/program/include/rcube_db_pgsql.php
+++ b/program/include/rcube_db_pgsql.php
@@ -23,11 +23,10 @@
 
 /**
  * Database independent query interface
- *
  * This is a wrapper for the PHP PDO
  *
- * @package Database
- * @version 1.0
+ * @package    Framework
+ * @subpackage Database
  */
 class rcube_db_pgsql extends rcube_db
 {
diff --git a/program/include/rcube_db_sqlite.php b/program/include/rcube_db_sqlite.php
index a7397674b..9aa67d0fd 100644
--- a/program/include/rcube_db_sqlite.php
+++ b/program/include/rcube_db_sqlite.php
@@ -23,11 +23,10 @@
 
 /**
  * Database independent query interface
- *
  * This is a wrapper for the PHP PDO
  *
- * @package Database
- * @version 1.0
+ * @package    Framework
+ * @subpackage Database
  */
 class rcube_db_sqlite extends rcube_db
 {
diff --git a/program/include/rcube_db_sqlsrv.php b/program/include/rcube_db_sqlsrv.php
index e58bf0704..8b6ffe807 100644
--- a/program/include/rcube_db_sqlsrv.php
+++ b/program/include/rcube_db_sqlsrv.php
@@ -23,11 +23,10 @@
 
 /**
  * Database independent query interface
- *
  * This is a wrapper for the PHP PDO
  *
- * @package Database
- * @version 1.0
+ * @package    Framework
+ * @subpackage Database
  */
 class rcube_db_sqlsrv extends rcube_db
 {
diff --git a/program/include/rcube_image.php b/program/include/rcube_image.php
index c0d4e878d..b72a24c51 100644
--- a/program/include/rcube_image.php
+++ b/program/include/rcube_image.php
@@ -21,6 +21,12 @@
  +-----------------------------------------------------------------------+
 */
 
+/**
+ * Image resizer and converter
+ *
+ * @package    Framework
+ * @subpackage Utils
+ */
 class rcube_image
 {
     private $image_file;
diff --git a/program/include/rcube_imap.php b/program/include/rcube_imap.php
index f2645f60f..9054b6bab 100644
--- a/program/include/rcube_imap.php
+++ b/program/include/rcube_imap.php
@@ -25,10 +25,10 @@
 /**
  * Interface class for accessing an IMAP server
  *
- * @package    Mail
+ * @package    Framework
+ * @subpackage Storage
  * @author     Thomas Bruederli <roundcube@gmail.com>
  * @author     Aleksander Machniak <alec@alec.pl>
- * @version    2.0
  */
 class rcube_imap extends rcube_storage
 {
diff --git a/program/include/rcube_imap_cache.php b/program/include/rcube_imap_cache.php
index f36ace0eb..31214cfbf 100644
--- a/program/include/rcube_imap_cache.php
+++ b/program/include/rcube_imap_cache.php
@@ -24,10 +24,10 @@
 /**
  * Interface class for accessing Roundcube messages cache
  *
- * @package    Cache
+ * @package    Framework
+ * @subpackage Storage
  * @author     Thomas Bruederli <roundcube@gmail.com>
  * @author     Aleksander Machniak <alec@alec.pl>
- * @version    1.0
  */
 class rcube_imap_cache
 {
diff --git a/program/include/rcube_imap_generic.php b/program/include/rcube_imap_generic.php
index bc7ecfc37..a0a8f3b77 100644
--- a/program/include/rcube_imap_generic.php
+++ b/program/include/rcube_imap_generic.php
@@ -30,8 +30,8 @@
 /**
  * PHP based wrapper class to connect to an IMAP server
  *
- * @package Mail
- * @author  Aleksander Machniak <alec@alec.pl>
+ * @package    Framework
+ * @subpackage Storage
  */
 class rcube_imap_generic
 {
diff --git a/program/include/rcube_ldap.php b/program/include/rcube_ldap.php
index 7cef25556..34e37e3b9 100644
--- a/program/include/rcube_ldap.php
+++ b/program/include/rcube_ldap.php
@@ -6,7 +6,7 @@
  |                                                                       |
  | This file is part of the Roundcube Webmail client                     |
  | Copyright (C) 2006-2012, The Roundcube Dev Team                       |
- | Copyright (C) 2011, Kolab Systems AG                                  |
+ | Copyright (C) 2011-2012, Kolab Systems AG                             |
  |                                                                       |
  | Licensed under the GNU General Public License version 3 or            |
  | any later version with exceptions for skins & plugins.                |
@@ -26,7 +26,8 @@
 /**
  * Model class to access an LDAP address directory
  *
- * @package Addressbook
+ * @package    Framework
+ * @subpackage Addressbook
  */
 class rcube_ldap extends rcube_addressbook
 {
diff --git a/program/include/rcube_message.php b/program/include/rcube_message.php
index 74bf4574f..87319f04f 100644
--- a/program/include/rcube_message.php
+++ b/program/include/rcube_message.php
@@ -24,7 +24,8 @@
  * Logical representation of a mail message with all its data
  * and related functions
  *
- * @package    Mail
+ * @package    Framework
+ * @subpackage Storage
  * @author     Thomas Bruederli <roundcube@gmail.com>
  */
 class rcube_message
diff --git a/program/include/rcube_message_header.php b/program/include/rcube_message_header.php
index 378fb98c9..db82247f9 100644
--- a/program/include/rcube_message_header.php
+++ b/program/include/rcube_message_header.php
@@ -23,8 +23,9 @@
 /**
  * Struct representing an e-mail message header
  *
- * @package Mail
- * @author  Aleksander Machniak <alec@alec.pl>
+ * @package    Framework
+ * @subpackage Storage
+ * @author     Aleksander Machniak <alec@alec.pl>
  */
 class rcube_message_header
 {
diff --git a/program/include/rcube_message_part.php b/program/include/rcube_message_part.php
index 80a019e50..c9c9257eb 100644
--- a/program/include/rcube_message_part.php
+++ b/program/include/rcube_message_part.php
@@ -25,10 +25,10 @@
 /**
  * Class representing a message part
  *
- * @package    Mail
+ * @package    Framework
+ * @subpackage Storage
  * @author     Thomas Bruederli <roundcube@gmail.com>
  * @author     Aleksander Machniak <alec@alec.pl>
- * @version    2.0
  */
 class rcube_message_part
 {
diff --git a/program/include/rcube_mime.php b/program/include/rcube_mime.php
index d8e04a97c..2dbeaf67a 100644
--- a/program/include/rcube_mime.php
+++ b/program/include/rcube_mime.php
@@ -25,9 +25,10 @@
 /**
  * Class for parsing MIME messages
  *
- * @package Mail
- * @author  Thomas Bruederli <roundcube@gmail.com>
- * @author  Aleksander Machniak <alec@alec.pl>
+ * @package    Framework
+ * @subpackage Storage
+ * @author     Thomas Bruederli <roundcube@gmail.com>
+ * @author     Aleksander Machniak <alec@alec.pl>
  */
 class rcube_mime
 {
diff --git a/program/include/rcube_output.php b/program/include/rcube_output.php
index 5c582e67c..f7ac3002f 100644
--- a/program/include/rcube_output.php
+++ b/program/include/rcube_output.php
@@ -22,7 +22,8 @@
 /**
  * Class for output generation
  *
- * @package HTML
+ * @package    Framework
+ * @subpackage View
  */
 abstract class rcube_output
 {
diff --git a/program/include/rcube_output_html.php b/program/include/rcube_output_html.php
index ac07d58e9..ffb5db4da 100644
--- a/program/include/rcube_output_html.php
+++ b/program/include/rcube_output_html.php
@@ -23,7 +23,8 @@
 /**
  * Class to create HTML page output using a skin template
  *
- * @package View
+ * @package    Framework
+ * @subpackage View
  */
 class rcube_output_html extends rcube_output
 {
diff --git a/program/include/rcube_output_json.php b/program/include/rcube_output_json.php
index eb1a9380d..fcd52c789 100644
--- a/program/include/rcube_output_json.php
+++ b/program/include/rcube_output_json.php
@@ -23,7 +23,8 @@
 /**
  * View class to produce JSON responses
  *
- * @package View
+ * @package    Framework
+ * @subpackage View
  */
 class rcube_output_json extends rcube_output
 {
diff --git a/program/include/rcube_plugin.php b/program/include/rcube_plugin.php
index 45088850a..dbb15e8be 100644
--- a/program/include/rcube_plugin.php
+++ b/program/include/rcube_plugin.php
@@ -22,7 +22,8 @@
 /**
  * Plugin interface class
  *
- * @package PluginAPI
+ * @package    Framework
+ * @subpackage PluginAPI
  */
 abstract class rcube_plugin
 {
diff --git a/program/include/rcube_plugin_api.php b/program/include/rcube_plugin_api.php
index c473b0b17..51daf2797 100644
--- a/program/include/rcube_plugin_api.php
+++ b/program/include/rcube_plugin_api.php
@@ -27,7 +27,8 @@ if (!defined('RCMAIL_PLUGINS_DIR'))
 /**
  * The plugin loader and global API
  *
- * @package PluginAPI
+ * @package    Framework
+ * @subpackage PluginAPI
  */
 class rcube_plugin_api
 {
diff --git a/program/include/rcube_result_index.php b/program/include/rcube_result_index.php
index 334ec8530..4d1ae13b6 100644
--- a/program/include/rcube_result_index.php
+++ b/program/include/rcube_result_index.php
@@ -24,6 +24,9 @@
 
 /**
  * Class for accessing IMAP's SORT/SEARCH/ESEARCH result
+ *
+ * @package    Framework
+ * @subpackage Storage
  */
 class rcube_result_index
 {
diff --git a/program/include/rcube_result_set.php b/program/include/rcube_result_set.php
index 809d8743f..456d1c9d6 100644
--- a/program/include/rcube_result_set.php
+++ b/program/include/rcube_result_set.php
@@ -24,7 +24,8 @@
  * Roundcube result set class.
  * Representing an address directory result set.
  *
- * @package Addressbook
+ * @package    Framework
+ * @subpackage Addressbook
  */
 class rcube_result_set
 {
diff --git a/program/include/rcube_result_thread.php b/program/include/rcube_result_thread.php
index b2325a499..c609bdc39 100644
--- a/program/include/rcube_result_thread.php
+++ b/program/include/rcube_result_thread.php
@@ -24,6 +24,9 @@
 
 /**
  * Class for accessing IMAP's THREAD result
+ *
+ * @package    Framework
+ * @subpackage Storage
  */
 class rcube_result_thread
 {
diff --git a/program/include/rcube_session.php b/program/include/rcube_session.php
index c71efa2aa..fdbf668ca 100644
--- a/program/include/rcube_session.php
+++ b/program/include/rcube_session.php
@@ -24,7 +24,8 @@
 /**
  * Class to provide database supported session storage
  *
- * @package    Core
+ * @package    Framework
+ * @subpackage Core
  * @author     Thomas Bruederli <roundcube@gmail.com>
  * @author     Aleksander Machniak <alec@alec.pl>
  */
diff --git a/program/include/rcube_shared.inc b/program/include/rcube_shared.inc
index 4577c6df5..5105fe22f 100644
--- a/program/include/rcube_shared.inc
+++ b/program/include/rcube_shared.inc
@@ -23,7 +23,8 @@
 /**
  * Roundcube shared functions
  *
- * @package Core
+ * @package    Framework
+ * @subpackage Core
  */
 
 
diff --git a/program/include/rcube_smtp.php b/program/include/rcube_smtp.php
index b28be5206..490ea8ad6 100644
--- a/program/include/rcube_smtp.php
+++ b/program/include/rcube_smtp.php
@@ -25,7 +25,8 @@ define('SMTP_MIME_CRLF', "\r\n");
 /**
  * Class to provide SMTP functionality using PEAR Net_SMTP
  *
- * @package    Mail
+ * @package    Framework
+ * @subpackage Mail
  * @author     Thomas Bruederli <roundcube@gmail.com>
  * @author     Aleksander Machniak <alec@alec.pl>
  */
diff --git a/program/include/rcube_spellchecker.php b/program/include/rcube_spellchecker.php
index 219dca780..30d15d721 100644
--- a/program/include/rcube_spellchecker.php
+++ b/program/include/rcube_spellchecker.php
@@ -25,7 +25,8 @@
 /**
  * Helper class for spellchecking with Googielspell and PSpell support.
  *
- * @package Core
+ * @package    Framework
+ * @subpackage Utils
  */
 class rcube_spellchecker
 {
diff --git a/program/include/rcube_storage.php b/program/include/rcube_storage.php
index 933ebcc25..1556aae41 100644
--- a/program/include/rcube_storage.php
+++ b/program/include/rcube_storage.php
@@ -25,10 +25,10 @@
 /**
  * Abstract class for accessing mail messages storage server
  *
- * @package Mail
- * @author  Thomas Bruederli <roundcube@gmail.com>
- * @author  Aleksander Machniak <alec@alec.pl>
- * @version 2.0
+ * @package    Framework
+ * @subpackage Storage
+ * @author     Thomas Bruederli <roundcube@gmail.com>
+ * @author     Aleksander Machniak <alec@alec.pl>
  */
 abstract class rcube_storage
 {
diff --git a/program/include/rcube_string_replacer.php b/program/include/rcube_string_replacer.php
index edb2ac34f..9af6b33e0 100644
--- a/program/include/rcube_string_replacer.php
+++ b/program/include/rcube_string_replacer.php
@@ -23,7 +23,8 @@
 /**
  * Helper class for string replacements based on preg_replace_callback
  *
- * @package Core
+ * @package    Framework
+ * @subpackage Utils
  */
 class rcube_string_replacer
 {
diff --git a/program/include/rcube_user.php b/program/include/rcube_user.php
index 72b03cd15..5a8e9005e 100644
--- a/program/include/rcube_user.php
+++ b/program/include/rcube_user.php
@@ -5,7 +5,7 @@
  | program/include/rcube_user.inc                                        |
  |                                                                       |
  | This file is part of the Roundcube Webmail client                     |
- | Copyright (C) 2005-2010, The Roundcube Dev Team                       |
+ | Copyright (C) 2005-2012, The Roundcube Dev Team                       |
  |                                                                       |
  | Licensed under the GNU General Public License version 3 or            |
  | any later version with exceptions for skins & plugins.                |
@@ -17,6 +17,7 @@
  |                                                                       |
  +-----------------------------------------------------------------------+
  | Author: Thomas Bruederli <roundcube@gmail.com>                        |
+ | Author: Aleksander Machniak <alec@alec.pl>                            |
  +-----------------------------------------------------------------------+
 */
 
@@ -24,8 +25,8 @@
 /**
  * Class representing a system user
  *
- * @package    Core
- * @author     Thomas Bruederli <roundcube@gmail.com>
+ * @package    Framework
+ * @subpackage Core
  */
 class rcube_user
 {
diff --git a/program/include/rcube_utils.php b/program/include/rcube_utils.php
index 5cfd8e70e..dfaa9b943 100644
--- a/program/include/rcube_utils.php
+++ b/program/include/rcube_utils.php
@@ -24,7 +24,8 @@
 /**
  * Utility class providing common functions
  *
- * @package Core
+ * @package    Framework
+ * @subpackage Utils
  */
 class rcube_utils
 {
diff --git a/program/include/rcube_vcard.php b/program/include/rcube_vcard.php
index 51a7fe71a..d0a341da1 100644
--- a/program/include/rcube_vcard.php
+++ b/program/include/rcube_vcard.php
@@ -5,7 +5,7 @@
  | program/include/rcube_vcard.php                                       |
  |                                                                       |
  | This file is part of the Roundcube Webmail client                     |
- | Copyright (C) 2008-2011, The Roundcube Dev Team                       |
+ | Copyright (C) 2008-2012, The Roundcube Dev Team                       |
  |                                                                       |
  | Licensed under the GNU General Public License version 3 or            |
  | any later version with exceptions for skins & plugins.                |
@@ -15,6 +15,7 @@
  |   Logical representation of a vcard address record                    |
  +-----------------------------------------------------------------------+
  | Author: Thomas Bruederli <roundcube@gmail.com>                        |
+ | Author: Aleksander Machniak <alec@alec.pl>                            |
  +-----------------------------------------------------------------------+
 */
 
@@ -23,8 +24,8 @@
  * Logical representation of a vcard-based address record
  * Provides functions to parse and export vCard data format
  *
- * @package    Addressbook
- * @author     Thomas Bruederli <roundcube@gmail.com>
+ * @package    Framework
+ * @subpackage Addressbook
  */
 class rcube_vcard
 {