Create class documentation with latest phpdoc utility

Thomas Bruederli

2014-01-30 9ba4967a73a3d3db80af333a7d3d93e5a2c8bf79

Create class documentation with latest phpdoc utility

 bin/makedoc.sh

@@ -1,7 +1,7 @@
#!/bin/sh

TITLE="Roundcube Webmail"
PACKAGES="Core"
PACKAGES="Webmail"

INSTALL_PATH="`dirname $0`/.."
PATH_PROJECT=$INSTALL_PATH/program/include
@@ -16,11 +16,9 @@
fi

OUTPUTFORMAT=HTML
CONVERTER=frames
TEMPLATE=earthli
PRIVATE=off
TEMPLATE=responsive-twig

# make documentation
$BIN_PHPDOC -d $PATH_PROJECT,$PATH_FRAMEWORK -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \
-o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE
$BIN_PHPDOC -d $PATH_PROJECT,$PATH_FRAMEWORK -t $PATH_DOCS --title "$TITLE" --defaultpackagename $PACKAGES \
    --template=$TEMPLATE


 program/include/bc.php

@@ -22,7 +22,7 @@
/**
 * Roundcube Webmail deprecated functions
 *
 * @package Core
 * @package Webmail
 * @subpackage Legacy
 * @author Thomas Bruederli <roundcube@gmail.com>
 */

 program/include/rcmail.php

@@ -25,7 +25,7 @@
 * Application class of Roundcube Webmail
 * implemented as singleton
 *
 * @package Core
 * @package Webmail
 */
class rcmail extends rcube
{

 program/include/rcmail_html_page.php

@@ -23,7 +23,7 @@
/**
 * Class to create an empty HTML page with some default styles
 *
 * @package    Core
 * @package Webmail
 * @subpackage View
 */
class rcmail_html_page extends rcmail_output_html

 program/include/rcmail_output.php

@@ -22,7 +22,7 @@
/**
 * Class for output generation
 *
 * @package    Core
 * @package Webmail
 * @subpackage View
 */
abstract class rcmail_output extends rcube_output

 program/include/rcmail_output_html.php

@@ -23,7 +23,7 @@
/**
 * Class to create HTML page output using a skin template
 *
 * @package    Core
 * @package Webmail
 * @subpackage View
 */
class rcmail_output_html extends rcmail_output

 program/include/rcmail_output_json.php

@@ -23,7 +23,7 @@
/**
 * View class to produce JSON responses
 *
 * @package    Core
 * @package Webmail
 * @subpackage View
 */
class rcmail_output_json extends rcmail_output

 program/include/rcmail_string_replacer.php

@@ -23,7 +23,7 @@
 * Helper class for turning URLs and email addresses in plaintext content
 * into clickable links.
 *
 * @package    Core
 * @package Webmail
 * @subpackage Utils
 */
class rcmail_string_replacer extends rcube_string_replacer