online - doxygen ubuntu
Cómo hacer una página de introducción con Doxygen (6)
A partir de v1.8.8 también existe la opción USE_MDFILE_AS_MAINPAGE . Así que asegúrese de agregar su archivo de índice, por ejemplo, README.md , a INPUT y configurarlo como el valor de esta opción:
INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md
Hice documentación para mi SDK, usando Doxygen. Contiene la lista de archivos, espacios de nombres, clases, tipos, etc., todo lo que coloqué como comentarios de Doxygen en el código. Ahora quiero escribir algo de información general sobre SDK (tipo de introducción), que no está relacionado directamente con ningún elemento de código. Quiero colocar esta introducción en la página de inicio de la documentación. ¿Cómo puedo hacer esto?
Agregue cualquier archivo en la documentación que incluirá su contenido, por ejemplo toc.h :
@ mainpage Manual SDK
<hr/>
@ section pageTOC Content
-# @ref Description
-# @ref License
-# @ref Item
...
Y en tu Doxyfile :
INPUT = toc.h /
Ejemplo (en ruso):
Intenté todo lo anterior con v 1.8.13 inútilmente. Lo que funcionó para mí (en macOS) fue utilizar la etiqueta doxywizard-> Expert para completar la configuración USE_MD_FILE_AS_MAINPAGE .
Hizo los siguientes cambios en mi archivo Doxy:
USE_MDFILE_AS_MAINPAGE = ../README.md
...
INPUT = ../README.md /
../sdk/include /
../sdk/src
Note la terminación de línea para INPUT , recién había estado usando espacio como separador como se especifica en la documentación. AFAICT este es el único cambio entre la versión que no funciona y funciona de Doxyfile.
La siguiente sintaxis puede ayudar a agregar una página principal y las subpáginas relacionadas para doxygen:
/*! /mainpage Drawing Shapes
*
* This project helps user to draw shapes.
* Currently two types of shapes can be drawn:
* - /subpage drawingRectanglePage "How to draw rectangle?"
*
* - /subpage drawingCirclePage "How to draw circle?"
*
*/
/*! /page drawingRectanglePage How to draw rectangle?
*
* Lorem ipsum dolor sit amet
*
*/
/*! /page drawingCirclePage How to draw circle?
*
* This page is about how to draw a circle.
* Following sections describe circle:
* - /ref groupCircleDefinition "Definition of Circle"
* - /ref groupCircleClass "Circle Class"
*/
Crear grupos como los siguientes también ayuda a diseñar páginas:
/** /defgroup groupCircleDefinition Circle Definition
* A circle is a simple shape in Euclidean geometry.
* It is the set of all points in a plane that are at a given distance from a given point, the centre;
* equivalently it is the curve traced out by a point that moves so that its distance from a given point is constant.
* The distance between any of the points and the centre is called the radius.
*/
Tenga en cuenta que con la versión 1.8.0 de Doxygen también puede agregar páginas formateadas Markdown. Para que esto funcione, debe crear páginas con una extensión .md o .markdown y agregar lo siguiente al archivo de configuración:
INPUT += your_page.md
FILE_PATTERNS += *.md *.markdown
Ver http://www.doxygen.org/markdown.html#md_page_header para más detalles.
Eche un vistazo al comando mainpage .
Además, eche un vistazo a esta respuesta a otro hilo: Cómo incluir archivos personalizados en Doxygen . Establece que hay tres extensiones que doxygen clasifican como archivos de documentación adicionales: .dox , .txt y .doc . Los archivos con estas extensiones no aparecen en el índice del archivo, pero se pueden usar para incluir información adicional en la documentación final, muy útil para la documentación que es necesaria pero que no es realmente apropiada para incluir con su código fuente (por ejemplo, una pregunta frecuente)
Por lo tanto, recomendaría tener un archivo mainpage.dox (o similar) en el directorio de su proyecto para presentarle SDK. Tenga en cuenta que dentro de este archivo debe colocar uno o más bloques de comentarios de estilo C / C ++.