Doxygen：剥离顶级命名空间

Question

使用库 ABC 时，很自然地，所有名称都包含在同一顶级命名空间中。是否可以从 class 名称中删除顶级 namespace，但显示封闭的 namespace？

Answer 1

Doxygen 内部没有这样的选项。您仍然可以使用预处理器来使其工作。

#ifndef DOXY_PARSER
    #define LIB_NAMESPACE_STARTS namespace lib_namespace { /##/
    #define LIB_NAMESPACE_ENDS } /##/
    #define LIB_NAMESPACE lib_namespace
#else
    #define LIB_NAMESPACE_STARTS /##/
    #define LIB_NAMESPACE_ENDS /##/
    #define LIB_NAMESPACE
#endif

您应该将此代码包含到一些公共标头中，并在 Doxygen 选项中设置预定义的 DOXY_PARSER 宏。此解决方法使库名称空间的使用不太方便，但并不是那么重要。

LIB_NAMESPACE_STARTS();
    namespace internal_namespace {
        struct Trololo {};
    }
    LIB_NAMESPACE::internal_namespace::Trololo T;
LIB_NAMESPACE_ENDS();

Answer 2

之前的解决方案有一个普遍的问题，在使用Qt时无效。 moc'ing 进程不使用预处理器，并且不使用命名空间（导致编译时错误）。

一种可能的解决方案是使用#define QT_NAMESPACE lib_namespace，但它会将整个 Qt 移动到该命名空间。

下一个解决方案更通用（为了方便起见，我保留了宏名称）：

#ifndef DOXY_PARSER
    #define LIB_NAMESPACE lib_namespace
    #define LIB_NAMESPACE_STARTS namespace LIB_NAMESPACE { /##/
    #if (defined MOCED_FILE)
        #define LIB_NAMESPACE_ENDS } using namespace LIB_NAMESPACE; /##/
    #else
        #define LIB_NAMESPACE_ENDS } /##/
    #endif
    #define USING_LIB_NAMESPACE using namespace LIB_NAMESPACE; /##/
#else
    #define LIB_NAMESPACE_STARTS /##/
    #define LIB_NAMESPACE_ENDS /##/
    #define LIB_NAMESPACE
    #define USING_LIB_NAMESPACE /##/
#endif

其中 MOCED_FILE 是 mocs 专用的定义。如果您使用 CMake，则可以使用以下方式指定此类选项：

QT4_WRAP_CPP(mocSources qt_file1.h qt_file2.h)
SET_SOURCE_FILES_PROPERTIES(${mocSources} PROPERTIES COMPILE_FLAGS "-DMOCED_FILE")