【问题标题】:How to embed/convert XML document for Doxygen documentation?如何为 Doxygen 文档嵌入/转换 XML 文档?
【发布时间】:2012-04-22 19:45:23
【问题描述】:

我有一个问题!

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

提前致谢!

【问题讨论】:

    标签: xml doxygen


    【解决方案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

    【讨论】:

    • 感谢您的回答!后来我意识到,如果我采用这种方法,并从 Doxygen 生成 LaTeX 或 PDF,事情将无法正确显示,因此我必须制作一个解析器,将 xml 标签转换为 doxygen 特殊命令。但是如果我只生成 HTML,那么这种方法仍然有效,但缺少一些颜色编码,例如在 &lt;code&gt; 标签中。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2012-03-26
    • 1970-01-01
    • 1970-01-01
    • 2017-02-17
    • 2015-06-03
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多