Create class documentation with latest phpdoc utility

pull/165/head
Thomas Bruederli 11 years ago
parent 1978ae97a5
commit 9ba4967a73

@ -1,7 +1,7 @@
#!/bin/sh #!/bin/sh
TITLE="Roundcube Webmail" TITLE="Roundcube Webmail"
PACKAGES="Core" PACKAGES="Webmail"
INSTALL_PATH="`dirname $0`/.." INSTALL_PATH="`dirname $0`/.."
PATH_PROJECT=$INSTALL_PATH/program/include PATH_PROJECT=$INSTALL_PATH/program/include
@ -16,11 +16,9 @@ then
fi fi
OUTPUTFORMAT=HTML OUTPUTFORMAT=HTML
CONVERTER=frames TEMPLATE=responsive-twig
TEMPLATE=earthli
PRIVATE=off
# make documentation # make documentation
$BIN_PHPDOC -d $PATH_PROJECT,$PATH_FRAMEWORK -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \ $BIN_PHPDOC -d $PATH_PROJECT,$PATH_FRAMEWORK -t $PATH_DOCS --title "$TITLE" --defaultpackagename $PACKAGES \
-o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE --template=$TEMPLATE

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

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

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

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

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

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

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

Loading…
Cancel
Save