如何为Doxygen文档嵌入/转换XML文档?

时间:2012-04-10 13:50:46

标签: xml doxygen

我有一个问题!

我已经有了一些代码,由Doxygen自动记录。另外,我想在此文档中添加一个相当长的mainpage。我想要包含的页面是XML格式,例如this page。我知道Doxygen只支持少数流行的标签而不支持其余的标签。那么如何将xml页面嵌入到我的文档主页中,或者将其转换为使用doxygen特殊命令的dox文件?

提前致谢!

1 个答案:

答案 0 :(得分:1)

尝试使用\htmlinclude命令。要将您链接到的页面合并到您的问题中,我将页面源保存为dox.xml,将其放在与最小测试源文件相同的目录中,并在源文件中包含以下内容:

/**
  \mainpage
  \htmlinclude dox.xml
*/

我还必须将当前目录添加到配置文件的EXAMPLE_PATH字段,因为这是\htmlinclude(和\verbinclude,另一个有用的命令)搜索要包含的文件的位置。

本网站上有许多有用的相关问题和答案,包括:

Add XML file to the file list

Is there a way to embed <script> content into a Doxygen \mainpage section?

How to include custom files in Doxygen