visual usar tutorial studio org index generar documentacion con como comentar c++ markdown doxygen

c++ - usar - doxygen tutorial



Genere documentación como archivos de reducción de rendimiento utilizando doxygen (3)

Genere XML con DOxygen http://www.stack.nl/~dimitri/doxygen/customize.html#xmlgenerator .

Use PanDoc http://pandoc.org/ para convertir XML a Markdown.

Sé que es posible usar markdown dentro de los comentarios y doxygen puede entenderlo. ¿Pero necesito saber si es posible generar la documentación en formato markdown?

Necesito que esta documentación se genere a partir de archivos C ++.

No conozco nada que lo haga directamente, pero Doxygen tiene la capacidad de generar un documento XML utilizando el generador XML .

Existen varios proyectos que luego pueden consumir dichos datos XML para transformarlos, uno de los más simples que conozco es Breathe que se usa para convertir los documentos XML en algo que Sphinx puede usar para generar documentación utilizando Doxygen como un preprocesador por así decirlo.

El código de Breathe puede ser lo suficientemente simple como para usarlo como un punto de partida para luego generar archivos de Markdown en lugar de los archivos de texto de ReStructured que requiere Sphinx. No he mirado el código de Breathe, pero lo he usado para algunos proyectos importantes.