在不同的命名空间中记录函数

时间:2013-12-30 15:07:50

标签: c++ doxygen

我有一个在名为implementation的命名空间中实现并记录的函数。我有另一个名称空间useful,我使用using来公开该函数。我不想记录implementation命名空间。我想要在useful命名空间下记录该函数。我在doxygen中寻找一种简单的方法。

以下是我希望useful_function文档位于namespace useful下的简单示例。现在,它位于namespace implementation

之下
/// \file test.cpp
/// \brief This is a brief description.
///
///
/// This is a longer description

namespace implementation{

    /// This is a useful function
    void useful_function(){}
}

namespace useful{

    using implementation::useful_function;
}

/// \namespace useful
/// This is a namespace that has useful functions


int main(int argc, char** argv){
    useful::useful_function();
}

1 个答案:

答案 0 :(得分:1)

useful_function位于名称空间implementation中,因此应该记录在其中。

using声明并未改变这一基本事实。