online - doxygen ubuntu

Cómo incluir archivos personalizados en Doxygen

Question

Me gustaría agregar archivos personalizados (que no sean de proyecto) para generar algunas páginas adicionales con Doxygen .

Estoy (en realidad) inseguro de cómo se deben nombrar estos archivos y cómo se debe formatear su contenido.

Answer 1

He estado buscando bastante antes de encontrar la respuesta, ¡así que pensé que sería bueno compartir!

De acuerdo con este artículo de Doxygen gotchas finalmente encontré que: necesitas agregar un archivo con la extensión dox . Su contenido debe contener bloques de comentarios estilo C:

/*!
  /page My test page
  contents
  ...
  more contents
*/

Asegúrese de que sus archivos personalizados se coloquen en un directorio que se incluye en la configuración de INPUT o en el directorio actual si INPUT se deja vacío, por lo que se pueden encontrar estos archivos.

Answer 2

Para mayor claridad:

En el archivo de configuración .dox, agregue el archivo a la directiva INPUT con algo como esto:

INPUT = ../src /
        ../include /
        ../docs/my-extra-file.txt

Si el archivo tenía la extensión adecuada, digamos como .h o .c, Doxygen encontraría el archivo sin agregarlo a la directiva INPUT. Dentro del archivo, use etiquetas Doxygen normales, como en la fuente, es decir, dentro de bloques de comentarios, como:

/*! /mainpage MyProject - A Brief Description.
/image html Mylogo.png
/section my-intro MyProject Introduction
/htmlinclude about-MyProject.html
*/

También se puede usar una de las etiquetas de inclusión, como "/ htmlinclude" en el ejemplo anterior, en cualquier parte del código.

Answer 3

Para una mayor integridad, comenzando con la versión 1.8 de Doxygen (creo), ahora es compatible con archivos de texto adicionales que son muy similares a la sintaxis de markdown . Ya no es necesario utilizar bloques de comentarios de estilo C / C ++. En su lugar, simplemente escriba texto casi normal y asegúrese de que el archivo de texto esté en la ruta INPUT, y que su exploración doxygen realmente busque archivos con la extensión .markdown (o cualquier otra extensión que elija usar, como .md).

Answer 4

Simplemente liste sus archivos personalizados en la macro INPUT en su archivo doxy. Puedes elegir el nombre que consideres apropiado. El formato es texto con etiquetas Doxygen.

Answer 5

Solo para completar: hay 3 extensiones posibles que doxygen trata como archivos de documentación adicionales: .dox, .txt y .doc.

Archivos que dicha extensión están ocultos desde el índice del archivo. Dentro del archivo, debe colocar uno o más bloques de comentarios de estilo C / C ++.