配置Doxygen以隐藏某些名称或关键字

Question

我刚刚开始使用Doxygen,并对此进行了大量的搜索,所以如果有明显的答案,请原谅我.

我正在开发一个嵌入式项目,其中函数可以在返回类型之前debug或nodebug之前标记.在我们的大多数库中,我们使用条件宏设置libname_debug为文件的顶部debug或nodebug顶部,然后每个函数都以libname_debug.开头.

出于文档目的,我想让Doxygen离开libname_debug功能文档.它使函数列表变得混乱,使得查看每个函数的返回类型变得更加困难.

是否有可能以某种方式标记文件,以便Doxygen将该符号留下？目前,我正在@ cond/@ endcond中包装每个实例:

/** @cond */ libname_debug /** @endcond */

但这是一个痛苦,并为源添加了额外的标记.

Answer 1

还有一个doxygen页面解释了如何处理这种情况.您将启用MACRO_EXPANSION(默认为NO),告诉doxygen仅扩展一些宏(EXPAND_ONLY_PREDEF)并将您的符号添加为具有空扩展的宏:

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = libname_debug=

Answer 2

您可以在 doxygen 配置文件中定义宏。像这样的东西

PREDEFINED += libname_debug