Skip to content

Commit e3ff0df

Browse files
committed
Simplify the docs-generate script.
Depends on moving the skeleton's config/phpdoc.xml file to /phpdoc.dist.xml. There also seems to be some serious issues with the composer package of phpdoc. It fails to produce any documentation, only "blank" html shell files. I've posted here: * phpDocumentor/phpDocumentor#1427 (comment) * phpDocumentor/phpDocumentor#1523 (comment)
1 parent 1082b88 commit e3ff0df

1 file changed

Lines changed: 5 additions & 17 deletions

File tree

docs-generate

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ usage ()
77
cat <<EOT
88
99
${0##*/}
10-
Convenience wrapper around phpDocumentor. Uses the config/phpdoc.xml
11-
file to control execution. Any additional arguments will be passed to
12-
phpdoc itself. By default, HTML docs will be generated in tmp/docs/.
13-
Depends on phpdoc.php being installed into bin/ via composer.
10+
Convenience wrapper around phpDocumentor. Any additional
11+
arguments will be passed to phpdoc itself. By default, HTML docs
12+
will be generated in tmp/docs/. Depends on phpdoc being
13+
installed into bin/ via composer.
1414
1515
Usage:
1616
bin/${0##*/} [additional phpdoc args]
@@ -24,17 +24,5 @@ if [ "$1" = '-h' ]; then
2424
fi
2525

2626
DIR="$( cd -P "$( dirname "$0" )"/.. >/dev/null 2>&1 && pwd )"
27-
BIN_DIR="${DIR}/bin"
28-
CFG_FILE="$DIR/config/phpdoc.xml"
2927

30-
# Bail out if phpcs isn't available to us
31-
PHPDOC="./bin/phpdoc"
32-
test -x $PHPDOC
33-
if [ $? -gt 0 ]; then
34-
echo "!! The 'phpdoc' command was not found on this system."
35-
echo ""
36-
exit 1
37-
fi
38-
echo "## Found phpdoc at: ${PHPDOC}"
39-
40-
bin/vagrant-exec ""${PHPDOC}" --config="${CFG_FILE}" "$@""
28+
bin/vagrant-exec "bin/phpdoc "$@""

0 commit comments

Comments
 (0)