Conventions

<> single word
() line
{} paragraph

@a argument (italics)
@b bold
@c code
@e emphasize (italics)
@p code
\n newline

Characters that may need to be escaped with backslash:

\@&$#<>%"
::

<b> bold
<em> emphasize (italics)
<tt> code

/// -     unordered list item
/// -#    ordered list item
/// <ul>  unordered list
/// <ol>  ordered list
/// <li>  list item

/// @arg {item-description}
/// @li {item-description}

Filesystem

/// @dir [<path-fragment>]
/// @file

Examples

/// @code
/// @endcode

/// @example <filename>

/// @snippet <filename> (block_id)
/// [block_id]

/// @include <filename>
/// @includelineno <filename>
/// @dontinclude <filename>
/// @line (pattern)
/// @skip (pattern)
/// @skipline (pattern)
/// @until (pattern)

/// @verbatim
/// @endverbatim

/// @verbinclude <filename>
/// @htmlinclude <filename>

Graphics

/// @image <format> <file> ["caption"] [<sizeindication>=<size>]
/// @callgraph
/// @callergraph

/// @dot
/// dot commands (clickable: URL="@ref <label>")
/// @enddot

/// @dotfile <file> ["caption"]

/// @msc
/// mscgen commands (clickable: URL="@ref <label>")
/// @endmsc

/// @mscfile <file> ["caption"]

Section Indicators

/// @par [(paragraph title)] {text}

/// @brief {text}
/// @details {text}

/// @author {text}
/// @copyright {text}
/// @date {text}
/// @version {text}

/// @pre {text}
/// @invariant {text}
/// @post {text}

/// @see {references}

/// @todo {text}
/// @bug {text}
/// @test {text}

/// @attention {text}
/// @remark {text}
/// @note {text}
/// @warning {text}

/// @since {text}
/// @deprecated {text}

/// @param [(dir)] <parameter-name> {text}
/// @tparam <template-parameter-name> {text}
/// @return {text}
/// @retval <return value> {text}
/// @throw <exception-object> {text}

/// @copydoc <link-object>
/// More information...

/// @copybrief <link-object>
/// @copydetails <link-object>

Links

/// @addindex (text)
/// @anchor <word>
/// @cite <label>

/// @link <link-object>
/// @endlink

Conditional

/// @cond [<section-label>]
/// @endcond

/// @if <section-label>
/// @ifnot <section-label>
/// @elseif <section-label>
/// @else
/// @endif

Grouping

/// @defgroup <label> ["<(title)>"]
/// @name <label>
/// @addtogroup <label> [(title)]
/// @ingroup <label>
/// @{
/// @}
/// @ref <label> ["(title)"]
/// @nosubgrouping

/// @mainpage (title)
/// @page <label> (title)
/// @subpage <label> ["(title)"]
/// @section <label> (title)
/// @subsection <label> (title)
/// @subsubsection <label> (title)
/// @paragraph <label> (title)

Formulas

/// The distance between @f$(x_1,y_1)@f$ is:
/// @f[
///   \sqrt{(x_2-x_1)^2+(y_2-y_1)^2}
/// @f]

/// @f{eqnarray*}{
/// LATEX equation stuff goes here.
/// @f}

Output Filters

/// @htmlonly
/// @latexonly
/// @manonly
/// @rtfonly
/// @xmlonly