From 9ba4967a73a3d3db80af333a7d3d93e5a2c8bf79 Mon Sep 17 00:00:00 2001 From: Thomas Bruederli Date: Thu, 30 Jan 2014 09:56:56 +0100 Subject: [PATCH] Create class documentation with latest phpdoc utility --- bin/makedoc.sh | 10 ++++------ program/include/bc.php | 2 +- program/include/rcmail.php | 2 +- program/include/rcmail_html_page.php | 2 +- program/include/rcmail_output.php | 2 +- program/include/rcmail_output_html.php | 2 +- program/include/rcmail_output_json.php | 2 +- program/include/rcmail_string_replacer.php | 2 +- 8 files changed, 11 insertions(+), 13 deletions(-) diff --git a/bin/makedoc.sh b/bin/makedoc.sh index 2a34254cb..3602c3a65 100755 --- a/bin/makedoc.sh +++ b/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 @@ then 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 diff --git a/program/include/bc.php b/program/include/bc.php index a7d7b5ac1..2cb151798 100644 --- a/program/include/bc.php +++ b/program/include/bc.php @@ -22,7 +22,7 @@ /** * Roundcube Webmail deprecated functions * - * @package Core + * @package Webmail * @subpackage Legacy * @author Thomas Bruederli */ diff --git a/program/include/rcmail.php b/program/include/rcmail.php index 9c7ed98aa..f4013d3d8 100644 --- a/program/include/rcmail.php +++ b/program/include/rcmail.php @@ -25,7 +25,7 @@ * Application class of Roundcube Webmail * implemented as singleton * - * @package Core + * @package Webmail */ class rcmail extends rcube { diff --git a/program/include/rcmail_html_page.php b/program/include/rcmail_html_page.php index d5610ab47..604d756e7 100644 --- a/program/include/rcmail_html_page.php +++ b/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 diff --git a/program/include/rcmail_output.php b/program/include/rcmail_output.php index 36512ad48..0f7aaf966 100644 --- a/program/include/rcmail_output.php +++ b/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 diff --git a/program/include/rcmail_output_html.php b/program/include/rcmail_output_html.php index 4df755985..17b5b9647 100644 --- a/program/include/rcmail_output_html.php +++ b/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 diff --git a/program/include/rcmail_output_json.php b/program/include/rcmail_output_json.php index d0e1eec64..fa35824db 100644 --- a/program/include/rcmail_output_json.php +++ b/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 diff --git a/program/include/rcmail_string_replacer.php b/program/include/rcmail_string_replacer.php index 6771375e1..d3fdc3e7f 100644 --- a/program/include/rcmail_string_replacer.php +++ b/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