在 Doxygen 中引用参数的正确方法是什么?

2024-03-28

我有以下 Doxygen 函数文档:

/**
  @brief Does interesting things

  @param[in]  pfirst The first parameter: a barrel full of monkeys

  @pre
    "pfirst" must have been previously passed through BarrelFiller()
*/

注意pfirst是一个参数,并且在前提条件中引用了它。

我在这里用引号将其引起来,因为我想将其与文本的其余部分区分开来。但如果这样做的话,Doxygen 会突出显示该命令,并且最好将其链接到参数定义,那就太好了。有没有办法做到这一点?

如果仅使用默认配置(或其较小的更改)就可以实现这种情况,那就特别好。


Doxygen 提供命令\p http://www.doxygen.nl/manual/commands.html#cmdp用于指示下一个单词是函数的参数。你会像这样使用它:

... the \p x and \p y coordinates are used to ...

我相信默认情况下这将使用打字机字体表示。我认为这目前不提供任何自动链接功能,但将来可能会提供。

有一个相关的命令,\a http://www.doxygen.nl/manual/commands.html#cmda用于标记成员参数。默认情况下,它在文本中强调显示(<em>arg</em>)

您可以找到有关各种 Doxygen 的更多信息特殊命令参考 http://www.doxygen.nl/manual/commands.html.

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

在 Doxygen 中引用参数的正确方法是什么? 的相关文章

  • 在 Doxygen 中处理两个同名的不同函数

    我有一个 C 项目 其中包含两个同名的函数 但每个函数都位于不同的组 模块中 defgroup 这些函数各自编译成不同的二进制文件 但我需要紧密交叉引用文档 因此我需要参考 ref 从彼此的模块到这些函数 以及其他地方 当我做简单的事情时
  • Roxygen 真的可以像 Doxygen 对 C++ 那样记录 R 脚本(而不是包)吗?

    Roxygen 的灵感来自 C C 程序员使用的 Doxygen 文档系统 我使用过 Doxygen 我发现只要有 doxygen 注释 记录任何程序都非常容易 它还生成函数和类的调用图 我认为 roxygen 会以同样的方式工作 但是当我
  • 为 swig 生成的包装 C++ 的 C# 生成 doxygen 注释

    我有一个用 C 编写的项目 我也使用 swig 生成一些 C 包装器 C 代码使用 Doxygen 样式注释来注释类和函数 是否可以让 Swig 获取这些 doxygen 注释并为 C 包装器类和函数生成 doxygen 注释 目前 SWI
  • 我应该如何使用 Doxygen 对 typedef 进行分类?

    我的 C 代码中有 typedef 结构 截至目前 它们被列为 var类型定义 有一个更好的方法吗 下面是我所拥有的示例 var typedef etc brief A type defined structure for etc para
  • 生成 C 代码的调用图 [关闭]

    就目前情况而言 这个问题不太适合我们的问答形式 我们希望答案得到事实 参考资料或专业知识的支持 但这个问题可能会引发辩论 争论 民意调查或扩展讨论 如果您觉得这个问题可以改进并可能重新开放 访问帮助中心 help reopen questi
  • Doxygen-如何记录具有非标准扩展名 (.INI) 的文件

    我有一个简单的问题 如何记录 INI 文件 我有一个具有以下布局的 C 项目 readme txt src main cpp data simple ini 我从 readme txt 和 main cpp 生成文档没有问题 但 simpl
  • Doxygen:是否可以控制依赖图的方向?

    Up until today I d been using an ancient version 1 4 7 of doxygen dot and it typically drew graphs with a vertical orien
  • 带有 C# 内部访问修饰符的 Doxygen

    我正在使用 Doxygen 为我正在处理的 C 项目生成一些 API 文档 我在这个项目中有相当多的 内部 功能 并且不希望 Doxygen 在它生成的生成的 html 中生成这些签名 我已尝试启用 HIDE FRIEND COMPOUND
  • Doxygen copydoc 标签可重用代码示例

    我想使用 copydoc 标签重用示例代码块 来解释一下问题 假设我有两个已记录的函数 Aquires resource Resource AquireResource int id Releases resource void Relea
  • C 和 doxygen - 删除变量文档的重复项

    我正在使用 doxygen 记录我的 C 代码 为了更好的可读性 我将每个 c h 文件对 有时还有更多文件 的文档分组为defgroup and addtogroup see c 中的 doxygen 定义分组 https stackov
  • 使用 Doxygen 自定义标签

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

    你好 我正在尝试使用 doxygen 记录我的 C 代码 问题是静态函数和公共 私有函数之间的依赖关系没有显示出来 其中 公共 私人之间的那些正在正确显示 有人可以在这件事上帮助我吗 将配置和一些示例代码粘贴到此处 Project rela
  • 我可以将 GitHub Pages index.html 放在存储库的子文件夹中吗?

    我正在尝试使用 GitHub 页面来托管 Doxygen 站点 理想情况下 我希望能够将生成的文件和目录推送到 GitHub 而无需对其进行任何调整 然而 这意味着我的 index html 位于存储库的子文件夹中 并且 GitHub Pa
  • Doxygen 将全局变量声明视为 C++ 中的函数

    当我运行 Doxygen 1 8 15 时 我在日志文件中收到警告 指出并未记录函数的所有参数 warning parameters of member gSwInstallIoMgr are not all documented warn
  • Doxygen 注释的“使用命名空间”

    我的库的所有类都是在命名空间内定义的 当我为 Doxygen 创建主页时 我必须在注释中显式使用此命名空间以使 Doxygen 生成链接 我想对整个评论块使用类似 使用命名空间 的内容 一个例子 mainpage My Library Us
  • Python 中 doxygen 风格文档字符串的 Vim 语法高亮显示

    我开始与doxygen生成我的 Python 代码的文档 我用doxypy过滤器来预处理 Python 文档字符串 我的目标是在 Python 中对 doxygen 注释进行良好的语法突出显示 当写我的mainpage在专用的 dox 文件
  • 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
  • 是否存在用于编辑 doxygen 评论的“wiki”? [关闭]

    Closed 此问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我正在开发一个相当大的开源 RTS 游戏引擎 Spring http springrts com 我最近
  • Doxygen:显示未记录方法的警告

    我已经用 doxygen 激活了警告 WARNINGS YES WARN IF UNDOCUMENTED YES WARN IF DOC ERROR YES WARN NO PARAMDOC YES 但未记录的方法如下 void Anima

随机推荐