SowerPHP

Framework PHP hecho en Chile

Herramientas de usuario

Herramientas del sitio


core:doxygen

Generar documentación mediante Doxygen

El directorio principal del framework, y el directorio website, contienen un archivo Doxyfile para ser utilizado con Doxygen para la generación de la documentación del proyecto.

Las opciones que se han modificado en el archivo Doxyfile para el el directorio website son:

OUTPUT_DIRECTORY       = webroot/doc
OUTPUT_LANGUAGE        = Spanish
TAB_SIZE               = 4
RECURSIVE              = YES
EXCLUDE                = Vendor
SOURCE_BROWSER         = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
GENERATE_LATEX         = NO
HAVE_DOT               = YES
CALL_GRAPH             = YES

Se recomienda asignar los valores a:

PROJECT_NAME           = ""
PROJECT_NUMBER         = ""
PROJECT_BRIEF          = ""

Para generar la documentación, dentro del directorio *website*, ejecutar:

$ doxygen Doxyfile

Luego la documentación puede ser accedida mediante un navegador web en la dirección http://example.com/website/doc

core/doxygen.txt · Última modificación: 2016/04/14 02:48 por delaf