diff options
Diffstat (limited to 'doc/commands.doc')
-rw-r--r-- | doc/commands.doc | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index c715160..4618000 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -74,6 +74,7 @@ documentation: <li> \refitem cmdfbrclose \f] <li> \refitem cmdfile \file <li> \refitem cmdfn \fn +<li> \refitem cmdhideinitializer \hideinitializer <li> \refitem cmdhtmlonly \htmlonly <li> \refitem cmdif \if <li> \refitem cmdimage \image @@ -100,11 +101,13 @@ documentation: <li> \refitem cmdretval \retval <li> \refitem cmdsa \sa <li> \refitem cmdsection \section +<li> \refitem cmdshowinitializer \showinitializer <li> \refitem cmdskip \skip <li> \refitem cmdskipline \skipline <li> \refitem cmdstruct \struct <li> \refitem cmdsubsection \subsection <li> \refitem cmdthrow \throw +<li> \refitem cmdtodo \todo <li> \refitem cmdtypedef \typedef <li> \refitem cmdunion \union <li> \refitem cmduntil \until @@ -301,6 +304,17 @@ Doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef". <hr> +\subsection cmdhideinitializer \hideinitializer + + \addindex \hideinitializer + By default the value of a define and the initializer of a variable + are displayed unless they are longer than 30 lines. By putting + this command in a comment block of a define or variable, the + initializer always hidden. + + \sa section \ref cmdshowinitializer "\\showinitializer". + +<hr> \subsection cmdingroup \ingroup (<groupname> [<groupname> <groupname>]) \addindex \ingroup @@ -453,6 +467,17 @@ Public/Protected/Private/... section. \endhtmlonly <hr> +\subsection cmdshowinitializer \showinitializer + + \addindex \showinitializer + By default the value of a define and the initializer of a variable + are only displayed if they are less than 30 lines long. By putting + this command in a comment block of a define or variable, the + initializer is shown unconditionally. + + \sa section \ref cmdhideinitializer "\\hideinitializer". + +<hr> \subsection cmdstruct \struct <name> [<header-file>] [<header-name>] \addindex \struct @@ -758,6 +783,13 @@ Public/Protected/Private/... section. the tag \\throws is a synonym for this tag. <hr> +\subsection cmdtodo \todo ( one line todo description ) + + \addindex \todo + Adds a TODO item to the documentation. The item will also be added + to a TODO list. Both instances of the item will be cross-referenced. + +<hr> \subsection cmdversion \version { version number } \addindex \version |