logo标签列表

使用Doxygen生成Markdown文件作为文档。

c++markdowndoxygen
24

我知道可以在注释中使用Markdown，并且doxygen可以理解它。但是我需要知道是否可以以Markdown格式生成文档？

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

1
我猜你可以使用原始的XML输出来编写自己的Markdown转换模块。但我相当确定（即使不是100%），直接生成Markdown输出目前还不可能。 - Christian Rau
3个回答
9
谢谢。这看起来是解决我遇到的问题的好方法。 - Sudar
1
moxygen与此非常相似。 - Amir
很遗憾，这两个项目都处于早期阶段。 - Pierrot
没有任何对答案和评论的反对，感谢提供链接！然而，在我看来，你的经验可能有所不同，但是不要浪费时间使用moxygen或doxygen2md选项，它们都是“好尝试”，但是失败了（比喻和大多数情况下字面上）。也许对于一些非常简单的代码，没有命名空间...或私有成员...前者虽然更新且具有更多功能，但甚至不会在许可证和版权声明中明确说明后者的来源。如果您要尝试，请先检查问题列表。 - Maxim Paperno
5

我不知道有什么可以直接做到这一点，但是doxygen有输出使用XML生成器生成XML文档的能力。

有各种各样的项目可以消耗这些XML数据来转换它，其中我知道最简单的一个是Breathe，它用于将XML文档转换为Sphinx可以使用的东西，使用doxygen作为预处理器。

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

Breathe将内容直接插入到Sphinx / docutils树结构中，因为在解析Sphinx文件时进行了操作。在此过程中，不会创建任何中间的ReStructuredText文件。 - Charles Ward
1
8
这个答案是虚假的，“XML”是一个非常通用的格式，而pandoc不支持doxygen的XML输出。 - Tamás Szelei
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接