主页 / coding / 问题 / 79106802
Accepted
JtTest
Asked: 2024-10-20 18:12:43 +0800 CST

我是否正确使用了 SKIP_FUNCTION_MACROS？

  • 772

阅读完 Doxygen文档后，我预计设置 ENABLE_PREPROCESSING = YES并SKIP_FUNCTION_MACROS = YES在我的 Doxygen 配置文件中不会引用以下 C MACRO。

/*! \file test_skip_macro_doxygen.h
 */
/*!
 * \brief DOXYGENIGNORESME
 */
#define DOXYGENIGNORESME(a) (do {} while 0)

尽管如此，Doxygen 还是在“宏”部分发布了文档并提供了对它的引用。Doxygen 版本：1.9.1。

我错在什么地方？

doxygen

1 个回答

  1. Best Answer

    根据文档SKIP_FUNCTION_MACROS（参见： https: //www.doxygen.nl/manual/config.html#cfg_skip_function_macros）：

    如果SKIP_FUNCTION_MACROS将标签设置为，YES则 Doxygen 的预处理器将删除所有对函数类宏的引用，这些宏单独占一行、名称全部大写且不以分号结尾。此类函数宏通常用于样板代码，如果不删除，会使解析器感到困惑。

    换句话说，删除的是代码中的引用，而不是宏本身。

    要跳过符号：（EXCLUDE_SYMBOLS参见： https: //www.doxygen.nl/manual/config.html#cfg_exclude_symbols）：

    标签EXCLUDE_SYMBOLS可用于指定应从输出中排除的一个或多个符号名称（命名空间、类、函数等）。符号名称可以是完全限定名称、单词，或者如果使用通配符 *，则是子字符串。示​​例：ANamespace、、、AClassANamespace::AClassANamespace::*Test

    因此在这种情况下：EXCLUDE_SYMBOLS = DOXYGENIGNORESME

    无论宏是否已记录，均可独立编辑。

    • 0

相关问题