banananetwork
/
roundcubemail
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

PHPDoc fixes

Browse Source
pull/6950/head
Aleksander Machniak 5 years ago
parent 3841f63fbd
commit e7ebff56df
28 changed files with 52 additions and 59 deletions
Show Stats Download Patch File Download Diff File

1
program/include/rcmail_install.php
Unescape Escape View File

@ -23,7 +23,6 @@
*
* @category Install
* @package Webmail
* @author Thomas Bruederli
*/
class rcmail_install
{

2
program/lib/Roundcube/cache/apc.php vendored
Unescape Escape View File

@ -24,8 +24,6 @@
*
* @package Framework
* @subpackage Cache
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_cache_apc extends rcube_cache
{

2
program/lib/Roundcube/cache/db.php vendored
Unescape Escape View File

@ -24,8 +24,6 @@
*
* @package Framework
* @subpackage Cache
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_cache_db extends rcube_cache
{

2
program/lib/Roundcube/cache/memcache.php vendored
Unescape Escape View File

@ -24,8 +24,6 @@
*
* @package Framework
* @subpackage Cache
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_cache_memcache extends rcube_cache
{

2
program/lib/Roundcube/cache/memcached.php vendored
Unescape Escape View File

@ -24,8 +24,6 @@
*
* @package Framework
* @subpackage Cache
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_cache_memcached extends rcube_cache
{

2
program/lib/Roundcube/cache/redis.php vendored
Unescape Escape View File

@ -24,8 +24,6 @@
*
* @package Framework
* @subpackage Cache
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_cache_redis extends rcube_cache
{

1
program/lib/Roundcube/rcube_base_replacer.php
Unescape Escape View File

@ -23,7 +23,6 @@
*
* @package Framework
* @subpackage Utils
* @author Thomas Bruederli <roundcube@gmail.com>
*/
class rcube_base_replacer
{

2
program/lib/Roundcube/rcube_cache.php
Unescape Escape View File

@ -24,8 +24,6 @@
*
* @package Framework
* @subpackage Cache
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_cache
{

4
program/lib/Roundcube/rcube_charset.php
Unescape Escape View File

@ -17,6 +17,7 @@
+-----------------------------------------------------------------------+
| Author: Thomas Bruederli <roundcube@gmail.com> |
| Author: Aleksander Machniak <alec@alec.pl> |
| Author: Edmund Grimley Evans <edmundo@rano.org> |
+-----------------------------------------------------------------------+
*/
@ -25,9 +26,6 @@
*
* @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
{

9
program/lib/Roundcube/rcube_csv2vcard.php
Unescape Escape View File

@ -22,7 +22,6 @@
*
* @package Framework
* @subpackage Addressbook
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_csv2vcard
{
@ -483,6 +482,10 @@ class rcube_csv2vcard
/**
* Parse CSV file line
*
* @param string $line Line of text from CSV file
*
* @return array CSV data extracted from the line
*/
protected function parse_line($line)
{
@ -512,6 +515,8 @@ class rcube_csv2vcard
/**
* Parse CSV header line, detect fields mapping
*
* @param array $elements Array of field names from a first line in CSV file
*/
protected function parse_header($elements)
{
@ -574,6 +579,8 @@ class rcube_csv2vcard
/**
* Convert CSV data row to vCard
*
* @param array $data CSV data array
*/
protected function csv_to_vcard($data)
{

8
program/lib/Roundcube/rcube_image.php
Unescape Escape View File

@ -395,7 +395,9 @@ class rcube_image
}
/**
* Checks if image format conversion is supported
* Checks if image format conversion is supported (for specified mimetype).
*
* @param string $mimetype Mimetype name
*
* @return boolean True if specified format can be converted to another format
*/
@ -441,6 +443,10 @@ class rcube_image
/**
* Check if we have enough memory to load specified image
*
* @param array Hash array with image props like channels, width, height
*
* @return bool True if there's enough memory to process the image, False otherwise
*/
private function mem_check($props)
{

2
program/lib/Roundcube/rcube_imap.php
Unescape Escape View File

@ -24,8 +24,6 @@
*
* @package Framework
* @subpackage Storage
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_imap extends rcube_storage
{

2
program/lib/Roundcube/rcube_imap_cache.php
Unescape Escape View File

@ -23,8 +23,6 @@
*
* @package Framework
* @subpackage Storage
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_imap_cache
{

1
program/lib/Roundcube/rcube_imap_search.php
Unescape Escape View File

@ -23,7 +23,6 @@
*
* @package Framework
* @subpackage Storage
* @author Thomas Bruederli <roundcube@gmail.com>
*/
class rcube_imap_search
{

34
program/lib/Roundcube/rcube_message.php
Unescape Escape View File

@ -24,7 +24,6 @@
*
* @package Framework
* @subpackage Storage
* @author Thomas Bruederli <roundcube@gmail.com>
*/
class rcube_message
{
@ -137,7 +136,8 @@ class rcube_message
* Return a (decoded) message header
*
* @param string $name Header name
* @param bool $row Don't mime-decode the value
* @param bool $raw Don't mime-decode the value
*
* @return string Header value
*/
public function get_header($name, $raw = false)
@ -164,6 +164,7 @@ class rcube_message
*
* @param string $mime_id Part MIME-ID
* @param mixed $embed Mimetype class for parts to be embedded
*
* @return string URL or false if part does not exist
*/
public function get_part_url($mime_id, $embed = false)
@ -935,16 +936,22 @@ class rcube_message
*/
private function get_mime_numbers(&$part)
{
if (strlen($part->mime_id))
if (strlen($part->mime_id)) {
$this->mime_parts[$part->mime_id] = &$part;
}
if (is_array($part->parts))
for ($i=0; $i<count($part->parts); $i++)
if (is_array($part->parts)) {
for ($i=0; $i<count($part->parts); $i++) {
$this->get_mime_numbers($part->parts[$i]);
}
}
}
/**
* Add a part to object parts array(s) (with context check)
*
* @param rcube_message_part $part Message part
* @param string $type Part type (inline/attachment)
*/
private function add_part($part, $type = null)
{
@ -961,6 +968,10 @@ class rcube_message
/**
* Check if specified part belongs to the current context
*
* @param rcube_message_part $part Message part
*
* @return bool True if the part belongs to the current context, False otherwise
*/
private function check_context($part)
{
@ -971,7 +982,8 @@ class rcube_message
* Decode a Microsoft Outlook TNEF part (winmail.dat)
*
* @param rcube_message_part $part Message part to decode
* @return array
*
* @return rcube_message_part[] List of message parts extracted from TNEF
*/
function tnef_decode(&$part)
{
@ -1006,7 +1018,8 @@ class rcube_message
* Parse message body for UUencoded attachments bodies
*
* @param rcube_message_part $part Message part to decode
* @return array
*
* @return rcube_message_part[] List of message parts extracted from the file
*/
function uu_decode(&$part)
{
@ -1059,7 +1072,12 @@ class rcube_message
}
/**
* Fix attachment name encoding if needed/possible
* Fix attachment name encoding if needed and possible
*
* @param string $name Attachment name
* @param rcube_message_part $part Message part
*
* @return string Fixed attachment name
*/
protected function fix_attachment_name($name, $part)
{

1
program/lib/Roundcube/rcube_message_header.php
Unescape Escape View File

@ -23,7 +23,6 @@
*
* @package Framework
* @subpackage Storage
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_message_header
{

2
program/lib/Roundcube/rcube_message_part.php
Unescape Escape View File

@ -24,8 +24,6 @@
*
* @package Framework
* @subpackage Storage
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_message_part
{

2
program/lib/Roundcube/rcube_mime.php
Unescape Escape View File

@ -24,8 +24,6 @@
*
* @package Framework
* @subpackage Storage
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_mime
{

1
program/lib/Roundcube/rcube_mime_decode.php
Unescape Escape View File

@ -25,7 +25,6 @@
*
* @package Framework
* @subpackage Storage
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_mime_decode
{

9
program/lib/Roundcube/rcube_plugin.php
Unescape Escape View File

@ -69,9 +69,16 @@ abstract class rcube_plugin
*/
public $allowed_prefs;
/** @var string Plugin directory location */
protected $home;
/** @var string Base URL to the plugin directory */
protected $urlbase;
/** @var string Plugin task name (if registered) */
private $mytask;
/** @var array List of plugin configuration files already loaded */
private $loaded_config = array();
@ -96,7 +103,7 @@ abstract class rcube_plugin
/**
* Provide information about this
*
* @return array Meta information about a plugin or false if not implemented:
* @return array Meta information about a plugin or false if not implemented.
* As hash array with the following keys:
* name: The plugin name
* vendor: Name of the plugin developer

2
program/lib/Roundcube/rcube_session.php
Unescape Escape View File

@ -25,8 +25,6 @@
*
* @package Framework
* @subpackage Core
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
abstract class rcube_session
{

3
program/lib/Roundcube/rcube_smtp.php
Unescape Escape View File

@ -14,6 +14,7 @@
| Provide SMTP functionality using socket connections |
+-----------------------------------------------------------------------+
| Author: Thomas Bruederli <roundcube@gmail.com> |
| Aleksander Machniak <alec@alec.pl> |
+-----------------------------------------------------------------------+
*/
@ -22,8 +23,6 @@
*
* @package Framework
* @subpackage Mail
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_smtp
{

2
program/lib/Roundcube/rcube_storage.php
Unescape Escape View File

@ -24,8 +24,6 @@
*
* @package Framework
* @subpackage Storage
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
abstract class rcube_storage
{

3
program/lib/Roundcube/session/db.php
Unescape Escape View File

@ -25,9 +25,6 @@
*
* @package Framework
* @subpackage Core
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
* @author Cor Bosman <cor@roundcu.be>
*/
class rcube_session_db extends rcube_session
{

3
program/lib/Roundcube/session/memcache.php
Unescape Escape View File

@ -25,9 +25,6 @@
*
* @package Framework
* @subpackage Core
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
* @author Cor Bosman <cor@roundcu.be>
*/
class rcube_session_memcache extends rcube_session
{

3
program/lib/Roundcube/session/memcached.php
Unescape Escape View File

@ -25,9 +25,6 @@
*
* @package Framework
* @subpackage Core
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
* @author Cor Bosman <cor@roundcu.be>
*/
class rcube_session_memcached extends rcube_session
{

3
program/lib/Roundcube/session/php.php
Unescape Escape View File

@ -25,9 +25,6 @@
*
* @package Framework
* @subpackage Core
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
* @author Cor Bosman <cor@roundcu.be>
*/
class rcube_session_php extends rcube_session {

3
program/lib/Roundcube/session/redis.php
Unescape Escape View File

@ -14,6 +14,7 @@
| Provide redis supported session management |
+-----------------------------------------------------------------------+
| Author: Cor Bosman <cor@roundcu.be> |
| Author: Aleksander Machniak <alec@alec.pl> |
+-----------------------------------------------------------------------+
*/
@ -22,8 +23,6 @@
*
* @package Framework
* @subpackage Core
* @author Cor Bosman <cor@roundcu.be>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_session_redis extends rcube_session {

Write Preview
Loading…
Cancel
Save