使用 doxygen 的 \link 命令

2023-11-23

我有一个外部 HTML 文件,我想从我的 doxygen“相关页面”选项卡或左侧框架中链接。看来我需要使用\link命令,但我找不到如何使用它或在哪里使用它的好例子。我目前正在使用 doxywizard 生成 HTML。

So, is \link我将其合并到我的 doxygen 配置文件中,还是在以某种方式构建 HTML 时添加它?

Update

所以我最终不得不执行以下操作:

  1. 创建一个新页面 (docs_main.html),其中包含以下内容:

    /*! \mainpage MY TITLE HERE
     * \section intro_sec External resources
     * <a href="link_to_my_external_page.html">My external page</a>
     */
    
  2. 将该页面包含在我的 doxygen 包含文件列表中

  3. 重建我的文档

这将以下内容添加到我的 doxygen“主页”中

MY TITLE HERE

My external page (which was a link to that page)

我们有一个支持降价如今在 doxygen 中。您的代码可能更清晰:

/*! \mainpage MY TITLE HERE
 * \anchor intro_sec
 * # External resources
 * [My external page](http://link_to_my_external_page.html)
 */

上面的内容应该有点接近:


外部资源

我的外部页面


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

使用 doxygen 的 \link 命令 的相关文章

  • Doxygen使用教程(个人总结)

    简介Doxygen 一 xff0e 什么是Doxygen Doxygen 是一个程序的文件产生工具 xff0c 可将程序中的特定批注转换成为说明文件 通常我们在写程序时 xff0c 或多或少都会写上批注 xff0c 但是对于其它人而言 xf
  • 是否可以使用 Doxygen、Sandcastle 或其他文档生成器来记录 XML?

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

    我对 doxygen 中的页面和组有疑问 我有一个项目 我在其中使用 defgroup 和 ingroup cmd 对类等进行分组 到目前为止这工作正常 现在我想使用 Markdown 页面向项目添加特殊文档 这些页面应出现在专用模块 组
  • C++:生成函数调用树

    我想解析项目中当前的 C 文件并列出其中的所有方法 函数 然后生成函数调用和调用者树 F g 您可以参考 doxygen 如何生成调用树 我已经检查了 gccxml 但它没有列出从另一个函数调用的函数 请建议我一些我可以使用的轻量级工具 开
  • 在 Objective-C 中,什么实用程序在注释中使用 @brief 标签?

    我刚刚开始使用 Objective C 编程 发现了一些示例注释 如下所示 brief The UIImageView we use to display the image generated from the imageBuffer 目
  • 在 doxygen 输出中隐藏公共包

    给定一些包foo bar project something FirstModule foo bar project something SecondModule等等 他们都有那么长foo bar project something共同点
  • 从 Shell 输出生成文档

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

    我正在使用 Doxygen 为 C 项目创建内部文档 我让 Doxygen 包含方法的源代码等 但这使得页面难以扫描 我希望它的行为像 rdoc 一样 并将源代码隐藏在默认折叠的块中 我以为HTML DYNAMIC SECTIONS可能会让
  • 从 DOxygen XML 输出中提取函数调用列表

    我发布了一个question https sourceforge net projects doxygen forums forum 130994 topic 3875842在 DOxygen 论坛上 也将其发布在这里以获得更好的回应 我有
  • 使用 Doxygen 或 PHPDoc 记录 Get/Post 参数 [关闭]

    Closed 这个问题需要多问focused help closed questions 目前不接受答案 我正在浏览 PHPDoc 的文档 但找不到一个好方法来记录我发送到各种方法的 Post 变量 因此 我开始研究 Doxygen 希望它
  • Visual Studio 自动完成 C++ 的 Doxygen 标签

    有没有办法让 Visual Studio 自动将 doxygen 标签放入 C 源文件中 我的意思是例如这段代码 int foo bool p 如果我输入 在其之上 Visual Studio 自动生成以下行
  • 在 doxygen 中使用模块组内的节

    我寻求构建 doxygen 模块组内容的首选方法 例如 我想在不同部分的以下模块组中构造 details 文本 特别是每个部分都应该出现在生成的 PDF 的书签中 作为模块组的子元素 defgroup lorem brief Lorem i
  • 使用 Doxygen 自定义标签

    我想弄清楚是否有办法使用 Doxygen 创建自定义标签 我确实找到了 ALIAS 配置文件选项 但这并不完全符合我的需要 基本上在我的代码中我希望能够编写类似的内容 req Requirement 322 blah blah 然后让 Do
  • doxygen 不显示静态函数和公共函数之间的依赖关系

    你好 我正在尝试使用 doxygen 记录我的 C 代码 问题是静态函数和公共 私有函数之间的依赖关系没有显示出来 其中 公共 私人之间的那些正在正确显示 有人可以在这件事上帮助我吗 将配置和一些示例代码粘贴到此处 Project rela
  • 如何将 LaTeX 片段直接包含在 Doxygen 注释中?

    我希望能够使用一些合适的编辑器在外部编辑一些 Doxygen 注释的 LaTeX 部分 我只会在复杂的环境中使用它 为此 我想我可以拥有纯 LaTeX 文件并从 Doxygen 中包含它们 我确实为以下内容创建了 Doxygen 别名 be
  • 我可以将 GitHub Pages index.html 放在存储库的子文件夹中吗?

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

    较新版本的 doxygen 附带了 Markdown 支持 有没有一种简单的方法可以将 Markdown 语法突出显示添加到 vim 中的 doxygen 注释块 顺便说一句 可以将 doxygen 语法添加到c文件通过使用set file
  • Doxygen:在不更改 CSS 的情况下显示数字 Enum 值?

    我需要一种方法让 doxygen 在 doxygen 输出中显示枚举成员的实际值 例如我有 MyEnum typedef enum My Enum MY ENUM 0
  • Doxygen 和 Objective-C 类别

    尽管 Doxygen 的最新版本声称可以更好地处理 Objective C 类别 http www doxygen nl manual changelog html 它似乎仍然对我的源代码中的类别感到窒息 我想知道是否有人已经让它正确地记录
  • 禁止对未记录的成员函数发出 doxygen 警告,但保留概要

    我正在寻找一种方法来抑制有关未记录成员函数的 doxygen 警告 但不使用 cond and endcond 因此成员函数仍然出现在类的概要中 像下面这样 class Foo public Foo Foo const Foo Foo op

随机推荐

  • 更改轴而不更改数据 (Python)

    我如何绘制一些数据 删除由该数据创建的轴 然后用不同比例的轴替换它们 假设我有类似的东西 import matplotlib pyplot as plt fig plt figure ax fig add subplot 111 plt x
  • Nginx + (nodejs、socketio、express) + php 站点

    我正在开发一个完全 js HTML5 画布游戏 并希望它是 实时 的 根据我的研究 我发现 Node js 是一个令人兴奋的前景 因此我在我的 ubuntu 12 Web 服务器上使用 socket io express 等配置了它 我是一
  • 如何在 PyCharm 中运行 Flask shell?

    我在 PyCharm 中创建了新的 Flask 项目 但我看不到如何在集成的 PyCharm python 控制台窗口中运行 Flask shell Name app is not defined when start console 我仍
  • 将 RSA 加密参数从 CRT(中国剩余定理)映射到 .NET 格式

    我需要使用 C 实现 RSA 加密 解密 我有一个带有以下参数的私钥 mod n exponent p q dP dQ and p 1mod q 上述参数的解释见中文余数算法 然而 RSA 的 C NET 实现具有不同的参数集 如下所示 M
  • 使用 JavaScript 控制 Flash Player

    我希望能够在与 Flash 组件相同的页面中使用 JavaScript 控制 Flash 电影流 包括 播放和暂停流 改变流 我已经可以加载播放器并设置 flash 参数 但我不知道流开始后如何与播放器交互 是否可以在不修改当前用于播放电影
  • 电子“要求未定义”

    我正在制作一个应用程序 我需要授予对文件系统 fs 模块的访问权限 但是即使使用nodeIntegration启用渲染器给我这个错误 Uncaught ReferenceError require is not defined 我能找到的所
  • Meyers 的单例模式实现线程安全吗?

    以下是使用延迟初始化的实现Singleton 迈耶斯的单例 线程安全吗 static Singleton instance static Singleton s return s 如果不是 为什么以及如何使其线程安全 In C 11 它是线
  • 编辑 UITextField 时如何关闭键盘

    我知道当我想关闭键盘时 我需要告诉我的 UITextField 退出第一响应者 但我不确定如何知道用户何时按下键盘上的 完成 键 有我可以留意的通知吗 我设置了代表UITextField to my ViewController class
  • 多维长度数组反射java

    如何在java上使用反射找到多维数组的长度 多维数组没有 长度 这个概念 它可能不是矩形的 我猜你说的是维数 您需要迭代地深入其中并进行计数 public int getDimensionCount Object array int cou
  • 在SSH.NET中执行长时间命令并在TextBox中连续显示结果

    有没有办法在 Windows 应用程序 如 PuTTY 中执行 Linux 命令并将结果显示在文本框中 例如我正在尝试执行以下命令 wget http centos webpanel com cwp latest sh cwp latest
  • Web API 中的异常处理

    在我的 Web API 项目中 我创建了子项目 类库 在其中处理实际的数据处理操作 我的后端数据库是DocumentDB 我的问题是如何告诉我的 Web API 操作方法我在类库的数据方法中可能遇到的任何错误 一旦我的 Web API 方法
  • 当应用程序处于后台时,NSTimer 的行为是什么?

    我知道当您后台应用程序时 计时器会停止运行 然而 当你从后台回来时 行为是什么 定时器是否保持原来的状态fireDate 我遇到了一个问题 即从后台返回并设置十分钟后触发的 NSTimer 时 有时我会立即让计时器在之前触发applicat
  • 在 RawContacts 中找不到 Facebook 联系人

    我正在尝试构建一个联系人管理应用程序 我的手机上有多个帐户的联系人 包括 Facebook 和 HTC Facebook 由于某种原因 我无法从RawContacts表的ContactsContract managedQuery Conta
  • 在 Google Chrome 中打印表格时,内容与标题重叠

    我在打印包含 HTML 代码的表格时使用 Google Chrome 遇到问题 我需要创建一个带有标题的文档 为了实现这一点 我使用带有 thead 元素的表格 因此浏览器将为打印文档的每个页面复制它 问题是当我在页面中有分页符时 内容与标
  • 获取Windows消息名称[重复]

    这个问题在这里已经有答案了 我有一个使用 DLL 扩展的 Windows 程序 我通过调试流对象包含调试代码 这些对象通过 OutputDebugString 进行打印 并且可以使用 DebugView 进行查看 接口的一部分是消息处理函数
  • 多相机图像拼接

    我一直在运行一个从多个摄像机拼接图像的项目 但我认为我遇到了瓶颈 我对这个问题有一些疑问 我想将来尝试将它们安装在车辆上 这意味着相机的相对位置和方向是固定的 另外 由于我使用多个相机并尝试使用同位图来缝合它们的图像 我会将相机放置得尽可能
  • Android底部导航查看项目文本颜色?

    我开始研究 Android 底部导航视图 但我面临一个问题 如果我向底部导航视图添加 5 个项目 则只有选定的项目显示项目文本 如果我添加 3 个项目 它就可以正常工作 任何人请告诉我如何显示所有 5 个项目的项目文本 先感谢您 菜单 xm
  • JsonMappingException 没有单字符串构造函数/工厂方法 Jackson

    我正在尝试使用 Spring 构建 Jackson 支持来解析从控制器中的 UI 发送的 JSON 数据 这是我的代码 final Map
  • 使用 Interface Builder 进行绑定(适用于 iPhone 应用程序)

    如何使用 Interface Builder 绑定 iPhone SDK 控件 例如 UISlider 与常规 Cocoa 应用程序不同 当使用 Interface Builder 打开 iPhone 应用程序 XIB 时 绑定选项卡似乎不
  • 使用 doxygen 的 \link 命令

    我有一个外部 HTML 文件 我想从我的 doxygen 相关页面 选项卡或左侧框架中链接 看来我需要使用 link命令 但我找不到如何使用它或在哪里使用它的好例子 我目前正在使用 doxywizard 生成 HTML So is link