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

2023-12-07

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


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

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

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

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

The url属性可以是您想要的任何文件的 URL。当然,它不一定是 HTML 文件。它可以是 PDF、Word DOC 或其他任何形式。您还可以使用"@ref mypage"链接到名为的 doxygen 页面mypage (详细信息请参阅文档).

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

在 doxygen 布局中添加新用户选项卡 的相关文章

  • 代码文档生成工具Doxygen教程及实例

    程序员的很多文档 xff0c 特别是有代码的文档 xff0c 绝大部分都是由一款文档生成工具 Doxygen 生成 什么是Doxygen Doxygen 是一个程序的文件产生工具 xff0c 可将程序中的特定批注转换成为说明文件 通常我们在
  • 是否可以使用 Doxygen、Sandcastle 或其他文档生成器来记录 XML?

    我目前正在使用 Sandcastle Doxygen 和 JavaDoc 为我编写的代码生成文档 是否可以使用这些包来记录 XML 模式 如果没有 是否有任何 最好是免费的 软件包可以做到这一点 我可以自己编写文档作为 Doxygen 或
  • 在 Doxygen 中处理两个同名的不同函数

    我有一个 C 项目 其中包含两个同名的函数 但每个函数都位于不同的组 模块中 defgroup 这些函数各自编译成不同的二进制文件 但我需要紧密交叉引用文档 因此我需要参考 ref 从彼此的模块到这些函数 以及其他地方 当我做简单的事情时
  • 在 .NET 中使用 XML 注释有哪些优点?

    我无法理解使用 XML 注释的优点 我知道它们可以转换为代码外部的漂亮文档 但使用更简洁的 DOxygen 语法也可以实现同样的效果 我认为 XML 注释是错误的 因为 他们总体上混淆了注释和代码 它们更难被人类阅读 在单个屏幕上可以查看的
  • 使用 Doxygen 的 Qt 风格文档? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 如何使用 Doxygen 生成 Qt 风格的文档 Trolltech 的 C Qt 或 Riverba
  • Doxygen - 将参数声明为可选

    我正在使用 Doxygen 记录代码库 并且想知道是否有一个关键字用于将函数的参数声明为可选 就像是 fn int add int a int b 0 brief adds two values param a the first oper
  • X 宏破坏 doxygen 调用图

    我有3个文件 test c int table define X val val include test x undef X void level2 void level3 level4 void level3 void level4 t
  • 如何设置 Doxygen 的输入目录?

    我有一个保存所有源文件和头文件的目录 我想运行 Doxygen 来生成这些源代码的文档 但是 我不想更改此目录中的任何内容 特别是我无法添加保存 Doxygen 文档的子目录 我怎样才能实现我所需要的 我想我需要做以下事情 我创建并转到 文
  • 从 Shell 输出生成文档

    有没有一种方法 工具可以直接从我的 Shell 输出甚至保存的日志生成 HTML 文档 类似于 doxygen 的作用 如果没有可用的东西 你们对如何使用现有工具做到这一点有什么创意吗 我想 在打字时 我可以放置某种标记或特殊字符 然后让一
  • 如何生成 rdoc 风格的可折叠代码段?

    我正在使用 Doxygen 为 C 项目创建内部文档 我让 Doxygen 包含方法的源代码等 但这使得页面难以扫描 我希望它的行为像 rdoc 一样 并将源代码隐藏在默认折叠的块中 我以为HTML DYNAMIC SECTIONS可能会让
  • 单击“模块”选项卡时,是否可以让 Doxygen 直接显示唯一的模块?

    考虑以下单文件项目 defgroup api Public API This is foo and bar together ingroup api void foobar Nothing here to see 在包含该文件的目录中 我运
  • 带有 C# 内部访问修饰符的 Doxygen

    我正在使用 Doxygen 为我正在处理的 C 项目生成一些 API 文档 我在这个项目中有相当多的 内部 功能 并且不希望 Doxygen 在它生成的生成的 html 中生成这些签名 我已尝试启用 HIDE FRIEND COMPOUND
  • 将 XML 文件添加到文件列表

    我想将 XML 文件的内容添加到 doxygen 生成的文档中 我将 XML 文件添加到INPUTdoxygen 配置文件的标记 但是 虽然 XML 文件列在文件列表中 但并未显示文件的内容 我需要做什么才能包含这些内容 Doxygen 没
  • 如何使用 Doxygen 和 Doxygen::Filter::Perl 生成 Perl 子例程的文档?

    我正在尝试弄清楚如何使用Doxygen Filter Perl https metacpan org pod Doxygen Filter Perl生成 Perl 文件的文档 我从一个非常简单的文件开始只是为了看看我是否可以让它工作 tes
  • 扫描代码注释并转换为标准格式的工具[关闭]

    Closed 此问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我正在开发一个 C 项目 该项目有许多不同的作者和许多不同的文档风格 我是以下的忠实粉丝doxygen
  • Doxygen 速度慢

    Doxygen 在我们的代码库上运行大约需要 12 小时 这主要是因为有大量代码需要处理 约 150 万行 然而 我们很快就无法进行夜间文档更新 因为它们花费的时间太长 我们已经不得不减少图表深度以将其缩短至 12 小时 我已经尝试过标准方
  • 我可以将 GitHub Pages index.html 放在存储库的子文件夹中吗?

    我正在尝试使用 GitHub 页面来托管 Doxygen 站点 理想情况下 我希望能够将生成的文件和目录推送到 GitHub 而无需对其进行任何调整 然而 这意味着我的 index html 位于存储库的子文件夹中 并且 GitHub Pa
  • Doxygen:在不更改 CSS 的情况下显示数字 Enum 值?

    我需要一种方法让 doxygen 在 doxygen 输出中显示枚举成员的实际值 例如我有 MyEnum typedef enum My Enum MY ENUM 0
  • Python 中 doxygen 风格文档字符串的 Vim 语法高亮显示

    我开始与doxygen生成我的 Python 代码的文档 我用doxypy过滤器来预处理 Python 文档字符串 我的目标是在 Python 中对 doxygen 注释进行良好的语法突出显示 当写我的mainpage在专用的 dox 文件
  • doxygen INSTALL 无法将文件“.../doxygen/build/bin/doxygen”复制到“/usr/local/bin/doxygen”

    解决了一些之后最初的问题 https stackoverflow com q 50986047 4120196在尝试让 doxygen 工作时 我在遵循以下步骤时偶然发现了下一个错误doxygen安装教程 http www doxygen

随机推荐