Me gustaría agregar archivos personalizados (que no sean de proyecto) para generar algunas páginas adicionales con Doxygen.Cómo incluir archivos personalizados en Doxygen
Estoy (en realidad) inseguro de cómo deben nombrarse estos archivos y cómo se debe formatear su contenido.
He estado buscando mucho antes de encontrar la respuesta, ¡así que pensé que sería bueno compartir!
De acuerdo con este artículo Doxygen gotchas Finalmente encontré que: es necesario agregar un archivo con el dox extensión. Su contenido debe contener bloques de comentarios de estilo C:
/*!
\page My test page
contents
...
more contents
*/
Asegúrese de que sus archivos personalizados se colocan en un directorio que se incluye en INPUT configuración o en el directorio actual si la entrada se deja vacío, por lo que estos archivos se pueden encontrar .
Simplemente haga una lista de sus archivos personalizados en la macro ENTRADA en su archivo doxy. Puedes elegir el nombre que consideres apropiado. El formato es texto con etiquetas Doxygen.
Lo intenté, pero el archivo se incluyó como un archivo fuente (agregado a la lista de archivos). Usar la extensión dox parece prevenir esto – Veger
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 del índice del archivo. Dentro del archivo, debe colocar uno o más bloques de comentarios de estilo C/C++.
Para una mayor completitud, 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 markdown. Ya no es necesario utilizar bloques de comentarios de estilo C/C++. En su lugar, simplemente escriba casi texto 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).
No soy positivo (quizás trate esto como una pregunta) pero no veo una manera de agregar comandos como \ dot en un documento de reducción. – pedz
@pedz: Ha pasado un tiempo desde que jugué con Doxygen (trabajos cambiados hace un tiempo), así que no recuerdo todos los detalles. No puede agregar ninguna etiqueta personalizada en el descuento. Tiene que ser compatible con el analizador sintáctico, pero creo que "\ dot" es una etiqueta válida: http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddot. así que posiblemente a) usted no tiene la versión correcta ob) en su archivo de configuración no especificó que la herramienta DOT está disponible. – DXM
Para mayor claridad:
En el fichero de configuración .dox, agregar el archivo a la directiva de entrada con algo así:
INPUT = ../src \
../include \
../docs/my-extra-file.txt
Si el archivo tiene la extensión apropiada, por ejemplo como .h o .c entonces Doxygen encontraría el archivo sin agregarlo a la directiva INPUT. Dentro del archivo usar etiquetas normales Doxygen, 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 utilizar sólo una de las etiquetas de incluir, al igual que el "\ htmlinclude" en el ejemplo anterior, cualquier donde en el código.
Creo que hay un pequeño error en el código de muestra. El token antes del comando especial 'page' debe ser" @ "o" \ ". Intenté usar tu muestra tal como está pero la página no se generó, sin embargo, con esa pequeña solución funcionó. – wil
El descuento ya está disponible. [Aquí está] (http://stackoverflow.com/a/9522667/339872) cómo usarlo. – antitoxic