1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
#!/bin/bash
# $Id: makedoc.sh 3807 2005-01-16 14:12:59Z cbayle $
#/**
# * makedoc - PHPDocumentor script to save your settings
# *
# * Put this file inside your PHP project homedir, edit its variables and run whenever you wants to
# * re/make your project documentation.
# *
# * The version of this file is the version of PHPDocumentor it is compatible.
# *
# * It simples run phpdoc with the parameters you set in this file.
# * NOTE: Do not add spaces after bash variables.
# *
# * @copyright makedoc.sh is part of PHPDocumentor project {@link http://freshmeat.net/projects/phpdocu/} and its LGPL
# * @author Roberto Berto <darkelder (inside) users (dot) sourceforge (dot) net>
# * @version Release-1.1.0
# */
##############################
# should be edited
##############################
#/**
# * title of generated documentation, default is 'Generated Documentation'
# *
# * @var string TITLE
# */
TITLE="GForge PHP Documentation"
#/**
# * name to use for the default package. If not specified, uses 'default'
# *
# * @var string PACKAGES
# */
PACKAGES="GForge"
#/**
# * name of a directory(s) to parse directory1,directory2
# * $PWD is the directory where makedoc.sh
# *
# * @var string PATH_PROJECT
# */
PATH_PROJECT=$PWD/../..
#/**
# * path of PHPDoc executable
# *
# * @var string PATH_PHPDOC
# */
PATH_PHPDOC=/tmp/phpdocumentor-1.3.0rc3/phpdoc
#/**
# * where documentation will be put
# *
# * @var string PATH_DOCS
# */
PATH_DOCS=$PWD/docs
#/**
# * what outputformat to use (html/pdf)
# *
# * @var string OUTPUTFORMAT
# */
OUTPUTFORMAT=HTML
#/**
# * converter to be used
# *
# * @var string CONVERTER
# */
CONVERTER=Smarty
#/**
# * template to use
# *
# * @var string TEMPLATE
# */
TEMPLATE=default
#/**
# * parse elements marked as private
# *
# * @var bool (on/off) PRIVATE
# */
PRIVATE=off
# make documentation
$PATH_PHPDOC -d $PATH_PROJECT -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \
-o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE
# vim: set expandtab :
|
