/******************************************************************************

 *

 *

 *

 * Copyright (C) 1997-2015 by Dimitri van Heesch.

 *

 * Permission to use, copy, modify, and distribute this software and its

 * documentation under the terms of the GNU General Public License is hereby

 * granted. No representations are made about the suitability of this software

 * for any purpose. It is provided "as is" without express or implied warranty.

 * See the GNU General Public License for more details.

 *

 * Documents produced by Doxygen are derivative works derived from the

 * input used in their production; they are not affected by this license.

 *

 */

/*! \page commands Special Commands

\section cmd_intro 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 in addition to the above argument specifiers [square] brackets are used the argument is optional.

Here is an alphabetically sorted list of all commands with references to their

documentation:

\anchor showsecreflist

\secreflist

\refitem cmda \\a

\refitem cmdaddindex \\addindex

\refitem cmdaddtogroup \\addtogroup

\refitem cmdanchor \\anchor

\refitem cmdarg \\arg

\refitem cmdattention \\attention

\refitem cmdauthor \\author

\refitem cmdauthors \\authors

\refitem cmdb \\b

\refitem cmdbrief \\brief

\refitem cmdbug \\bug

\refitem cmdc \\c

\refitem cmdcallergraph \\callergraph

\refitem cmdcallgraph \\callgraph

\refitem cmdcategory \\category

\refitem cmdcite \\cite

\refitem cmdclass \\class

\refitem cmdcode \\code

\refitem cmdcond \\cond

\refitem cmdcopybrief \\copybrief

\refitem cmdcopydetails \\copydetails

\refitem cmdcopydoc \\copydoc

\refitem cmdcopyright \\copyright

\refitem cmddate \\date

\refitem cmddef \\def

\refitem cmddefgroup \\defgroup

\refitem cmddeprecated \\deprecated

\refitem cmddetails \\details

\refitem cmddiafile \\diafile

\refitem cmddir \\dir

\refitem cmddocbookonly \\docbookonly

\refitem cmddontinclude \\dontinclude

\refitem cmddot \\dot

\refitem cmddotfile \\dotfile

\refitem cmde \\e

\refitem cmdelse \\else

\refitem cmdelseif \\elseif

\refitem cmdem \\em

\refitem cmdendcode \\endcode

\refitem cmdendcond \\endcond

\refitem cmdenddocbookonly \\enddocbookonly

\refitem cmdenddot \\enddot

\refitem cmdendhtmlonly \\endhtmlonly

\refitem cmdendif \\endif

\refitem cmdendinternal \\endinternal

\refitem cmdendlatexonly \\endlatexonly

\refitem cmdendlink \\endlink

\refitem cmdendmanonly \\endmanonly

\refitem cmdendmsc \\endmsc

\refitem cmdendparblock \\endparblock

\refitem cmdendrtfonly \\endrtfonly

\refitem cmdendsecreflist \\endsecreflist

\refitem cmdendverbatim \\endverbatim

\refitem cmdenduml \\enduml

\refitem cmdendxmlonly \\endxmlonly

\refitem cmdenum \\enum

\refitem cmdexample \\example

\refitem cmdexception \\exception

\refitem cmdextends \\extends

\refitem cmdfdollar \\f\$

\refitem cmdfbropen \\f[

\refitem cmdfbrclose \\f]

\refitem cmdfcurlyopen \\f{

\refitem cmdfcurlyclose \\f}

\refitem cmdfile \\file

\refitem cmdfn \\fn

\refitem cmdheaderfile \\headerfile

\refitem cmdhidecallergraph \\hidecallergraph

\refitem cmdhidecallgraph \\hidecallgraph

\refitem cmdhideinitializer \\hideinitializer

\refitem cmdhtmlinclude \\htmlinclude

\refitem cmdhtmlonly \\htmlonly

\refitem cmdidlexcept \\idlexcept 

\refitem cmdif \\if

\refitem cmdifnot \\ifnot

\refitem cmdimage \\image

\refitem cmdimplements \\implements

\refitem cmdinclude \\include

\refitem cmdincludedoc \\includedoc

\refitem cmdincludelineno \\includelineno

\refitem cmdingroup \\ingroup

\refitem cmdinternal \\internal

\refitem cmdinvariant \\invariant

\refitem cmdinterface \\interface

\refitem cmdlatexinclude \\latexinclude

\refitem cmdlatexonly \\latexonly

\refitem cmdli \\li

\refitem cmdline \\line

\refitem cmdlink \\link

\refitem cmdmainpage \\mainpage

\refitem cmdmanonly \\manonly

\refitem cmdmemberof \\memberof

\refitem cmdmsc \\msc

\refitem cmdmscfile \\mscfile

\refitem cmdn \\n

\refitem cmdname \\name

\refitem cmdnamespace \\namespace

\refitem cmdnosubgrouping \\nosubgrouping

\refitem cmdnote \\note

\refitem cmdoverload \\overload

\refitem cmdp \\p

\refitem cmdpackage \\package

\refitem cmdpage \\page

\refitem cmdpar \\par

\refitem cmdparagraph \\paragraph

\refitem cmdparam \\param

\refitem cmdparblock \\parblock

\refitem cmdpost \\post

\refitem cmdpre \\pre

\refitem cmdprivate \\private

\refitem cmdprivatesection \\privatesection

\refitem cmdproperty \\property

\refitem cmdprotected \\protected

\refitem cmdprotectedsection \\protectedsection

\refitem cmdprotocol \\protocol

\refitem cmdpublic \\public

\refitem cmdpublicsection \\publicsection

\refitem cmdpure \\pure

\refitem cmdref \\ref

\refitem cmdrefitem \\refitem

\refitem cmdrelated \\related

\refitem cmdrelates \\relates

\refitem cmdrelatedalso \\relatedalso

\refitem cmdrelatesalso \\relatesalso

\refitem cmdremark \\remark

\refitem cmdremarks \\remarks

\refitem cmdresult \\result

\refitem cmdreturn \\return

\refitem cmdreturns \\returns

\refitem cmdretval \\retval

\refitem cmdrtfonly \\rtfonly

\refitem cmdsa \\sa

\refitem cmdsecreflist \\secreflist

\refitem cmdsection \\section

\refitem cmdsee \\see

\refitem cmdshort \\short

\refitem cmdshowinitializer \\showinitializer

\refitem cmdsince \\since

\refitem cmdskip \\skip

\refitem cmdskipline \\skipline

\refitem cmdsnippet \\snippet

\refitem cmdsnippetdoc \\snippetdoc

\refitem cmdsnippetlineno \\snippetlineno

\refitem cmdstartuml \\startuml

\refitem cmdstruct \\struct

\refitem cmdsubpage \\subpage

\refitem cmdsubsection \\subsection

\refitem cmdsubsubsection \\subsubsection

\refitem cmdtableofcontents \\tableofcontents

\refitem cmdtest \\test

\refitem cmdthrow \\throw

\refitem cmdthrows \\throws

\refitem cmdtodo \\todo

\refitem cmdtparam \\tparam

\refitem cmdtypedef \\typedef

\refitem cmdunion \\union

\refitem cmduntil \\until

\refitem cmdvar \\var

\refitem cmdverbatim \\verbatim

\refitem cmdverbinclude \\verbinclude

\refitem cmdversion \\version

\refitem cmdvhdlflow \\vhdlflow

\refitem cmdwarning \\warning

\refitem cmdweakgroup \\weakgroup

\refitem cmdxmlonly \\xmlonly

\refitem cmdxrefitem \\xrefitem

\refitem cmddollar \\\$

\refitem cmdat \\\@

\refitem cmdbackslash \\\\

\refitem cmdamp \\\&

\refitem cmdtilde \\~

\refitem cmdlt \\\<

\refitem cmdgt \\\>

\refitem cmdhash \\\#

\refitem cmdperc \\\%

\refitem cmdquot \\\"

\refitem cmdchardot \\\.

\refitem cmddcolon \::

\refitem cmdpipe \\|

\refitem cmdndash \\\--

\refitem cmdmdash \\\---

\endsecreflist

The following subsections provide a list of all commands that are recognized by

doxygen. Unrecognized commands are treated as normal text.

\htmlonly
<center>
\endhtmlonly

\htmlonly --- \endhtmlonly

Structural indicators

\htmlonly --- \endhtmlonly

\htmlonly
</center>
\endhtmlonly

\section cmdaddtogroup \\addtogroup <name> [(title)]

  \addindex \\addtogroup

  Defines a group just like \ref cmddefgroup "\\defgroup", but in contrast to

  that command using the same \<name\> more than once will not result in a warning,

  but rather one group with a merged documentation and the first title found in

  any of the commands.

  The title is optional, so this command can also be used to add a number of

  entities to an existing group using \c \@{ and \c \@} like this:

\verbatim

  /*! \addtogroup mygrp

   *  Additional documentation for group 'mygrp'

   *  @{

   */

  /*!

   *  A function

   */

  void func1()

  {

  }

  /*! Another function */

  void func2()

  {

  }

  /*! @} */

\endverbatim

  \sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup", \ref cmdingroup "\\ingroup", and

  \ref cmdweakgroup "\\weakgroup".

\section cmdcallgraph \\callgraph

  \addindex \\callgraph

  When this command is put in a comment block of a function or method

  and \ref cfg_have_dot "HAVE_DOT" is set to \c YES, then doxygen will

  generate a call graph for that function (provided the implementation of the

  function or method calls other documented functions). The call graph will be

  generated regardless of the value of \ref cfg_call_graph "CALL_GRAPH".

  \note The completeness (and correctness) of the call graph depends on the

  doxygen code parser which is not perfect.

  \sa section \ref cmdcallergraph "\\callergraph",

      section \ref cmdhidecallgraph "\\hidecallgraph",

      section \ref cmdhidecallergraph "\\hidecallergraph" and

      option \ref cfg_call_graph "CALL_GRAPH"

\section cmdhidecallgraph \\hidecallgraph

  \addindex \\hidecallgraph

  When this command is put in a comment block of a function or method

  and then doxygen will not generate a call graph for that function. The

  call graph will not be generated regardless of the value of

  \ref cfg_call_graph "CALL_GRAPH".

  \note The completeness (and correctness) of the call graph depends on the

  doxygen code parser which is not perfect.

  \sa section \ref cmdcallergraph "\\callergraph",

      section \ref cmdcallgraph "\\callgraph",

      section \ref cmdhidecallergraph "\\hidecallergraph" and

      option \ref cfg_call_graph "CALL_GRAPH"

\section cmdcallergraph \\callergraph

  \addindex \\callergraph

  When this command is put in a comment block of a function or method

  and \ref cfg_have_dot "HAVE_DOT" is set to \c YES, then doxygen will

  generate a caller graph for that function (provided the implementation of the

  function or method calls other documented functions). The caller graph will be

  generated regardless of the value of \ref cfg_caller_graph "CALLER_GRAPH".

  \note The completeness (and correctness) of the caller graph depends on the

  doxygen code parser which is not perfect.

  \sa section \ref cmdcallgraph "\\callgraph",

      section \ref cmdhidecallgraph "\\hidecallgraph",

      section \ref cmdhidecallergraph "\\hidecallergraph" and

      option \ref cfg_caller_graph "CALLER_GRAPH"

\section cmdhidecallergraph \\hidecallergraph

  \addindex \\hidecallergraph

  When this command is put in a comment block of a function or method

  and then doxygen will not generate a caller graph for that function. The

  caller graph will not be generated regardless of the value of

  \ref cfg_caller_graph "CALLER_GRAPH".

  \note The completeness (and correctness) of the caller graph depends on the

  doxygen code parser which is not perfect.

  \sa section \ref cmdcallergraph "\\callergraph",

      section \ref cmdcallgraph "\\callgraph",

      section \ref cmdhidecallgraph "\\hidecallgraph" and

      option \ref cfg_caller_graph "CALLER_GRAPH"

\section cmdcategory \\category <name> [<header-file>] [<header-name>]

  \addindex \\category

  For Objective-C only: Indicates that a comment block contains documentation

  for a class category with name \<name\>. The arguments are

  equal to the \ref cmdclass "\\class" command.

  \sa section \ref cmdclass "\\class".

\section cmdclass \\class <name> [<header-file>] [<header-name>]

  \addindex \\class

  Indicates that a comment block contains documentation for a

  class with name \<name\>. Optionally a header file and a header name

  can be specified. If the header-file is specified, a link to a verbatim copy

  of the header will be included in the HTML documentation.

  The \<header-name\> argument can be used to overwrite the

  name of the link that is used in the class documentation to something other

  than \<header-file\>. This can be useful if the include name is not located

  on the default include path (like \<X11/X.h\>). With the \<header-name\>

  argument you can also specify how the include statement should look like,

  by adding either quotes or sharp brackets around the name.

  Sharp brackets are used if just the name is given. Note that the

  last two arguments can also be specified using

  the \ref cmdheaderfile "\\headerfile" command.

  \par Example:

  \include class.h

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \latexonly

  See \hyperlink{class_example}{Class example}

  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.

  \endlatexonly

\section cmddef \\def <name>

  \addindex \\def

  Indicates that a comment block contains documentation for a

  \c \#define macro.

  \par Example:

  \include define.h

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \latexonly

  See \hyperlink{define_8h}{Define example}

  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.

  \endlatexonly

\section cmddefgroup \\defgroup <name> (group title)

  \addindex \\defgroup

  Indicates that a comment block contains documentation for a

  \ref modules "group" of classes, files or namespaces. This can be used to

  categorize classes, files or namespaces, and document those

  categories. You can also use groups as members of other groups,

  thus building a hierarchy of groups.

  The \<name\> argument should be a single-word identifier.

  \sa page \ref grouping "Grouping", sections \ref cmdingroup "\\ingroup", \ref cmdaddtogroup "\\addtogroup", and

  \ref cmdweakgroup "\\weakgroup".

\section cmddir \\dir [<path fragment>]

  \addindex \\dir

  Indicates that a comment block contains documentation for a directory.

  The "path fragment" argument should include the directory name and

  enough of the path to be unique with respect to the other directories

  in the project.

  The \ref cfg_strip_from_path "STRIP_FROM_PATH" option determines what is

  stripped from the full path before it appears in the output.

\section cmdenum \\enum <name>

  \addindex \\enum

  Indicates that a comment block contains documentation for an

  enumeration, with name \<name\>. If the enum is a member of a class and

  the documentation block is located outside the class definition,

  the scope of the class should be specified as well.

  If a comment block is located directly in front of an enum declaration,

  the \c \\enum comment may be omitted.

  \par Note:

  The type of an anonymous enum cannot be documented, but the values

  of an anonymous enum can.

  \par Example:

  \include enum.h

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \latexonly

  See \hyperlink{class_enum___test}{Enum example}

  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.

  \endlatexonly

\section cmdexample \\example <file-name>

  \addindex \\example

  Indicates that a comment block contains documentation for a source code

  example. The name of the source file is \<file-name\>. The text of

  this file will be included in the documentation, just after the

  documentation contained in the comment block. All examples are placed

  in a list. The source code is scanned for documented members and classes.

  If any are found, the names are cross-referenced with the documentation.

  Source files or directories can be specified using the

  \ref cfg_example_path "EXAMPLE_PATH"

  tag of doxygen's configuration file.

  If \<file-name\> itself is not unique for the set of example files specified

  by the

  \ref cfg_example_path "EXAMPLE_PATH" tag, you can include part of the absolute path

  to disambiguate it.

  If more than one source file is needed for the example,

  the \ref cmdinclude "\\include" command can be used.

  \par Example:

  \include example.cpp

  Where the example file \c example_test.cpp looks as follows:

  \include example_test.cpp

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \latexonly

  See \hyperlink{example_test_8cpp-example}{Example example}

  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.

  \endlatexonly

  \sa section \ref cmdinclude "\\include".

\section cmdendinternal \\endinternal

  \addindex \\endinternal

  This command ends a documentation fragment that was started with a

  \ref cmdinternal "\\internal" command. The text between \ref cmdinternal "\\internal" and

  \c \\endinternal will only be visible

  if \ref cfg_internal_docs "INTERNAL_DOCS" is set to \c YES.

\section cmdextends \\extends <name>

  \addindex \\extends

  This command can be used to manually indicate an inheritance relation,

  when the programming language does not support this concept natively

  (e.g. C).

  The file \c manual.c in the example directory shows how to use this command.

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \latexonly

  See \hyperlink{extends_example}{Extends example}

  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.

  \endlatexonly

  \sa section \ref cmdimplements "\\implements" and section

      \ref cmdmemberof "\\memberof"

\section cmdfile \\file [<name>]

  \addindex \\file

  Indicates that a comment block contains documentation for a source or

  header file with name \<name\>. The file name may include (part of) the

  path if the file-name alone is not unique. If the file name is omitted

  (i.e. the line after \c \\file is left blank) then the documentation block that

  contains the \c \\file command will belong to the file it is located in.

  \par Important:

  The documentation of global functions, variables, typedefs, and enums will

  only be included in the output if the file they are in is documented as well.

  \par Example:

  \include file.h

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \latexonly

  See \hyperlink{file_example}{File example}

  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.

  \endlatexonly

  \note In the above example \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF"

  has been set to \c YES in the configuration file.

\section cmdfn \\fn (function declaration)

  \addindex \\fn

  Indicates that a comment block contains documentation for a function

  (either global or as a member of a class). This command is \em only

  needed if a comment block is \e not placed in front (or behind)

  the function declaration or definition.

  If your comment block \e is in front of the function

  declaration or definition this command can (and to avoid redundancy

  should) be omitted.

  A full function declaration including arguments should be specified after the

  \c \\fn command on a \e single line, since the argument ends at the end

  of the line!

  This command is equivalent to \ref cmdvar "\\var", \ref cmdtypedef "\\typedef",

  and \ref cmdproperty "\\property".

  \warning Do not use this command

  if it is not absolutely needed, since it will lead to duplication of

  information and thus to errors.

  \par Example:

  \include func.h

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \latexonly

  See \hyperlink{class_fn___test}{Fn example}

  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.

  \endlatexonly

  \sa sections \ref cmdvar "\\var", \ref cmdproperty "\\property", and

               \ref cmdtypedef "\\typedef".

\section cmdheaderfile \\headerfile <header-file> [<header-name>]

  \addindex \\headerfile

  Intended to be used for class, struct, or union documentation, where

  the documentation is in front of the definition. The arguments of

  this command are the same as the second and third argument of

  \ref cmdclass "\\class".

  The \<header-file\> name refers to the file that should be included by the

  application to obtain the definition of the class, struct, or union.

  The \<header-name\> argument can be used to overwrite the

  name of the link that is used in the class documentation to something other

  than \<header-file\>. This can be useful if the include name is not located

  on the default include path (like \<X11/X.h\>).

  With the \<header-name\>

  argument you can also specify how the include statement should look like,

  by adding either double quotes or sharp brackets around the name.

  By default sharp brackets are used if just the name is given.

  If a pair of double quotes is given for either the \<header-file\> or

  \<header-name\> argument, the current file (in which the command was found)

  will be used but with quotes. So for a comment block with a \c \\headerfile

  command inside a file test.h, the following three commands are equivalent:

  \verbatim

  \headerfile test.h "test.h"

  \headerfile test.h ""

  \headerfile "" \endverbatim

  To get sharp brackets you do not need to specify anything,

  but if you want to be explicit you could use any of the following:

  \verbatim

  \headerfile test.h <test.h>

  \headerfile test.h <>

  \headerfile <> \endverbatim

  To globally reverse the default include representation to

  local includes you can set

  \ref cfg_force_local_includes "FORCE_LOCAL_INCLUDES" to \c YES.

  To disable the include information altogether set

  \ref cfg_show_include_files "SHOW_INCLUDE_FILES" to \c NO.

\section 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 is always hidden. The maximum number of initialization lines

  can be changed by means of the configuration parameter

  \ref cfg_max_initializer_lines "MAX_INITIALIZER_LINES", the default 

  value is 30.

  \sa section \ref cmdshowinitializer "\\showinitializer".

\section cmdidlexcept \\idlexcept <name> 

  \addindex \\idlexcept

  Indicates that a comment block contains documentation for a

  IDL exception with name \<name\>.

\section cmdimplements \\implements <name>

  \addindex \\implements

  This command can be used to manually indicate an inheritance relation,

  when the programming language does not support this concept natively

  (e.g. C).

  The file \c manual.c in the example directory shows how to use this command.

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \latexonly

  See \hyperlink{extends_example}{Implements example}

  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.

  \endlatexonly

  \sa section \ref cmdextends "\\extends" and section

      \ref cmdmemberof "\\memberof"

\section cmdingroup \\ingroup (<groupname> [<groupname> <groupname>])

  \addindex \\ingroup

  If the \c \\ingroup command is placed in a comment block of a

  class, file or namespace, then it will be added to the group or

  groups identified by \<groupname\>.

  \sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup",

  \ref cmdaddtogroup "\\addtogroup", and \ref cmdweakgroup "\\weakgroup"

\section cmdinterface \\interface <name> [<header-file>] [<header-name>]

  \addindex \\interface

  Indicates that a comment block contains documentation for an

  interface with name \<name\>. The arguments are equal to the arguments of the 

  \ref cmdclass "\\class" command.

  \sa section \ref cmdclass "\\class".

\section cmdinternal \\internal

  \addindex \\internal

  This command starts a documentation fragment that is meant for internal

  use only. The fragment naturally ends at the end of the comment block.

  You can also force the internal section to end earlier by using the

  \ref cmdendinternal "\\endinternal" command.

  If the \c \\internal command is put inside a section

  (see for example \ref cmdsection "\\section") all subsections after the

  command are considered to be internal as well. Only a new section at the

  same level will end the fragment that is considered internal.

  You can use \ref cfg_internal_docs "INTERNAL_DOCS" in the config file

  to show (\c YES) or hide (\c NO) the internal documentation.

  \sa section \ref cmdendinternal "\\endinternal".

\section cmdmainpage \\mainpage [(title)]

  \addindex \\mainpage

  If the \c \\mainpage command is placed in a comment block the

  block is used to customize the index page (in HTML) or

  the first chapter (in \LaTeX).

  The title argument is optional and replaces the default title that

  doxygen normally generates. If you do not want any title you can

  specify \c notitle as the argument of \c \\mainpage.

  Here is an example:

\verbatim

/*! \mainpage My Personal Index Page

 *

 * \section intro_sec Introduction

 *

 * This is the introduction.

 *

 * \section install_sec Installation

 *

 * \subsection step1 Step 1: Opening the box

 *

 * etc...

 */

\endverbatim

 You can refer to the main page using: \ref cmdref "\\ref" index.

 \sa section \ref cmdsection "\\section",

     section \ref cmdsubsection "\\subsection", and

     section \ref cmdpage "\\page".

\section cmdmemberof \\memberof <name>

  \addindex \\memberof

  This command makes a function a member of a class in a similar way

  as \ref cmdrelates "\\relates" does, only with this command the function

  is represented as a real member of the class.

  This can be useful when the programming language does not support

  the concept of member functions natively (e.g. C).

  It is also possible to use this command together with

  \ref cmdpublic "\\public", \ref cmdprotected "\\protected" or

  \ref cmdprivate "\\private".

  The file \c manual.c in the example directory shows how to use this command.

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \sa sections \ref cmdextends "\\extends", \ref cmdimplements "\\implements",

      \ref cmdpublic "\\public", \ref cmdprotected "\\protected" and

      \ref cmdprivate "\\private".

\section cmdname \\name [(header)]

  \addindex \\name

  This command turns a comment block into a header

  definition of a member group. The

  comment block should be followed by a

  //\@{ ... //\@} block containing the

  members of the group.

  See section \ref memgroup for an example.

\section cmdnamespace \\namespace <name>

  \addindex \\namespace

  Indicates that a comment block contains documentation for a

  namespace with name \<name\>.

\section cmdnosubgrouping \\nosubgrouping

  \addindex \\nosubgrouping

  This command can be put in the documentation

  of a class. It can be used in combination with member grouping

  to avoid that doxygen puts a member group as a subgroup of a

  Public/Protected/Private/... section.

  \sa sections \ref cmdpublicsection "\\publicsection",

      \ref cmdprotectedsection "\\protectedsection" and

      \ref cmdprivatesection "\\privatesection".

\section cmdoverload \\overload [(function declaration)]

  \addindex \\overload

  This command can be used to generate the following

  standard text for an overloaded member function:

  > This is an overloaded member function, provided for convenience.

  > It differs from the above function only in what argument(s) it accepts.

  If the documentation for the overloaded member function is not located

  in front of the function declaration or definition, the optional

  argument should be used to specify the correct function.

  Any other documentation that is inside the documentation block will

  by appended after the generated message.

  \par Note 1:

    You are responsible that there is indeed an

    earlier documented member that is overloaded by this one.

    To prevent that document reorders the documentation you should set

    \ref cfg_sort_member_docs "SORT_MEMBER_DOCS" to \c NO in this case.

  \par Note 2:

    The \c \\overload command does not work inside a one-line comment.

  \par Example:

  \include overload.cpp

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \latexonly

  See \hyperlink{class_overload___test}{Overload example}

  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.

  \endlatexonly

\section cmdpackage \\package <name>

  \addindex \\package

  Indicates that a comment block contains documentation for a

  Java package with name \<name\>.

\section cmdpage \\page <name> (title)

  \addindex \\page

  Indicates that a comment block contains a piece of documentation that is

  not directly related to one specific class, file or member.

  The HTML generator creates a page containing the documentation. The

  \LaTeX generator

  starts a new section in the chapter 'Page documentation'.

  \par Example:

  \include page.doc

  \htmlonly

  Click here

  for the corresponding HTML documentation that is generated by doxygen.

  \endhtmlonly

  \latexonly

  See \hyperlink{page_example}{Page example}

  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.

  \endlatexonly

  \par Note:

     The \<name\> argument consists of a combination of letters and number

     digits. If you wish to use upper case letters (e.g. \c MYPAGE1), or

     mixed case letters (e.g. \c MyPage1) in the \<name\> argument, you

     should set \ref cfg_case_sense_names "CASE_SENSE_NAMES" to \c YES. However, this is advisable

     only if your file system is case sensitive. Otherwise (and for better

     portability) you should use all lower case letters (e.g. \c mypage1)

     for \<name\> in all references to the page.

  \sa section \ref cmdsection "\\section", section

              \ref cmdsubsection "\\subsection", and section

              \ref cmdref "\\ref".