如何在doxygen中记录生成的构造函数

时间:2011-02-23 13:16:08

标签: c++ doxygen

我们使用doxygen来记录我们的课程。我想明确记录一个类已生成构造函数和/或析构函数,以表明我已经考虑过它并决定例如使用生成的复制构造函数进行复制是安全的。但是,没有声明构造函数/析构函数,因此doxygen不知道文档属于哪个函数。有没有办法让doxygen包括函数注释,即使函数从未被声明?

//! The Foo class documentation
class Foo {
    //! @fn Foo(const Foo&) 
    //! Generated copy constructor OK to use

    //! method documentation
    void method();
}

此外,我根本不想写生成文件的签名。

我想我的另一个选择就是在类标题中描述它。还有其他方法吗?

1 个答案:

答案 0 :(得分:1)

如果使用C ++ 0x中引入的= default默认值作为默认生成的构造函数,doxygen应该选择它们

http://www2.research.att.com/~bs/C++0xFAQ.html#default

我不知道doxygen是否实现了C ++ 0x新的关键字和模式,但是