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

问题描述 投票:1回答:2

有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

Doxygen版本1.8.16的输出:enter image description here

c++ c++11 doxygen
2个回答
1
投票

[方法等]在没有详细文档(或参数文档等)的情况下,默认未在“构造函数和析构函数文档”之类的详细部分显示。通过设置:ALWAYS_DETAILED_SEC=YES您还将获得“缺少的”构造函数。

请注意,例如REPEAT_BRIEF


0
投票

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

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

© www.soinside.com 2019 - 2024. All rights reserved.