diff options
| author | Thomas Bruederli <thomas@roundcube.net> | 2012-12-16 17:03:01 +0100 |
|---|---|---|
| committer | Thomas Bruederli <thomas@roundcube.net> | 2012-12-16 17:03:01 +0100 |
| commit | a072247dde60497f879b2a00790a6ec0a64fab4c (patch) | |
| tree | a70ae364717100d7487cb37dfdcd00805739573c | |
| parent | ff4a92c8e2f11711975f9697a057cd96ce370bc5 (diff) | |
Fix package definitions and include framework classes in phpdoc
| -rwxr-xr-x | bin/makedoc.sh | 5 | ||||
| -rw-r--r-- | program/include/bc.php | 1 | ||||
| -rw-r--r-- | program/lib/Roundcube/rcube.php | 3 | ||||
| -rw-r--r-- | program/lib/Roundcube/rcube_db.php | 2 | ||||
| -rw-r--r-- | program/lib/Roundcube/rcube_message_header.php | 3 |
5 files changed, 9 insertions, 5 deletions
diff --git a/bin/makedoc.sh b/bin/makedoc.sh index 40c75bf47..2a34254cb 100755 --- a/bin/makedoc.sh +++ b/bin/makedoc.sh @@ -1,10 +1,11 @@ #!/bin/sh -TITLE="Roundcube Classes" +TITLE="Roundcube Webmail" PACKAGES="Core" INSTALL_PATH="`dirname $0`/.." PATH_PROJECT=$INSTALL_PATH/program/include +PATH_FRAMEWORK=$INSTALL_PATH/program/lib/Roundcube PATH_DOCS=$INSTALL_PATH/doc/phpdoc BIN_PHPDOC="`/usr/bin/which phpdoc`" @@ -20,6 +21,6 @@ TEMPLATE=earthli PRIVATE=off # make documentation -$BIN_PHPDOC -d $PATH_PROJECT -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \ +$BIN_PHPDOC -d $PATH_PROJECT,$PATH_FRAMEWORK -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \ -o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE diff --git a/program/include/bc.php b/program/include/bc.php index 12110c0ad..dc4d54fd7 100644 --- a/program/include/bc.php +++ b/program/include/bc.php @@ -23,6 +23,7 @@ * Roundcube Webmail deprecated functions * * @package Core + * @subpackage Legacy * @author Thomas Bruederli <roundcube@gmail.com> */ diff --git a/program/lib/Roundcube/rcube.php b/program/lib/Roundcube/rcube.php index cc4905a14..a127eeb4f 100644 --- a/program/lib/Roundcube/rcube.php +++ b/program/lib/Roundcube/rcube.php @@ -1266,7 +1266,8 @@ class rcube /** * Lightweight plugin API class serving as a dummy if plugins are not enabled * - * @package Core + * @package Framework + * @subpackage Core */ class rcube_dummy_plugin_api { diff --git a/program/lib/Roundcube/rcube_db.php b/program/lib/Roundcube/rcube_db.php index 2c471e74d..e6e8c2ede 100644 --- a/program/lib/Roundcube/rcube_db.php +++ b/program/lib/Roundcube/rcube_db.php @@ -25,7 +25,7 @@ * This is a wrapper for the PHP PDO. * * @package Framework - * @sbpackage Database + * @subpackage Database */ class rcube_db { diff --git a/program/lib/Roundcube/rcube_message_header.php b/program/lib/Roundcube/rcube_message_header.php index 7009a00af..16a0aaac9 100644 --- a/program/lib/Roundcube/rcube_message_header.php +++ b/program/lib/Roundcube/rcube_message_header.php @@ -257,7 +257,8 @@ class rcube_message_header /** * Class for sorting an array of rcube_message_header objects in a predetermined order. * - * @package Mail + * @package Framework + * @subpackage Storage * @author Aleksander Machniak <alec@alec.pl> */ class rcube_message_header_sorter |