c - 如何防止 doxygen 在 C 文件中记录 #defines？

Question

我在 header 中有 #define 值，我当然希望 Doxygen 记录这些值，但我在 C 文件中有其他值，我将它们视为静态常量，我不想Doxygen 来记录它们。像

这样简单和愚蠢的东西

#define NUMBER_OF(a) (sizeof((a))/sizeof((a)[0]))
#define MSTR(e) #e

如何防止 Doxygen 将那些 #define 放入它创建的文档中？我试过用 @internal 标记它，但这似乎没有帮助。

关于 Doxygen 和 #define 的一个有点相关的问题，我怎样才能得到:

#define SOME_CONSTANT 1234 /**< An explanation */

在输出中放入“SOME_CONSTANT”和“An explanation”而不是“1234”？

Answer 1

不需要使用\cond 和\endcond 命令。您可以通过简单地使用 \hideinitializer 命令隐藏初始化器:

#define SOME_CONSTANT 1234 /**< An explanation @hideinitializer */

关于第一个问题，您可以设置 HIDE_UNDOC_MEMBERS = YES 并且只有具有 Doxygen 文档 block 的宏才会显示在输出中。