From 588727c7e2b8954ec3dbde293cf4c4d68b119f9b Mon Sep 17 00:00:00 2001 From: xue <> Date: Mon, 19 Jun 2006 18:38:29 +0000 Subject: Merge from 3.0 branch till 1185. --- buildscripts/PhpDocumentor/scripts/makedoc.sh | 94 +++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 buildscripts/PhpDocumentor/scripts/makedoc.sh (limited to 'buildscripts/PhpDocumentor/scripts/makedoc.sh') diff --git a/buildscripts/PhpDocumentor/scripts/makedoc.sh b/buildscripts/PhpDocumentor/scripts/makedoc.sh new file mode 100644 index 00000000..83c3bcc0 --- /dev/null +++ b/buildscripts/PhpDocumentor/scripts/makedoc.sh @@ -0,0 +1,94 @@ +#!/bin/bash +# $Id: makedoc.sh,v 1.1 2005/10/17 18:37:43 jeichorn Exp $ + +#/** +# * 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 +# * @version Release-1.1.0 +# */ + + +############################## +# should be edited +############################## + +#/** +# * title of generated documentation, default is 'Generated Documentation' +# * +# * @var string TITLE +# */ +TITLE="Your Project Documentation" + +#/** +# * name to use for the default package. If not specified, uses 'default' +# * +# * @var string PACKAGES +# */ +PACKAGES="yourProject" + +#/** +# * 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=~/phpdoc/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 : -- cgit v1.2.3