Descargar la última distribución de phpDocumentor del sitio oficial.
Descomprimir el paquete recién descargado en la ubicación de destino.
$ unzip PhpDocumentor-1.4.2.zip
Instalar el intérprete de PHP desde línea de comando si no se tiene aún.
$ sudo apt-get install php5-cli
Crear el script de ejecución.
$ vi run.sh
PHP_CLI=`which php`
TYPE=HTML
DOCUMENTOR_PATH=/$HOME/PhpDocumentor
PHP_INI=/etc/php5/cli/php.ini
SOURCE_PATH=$1
DESTINATION_PATH=$2
TITLE=$3
PARSEPRIVATE=$4
export PHP_CLI PHP_INI TYPE DOCUMENTOR_PATH
export SOURCE_PATH DESTINATION_PATH TITLE
$PHP_CLI "-c $PHP_INI" "$DOCUMENTOR_PATH/phpdoc" -t $DESTINATION_PATH -o $TYPE:frames:default -d $SOURCE_PATH --title $TITLE --parseprivate $PARSEPRIVATE --quiet
Tenga en cuenta personalizar el contenido de las variables DOCUMENTOR_PATH (ubicación donde se instaló el phpDoc) y TYPE (tipo de formato generado) el cual puede ser HTML, PDF, XML o CHM.
Actualizar los permisos de ejecución del script.
$ chmod +x run.sh
$ chmod +x phpdoc
Ejecutar el script de generación de documentos.
$ $HOME/PhpDocumentor/run.sh UBICACION_ORIGEN UBICACION_DESTINO TITULO INCLUYE_PRIVADO
Tenga en cuenta el significado de las siguientes variables en la ejecución del comando anterior.
- UBICACION_ORIGEN: directorio base que contiene los archivos fuente de los cuales se generará la documentación.
- UBICACION_DESTINO: directorio donde se almacenará la documentación generada.
- TITULO: título de la documentación a generarse.
- INCLUYE_PRIVADO: indicación para incluír (on) o no incluír (off) la información privada (@internal) en la documentación generada.
Ejemplo:
$ $HOME/PhpDocumentor/run.sh /web/proyecto/ $HOME/doc “Documentación del proyecto” on
El comando anterior genera la documentación del código fuente ubicado bajo /web/proyecto/ y lo almacena en $HOME/doc, incluyendo la información de las etiquetas privadas (on) y con el texto “Documentación del proyecto” como título.
Enlaces: