¿Ejecutar Doxygen solo en archivos/módulos seleccionados?

Question

Recientemente comencé a escribir doxgen docs en un proyecto existente que ya tiene bastantes comentarios doxygen.

Como estoy aprendiendo un poco, me gusta iterar con la edición y la generación de documentos, ya que la generación de documentos es bastante lenta: 3-5 minutos. Esto se vuelve inviable.

Logré eliminar la mayoría de los archivos en el árbol de fuentes, así que doxy solo encontró los que estaba editando, pero esta es realmente una solución horrible y no es algo que quisiera hacer con frecuencia.

¿Hay alguna manera (por ejemplo, línea de comando arg o variable env) de limitar qué archivos/módulos se utilizan para generar documentos, por lo que la reconstrucción de documentos se puede hacer mucho más rápido?

Answer 1

Sí, puede personalizar el comportamiento de Doxygen desde la línea de comando o mediante variables de entorno. Por ejemplo, si sólo desea incluir un archivo (include/somefile.h), se podría ejecutar Doxygen como:

(cat Doxyfile ; echo "INPUT=include/somefile.h") | doxygen - 

ver la Doxygen FAQ 's '¿Puedo configurar doxygen desde la línea de comandos?' para más detalles sobre cómo personalizar el comportamiento desde la línea de comando.

Alternativamente, si desea utilizar variables de entorno, se puede usar especificar algo como lo siguiente en el fichero de configuración:

INPUT = $(FILE) 

Doxygen lleva a cabo la sustitución de variable de entorno en sus archivos de configuración, que le permite especificar qué archivo (s) que deberían adoptarse medidas usando:

export FILE=include/somefile.h 
doxygen Doxyfile 

Ver Doxygen Configuration para obtener más información sobre el uso de variables de entorno en archivos de configuración.