Special Commands
Introduction
All commands in the documentation start with a backslash (\) or an at-sign (@). If you prefer you can replace all commands starting with a backslash below by their counterparts that start with an at-sign.
Introduction
All commands in the documentation start with a backslash (\) or an at-sign (@). If you prefer you can replace all commands starting with a backslash below by their counterparts that start with an at-sign.
Some commands have one or more arguments. Each argument has a certain range:
If <sharp> braces are used the argument is a single word.
If (round) braces are used the argument extends until the end of the line on which the command was found.
If {curly} braces are used the argument extends until the next paragraph. Paragraphs are delimited by a blank line or by a section indicator.
If [square] brackets are used the argument is optional.
If <sharp> braces are used the argument is a single word.
If (round) braces are used the argument extends until the end of the line on which the command was found.
If {curly} braces are used the argument extends until the next paragraph. Paragraphs are delimited by a blank line or by a section indicator.
If [square] brackets are used the argument is optional.
Here is an alphabetically sorted list of all commands with references to their documentation:
\a
\addindex
\addtogroup
\anchor
\arg
\attention
\author
\b
\brief
\bug
\c
\callgraph
\callergraph
\category
\class
\code
\cond
\copydoc
\date
\def
\defgroup
\deprecated
\dir
\dontinclude
\dot
\dotfile
\e
\else
\elseif
\em
\endcode
\endcond
\enddot
\endhtmlonly
\endif
\endlatexonly
\endlink
\endmanonly
\endverbatim
\endxmlonly
\enum
\example
\exception
\f$
\f[
\f]
\file
\fn
\hideinitializer
\htmlinclude
\htmlonly
\if
\ifnot
\image
\include
\includelineno
\ingroup
\internal
\invariant
\interface
\latexonly
\li
\line
\link
\mainpage
\manonly
\n
\name
\namespace
\nosubgrouping
\note
\overload
\p
\package
\page
\par
\paragraph
\param
\post
\pre
\private (PHP only)
\privatesection (PHP only)
\property
\protected (PHP only)
\protectedsection (PHP only)
\protocol
\public (PHP only)
\publicsection (PHP only)
\ref
\relates
\relatesalso
\remarks
\return
\retval
\sa
\section
\see
\showinitializer
\since
\skip
\skipline
\struct
\subpage
\subsection
\subsubsection
\test
\throw
\todo
\typedef
\union
\until
\var
\verbatim
\verbinclude
\version
\warning
\weakgroup
\xmlonly
\xrefitem
\$
\@
\\
\&
\~
\<
\>
\#
\%
\a
\addindex
\addtogroup
\anchor
\arg
\attention
\author
\b
\brief
\bug
\c
\callgraph
\callergraph
\category
\class
\code
\cond
\copydoc
\date
\def
\defgroup
\deprecated
\dir
\dontinclude
\dot
\dotfile
\e
\else
\elseif
\em
\endcode
\endcond
\enddot
\endhtmlonly
\endif
\endlatexonly
\endlink
\endmanonly
\endverbatim
\endxmlonly
\enum
\example
\exception
\f$
\f[
\f]
\file
\fn
\hideinitializer
\htmlinclude
\htmlonly
\if
\ifnot
\image
\include
\includelineno
\ingroup
\internal
\invariant
\interface
\latexonly
\li
\line
\link
\mainpage
\manonly
\n
\name
\namespace
\nosubgrouping
\note
\overload
\p
\package
\page
\par
\paragraph
\param
\post
\pre
\private (PHP only)
\privatesection (PHP only)
\property
\protected (PHP only)
\protectedsection (PHP only)
\protocol
\public (PHP only)
\publicsection (PHP only)
\ref
\relates
\relatesalso
\remarks
\return
\retval
\sa
\section
\see
\showinitializer
\since
\skip
\skipline
\struct
\subpage
\subsection
\subsubsection
\test
\throw
\todo
\typedef
\union
\until
\var
\verbatim
\verbinclude
\version
\warning
\weakgroup
\xmlonly
\xrefitem
\$
\@
\\
\&
\~
\<
\>
\#
\%
The following subsections provide a list of all commands that are recognized by doxygen. Unrecognized commands are treated as normal text.
No comments:
Post a Comment