Add class docuumentation blocks and make phpdoc work again

thomascube

2010-04-23 d062dbe18cbb2609cd2cc67ae843cf33bb4971cf

Add class docuumentation blocks and make phpdoc work again

 bin/makedoc.sh

@@ -1,15 +1,6 @@
#!/usr/bin/env bash
#!/bin/sh

if [ -z "$SSH_TTY" ]
then
  if [ -z "$DEV_TTY" ]
  then
    echo "Not on the shell."
    exit 1
  fi
fi

TITLE="RoundCube Classes"
TITLE="Roundcube Classes"
PACKAGES="Core"

INSTALL_PATH="`dirname $0`/.."

 program/include/rcube_imap.php

@@ -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
{

 program/include/rcube_imap_generic.php

@@ -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 @@
{
}

/**
 * PHP based wrapper class to connect to an IMAP server
 *
 * @package    Mail
 * @author     Aleksander Machniak <alec@alec.pl> 
 */
class rcube_imap_generic
{
    public $error;

 program/include/rcube_mime_struct.php

@@ -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;

 program/include/rcube_plugin.php

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

 program/include/rcube_plugin_api.php

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

 program/include/rcube_session.php

@@ -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;

 program/include/rcube_smtp.php

@@ -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 @@
        $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;
      }
    }