CODEWITHSUNDEEP
doxygencode-documentation
Zachary Kraus
Zachary Kraus

Reputation: 1101

Can different styles be read by Doxygen

Can Both Style of comments below be read by Doyxgen?

The Doxy Block Comments are in this format:

/**
* \brief
* \param
* \return
*/

and the ones in the libstdc++ are in this format:

/**
* @brief
* @param
* @return
*/

Upvotes: 0

Views: 160

Answers (2)

Zachary Kraus
Zachary Kraus

Reputation: 1101

I finally was able to test both methods in the original question and they both work. Also the additional method posted in one of the answers works as well. If you have other methods that work please add them. Thank you everybody for the advice.

Oh and by the way if you are using codeblocks. The software does not come with doxygen pre-installed. You have to install it to use the doxyblocks features.

Upvotes: 0

Ye Wang
Ye Wang

Reputation: 43

I think the correct formats are like:

/*!
  \brief
  \param
  \return
*/

and

/**
 * @brief
 * @param
 * @return
 */

Mixed style couldn't work.

Upvotes: 1

Related Questions