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