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

标签 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();
}

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

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

最佳答案

如果您对默认生成的构造函数使用 C++0x 中引入的 = default 概念,doxygen 应该会使用它们

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

虽然我不知道 doxygen 是否已经实现了 C++0x 新的关键字和模式

关于c++ - 如何在 doxygen 中记录生成的构造函数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/5091398/

相关文章:

C++抽象模板类

c++ - boost::variant - 为什么模板参数的优先级高于 const 字符串参数

c++ - 为什么仅当我的容器包含32个以上元素时,std::sort才会调用swap?

doxygen - 从依赖图中排除特定标题

Doxygen:如何仅使用其文档 block 而不是代码来记录非 C 函数?

c++ - C++ 标准中的条件变量与互斥锁

python - 如何使用 doxygen 为所有 python 文件创建文档(和调用图)

c - 如何记录未定义的预编译标志

c++ - 正确使用Doxygen

c++ - vector.push_back()在推送线程时(在编译过程中)产生已删除的函数错误