忽略函数内的 Doxygen 尾随注释

Question

我正在使用 ST 的 RFAL 库，该库对跟随值的定义有很多注释。

示例：

#define RFAL_ANALOG_CONFIG_LUT_SIZE                 (87U)     /*!< Maximum number of Configuration IDs in the Loop Up Table     */
#define RFAL_ANALOG_CONFIG_LUT_NOT_FOUND            (0xFFU)   /*!< Index value indicating no Configuration IDs found            */

#define RFAL_ANALOG_CONFIG_TBL_SIZE                 (1024U)   /*!< Maximum number of Register-Mask-Value in the Setting List    */

我正在使用 Doxygen 进行代码注释，并发现这会导致在代码中引用定义时出现严重行为。

所有带“<" preceding the line are due to be using one of RFAL's definitions within this function.

”的评论

有什么方法可以忽略内部函数注释吗？我不打算在我希望 Doxygen 解析函数内部的地方注释我的代码。但当我在 Doxygen 中查看 RFAL 的定义之一时，我仍然想要定义注释。

Answer 1

有什么办法可以忽略内部函数注释吗？

隐藏_BODY_DOCS

如果 HIDE_IN_BODY_DOCS 标记设置为 YES，Doxygen 将隐藏在函数体内找到的任何文档块。如果设置为 NO，这些块将被附加到函数的详细文档块中。

默认值为：NO。