doxygen - 在 doxygen 布局中添加新的用户选项卡

Question

我刚开始使用 doxygen 1.8.7。我正在尝试将体系结构图添加为使用 doxygen 为我的 C# 项目生成的 API 文档的一部分。我生成了默认的 doxygen 布局文件 (DoxygenLayout.xml) 并通过添加以下更改对其进行了编辑 -

<navindex>
    <tab type="mainpage" visible="yes" title="">
        <tab type="mainpage" visible="yes" title="Audience" />
        <tab type="user" url="@ref Architecture" title="My Page" />
    </tab>
    <tab type="pages" visible="yes" title="" intro=""/>
    <tab type="modules" visible="yes" title="" intro=""/>
    <tab type="namespaces" visible="yes" title="">
      <tab type="namespacelist" visible="yes" title="" intro=""/>
      <tab type="namespacemembers" visible="yes" title="" intro=""/>
    </tab>
    <tab type="classes" visible="yes" title="">
      <tab type="classlist" visible="yes" title="" intro=""/>
      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
      <tab type="hierarchy" visible="yes" title="" intro=""/>
      <tab type="classmembers" visible="yes" title="" intro=""/>
    </tab>
    <tab type="files" visible="yes" title="">
      <tab type="filelist" visible="yes" title="" intro=""/>
      <tab type="globals" visible="yes" title="" intro=""/>
    </tab>
    <tab type="examples" visible="yes" title="" intro=""/>  

  </navindex>

Architecture diagram 是一个外部文档，不是通过运行 doxygen 生成的。所以我的问题是 -我应该把这个架构文档放在哪里？？或者它应该是项目解决方案的一部分。

Answer 1

这很容易实现。您已经通过生成自定义 DoxygenLayout.xml 完成了困难的部分文件。现在，您只需向其中添加一个自定义选项卡:

<tab type="user" url="architecture.html" title="Architecture"/>

你可以把它放在 <navindex> 下的任何地方。标签。出于测试目的，您可以将它扔到组的最后。

title属性可以是您想要的任何文本字符串。

url属性可以是您想要的任何文件的 URL。当然，它不一定是 HTML 文件。它可以是 PDF、Word DOC 或其他格式。您也可以使用 "@ref mypage"链接到名为 mypage 的 doxygen 页面(see the documentation for details)。