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

时间:2014-05-01 22:23:50

标签: doxygen doxywizard

我是使用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>

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

2 个答案:

答案 0 :(得分:1)

这很容易实现。您已经通过生成自定义DoxygenLayout.xml文件完成了困难的部分。现在,您只需要为其添加自定义标签:

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

您可以将其放在<navindex>标记下的任意位置。出于测试目的,您可以在组的最末端将其丢弃。

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

url属性可以是您想要的任何文件的URL。当然,它不必是HTML文件。它可以是PDF,Word DOC等等。您还可以使用"@ref mypage"链接到名为mypagesee the documentation for details)的doxygen页面。

答案 1 :(得分:0)

使用以下命令生成默认的 DoxygenLayout.xml 文档:

doxygen -l 

下一步就是在配置文件中提到布局文件:

LAYOUT_FILE = DoxygenLayout.xml

Doxygen GUI 1.8.20

enter image description here