A quick cheatsheet for Doxygen, adapted from [1].
/** \file file.ext
* Description of the file
*
* \author Olivier Mehani <shtrom-...@ssji.net>
* \version 1.0
* \date 1999
* \bug A known bug
*/
/**
* Brief (one-line) description of method
*
* Extended description (may extend over several lines).
*
* \code
* NSString *example = \"example string!";
* \endcode
*
* We can also use lists.
*
* - item 1
* - item 2
*
* \param[in,out] first Description of first param
* \param[in] second Description of second param
* \return Description of returned value
* \exception e Description of e
* \warning Bad things can happen
* \note Using on your birthday will provide a bonus
* \see [name-list]
*/