CODEWITHSUNDEEP
c++c++11doxygen
SecretIndividual
SecretIndividual

Reputation: 2519

How to show the default constructor in Doxygen generated documentation?

Having a class 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) {}
};

After generating documentation using Doxygen the "Constructor & Destructor Documentation" section will contain the documentation for constructors A(int x) and A(int x, int y). However not for A().

Is there any flag I can set to force Doxygen to include the constructor for A() in the relevant section of the class documentation?

Edit: I had to edit my original code as it seems to depend on having a @param whether the code is documented in the "Constructor & Destructor Documentation" section by default.

The output by Doxygen version 1.8.16: enter image description here

Upvotes: 2

Views: 1565

Answers (3)

Lightness Races in Orbit
Lightness Races in Orbit

Reputation: 385174

From the documentation:

ALWAYS_DETAILED_SEC

If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then doxygen will generate a detailed section even if there is only a brief description.

The default value is: NO.

As such, you should find the ctor listed up top; it just doesn't get its own "detailed" description by default, because there are no details to give.

Upvotes: 2

Nicol Bolas
Nicol Bolas

Reputation: 473447

The documented constructor has non non-brief documentation content. As such, that constructor doesn't get its own block of documentation. It will appear in the brief listing, but not in the full listing.

So you should give the constructor some non-brief content.

Upvotes: 1

albert
albert

Reputation: 9057

A method etc. is not shown by default in the detailed section like 'Constructor & Destructor Documentation' when there is no detailed documentation (or parameter documentation etc.). By setting: ALWAYS_DETAILED_SEC=YES you will get also the "missing" constructor.

Note have also a look at e.g. REPEAT_BRIEF.

Upvotes: 4

Related Questions