如何在Doxygen生成的文档中显示默认构造函数？

2024-05-18 • 问答

具有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] y y
    A(int x,int y) {}
};

在使用Doxygen生成文档后，“构造函数和析构函数文档”部分将包含构造函数A(int x)和A(int x,int y)的文档。但是不适用于A()。

我可以设置任何标志来强制Doxygen在类文档的相关部分中包含A()的构造函数吗？

编辑：我不得不编辑原始代码，因为默认情况下，似乎取决于是否有@param该代码是否记录在“构造函数和析构函数文档”部分中。 / p>

Doxygen版本1.8.16的输出：

当没有详细的文档（或参数文档等）时，默认情况下在“构造函数和析构函数文档”等详细部分中未显示方法等。通过设置： ALWAYS_DETAILED_SEC=YES 您还将获得“缺失的”构造函数。

请注意例如REPEAT_BRIEF。

来自the documentation：

ALWAYS_DETAILED_SEC

如果ALWAYS_DETAILED_SEC和REPEAT_BRIEF标签都设置为YES，那么doxygen会生成一个详细的部分，即使只有简短的描述。

默认值为：NO。

这样，您应该找到顶部列出的ctor；默认情况下，它只是没有自己的“详细”描述，因为没有详细信息可提供。

记录的构造函数具有非简短的文档内容。因此，该构造函数没有自己的文档块。它会显示在简短列表中，但不会出现在完整列表中。

所以您应该给构造函数一些简短的内容。

如何在Doxygen生成的文档中显示默认构造函数？

chenmin1258 回答：如何在Doxygen生成的文档中显示默认构造函数？

大家都在问