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

时间:2010-06-25 17:31:30

标签: c doxygen

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

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

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

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

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

但这是一种痛苦,并为来源添加了额外的标记。

2 个答案:

答案 0 :(得分:5)

还有一个doxygen page解释了如何处理这种情况。你可以启用MACRO_EXPANSION(默认为NO),告诉doxygen只展开一些宏(EXPAND_ONLY_PREDEF)并将你的符号添加为带有空扩展的宏:

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

答案 1 :(得分:2)

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

PREDEFINED += libname_debug