Add class docuumentation blocks and make phpdoc work again

This commit is contained in:
thomascube
2010-04-23 14:25:28 +00:00
parent d824acaf11
commit d062dbe18c
8 changed files with 43 additions and 19 deletions

View File

@@ -26,7 +26,8 @@
*
* @package Mail
* @author Thomas Bruederli <roundcube@gmail.com>
* @version 1.6
* @author Aleksander Machniak <alec@alec.pl>
* @version 2.0
*/
class rcube_imap
{

View File

@@ -26,6 +26,12 @@
*/
/**
* Struct representing an e-mail message header
*
* @package Mail
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_mail_header
{
public $id;
@@ -70,6 +76,12 @@ class iilBasicHeader extends rcube_mail_header
{
}
/**
* PHP based wrapper class to connect to an IMAP server
*
* @package Mail
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_imap_generic
{
public $error;

View File

@@ -23,7 +23,12 @@
*/
/**
* Helper class to process IMAP's BODYSTRUCTURE string
*
* @package Mail
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_mime_struct
{
private $structure;

View File

@@ -22,7 +22,7 @@
/**
* Plugin interface class
*
* @package Core
* @package PluginAPI
*/
abstract class rcube_plugin
{

View File

@@ -22,7 +22,7 @@
/**
* The plugin loader and global API
*
* @package Core
* @package PluginAPI
*/
class rcube_plugin_api
{

View File

@@ -5,7 +5,7 @@
| program/include/rcube_session.php |
| |
| This file is part of the RoundCube Webmail client |
| Copyright (C) 2005-2009, RoundCube Dev. - Switzerland |
| Copyright (C) 2005-2010, RoundCube Dev. - Switzerland |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -20,6 +20,13 @@
*/
/**
* Class to provide database supported session storage
*
* @package Core
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_session
{
private $db;

View File

@@ -5,7 +5,7 @@
| program/include/rcube_smtp.php |
| |
| This file is part of the RoundCube Webmail client |
| Copyright (C) 2005-2007, RoundCube Dev. - Switzerland |
| Copyright (C) 2005-2010, RoundCube Dev. - Switzerland |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -22,7 +22,15 @@
// define headers delimiter
define('SMTP_MIME_CRLF', "\r\n");
class rcube_smtp {
/**
* Class to provide SMTP functionality using PEAR Net_SMTP
*
* @package Mail
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
*/
class rcube_smtp
{
private $conn = null;
private $response;
@@ -124,7 +132,7 @@ class rcube_smtp {
$this->error = array('label' => 'smtpautherror', 'vars' => array('code' => $this->conn->_code));
$this->response[] .= 'Authentication failure: ' . $result->getMessage() . ' (Code: ' . $result->getCode() . ')';
$this->reset();
$this->disconnect();
$this->disconnect();
return false;
}
}