La configuracion de doxygen se puede hacer de 2 formas:
A continuación se muestran algunas etiquetas importantes que se deben especificar al momento de configurar:
PROJECT_NAME | El nombre del proyecto |
PROJECT_NUMBER | Algun numero de identificación, revisión o versión |
OUTPUT_DIRECTORY | Directorio donde se generaran las documentaciones |
OUTPUT_LANGUAGE | Idioma (English, Spanish) |
USE_WINDOWS_ENCODING | Colocar YES si se trabaja en Windows, en otro caso poner NO |
OPTIMIZE_OUTPUT_FOR_C | Si el lenguaje de programación es C, deberia configurarse en YES |
INPUT | Directorio don se encuentran los códigos |
FILE_PATTERNS | Tipos de archivos a documentar: *.c *.cpp *.java ... etc. Deben ir separados por espacios |
SOURCE_BROWSER | Si es YES, entonces se generarán páginas donde aparecerán los archivos fuente. |
INLINE_SOURCES | Si es YES, el código de cada función aparecerá a continuación de la documentación de éstas, para mejor compresión del lector. |
EXTRACT_ALL | Si está en YES, doxygen agregará a la documentación todo lo que encuentre (funciones, variables, etc), aunque no se hayan documentado |
RECURSIVE | YES implica que se recorrerán los subdirectorios en búsqueda de más códigos fuente. |
GENERATE_XXX | Si está en YES, habilita la documentacion en el formato XXX. Los formatos son Latex, HTML, XML, Man, RTF. |
El opuesto a YES es NO.
Para más informacion acerca de las etiquetas del archivo de configuración haga click aquí.