如何显示定义的值

2024-02-01

在一些 doxygen 文档中,我想显示#define,而不是标签本身。例如,在一个 C 文件中我有

#define REPEAT_N_TIMES 10

现在我想在我的文档中显示:

该动作进行10次。

如果我使用\ref REPEAT_N_TIMES,它显示:

该操作已执行 REPEAT_N_TIMES 次

有没有办法显示content链接的,而不是链接本身,例如\ValueOf(\ref REPEAT_N_TIMES) or \contentOf(\ref REPEAT_N_TIMES)?

Update:我的 Doxygen 的配置是:

// Configuration options related to the preprocessor

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
SEARCH_INCLUDES        = YES
INCLUDE_PATH           =
INCLUDE_FILE_PATTERNS  =
PREDEFINED             = WXUNUSED()=
EXPAND_AS_DEFINED      =
SKIP_FUNCTION_MACROS   = YES

The MACRO_EXPANSION设置似乎改变了宏的“细节”。但我没有找到选择宏名称或其内容的方法。使用命令\ref似乎不是正确的方式:它指的是“某物”而不是“某物”的内容

是否有我可以使用的运算符或函数,可能类似于C,我可以使用类似的东西\ref *something代替\ref something?


doxygen 手册页位于预处理 http://www.doxygen.nl/manual/preprocessing.html似乎有您需要的所有信息。第一步尝试设置MACRO_EXPANSIONdoxygen 配置文件中的标志为YES,然后在您的文档中包括

The action is done REPEAT_N_TIMES times.

正如 doxygen 手册中所述,这将扩展所有宏定义(如果需要,则递归),这通常太多了。因此,您可以使用以下命令准确指定要扩展的宏EXPAND_ONLY_PREDEF and EXPAND_AS_DEFINED配置文件中的设置。例如,尝试设置

EXPAND_ONLY_PREDEF = 是
EXPAND_AS_DEFINED = REPEAT_N_TIMES

在配置文件中。

UPDATE:根据 @spamy 的评论,我对此进行了更多研究,似乎我上面提到的方法不适用于宏within注释块,即仅扩展源代码中的宏。例如,参见这个帖子 http://sourceforge.net/mailarchive/message.php?msg_id=11649789在 doxygen Sourceforge 页面上。根据这篇文章,在注释块中实现宏扩展的唯一方法是使用INPUT_FILTER配置文件设置。使用类似的东西

INPUT_FILTER = sed /REPEAT_N_TIMES/10

Warning:以上INPUT_FILTER尚未经过测试。

如果您不想使用INPUT_FILTER then this https://stackoverflow.com/a/9299914/623518另一个线程的答案可能是你最好的选择。本质上它说您可以记录宏,以便文档的读者能够轻松找到真正的价值。因此,将文档添加到您的#define并且只是\ref它在文档的其他地方。

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

如何显示定义的值 的相关文章

随机推荐

  • 使用 ScrollViewer.ScrollToEnd() 进行自动滚动仅在调试时有效,事件处理程序太简单

    看着这个解决方案 https stackoverflow com questions 2984803 how to automatically scroll scrollviewer only if the user did not cha
  • VS 2015 Update 1 - 声称我正在调试发布版本

    更新到 VS 2015 update 1 后 如果我运行一个 Web 项目 MVC 停止该应用程序 然后尝试再次运行它 VS 停止并弹出一个对话框 声称 您正在调试发布版本
  • JSON.stringify 不会对嵌套数组进行字符串化

    我目前正在调查为什么 JSON stringify 无法正确解析我的对象 这是我试图解析为 JSON 字符串的对象 var data name string active bool data value number date string
  • 什么是 doc2vec 训练迭代?

    我是 doc2vec 的新手 我最初试图理解 doc2vec 下面提到的是我使用 Gensim 的代码 正如我想要的那样 我得到了两个文档的训练模型和文档向量 但是 我想知道在几个时期重新训练模型的好处以及如何在 Gensim 中做到这一点
  • 自动合并 Github 上的拉取请求,没有合并气泡

    github 中的 此拉取请求可以自动合并 合并拉取请求 按钮非常棒 除了它会创建合并气泡 有没有办法在 github 中使用这个按钮 功能而不产生合并气泡 No The git blog https github com blog 843
  • SeriesCollection 和 FullSeriesCollection 之间的区别

    我正在尝试清理一些自动生成的代码 并且我对 Excel 中的系列功能相当陌生 所以在许多网站 论坛中我发现人们使用更多SeriesCollection而不是我生成的代码使用FullSeriesCollection 我的代码正在过滤一些内容
  • 没有 Docker 的 Gitlab-runner

    我已经在 ubuntu 16 04 上安装了 gitlab runner 我已经设置了 Executor shell 我的项目托管在 gitlab com 上 有一个非常简单的 yaml 配置文件 dev script pwd I am n
  • 从 Spring WS 拦截器获取请求参数

    我将 Jaxb 2 与 Spring WS 一起使用 并且我有一个针对特定有效负载的拦截器 并且它工作正常 这里我的要求是从拦截器的handleRequest方法中读取请求参数 我知道这应该是相当简单的 但是无法找到读取请求参数的方法 目前
  • fstream 文件结尾问题

    我正在读取多个文件 这些文件大约有 300 个 由于某种原因 如果我将循环设置为运行超过 3 次迭代 则应该迭代每一行的 while 循环将变得无限 我的问题是 我是否忘记在 while 循环中包含一些内容 现在我只是尝试一次读取一行 最终
  • Android + 字符串

    谁能告诉我 Android 中的 toString 是什么以及如何使用它 作为例子将受到高度赞赏 toString http download llnw oracle com javase 6 docs api java lang Obje
  • SQL 中的特殊字符转义

    Oracle 有没有一种简单的方法来转义 SQL 语句中的特殊字符 即 我看到了这个link http orafaq com faq how does one escape special characters when writing s
  • php://输入返回空

    我有骨干应用程序 当模型更新时 PUT 请求会发送到我的服务器 客户端看起来不错 但在服务器端 PHP 我遇到了一些麻烦 当我第一次在 PHPStorm 中测试这个请求时 file get contents php input 返回我所期望
  • 使用 jQuery 确定相对路径

    我在顶级域下的子文件夹中安装了几个 WordPress 站点 http www mydomain com site a http www mydomain com site a http www mydomain com site b ht
  • 节点 - 将 jest 与 esm 包一起使用

    我想知道如何合并esm包裹https www npmjs com package esm https www npmjs com package esm在节点后端使用笑话 我尝试设置一个安装文件require esm and require
  • 谷歌分析 4 与 React

    我一直在尝试在我的应用程序中将 React ga 包与 google Analytics 4 一起使用 测量 ID 不适用于它 并且我可以使用的 google Analytics 4 中没有跟踪代码 拜托 我需要帮助 import Reac
  • jquery根据背景图像名称选择元素

    我正在尝试选择一个具有特定背景图像的 div 这是我迄今为止所拥有的 不工作 对我做错了什么有什么想法吗 我正在尝试遵循 jQuery 文档 var markerShadow0 div background image url http w
  • 在电子邮件中发送内嵌图像

    通过电子邮件将图像作为正文中的嵌入图像发送时遇到问题 图像文件显示为附件 这没问题 但内联图像部分仅显示为红色 x 这是我到目前为止所拥有的 LinkedResource inline new LinkedResource filePath
  • 如何使用 mox 模拟类属性?

    我有一堂课 class MyClass object property def myproperty self return hello Using mox http code google com p pymox and py test
  • AS3:调用静态类方法 - 类和方法名称是字符串

    我有一个丑陋的问题 我有两个字符串变量 className 和 staticMethod 存储类的名称以及我必须调用的静态方法 package import flash display Sprite import flash utils g
  • 如何显示定义的值

    在一些 doxygen 文档中 我想显示 define 而不是标签本身 例如 在一个 C 文件中我有 define REPEAT N TIMES 10 现在我想在我的文档中显示 该动作进行10次 如果我使用 ref REPEAT N TIM