Aleksander Machniak
2012-11-17 9ab34604d94270f6c1795c7dd7b615273d05db0c
Define @package and @subpackage of Framework classes
42 files modified
160 ■■■■■ changed files
program/include/html.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_addressbook.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_base_replacer.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_browser.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_cache.php 4 ●●●● patch | view | raw | blame | history
program/include/rcube_charset.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_config.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_contacts.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_content_filter.php 3 ●●●●● patch | view | raw | blame | history
program/include/rcube_csv2vcard.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_db.php 9 ●●●●● patch | view | raw | blame | history
program/include/rcube_db_mssql.php 5 ●●●●● patch | view | raw | blame | history
program/include/rcube_db_mysql.php 4 ●●●● patch | view | raw | blame | history
program/include/rcube_db_pgsql.php 5 ●●●●● patch | view | raw | blame | history
program/include/rcube_db_sqlite.php 5 ●●●●● patch | view | raw | blame | history
program/include/rcube_db_sqlsrv.php 5 ●●●●● patch | view | raw | blame | history
program/include/rcube_image.php 6 ●●●●● patch | view | raw | blame | history
program/include/rcube_imap.php 4 ●●●● patch | view | raw | blame | history
program/include/rcube_imap_cache.php 4 ●●●● patch | view | raw | blame | history
program/include/rcube_imap_generic.php 4 ●●●● patch | view | raw | blame | history
program/include/rcube_ldap.php 5 ●●●●● patch | view | raw | blame | history
program/include/rcube_message.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_message_header.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_message_part.php 4 ●●●● patch | view | raw | blame | history
program/include/rcube_mime.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_output.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_output_html.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_output_json.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_plugin.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_plugin_api.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_result_index.php 3 ●●●●● patch | view | raw | blame | history
program/include/rcube_result_set.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_result_thread.php 3 ●●●●● patch | view | raw | blame | history
program/include/rcube_session.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_shared.inc 3 ●●●● patch | view | raw | blame | history
program/include/rcube_smtp.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_spellchecker.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_storage.php 4 ●●●● patch | view | raw | blame | history
program/include/rcube_string_replacer.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_user.php 7 ●●●●● patch | view | raw | blame | history
program/include/rcube_utils.php 3 ●●●● patch | view | raw | blame | history
program/include/rcube_vcard.php 7 ●●●●● patch | view | raw | blame | history
program/include/html.php
@@ -23,7 +23,8 @@
/**
 * Class for HTML code creation
 *
 * @package HTML
 * @package    Framework
 * @subpackage HTML
 */
class html
{
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
{
program/include/rcube_base_replacer.php
@@ -23,7 +23,8 @@
 * Helper class to turn relative urls into absolute ones
 * using a predefined base
 *
 * @package Core
 * @package    Framework
 * @subpackage Core
 * @author Thomas Bruederli <roundcube@gmail.com>
 */
class rcube_base_replacer
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
{
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
{
program/include/rcube_charset.php
@@ -25,7 +25,8 @@
/**
 * Character sets conversion functionality
 *
 * @package Core
 * @package    Framework
 * @subpackage Core
 * @author Thomas Bruederli <roundcube@gmail.com>
 * @author Aleksander Machniak <alec@alec.pl>
 * @author Edmund Grimley Evans <edmundo@rano.org>
program/include/rcube_config.php
@@ -22,7 +22,8 @@
/**
 * Configuration class for Roundcube
 *
 * @package Core
 * @package    Framework
 * @subpackage Core
 */
class rcube_config
{
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
{
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
{
program/include/rcube_csv2vcard.php
@@ -21,7 +21,8 @@
/**
 * CSV to vCard data converter
 *
 * @package Roundcube Framework
 * @package    Framework
 * @subpackage Addressbook
 * @author  Aleksander Machniak <alec@alec.pl>
 */
class rcube_csv2vcard
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
{
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
{
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
{
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
{
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
{
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
{
program/include/rcube_image.php
@@ -21,6 +21,12 @@
 +-----------------------------------------------------------------------+
*/
/**
 * Image resizer and converter
 *
 * @package    Framework
 * @subpackage Utils
 */
class rcube_image
{
    private $image_file;
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
{
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
{
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
{
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
{
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
program/include/rcube_message_header.php
@@ -23,7 +23,8 @@
/**
 * Struct representing an e-mail message header
 *
 * @package Mail
 * @package    Framework
 * @subpackage Storage
 * @author  Aleksander Machniak <alec@alec.pl>
 */
class rcube_message_header
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
{
program/include/rcube_mime.php
@@ -25,7 +25,8 @@
/**
 * Class for parsing MIME messages
 *
 * @package Mail
 * @package    Framework
 * @subpackage Storage
 * @author  Thomas Bruederli <roundcube@gmail.com>
 * @author  Aleksander Machniak <alec@alec.pl>
 */
program/include/rcube_output.php
@@ -22,7 +22,8 @@
/**
 * Class for output generation
 *
 * @package HTML
 * @package    Framework
 * @subpackage View
 */
abstract class rcube_output
{
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
{
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
{
program/include/rcube_plugin.php
@@ -22,7 +22,8 @@
/**
 * Plugin interface class
 *
 * @package PluginAPI
 * @package    Framework
 * @subpackage PluginAPI
 */
abstract class rcube_plugin
{
program/include/rcube_plugin_api.php
@@ -27,7 +27,8 @@
/**
 * The plugin loader and global API
 *
 * @package PluginAPI
 * @package    Framework
 * @subpackage PluginAPI
 */
class rcube_plugin_api
{
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
{
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
{
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
{
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>
 */
program/include/rcube_shared.inc
@@ -23,7 +23,8 @@
/**
 * Roundcube shared functions
 *
 * @package Core
 * @package    Framework
 * @subpackage Core
 */
program/include/rcube_smtp.php
@@ -25,7 +25,8 @@
/**
 * 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>
 */
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
{
program/include/rcube_storage.php
@@ -25,10 +25,10 @@
/**
 * Abstract class for accessing mail messages storage server
 *
 * @package Mail
 * @package    Framework
 * @subpackage Storage
 * @author  Thomas Bruederli <roundcube@gmail.com>
 * @author  Aleksander Machniak <alec@alec.pl>
 * @version 2.0
 */
abstract class rcube_storage
{
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
{
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
{
program/include/rcube_utils.php
@@ -24,7 +24,8 @@
/**
 * Utility class providing common functions
 *
 * @package Core
 * @package    Framework
 * @subpackage Utils
 */
class rcube_utils
{
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
{