3

我是使用 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 生成的。所以我的问题是——我把这个架构文档放在哪里？或者它应该是项目解决方案的一部分。

4

2 回答 2

1

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

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

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

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

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

于 2014-07-04T07:11:23.137 回答
0

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

doxygen -l

接下来就是在配置文件中提到布局文件：

LAYOUT_FILE = DoxygenLayout.xml

Doxygen GUI 1.8.20

在此处输入图像描述

于 2021-01-14T06:55:00.427 回答