在doxygen布局中添加新的用户选项卡 [英] Adding new user Tab in the doxygen Layout

问题描述

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

I am new to using doxygen 1.8.7. I am trying to add the Architecture diagram to be the part of the API documentation generated for my C# project using doxygen. I generated the default doxygen Layout file (DoxygenLayout.xml) and edited it by adding the below changes -

<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生成的。
所以我的问题是-
我应将此建筑文档放在哪里？还是应该将其作为项目解决方案的一部分。

The Architecture diagram is an external document and is not generated by running doxygen. So my question is - Where do I put this Architecture Document?? Or should it be a part of the project solution.

推荐答案

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

This is very simple to accomplish. You've already done the hard part by generating the custom DoxygenLayout.xml file. Now, you just need to add a custom tab to it:

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

您可以将其放在< navindex>下的任意位置code>标记。出于测试目的，您可以将其扔到组的最后。

You can put that wherever you want under the <navindex> tag. For testing purposes, you can just toss it in at the very end of the group.

title 属性可以

url 属性可以是您想要的任何文件的URL。当然，它不一定是HTML文件。它可以是PDF，Word DOC等。您还可以使用 @ ref mypage 链接到名为 mypage 的doxygen页面（有关详细信息，请参阅文档）。

The url attribute can be a URL to any file you want. It doesn't have to be an HTML file, of course. It can be a PDF, Word DOC, or whatever. You can also use "@ref mypage" to link to a doxygen page named mypage (see the documentation for details).

这篇关于在doxygen布局中添加新的用户选项卡的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！