4 # WARNING. In order to use it with SquirrelMail, you should
5 # modify phpDocumentor.ini and add .mod extension
6 # to [_phpDocumentor_phpfile_exts] settings.
9 # * makedoc - PHPDocumentor script to save your settings
11 # * Put this file inside your PHP project homedir, edit its variables and run whenever you wants to
12 # * re/make your project documentation.
14 # * The version of this file is the version of PHPDocumentor it is compatible.
16 # * It simples run phpdoc with the parameters you set in this file.
17 # * NOTE: Do not add spaces after bash variables.
19 # * @copyright makedoc.sh is part of PHPDocumentor project {@link http://freshmeat.net/projects/phpdocu/} and its LGPL
20 # * @author Roberto Berto <darkelder (inside) users (dot) sourceforge (dot) net>
21 # * @version Release-1.1.0
25 ##############################
27 ##############################
30 # * title of generated documentation, default is 'Generated Documentation'
34 TITLE
="SquirrelMail Devel CVS Documentation"
37 # * name to use for the default package. If not specified, uses 'default'
39 # * @var string PACKAGES
41 PACKAGES
="squirrelmail"
44 # * name of a directory(s) to parse directory1,directory2
45 # * $PWD is the directory where makedoc.sh
47 # * @var string PATH_PROJECT
52 # * path of PHPDoc executable
54 # * @var string PATH_PHPDOC
56 PATH_PHPDOC
=/home
/chilts
/phpDocumentor-1.2
.2/phpdoc
59 # * where documentation will be put
61 # * @var string PATH_DOCS
63 PATH_DOCS
=/var
/www
/smdocs
66 # * what outputformat to use (html/pdf)
68 # * @var string OUTPUTFORMAT
73 # * converter to be used
75 # * @var string CONVERTER
83 # * @var string TEMPLATE
89 # * parse elements marked as private
91 # * @var bool (on/off) PRIVATE
96 # * Ignore certain files (comma separated, wildcards enabled)
97 # * @var string IGNORE
99 IGNORE
=CVS
/,*.txt
,contrib
/,index.php
102 $PATH_PHPDOC -d $PATH_PROJECT -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \
103 -o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE -i $IGNORE
106 # vim: set expandtab :