Doxygen documentation after members and XML commands

Question

I am trying to get the best out of doxygen and IntelliSense, and found the XML commands to be a pretty good win here: documentation get generated on one hand, while it appears during completion on the other hand.

One of the catches though, is the inline documentation after members.

The doxygen manual mentions only one way to have documentation after members: ///<. Unfortunately it clashes with Visual Studio's, as illustrated here:

enum
{
    A, ///< Doxygen understands this, but IntelliSense is oblivious to it.
    B, ///  <summary>IntelliSense understands this, but Doxygen applies it to the wrong member.</summary>
    C, ///< <summary>Doxygen understand this, but IntelliSense considers it to be invalid XML.</summary>
};

Is there a way to write documentation after members in XML in a way that is understood correctly by both Doxygen and Visual Studio, or should I fall back on commenting on the preceding line?

Lukas · Accepted Answer · 2019-11-19 08:32:31Z

1

It's not exactly pretty, but you can use //!< instead. That way Visual Studio won't try to parse the comment as XML.

As mentioned in the linked doxygen documentation:

Most often one only wants to put a brief description after a member. This is done as follows:

int var; //!< Brief description after the member

or

int var; ///< Brief description after the member

answered Nov 19, 2019 at 8:32

Lukas

2,7082 gold badges21 silver badges36 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Doxygen documentation after members and XML commands

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related