2011-06-14 13 views
12

Quiero incluir la carpeta en la documentación de doxygen.¿Cómo incluir la carpeta en la documentación de doxygen?

He intentado \ page e \ include pero no funcionó, ¿alguien sabe cómo hacerlo? Aquí está el árbol:

+0

Esto es útil: http://comments.gmane.org/gmane.text.doxygen.general/8425? –

+0

Me gustaría saber qué contiene la carpeta. Imágenes? ¿Clases para ser documentadas? Archivos HTML para ser incluidos? – cweiske

+0

@cweiske la carpeta contiene clases para ser documentadas –

Respuesta

19

Para añadir a los comentarios sobre su pregunta, el comando \ página añadirá páginas en la documentación que ha escrito manualmente. Es decir. si un archivo fuente contiene una declaración \ page, agregará los contenidos al índice de documentación. Puede añadir ayuda adicional aquí, tales como:

/*! \page overviewpage Architecture Overview 
* 
* \section memorymanagement Memory Management 
* 
* Some writing you want to appear as a help page in the documentation here. 
*/ 

La instrucción \ include incluirá una copia de un archivo como un bloque de código fuente.

Creo que en realidad está preguntando cómo obtener Doxygen para agregar múltiples directorios de origen. Siempre que la configuración recursiva sea SÍ, que no es la predeterminada, debería funcionar bien para su estructura si ha configurado la carpeta raíz como la entrada de Doxygen.

RECURSIVE    = YES 

Si no es así, se puede añadir diferentes carpetas así, con rutas relativas al archivo Doxyfile.

#--------------------------------------------------------------------------- 
# configuration options related to the input files 
#--------------------------------------------------------------------------- 

# The INPUT tag can be used to specify the files and/or directories that contain 
# documented source files. You may enter file names like "myfile.cpp" or 
# directories like "/usr/src/myproject". Separate the files or directories 
# with spaces. 

INPUT     = src test/src 
Cuestiones relacionadas