Comment Syntax

Supported Doxygen Comment Styles

We’re supporting the following Doxygen comment styles (see also Doxygen: Comment Blocks for C-Style Languages).

Triple-Slashes

/// @brief brings the unicorns back
///
/// It does that with an extraordinary special top secret device of extraterrestrial origin.
void bring_the_unicorns_back();

Javadoc

/**
 * @brief brings the unicorns back
 *
 * It does that with an extraordinary special top secret device of extraterrestrial origin.
 */
void bring_the_unicorns_back();

or

/**
  @brief brings the unicorns back

  It does that with an extraordinary special top secret device of extraterrestrial origin.
 */
void bring_the_unicorns_back();

Qt

/*!
 * @brief brings the unicorns back
 *
 * It does that with an extraordinary special top secret device of extraterrestrial origin.
 */
void bring_the_unicorns_back();

or

/*!
  @brief brings the unicorns back

  It does that with an extraordinary special top secret device of extraterrestrial origin.
 */
void bring_the_unicorns_back();

Double-Slashes-With-Exclamation-Marks

//! @brief brings the unicorns back
//!
//! It does that with an extraordinary special top secret device of extraterrestrial origin.
void bring_the_unicorns_back();