Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Generate documentation as markdown files using doxygen [closed]

Tags:

I know that it is possible to use markdown inside comments and doxygen can understand it. But I need to know if it is possible to generate the documentation in markdown format?

I need these documentation to be generated from C++ files.

like image 460
Sudar Avatar asked Oct 26 '12 06:10

Sudar


People also ask

Can doxygen generate markdown?

Including Markdown files as pagesDoxygen can process files with Markdown formatting.

How exclude code from doxygen?

How can I make doxygen ignore some code fragment? The new and easiest way is to add one comment block with a \cond command at the start and one comment block with a \endcond command at the end of the piece of code that should be ignored. This should be within the same file of course.


2 Answers

I know this question is old but there seems to be a new tool available: https://www.npmjs.com/package/doxygen2md

like image 94
bonanza Avatar answered Oct 13 '22 00:10

bonanza


I don't know of anything that will do it directly, but doxygen has the ability to output an XML document using the XML generator.

There are various projects out there that can then consume said XML data to transform it, one of the simplest ones that I am aware of is Breathe which is used to convert the XML documents to something that Sphinx can use to output documentation using doxygen as a pre-processor so to say.

The code for Breathe may be simple enough to use as a starting point to then generate Markdown files instead of the ReStructuredText files that Sphinx requires. I haven't looked at the code for Breathe, but I have used it for some major projects.

like image 27
X-Istence Avatar answered Oct 12 '22 23:10

X-Istence