doxygen - 在 doxygen 中记录 #undef 的好方法

Question

我目前在 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？？？

Answer 1

在仅由 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

我用它也有条件地包含了 lightweight class definitions对于诸如 MFC 基类之类的东西，这样它们就可以作为类层次结构的基础出现，而无需解析所有 MFC。