在 doxygen 中记录 #undef 的好方法

2023-12-29

我目前在 c 文件中有几个#define,可以关闭硬件的某些功能以进行测试。但是,当它们未定义时,我想用 doxygen 记录它们。

例如:

这工作正常:

/// \def SIMULATE_SOME_HW_INTERFACE
/// Define this when you want to simulate HW interface.
#define SIMULATE_SOME_HW_INTERFACE

当您将 #define 更改为 #undef 时,您会在 doxygen 中收到警告,并且它不会显示在 doxygen 生成的输出中。我想记录这个#define,无论它是定义的还是未定义的。

我如何强制 doxygen 记录#undef???


在仅由 Doxygen 包含的头文件中定义它们(放在与主源不同的目录树中)。

通过使用仅在 Doxygen 设置中定义的定义来包装此头文件,例如:

#ifdef ONLY_FOR_DOXYGEN

/// \def SIMULATE_SOME_HW_INTERFACE
/// Define this when you want to simulate HW interface.
#define SIMULATE_SOME_HW_INTERFACE

#endif

我也用它来有条件地包括轻量级类定义 http://www.oofile.com.au/oofile_ref/htmlwin/class_c_object.html对于诸如 MFC 基类之类的内容,它们将显示为类层次结构的基础,而无需解析所有 MFC。

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

在 doxygen 中记录 #undef 的好方法 的相关文章

  • 是否可以使用 Doxygen、Sandcastle 或其他文档生成器来记录 XML?

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

    我有一个 C 项目 其中包含两个同名的函数 但每个函数都位于不同的组 模块中 defgroup 这些函数各自编译成不同的二进制文件 但我需要紧密交叉引用文档 因此我需要参考 ref 从彼此的模块到这些函数 以及其他地方 当我做简单的事情时
  • Doxygen 在记录 PHP 时出现奇怪的问题 if

    当我尝试记录我的项目时 我遇到了一个奇怪的问题 我有以下代码 Set default action for called controller If no action is called default index will be set
  • 为 swig 生成的包装 C++ 的 C# 生成 doxygen 注释

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

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

    例如 在我的函数中 starting code with doxygen documentation The main function I will now try to document variables within this ma
  • 使用 Doxygen 的 Qt 风格文档? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 如何使用 Doxygen 生成 Qt 风格的文档 Trolltech 的 C Qt 或 Riverba
  • 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-如何记录具有非标准扩展名 (.INI) 的文件

    我有一个简单的问题 如何记录 INI 文件 我有一个具有以下布局的 C 项目 readme txt src main cpp data simple ini 我从 readme txt 和 main cpp 生成文档没有问题 但 simpl
  • 如何避免 c++ 和 boost::python 文档之间的冗余?

    我使用 boost python 在 C 代码中添加 python 模块 C 项目使用 doxygen 进行记录 我想为 python 模块创建一个文档 但我不知道如何不像这样冗余 include
  • 从 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 希望它
  • Doxygen 将全局变量声明视为 C++ 中的函数

    当我运行 Doxygen 1 8 15 时 我在日志文件中收到警告 指出并未记录函数的所有参数 warning parameters of member gSwInstallIoMgr are not all documented warn
  • 如何在 vim 下突出显示 doxygen 中的 markdown?

    较新版本的 doxygen 附带了 Markdown 支持 有没有一种简单的方法可以将 Markdown 语法突出显示添加到 vim 中的 doxygen 注释块 顺便说一句 可以将 doxygen 语法添加到c文件通过使用set file
  • 忽略 doxygen 注释块中的行

    是否可以在 doxygen 注释块中包含将被 doxygen 忽略的内容 换句话说 我们可以在 doxygen 评论块中发表评论吗 背景 我们正在将 Fortran 项目的代码内注释转换为 doxygen 可解析的格式 但是该项目要求代码内
  • Doxygen 和 Objective-C 类别

    尽管 Doxygen 的最新版本声称可以更好地处理 Objective C 类别 http www doxygen nl manual changelog html 它似乎仍然对我的源代码中的类别感到窒息 我想知道是否有人已经让它正确地记录
  • 如何管理具有多个库的 Doxygen 项目?

    我正在开发一个使用多个库的项目 其结构设置如下 src libs libOne libs libTwo 我想生成一个 Doxygen 页面 其中涵盖我的所有代码以及库 这非常简单 只需将 Doxygen 指向根即可 但是 我希望对 doxy
  • 德尔福和Doxygen

    我想使用 doxygen pas2dox 记录我的源代码 当我设置好所有内容 包括过滤器和提取选项 提取所有内容 时 doxygen 运行良好 但生成的文档仅包含源文件作为链接 并且没有提取类型 方法 过滤后的源看起来不错 有任何提示如何定
  • 在 doxygen 中使用 @see 或 @link

    我之前用 Javadoc 记录并使用了标签 see link or see foo and link foo 在我的描述中链接到其他课程 现在我尝试了doxygen 似乎这些标签不兼容 如果我运行 doxygen 完整的标签将被简单地解释为
  • 如何让Doxygen忽略继承关系?

    我试图让 Doxygen 在绘制协作图时忽略继承关系 假设我的类定义如下所示 class Derived public Base int x int y int z 现在 当我运行 Doxygen 时 我不想在生成的协作图中看到基类 乍一看

随机推荐