我目前在 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(使用前将#替换为@)