b811746b |
1 | #!/bin/bash |
598294a7 |
2 | # $Id$ |
b811746b |
3 | |
598294a7 |
4 | # WARNING. In order to use it with SquirrelMail, you should |
5 | # modify phpDocumentor.ini and add .mod extension |
c630ef28 |
6 | # to [_phpDocumentor_phpfile_exts] settings. |
7 | |
b811746b |
8 | #/** |
9 | # * makedoc - PHPDocumentor script to save your settings |
598294a7 |
10 | # * |
b811746b |
11 | # * Put this file inside your PHP project homedir, edit its variables and run whenever you wants to |
12 | # * re/make your project documentation. |
598294a7 |
13 | # * |
b811746b |
14 | # * The version of this file is the version of PHPDocumentor it is compatible. |
598294a7 |
15 | # * |
b811746b |
16 | # * It simples run phpdoc with the parameters you set in this file. |
17 | # * NOTE: Do not add spaces after bash variables. |
18 | # * |
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 |
22 | # */ |
23 | |
24 | |
25 | ############################## |
26 | # should be edited |
27 | ############################## |
28 | |
29 | #/** |
30 | # * title of generated documentation, default is 'Generated Documentation' |
598294a7 |
31 | # * |
b811746b |
32 | # * @var string TITLE |
33 | # */ |
598294a7 |
34 | TITLE="SquirrelMail Devel CVS Documentation" |
b811746b |
35 | |
598294a7 |
36 | #/** |
b811746b |
37 | # * name to use for the default package. If not specified, uses 'default' |
38 | # * |
39 | # * @var string PACKAGES |
40 | # */ |
41 | PACKAGES="squirrelmail" |
42 | |
598294a7 |
43 | #/** |
b811746b |
44 | # * name of a directory(s) to parse directory1,directory2 |
598294a7 |
45 | # * $PWD is the directory where makedoc.sh |
b811746b |
46 | # * |
47 | # * @var string PATH_PROJECT |
48 | # */ |
49 | PATH_PROJECT=$PWD |
50 | |
51 | #/** |
52 | # * path of PHPDoc executable |
53 | # * |
54 | # * @var string PATH_PHPDOC |
55 | # */ |
56 | PATH_PHPDOC=/home/chilts/phpDocumentor-1.2.2/phpdoc |
57 | |
58 | #/** |
59 | # * where documentation will be put |
60 | # * |
61 | # * @var string PATH_DOCS |
62 | # */ |
63 | PATH_DOCS=/var/www/smdocs |
64 | |
65 | #/** |
66 | # * what outputformat to use (html/pdf) |
67 | # * |
68 | # * @var string OUTPUTFORMAT |
69 | # */ |
70 | OUTPUTFORMAT=HTML |
71 | |
598294a7 |
72 | #/** |
b811746b |
73 | # * converter to be used |
74 | # * |
75 | # * @var string CONVERTER |
76 | # */ |
77 | #CONVERTER=Smarty |
78 | CONVERTER=frames |
79 | |
80 | #/** |
81 | # * template to use |
82 | # * |
83 | # * @var string TEMPLATE |
84 | # */ |
85 | #TEMPLATE=default |
86 | TEMPLATE=earthli |
87 | |
88 | #/** |
89 | # * parse elements marked as private |
90 | # * |
91 | # * @var bool (on/off) PRIVATE |
92 | # */ |
93 | PRIVATE=off |
94 | |
95 | #/** |
96 | # * Ignore certain files (comma separated, wildcards enabled) |
97 | # * @var string IGNORE |
98 | # */ |
99 | IGNORE=CVS/,*.txt,contrib/,index.php |
100 | |
101 | # make documentation |
102 | $PATH_PHPDOC -d $PATH_PROJECT -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \ |
103 | -o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE -i $IGNORE |
104 | |
105 | |
106 | # vim: set expandtab : |