Doxygen

Reference

• https://www.stack.nl/~dimitri/doxygen/manual/

Reference

One-liner

Documentation block are usually added before the item to document. Use /** ... */ or ///:

/** Brief description which ends at this dot. Details follow
 *  here.
 */
uint8_t my_int;

/// Brief description which ends at this dot. Details follow
/// here.
uint8_t my_other_int;

Documentation can also be added after members.

int var; /*!< Detailed description after the member */ 

int var; /**< Detailed description after the member */

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

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

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

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

Tips

Link to Main Page

Use /ref index [1]:

/**
 * See \ref index.
 */