5 # * makedoc - PHPDocumentor script to save your settings
7 # * Put this file inside your PHP project homedir, edit its variables and run whenever you wants to
8 # * re/make your project documentation.
10 # * The version of this file is the version of PHPDocumentor it is compatible.
12 # * It simples run phpdoc with the parameters you set in this file.
13 # * NOTE: Do not add spaces after bash variables.
15 # * @copyright makedoc.sh is part of PHPDocumentor project {@link http://freshmeat.net/projects/phpdocu/} and its LGPL
16 # * @author Roberto Berto <darkelder (inside) users (dot) sourceforge (dot) net>
17 # * @version Release-1.1.0
21 ##############################
23 ##############################
26 # * title of generated documentation, default is 'Generated Documentation'
30 TITLE
="Squirrelmail Devel CVS Documentation"
33 # * name to use for the default package. If not specified, uses 'default'
35 # * @var string PACKAGES
37 PACKAGES
="squirrelmail"
40 # * name of a directory(s) to parse directory1,directory2
41 # * $PWD is the directory where makedoc.sh
43 # * @var string PATH_PROJECT
48 # * path of PHPDoc executable
50 # * @var string PATH_PHPDOC
52 PATH_PHPDOC
=/home
/chilts
/phpDocumentor-1.2
.2/phpdoc
55 # * where documentation will be put
57 # * @var string PATH_DOCS
59 PATH_DOCS
=/var
/www
/smdocs
62 # * what outputformat to use (html/pdf)
64 # * @var string OUTPUTFORMAT
69 # * converter to be used
71 # * @var string CONVERTER
79 # * @var string TEMPLATE
85 # * parse elements marked as private
87 # * @var bool (on/off) PRIVATE
92 # * Ignore certain files (comma separated, wildcards enabled)
93 # * @var string IGNORE
95 IGNORE
=CVS
/,*.txt
,contrib
/,index.php
98 $PATH_PHPDOC -d $PATH_PROJECT -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \
99 -o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE -i $IGNORE
102 # vim: set expandtab :