C++ 如何在Doxygen生成的文档中显示默认构造函数?
拥有甲级:C++ 如何在Doxygen生成的文档中显示默认构造函数?,c++,c++11,doxygen,C++,C++11,Doxygen,拥有甲级: 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] y y
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] y y
A(int x, int y) {}
};
使用Doxygen生成文档后,“构造函数和析构函数文档”部分将包含构造函数的文档A(int x)
和A(int x,int y)
。但是不适用于A()
我是否可以设置任何标志来强制Doxygen在类文档的相关部分中包含A()
的构造函数
编辑:我必须编辑我的原始代码,因为这似乎取决于默认情况下是否在“构造函数和析构函数文档”部分记录了代码
Doxygen版本1.8.16的输出:
如果没有详细的文档(或参数文档等),则默认情况下,在“构造函数和析构函数文档”等详细部分中不会显示方法等。通过设置:
始终\u详细\u秒=是
您还将获得“缺少”构造函数
注:还可以查看例如
REPEAT_-BRIEF
记录的构造函数具有非简短的文档内容。因此,该构造函数没有自己的文档块。它将出现在简要列表中,但不会出现在完整列表中
因此,您应该为构造函数提供一些非简短的内容。来源:
始终详细\u秒
如果ALWAYS\u DETAILED\u SEC
和REPEAT\u BRIEF
标记都设置为YES
,则即使只有简要说明,doxygen也会生成详细部分
默认值为:NO
因此,您应该发现列在顶部的CTR;默认情况下,它没有自己的“详细”描述,因为没有详细信息可提供。听起来不太对。为什么它会跳过这个?你能给我一张截图吗?您确定添加构造函数后已重建了文档吗?相关信息还有:您使用的是哪个doxygen版本?@LightnessRaceswithMonica我发布了一个屏幕并进行了小编辑。有点接近原因,因为我似乎必须至少添加一个\@param才能显示构造函数。顶部呢?可能您正在查看的部分只列出了带有参数的内容。请注意,由于复制/粘贴,您记录了
x
两次`并且没有注释y
,配置该工具可能比在没有保证的文档中进行黑客攻击更好,以便解决问题configuration@LightnessRaceswithMonica我同意这一点。例如,向其添加@param以强制将其列出是错误的。这看起来确实有效,但不是首选解决方案(至少不是我的)。@LightnessRaces:这取决于您是否将其视为“坏配置”。没有非简要内容的文档实体不需要详细条目,因为。。。它不够复杂,不需要一个。如果一行程序足以解释功能,那么当简要文档中出现一行程序时,为什么需要一大块文本?@Nicolas Grant-用“此特定OP不需要的配置”替换“错误配置”: