Outils d'utilisateurs

Outils du Site


Sidebar

Tips

Divers

Projets

Machines

Research

Privé

Études

tips:doxygencheatsheet

Doxygen Cheatsheet

A quick cheatsheet for Doxygen, 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[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]
 */

References

  1. Wincent Colaiuta. “Doxygen cheatsheet.” Online: https://wincent.com/wiki/Doxygen_cheatsheet
  2. Doxygen. “Documenting the code.” Online: http://www.stack.nl/~dimitri/doxygen/docblocks.html
  3. Doxygen. “Special Commands.” http://www.stack.nl/~dimitri/doxygen/commands.html
tips/doxygencheatsheet.txt · Dernière modification: 2013/11/15 05:06 (modification externe)