有A班:
class A {
public:
/// @brief constructor taking no param
A() {}
/// @brief constructor taking 1 param
/// @param[in] x x
A(int x) {}
/// @brief constructor taking 2 params
/// @param[in] x x
/// @param[in] x y
A(int x, int y) {}
};
使用Doxygen生成文档后,“构造函数和析构函数文档”部分将包含构造函数A(int x)
和A(int x, int y)
的文档。但是不适用于A()
。
我可以设置任何标志来强制Doxygen在类文档的相关部分中包含A()
的构造函数吗?
编辑:我不得不编辑我的原始代码,因为默认情况下,该代码是否已记录在“构造函数和析构函数文档”部分中,而这取决于@param
。
[方法等]在没有详细文档(或参数文档等)的情况下,默认未在“构造函数和析构函数文档”之类的详细部分显示。通过设置:ALWAYS_DETAILED_SEC=YES
您还将获得“缺少的”构造函数。
请注意,例如REPEAT_BRIEF
。
已记录的构造函数具有非简短的文档内容。因此,该构造函数没有自己的文档块。它会出现在简短列表中,但不会出现在完整列表中。
所以您应该给构造函数一些简短的内容。