使用doxygen将文档生成为markdown文件

时间:2012-10-26 06:38:05

标签: c++ markdown doxygen

我知道可以在评论中使用markdown,doxygen可以理解它。但我需要知道是否有可能以降价格式生成文档?

我需要从C ++文件生成这些文档。

3 个答案:

答案 0 :(得分:6)

我知道这个问题很旧但似乎有一个新工具可用:https://www.npmjs.com/package/doxygen2md

答案 1 :(得分:5)

我不知道会直接做什么,但是doxygen能够输出XML document using the XML generator

有各种项目可以使用所述XML数据来转换它,我所知道的最简单的一个是Breathe,它用于将XML文档转换为{{3}使用doxygen作为预处理器就可以用来输出文档了。

Breathe的代码可能很简单,可以用作生成Markdown文件的起点,而不是Sphinx所需的ReStructuredText文件。我没有看过Breathe的代码,但我已将它用于一些重大项目。

答案 2 :(得分:4)

使用doxygen http://www.doxygen.nl/manual/customize.html#xmlgenerator生成XML。

使用PanDoc http://pandoc.org/ 将XML转换为Markdown。