Outils pour utilisateurs

Outils du site


Panneau latéral

Tips

Divers

Projets

Ham Radio

Machines

Research

Privé

Études

tips:doxygencheatsheet

Ceci est une ancienne révision du document !


Doxygen Cheatsheet

Adapted from [1].

File header

/** \file file.ext
 * Description of the file
 *
 * \author Olivier Mehani <shtrom-...@ssji.net>
 * \version 1.0
 * \date 1999
 * \bug A known bug
 */

Function

/**
 * 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 first Description of first param
 * \param 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]
 */

References

- Wincent Colaiuta. “Doxygen cheatsheet.” Online: https://wincent.com/wiki/Doxygen_cheatsheet

tips/doxygencheatsheet.1334021720.txt.gz · Dernière modification: 2013-11-15 05:04 (modification externe)