Doxygen Commands Manifest

doxygen-commands.yaml

source_file: doxygen-commands.html
page_title: 'Doxygen Commands'
command_count: 231
commands:
  - id: cmdaddtogroup
    title: "\\addtogroup <name> [(title)]"
    paragraphs:
      - "Defines a group just like \\defgroup,\n but in contrast to that command using the same <name> more than \nonce will not result in a warning, but rather one group with a merged \ndocumentation 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 @{ and @} like this:'
    lists: []
    definition_lists:
      - - term: See also
          description: page Grouping, sections \defgroup, \ingroup, and \weakgroup.
    preformatted:
      - |2-
          /*! \addtogroup mygrp
           *  Additional documentation for group 'mygrp'
           *  @{
           */

          /*!
           *  A function
           */
          void func1()
          {
          }

          /*! Another function */
          void func2()
          {
          }

          /*! @} */
    text: "\\addtogroup <name> [(title)]\n\nDefines a group just like \\defgroup,\n but in contrast to that command using the same <name> more than \nonce will not result in a warning, but rather one group with a merged \ndocumentation and the first title found in any of the commands.\n\nThe title is optional, so this command can also be used to add a number of entities to an existing group using @{ and @} like this:\n\n /*! \\addtogroup mygrp\n * Additional documentation for group 'mygrp'\n * @{\n */\n\n /*!\n * A function\n */\n void func1()\n {\n }\n\n /*! Another function */\n void func2()\n {\n }\n\n /*! @} */\n\nSee also\n\npage Grouping, sections \\defgroup, \\ingroup, and \\weakgroup."
  - id: cmdcallgraph
    title: "\\callgraph"
    paragraphs:
      - "When this command is put in a comment block of a function or method and HAVE_DOT is set to YES,\n then Doxygen will generate a call graph for that function (provided the\n implementation of the function or method calls other documented \nfunctions). The call graph will be generated regardless of the value of CALL_GRAPH."
    lists: []
    definition_lists:
      - - term: Note
          description: The completeness (and correctness) of the call graph depends on the Doxygen code parser which is not perfect.
      - - term: See also
          description: section \callergraph, section \hidecallgraph, section \hidecallergraph and option CALL_GRAPH
    preformatted: []
    text: "\\callgraph\n\nWhen this command is put in a comment block of a function or method and HAVE_DOT is set to YES,\n then Doxygen will generate a call graph for that function (provided the\n implementation of the function or method calls other documented \nfunctions). The call graph will be generated regardless of the value of CALL_GRAPH.\n\nNote\n\nThe completeness (and correctness) of the call graph depends on the Doxygen code parser which is not perfect.\n\nSee also\n\nsection \\callergraph, section \\hidecallgraph, section \\hidecallergraph and option CALL_GRAPH"
  - id: cmdhidecallgraph
    title: "\\hidecallgraph"
    paragraphs:
      - "When \nthis command is put in a comment block of a function or method and then \nDoxygen will not generate a call graph for that function. The call graph\n will not be generated regardless of the value of CALL_GRAPH."
    lists: []
    definition_lists:
      - - term: Note
          description: The completeness (and correctness) of the call graph depends on the Doxygen code parser which is not perfect.
      - - term: See also
          description: section \callergraph, section \callgraph, section \hidecallergraph and option CALL_GRAPH
    preformatted: []
    text: "\\hidecallgraph\n\nWhen \nthis command is put in a comment block of a function or method and then \nDoxygen will not generate a call graph for that function. The call graph\n will not be generated regardless of the value of CALL_GRAPH.\n\nNote\n\nThe completeness (and correctness) of the call graph depends on the Doxygen code parser which is not perfect.\n\nSee also\n\nsection \\callergraph, section \\callgraph, section \\hidecallergraph and option CALL_GRAPH"
  - id: cmdcallergraph
    title: "\\callergraph"
    paragraphs:
      - "When this command is put in a comment block of a function or method and HAVE_DOT is set to YES,\n then Doxygen will generate a caller graph for that function (provided \nthe implementation of the function or method is called by other \ndocumented functions). The caller graph will be generated regardless of \nthe value of CALLER_GRAPH."
    lists: []
    definition_lists:
      - - term: Note
          description: The completeness (and correctness) of the caller graph depends on the Doxygen code parser which is not perfect.
      - - term: See also
          description: section \callgraph, section \hidecallgraph, section \hidecallergraph and option CALLER_GRAPH
    preformatted: []
    text: "\\callergraph\n\nWhen this command is put in a comment block of a function or method and HAVE_DOT is set to YES,\n then Doxygen will generate a caller graph for that function (provided \nthe implementation of the function or method is called by other \ndocumented functions). The caller graph will be generated regardless of \nthe value of CALLER_GRAPH.\n\nNote\n\nThe completeness (and correctness) of the caller graph depends on the Doxygen code parser which is not perfect.\n\nSee also\n\nsection \\callgraph, section \\hidecallgraph, section \\hidecallergraph and option CALLER_GRAPH"
  - id: cmdhidecallergraph
    title: "\\hidecallergraph"
    paragraphs:
      - "When this command is put in a comment block of a function or method and \nthen Doxygen will not generate a caller graph for that function. The \ncaller graph will not be generated regardless of the value of CALLER_GRAPH."
    lists: []
    definition_lists:
      - - term: Note
          description: The completeness (and correctness) of the caller graph depends on the Doxygen code parser which is not perfect.
      - - term: See also
          description: section \callergraph, section \callgraph, section \hidecallgraph and option CALLER_GRAPH
    preformatted: []
    text: "\\hidecallergraph\n\nWhen this command is put in a comment block of a function or method and \nthen Doxygen will not generate a caller graph for that function. The \ncaller graph will not be generated regardless of the value of CALLER_GRAPH.\n\nNote\n\nThe completeness (and correctness) of the caller graph depends on the Doxygen code parser which is not perfect.\n\nSee also\n\nsection \\callergraph, section \\callgraph, section \\hidecallgraph and option CALLER_GRAPH"
  - id: cmdshowrefby
    title: "\\showrefby"
    paragraphs:
      - "When this \ncommand is put in a comment block of a function, method or variable, \nthen Doxygen will generate an overview for that function, method, \nvariable of the, documented, functions and methods that call / use it. \nThe overview will be generated regardless of the value of REFERENCED_BY_RELATION."
    lists: []
    definition_lists:
      - - term: Note
          description: The completeness (and correctness) of the overview depends on the Doxygen code parser which is not perfect.
      - - term: See also
          description: section \showrefs, section \hiderefby, section \hiderefs and option REFERENCED_BY_RELATION
    preformatted: []
    text: "\\showrefby\n\nWhen this \ncommand is put in a comment block of a function, method or variable, \nthen Doxygen will generate an overview for that function, method, \nvariable of the, documented, functions and methods that call / use it. \nThe overview will be generated regardless of the value of REFERENCED_BY_RELATION.\n\nNote\n\nThe completeness (and correctness) of the overview depends on the Doxygen code parser which is not perfect.\n\nSee also\n\nsection \\showrefs, section \\hiderefby, section \\hiderefs and option REFERENCED_BY_RELATION"
  - id: cmdhiderefby
    title: "\\hiderefby"
    paragraphs:
      - "When this \ncommand is put in a comment block of a function, method or variable then\n Doxygen will not generate an overview for that function, method or \nvariable of the functions and methods that call / use it. The overview \nwill not be generated regardless of the value of REFERENCED_BY_RELATION."
    lists: []
    definition_lists:
      - - term: Note
          description: The completeness (and correctness) of the overview depends on the Doxygen code parser which is not perfect.
      - - term: See also
          description: section \showrefs, section \showrefby, section \hiderefs and option REFERENCED_BY_RELATION
    preformatted: []
    text: "\\hiderefby\n\nWhen this \ncommand is put in a comment block of a function, method or variable then\n Doxygen will not generate an overview for that function, method or \nvariable of the functions and methods that call / use it. The overview \nwill not be generated regardless of the value of REFERENCED_BY_RELATION.\n\nNote\n\nThe completeness (and correctness) of the overview depends on the Doxygen code parser which is not perfect.\n\nSee also\n\nsection \\showrefs, section \\showrefby, section \\hiderefs and option REFERENCED_BY_RELATION"
  - id: cmdshowrefs
    title: "\\showrefs"
    paragraphs:
      - "When this \ncommand is put in a comment block of a function or method, then Doxygen \nwill generate an overview for that function or method of the functions \nand methods that call it. The overview will be generated regardless of \nthe value of REFERENCES_RELATION."
    lists: []
    definition_lists:
      - - term: Note
          description: The completeness (and correctness) of the overview depends on the Doxygen code parser which is not perfect.
      - - term: See also
          description: section \showrefby, section \hiderefby, section \hiderefs and option REFERENCES_RELATION
    preformatted: []
    text: "\\showrefs\n\nWhen this \ncommand is put in a comment block of a function or method, then Doxygen \nwill generate an overview for that function or method of the functions \nand methods that call it. The overview will be generated regardless of \nthe value of REFERENCES_RELATION.\n\nNote\n\nThe completeness (and correctness) of the overview depends on the Doxygen code parser which is not perfect.\n\nSee also\n\nsection \\showrefby, section \\hiderefby, section \\hiderefs and option REFERENCES_RELATION"
  - id: cmdhiderefs
    title: "\\hiderefs"
    paragraphs:
      - "When this \ncommand is put in a comment block of a function or method and then \nDoxygen will not generate an overview for that function or method of the\n functions and methods that call it. The overview will not be generated \nregardless of the value of REFERENCES_RELATION."
    lists: []
    definition_lists:
      - - term: Note
          description: The completeness (and correctness) of the overview depends on the Doxygen code parser which is not perfect.
      - - term: See also
          description: section \showrefs, section \showrefby, section \hiderefby and option REFERENCES_RELATION
    preformatted: []
    text: "\\hiderefs\n\nWhen this \ncommand is put in a comment block of a function or method and then \nDoxygen will not generate an overview for that function or method of the\n functions and methods that call it. The overview will not be generated \nregardless of the value of REFERENCES_RELATION.\n\nNote\n\nThe completeness (and correctness) of the overview depends on the Doxygen code parser which is not perfect.\n\nSee also\n\nsection \\showrefs, section \\showrefby, section \\hiderefby and option REFERENCES_RELATION"
  - id: cmdshowinlinesource
    title: "\\showinlinesource"
    paragraphs:
      - "When this command is put in a comment block of a function, multi-line \nmacro, enum or a list initialized variable then Doxygen will generate \nthe inline source for that member. The inline source will be generated \nregardless of the value of INLINE_SOURCES."
    lists: []
    definition_lists:
      - - term: See also
          description: section \hideinlinesource, option INLINE_SOURCES
    preformatted: []
    text: "\\showinlinesource\n\nWhen this command is put in a comment block of a function, multi-line \nmacro, enum or a list initialized variable then Doxygen will generate \nthe inline source for that member. The inline source will be generated \nregardless of the value of INLINE_SOURCES.\n\nSee also\n\nsection \\hideinlinesource, option INLINE_SOURCES"
  - id: cmdhideinlinesource
    title: "\\hideinlinesource"
    paragraphs:
      - "When this command is put in a comment block of a function, multi-line \nmacro, enum or a list initialized variable then Doxygen will not \ngenerate the inline source for that member. The inline source will not \nbe generated regardless of the value of INLINE_SOURCES."
    lists: []
    definition_lists:
      - - term: See also
          description: section \showinlinesource, option INLINE_SOURCES
    preformatted: []
    text: "\\hideinlinesource\n\nWhen this command is put in a comment block of a function, multi-line \nmacro, enum or a list initialized variable then Doxygen will not \ngenerate the inline source for that member. The inline source will not \nbe generated regardless of the value of INLINE_SOURCES.\n\nSee also\n\nsection \\showinlinesource, option INLINE_SOURCES"
  - id: cmdincludegraph
    title: "\\includegraph"
    paragraphs:
      - "When \nthis command is put in a comment block of a file then Doxygen will \ngenerate an include graph for that file. The include graph will be \ngenerated regardless of the value of INCLUDE_GRAPH."
    lists: []
    definition_lists:
      - - term: See also
          description: section \hideincludegraph, section \includedbygraph, section \hideincludedbygraph and option INCLUDE_GRAPH
    preformatted: []
    text: "\\includegraph\n\nWhen \nthis command is put in a comment block of a file then Doxygen will \ngenerate an include graph for that file. The include graph will be \ngenerated regardless of the value of INCLUDE_GRAPH.\n\nSee also\n\nsection \\hideincludegraph, section \\includedbygraph, section \\hideincludedbygraph and option INCLUDE_GRAPH"
  - id: cmdhideincludegraph
    title: "\\hideincludegraph"
    paragraphs:
      - |-
        When this command is put in a comment block of a file then Doxygen will
         not generate an include graph for that file. The include graph will not
         be generated regardless of the value of INCLUDE_GRAPH.
    lists: []
    definition_lists:
      - - term: See also
          description: section \includegraph, section \includedbygraph, section \hideincludedbygraph and option INCLUDE_GRAPH
    preformatted: []
    text: |-
      \hideincludegraph

      When this command is put in a comment block of a file then Doxygen will
       not generate an include graph for that file. The include graph will not
       be generated regardless of the value of INCLUDE_GRAPH.

      See also

      section \includegraph, section \includedbygraph, section \hideincludedbygraph and option INCLUDE_GRAPH
  - id: cmdincludedbygraph
    title: "\\includedbygraph"
    paragraphs:
      - "When this command is put in a comment block of an include file then \nDoxygen will generate an included by graph for that include file. The \nincluded by graph will be generated regardless of the value of INCLUDED_BY_GRAPH."
    lists: []
    definition_lists:
      - - term: See also
          description: section \hideincludedbygraph, section \ncludegraph, section \hideincludegraph and option INCLUDED_BY_GRAPH
    preformatted: []
    text: "\\includedbygraph\n\nWhen this command is put in a comment block of an include file then \nDoxygen will generate an included by graph for that include file. The \nincluded by graph will be generated regardless of the value of INCLUDED_BY_GRAPH.\n\nSee also\n\nsection \\hideincludedbygraph, section \\ncludegraph, section \\hideincludegraph and option INCLUDED_BY_GRAPH"
  - id: cmdhideincludedbygraph
    title: "\\hideincludedbygraph"
    paragraphs:
      - "When this command is put in a comment block of an include file then \nDoxygen will not generate an included by graph for that include file. \nThe included by graph will not be generated regardless of the value of INCLUDED_BY_GRAPH."
    lists: []
    definition_lists:
      - - term: See also
          description: section \includedbygraph, section \ncludegraph, section \hideincludegraph and option INCLUDED_BY_GRAPH
    preformatted: []
    text: "\\hideincludedbygraph\n\nWhen this command is put in a comment block of an include file then \nDoxygen will not generate an included by graph for that include file. \nThe included by graph will not be generated regardless of the value of INCLUDED_BY_GRAPH.\n\nSee also\n\nsection \\includedbygraph, section \\ncludegraph, section \\hideincludegraph and option INCLUDED_BY_GRAPH"
  - id: cmddirectorygraph
    title: "\\directorygraph"
    paragraphs:
      - "When this command is put in a comment block of a directory (see section \\dir)\n then Doxygen will generate a directory graph for that directory. The \ndirectory graph will be generated regardless of the value of DIRECTORY_GRAPH."
    lists: []
    definition_lists:
      - - term: See also
          description: section \hidedirectorygraph, option DIRECTORY_GRAPH
    preformatted: []
    text: "\\directorygraph\n\nWhen this command is put in a comment block of a directory (see section \\dir)\n then Doxygen will generate a directory graph for that directory. The \ndirectory graph will be generated regardless of the value of DIRECTORY_GRAPH.\n\nSee also\n\nsection \\hidedirectorygraph, option DIRECTORY_GRAPH"
  - id: cmdhidedirectorygraph
    title: "\\hidedirectorygraph"
    paragraphs:
      - "When this command is put in a comment block of a directory (see section \\dir)\n then Doxygen will not generate a directory graph for that directory. \nThe directory graph will not be generated regardless of the value of DIRECTORY_GRAPH."
    lists: []
    definition_lists:
      - - term: See also
          description: section \directorygraph, option DIRECTORY_GRAPH
    preformatted: []
    text: "\\hidedirectorygraph\n\nWhen this command is put in a comment block of a directory (see section \\dir)\n then Doxygen will not generate a directory graph for that directory. \nThe directory graph will not be generated regardless of the value of DIRECTORY_GRAPH.\n\nSee also\n\nsection \\directorygraph, option DIRECTORY_GRAPH"
  - id: cmdcollaborationgraph
    title: "\\collaborationgraph"
    paragraphs:
      - "When this command is put in a comment block of a class then Doxygen \nwill generate a collaboration graph for that class. The collaboration \ngraph will be generated regardless of the value of COLLABORATION_GRAPH."
    lists: []
    definition_lists:
      - - term: See also
          description: section \hidecollaborationgraph, option COLLABORATION_GRAPH
    preformatted: []
    text: "\\collaborationgraph\n\nWhen this command is put in a comment block of a class then Doxygen \nwill generate a collaboration graph for that class. The collaboration \ngraph will be generated regardless of the value of COLLABORATION_GRAPH.\n\nSee also\n\nsection \\hidecollaborationgraph, option COLLABORATION_GRAPH"
  - id: cmdhidecollaborationgraph
    title: "\\hidecollaborationgraph"
    paragraphs:
      - "When this command is put in a comment block of a class then Doxygen \nwill not generate a collaboration graph for that class. The \ncollaboration graph will not be generated regardless of the value of COLLABORATION_GRAPH."
    lists: []
    definition_lists:
      - - term: See also
          description: section \collaborationgraph, option COLLABORATION_GRAPH
    preformatted: []
    text: "\\hidecollaborationgraph\n\nWhen this command is put in a comment block of a class then Doxygen \nwill not generate a collaboration graph for that class. The \ncollaboration graph will not be generated regardless of the value of COLLABORATION_GRAPH.\n\nSee also\n\nsection \\collaborationgraph, option COLLABORATION_GRAPH"
  - id: cmdinheritancegraph
    title: "\\inheritancegraph['{option}']"
    paragraphs:
      - "When this command is put in a comment block of a class then Doxygen \nwill generate an inheritance graph for that class conforming the option. The inheritance graph will be generated, conforming the option, regardless of the value of CLASS_GRAPH. The possible values of option are the same values as can be used with CLASS_GRAPH. In case no option is specified the value YES is assumed."
    lists: []
    definition_lists:
      - - term: See also
          description: section \hideinheritancegraph, option CLASS_GRAPH
    preformatted: []
    text: "\\inheritancegraph['{option}']\n\nWhen this command is put in a comment block of a class then Doxygen \nwill generate an inheritance graph for that class conforming the option. The inheritance graph will be generated, conforming the option, regardless of the value of CLASS_GRAPH. The possible values of option are the same values as can be used with CLASS_GRAPH. In case no option is specified the value YES is assumed.\n\nSee also\n\nsection \\hideinheritancegraph, option CLASS_GRAPH"
  - id: cmdhideinheritancegraph
    title: "\\hideinheritancegraph"
    paragraphs:
      - "When this command is put in a comment block of a class then Doxygen \nwill not generate an inheritance graph for that class. The inheritance \ngraph will not be generated regardless of the value of CLASS_GRAPH."
    lists: []
    definition_lists:
      - - term: See also
          description: section \inheritancegraph, option CLASS_GRAPH
    preformatted: []
    text: "\\hideinheritancegraph\n\nWhen this command is put in a comment block of a class then Doxygen \nwill not generate an inheritance graph for that class. The inheritance \ngraph will not be generated regardless of the value of CLASS_GRAPH.\n\nSee also\n\nsection \\inheritancegraph, option CLASS_GRAPH"
  - id: cmdgroupgraph
    title: "\\groupgraph"
    paragraphs:
      - "When this command is put in a comment block of a \\defgroup\n command then Doxygen will generate a group dependency graph for that \ngroup. The group graph will be generated regardless of the value of GROUP_GRAPHS."
    lists: []
    definition_lists:
      - - term: See also
          description: section \hidegroupgraph, option GROUP_GRAPHS
    preformatted: []
    text: "\\groupgraph\n\nWhen this command is put in a comment block of a \\defgroup\n command then Doxygen will generate a group dependency graph for that \ngroup. The group graph will be generated regardless of the value of GROUP_GRAPHS.\n\nSee also\n\nsection \\hidegroupgraph, option GROUP_GRAPHS"
  - id: cmdhidegroupgraph
    title: "\\hidegroupgraph"
    paragraphs:
      - "When this command is put in a comment block of a \\defgroup\n command then Doxygen will not generate a group dependency graph for \nthat group. The group graph will not be generated regardless of the \nvalue of GROUP_GRAPHS."
    lists: []
    definition_lists:
      - - term: See also
          description: section \groupgraph, option GROUP_GRAPHS
    preformatted: []
    text: "\\hidegroupgraph\n\nWhen this command is put in a comment block of a \\defgroup\n command then Doxygen will not generate a group dependency graph for \nthat group. The group graph will not be generated regardless of the \nvalue of GROUP_GRAPHS.\n\nSee also\n\nsection \\groupgraph, option GROUP_GRAPHS"
  - id: cmdshowenumvalues
    title: "\\showenumvalues"
    paragraphs:
      - "When this command is put in a comment block of an enum then doxygen will\n show the specified enum values for that enum, regardless of the value \nof SHOW_ENUM_VALUES."
    lists: []
    definition_lists:
      - - term: See also
          description: section \hideenumvalues, option SHOW_ENUM_VALUES
    preformatted: []
    text: "\\showenumvalues\n\nWhen this command is put in a comment block of an enum then doxygen will\n show the specified enum values for that enum, regardless of the value \nof SHOW_ENUM_VALUES.\n\nSee also\n\nsection \\hideenumvalues, option SHOW_ENUM_VALUES"
  - id: cmdhideenumvalues
    title: "\\hideenumvalues"
    paragraphs:
      - "When this command is put in a comment block of an enum then doxygen will\n not show the specified enum values for that enum, regardless of the \nvalue of SHOW_ENUM_VALUES."
    lists: []
    definition_lists:
      - - term: See also
          description: section \showenumvalues, option SHOW_ENUM_VALUES
    preformatted: []
    text: "\\hideenumvalues\n\nWhen this command is put in a comment block of an enum then doxygen will\n not show the specified enum values for that enum, regardless of the \nvalue of SHOW_ENUM_VALUES.\n\nSee also\n\nsection \\showenumvalues, option SHOW_ENUM_VALUES"
  - id: cmdqualifier
    title: \qualifier <label> | "(text)"
    paragraphs:
      - "With this command it is possible to add custom qualifier labels to \nmembers and classes. These labels will be shown in the output in the \nsame way as the automatically generated labels such as \"static\", \n\"inline\", and \"final\"."
      - For instance to indicate that a function is only meant for testing purposes one could add \qualifier test
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\qualifier <label> | \"(text)\"\n\nWith this command it is possible to add custom qualifier labels to \nmembers and classes. These labels will be shown in the output in the \nsame way as the automatically generated labels such as \"static\", \n\"inline\", and \"final\".\n\nFor instance to indicate that a function is only meant for testing purposes one could add \\qualifier test"
  - id: cmdcategory
    title: "\\category <name> [<header-file>] [<header-name>]"
    paragraphs:
      - |-
        For Objective-C
         only: Indicates that a comment block contains documentation for a class
         category with name <name>. The arguments are equal to the \class command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \class.
    preformatted: []
    text: |-
      \category <name> [<header-file>] [<header-name>]

      For Objective-C
       only: Indicates that a comment block contains documentation for a class
       category with name <name>. The arguments are equal to the \class command.

      See also

      section \class.
  - id: cmdclass
    title: "\\class <name> [<header-file>] [<header-name>]"
    paragraphs:
      - "Indicates that a \ncomment block contains documentation for a class with name <name>.\n Optionally a header file and a header name can be specified. If the \nheader-file is specified, a link to a verbatim copy of the header will \nbe included in the HTML documentation. The <header-name> argument \ncan be used to overwrite the name of the link that is used in the class \ndocumentation to something other than <header-file>. This can be \nuseful if the include name is not located on the default include path \n(like <X11/X.h>). With the <header-name> argument you can \nalso specify how the include statement should look like, by adding \neither quotes or sharp brackets around the name. Sharp brackets are used\n if just the name is given. Note that the last two arguments can also be\n specified using the \\headerfile command."
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            /* A dummy class */

            class Test
            {
            };

            /*! \class Test class.h "inc/class.h"
             * \brief This is a test class.
             *
             * Some details about the Test class.
             */

             Click here
             for the corresponding HTML documentation that is generated by Doxygen.
    preformatted: []
    text: "\\class <name> [<header-file>] [<header-name>]\n\nIndicates that a \ncomment block contains documentation for a class with name <name>.\n Optionally a header file and a header name can be specified. If the \nheader-file is specified, a link to a verbatim copy of the header will \nbe included in the HTML documentation. The <header-name> argument \ncan be used to overwrite the name of the link that is used in the class \ndocumentation to something other than <header-file>. This can be \nuseful if the include name is not located on the default include path \n(like <X11/X.h>). With the <header-name> argument you can \nalso specify how the include statement should look like, by adding \neither quotes or sharp brackets around the name. Sharp brackets are used\n if just the name is given. Note that the last two arguments can also be\n specified using the \\headerfile command.\n\nExample:\n\n/* A dummy class */\n\nclass Test\n{\n};\n\n/*! \\class Test class.h \"inc/class.h\"\n * \\brief This is a test class.\n *\n * Some details about the Test class.\n */\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
  - id: cmdconcept
    title: "\\concept <name>"
    paragraphs:
      - Indicates that a comment block contains documentation for a C++20 concept with name <name>. See also the \headerfile command to specify the header a user should be included to use the concept.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \concept <name>

      Indicates that a comment block contains documentation for a C++20 concept with name <name>. See also the \headerfile command to specify the header a user should be included to use the concept.
  - id: cmddef
    title: "\\def <name>"
    paragraphs:
      - 'Indicates that a comment block contains documentation for a #define macro.'
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: "/*! \\file define.h\n \\brief testing defines\n\n This is to test the documentation of defines.\n*/\n\n/*!\n \\def MAX(x,y)\n Computes the maximum of \\a x and \\a y.\n*/\n\n/*! \n \\brief Computes the absolute value of its argument \\a x.\n \\param x input value.\n \\returns absolute value of \\a x.\n*/\n#define ABS(x) (((x)>0)?(x):-(x))\n#define MAX(x,y) ((x)>(y)?(x):(y))\n#define MIN(x,y) ((x)>(y)?(y):(x)) \n /*!< Computes the minimum of \\a x and \\a y. */\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
    preformatted: []
    text: "\\def <name>\n\nIndicates that a comment block contains documentation for a #define macro.\n\nExample:\n\n/*! \\file define.h\n \\brief testing defines\n\n This is to test the documentation of defines.\n*/\n\n/*!\n \\def MAX(x,y)\n Computes the maximum of \\a x and \\a y.\n*/\n\n/*! \n \\brief Computes the absolute value of its argument \\a x.\n \\param x input value.\n \\returns absolute value of \\a x.\n*/\n#define ABS(x) (((x)>0)?(x):-(x))\n#define MAX(x,y) ((x)>(y)?(x):(y))\n#define MIN(x,y) ((x)>(y)?(y):(x)) \n /*!< Computes the minimum of \\a x and \\a y. */\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
  - id: cmddefgroup
    title: "\\defgroup <name> (group title)"
    paragraphs:
      - "Indicates that a comment block contains documentation for a topics\n of classes, modules, concepts, files or namespaces. This can be used to\n categorize symbols, and document those categories. You can also use \ngroups as members of other groups, thus building a hierarchy of groups."
      - The <name> argument should be a single-word identifier.
    lists: []
    definition_lists:
      - - term: See also
          description: page Grouping, sections \ingroup, \addtogroup, and \weakgroup.
    preformatted: []
    text: "\\defgroup <name> (group title)\n\nIndicates that a comment block contains documentation for a topics\n of classes, modules, concepts, files or namespaces. This can be used to\n categorize symbols, and document those categories. You can also use \ngroups as members of other groups, thus building a hierarchy of groups.\n\nThe <name> argument should be a single-word identifier.\n\nSee also\n\npage Grouping, sections \\ingroup, \\addtogroup, and \\weakgroup."
  - id: cmddir
    title: "\\dir [<path fragment>]"
    paragraphs:
      - "Indicates that a comment \nblock contains documentation for a directory. The \"path fragment\" \nargument should include the directory name and enough of the path to be \nunique with respect to the other directories in the project. The STRIP_FROM_PATH option determines what is stripped from the full path before it appears in the output."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\dir [<path fragment>]\n\nIndicates that a comment \nblock contains documentation for a directory. The \"path fragment\" \nargument should include the directory name and enough of the path to be \nunique with respect to the other directories in the project. The STRIP_FROM_PATH option determines what is stripped from the full path before it appears in the output."
  - id: cmdenum
    title: "\\enum <name>"
    paragraphs:
      - "Indicates that a \ncomment block contains documentation for an enumeration, with name \n<name>. If the enum is a member of a class and the documentation \nblock is located outside the class definition, the scope of the class \nshould be specified as well. If a comment block is located directly in \nfront of an enum declaration, the \\enum comment may be omitted."
    lists: []
    definition_lists:
      - - term: 'Note:'
          description: The type of an anonymous enum cannot be documented, but the values of an anonymous enum can.
      - - term: 'Example:'
          description: "class Enum_Test\n{\n public:\n enum TEnum { Val1, Val2 };\n\n /*! Another enum, with inline docs */\n enum AnotherEnum \n { \n V1, /*!< value 1 */\n V2 /*!< value 2 */\n };\n};\n\n/*! \\class Enum_Test\n * The class description.\n */\n\n/*! \\enum Enum_Test::TEnum\n * A description of the enum type.\n */\n\n/*! \\var Enum_Test::TEnum Enum_Test::Val1\n * The description of the first enum value.\n */\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
    preformatted: []
    text: "\\enum <name>\n\nIndicates that a \ncomment block contains documentation for an enumeration, with name \n<name>. If the enum is a member of a class and the documentation \nblock is located outside the class definition, the scope of the class \nshould be specified as well. If a comment block is located directly in \nfront of an enum declaration, the \\enum comment may be omitted.\n\nNote:\n\nThe type of an anonymous enum cannot be documented, but the values of an anonymous enum can.\n\nExample:\n\nclass Enum_Test\n{\n public:\n enum TEnum { Val1, Val2 };\n\n /*! Another enum, with inline docs */\n enum AnotherEnum \n { \n V1, /*!< value 1 */\n V2 /*!< value 2 */\n };\n};\n\n/*! \\class Enum_Test\n * The class description.\n */\n\n/*! \\enum Enum_Test::TEnum\n * A description of the enum type.\n */\n\n/*! \\var Enum_Test::TEnum Enum_Test::Val1\n * The description of the first enum value.\n */\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
  - id: cmdexample
    title: "\\example['{lineno}'] <file-name>"
    paragraphs:
      - "Indicates that a \ncomment block contains documentation for a source code example. The name\n of the source file is <file-name>. The contents of this file will\n be included in the documentation, just after the documentation \ncontained in the comment block. You can add option {lineno}\n to enable line numbers for the example if desired. All examples are \nplaced in a list. The source code is scanned for documented members and \nclasses. If any are found, the names are cross-referenced with the \ndocumentation. Source files or directories can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file."
      - If <file-name> itself is not unique for the set of example files specified by the 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 \include command can be used.
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            /** A Example_Test class.
             * More details about this class.
             */

            class Example_Test
            {
             public:
             /** An example member function.
             * More details about this function.
             */
             void example();
            };

            void Example_Test::example() {}

            /** \example example_test.cpp
             * This is an example of how to use the Example_Test class.
             * More details about this example.
             */
             Where the example file example_test.cpp looks as follows: void main()
            {
             Example_Test t;
             t.example();
            }

             Click here
             for the corresponding HTML documentation that is generated by Doxygen.
      - - term: See also
          description: section \include.
    preformatted: []
    text: "\\example['{lineno}'] <file-name>\n\nIndicates that a \ncomment block contains documentation for a source code example. The name\n of the source file is <file-name>. The contents of this file will\n be included in the documentation, just after the documentation \ncontained in the comment block. You can add option {lineno}\n to enable line numbers for the example if desired. All examples are \nplaced in a list. The source code is scanned for documented members and \nclasses. If any are found, the names are cross-referenced with the \ndocumentation. Source files or directories can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.\n\nIf <file-name> itself is not unique for the set of example files specified by the EXAMPLE_PATH tag, you can include part of the absolute path to disambiguate it.\n\nIf more than one source file is needed for the example, the \\include command can be used.\n\nExample:\n\n/** A Example_Test class.\n * More details about this class.\n */\n\nclass Example_Test\n{\n public:\n /** An example member function.\n * More details about this function.\n */\n void example();\n};\n\nvoid Example_Test::example() {}\n\n/** \\example example_test.cpp\n * This is an example of how to use the Example_Test class.\n * More details about this example.\n */\n Where the example file example_test.cpp looks as follows: void main()\n{\n Example_Test t;\n t.example();\n}\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen.\n\nSee also\n\nsection \\include."
  - id: cmdendinternal
    title: "\\endinternal"
    paragraphs:
      - This command ends a documentation fragment that was started with a \internal command. The text between \internal and \endinternal will only be visible if INTERNAL_DOCS is set to YES.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \endinternal

      This command ends a documentation fragment that was started with a \internal command. The text between \internal and \endinternal will only be visible if INTERNAL_DOCS is set to YES.
  - id: cmdextends
    title: "\\extends <name>"
    paragraphs:
      - "This command can \nbe used to manually indicate an inheritance relation, when the \nprogramming language does not support this concept natively (e.g. C)."
      - The file manual.c in the example directory shows how to use this command (see also \memberof for the complete file).
      - |-
        Click here
         for the corresponding HTML documentation that is generated by Doxygen.
    lists: []
    definition_lists:
      - - term: See also
          description: section \implements and section \memberof
    preformatted: []
    text: "\\extends <name>\n\nThis command can \nbe used to manually indicate an inheritance relation, when the \nprogramming language does not support this concept natively (e.g. C).\n\nThe file manual.c in the example directory shows how to use this command (see also \\memberof for the complete file).\n\nClick here\n for the corresponding HTML documentation that is generated by Doxygen.\n\nSee also\n\nsection \\implements and section \\memberof"
  - id: cmdfile
    title: "\\file [<name>]"
    paragraphs:
      - "Indicates that a \ncomment block contains documentation for a source or header file with \nname <name>. The file name may include (part of) the path if the \nfile-name alone is not unique. If the file name is omitted (i.e. the \nline after \\file is left blank) then the documentation block that contains the \\file command will belong to the file it is located in."
    lists: []
    definition_lists:
      - - term: Important
          description: "The documentation of\n global functions, variables, typedefs, and enums will only be included \nin the output if the file they are in is documented as well or if EXTRACT_ALL is set to YES."
      - - term: 'Example:'
          description: |-
            /** \file file.h
             * A brief file description.
             * A more elaborated file description.
             */

            /**
             * A global integer value.
             * More details about this value.
             */
            extern int globalValue;

             Click here
             for the corresponding HTML documentation that is generated by Doxygen.
      - - term: Note
          description: In the above example JAVADOC_AUTOBRIEF has been set to YES in the configuration file.
    preformatted: []
    text: "\\file [<name>]\n\nIndicates that a \ncomment block contains documentation for a source or header file with \nname <name>. The file name may include (part of) the path if the \nfile-name alone is not unique. If the file name is omitted (i.e. the \nline after \\file is left blank) then the documentation block that contains the \\file command will belong to the file it is located in.\n\nImportant\n\nThe documentation of\n global functions, variables, typedefs, and enums will only be included \nin the output if the file they are in is documented as well or if EXTRACT_ALL is set to YES.\n\nExample:\n\n/** \\file file.h\n * A brief file description.\n * A more elaborated file description.\n */\n\n/**\n * A global integer value.\n * More details about this value.\n */\nextern int globalValue;\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen.\n\nNote\n\nIn the above example JAVADOC_AUTOBRIEF has been set to YES in the configuration file."
  - id: cmdfileinfo
    title: "\\fileinfo['{'option'}']"
    paragraphs:
      - Shows (part) of the file name in which this command is placed. The option can be name, extension, filename, directory or, full, with
      - In case no option is specified the filename is used unless FULL_PATH_NAMES is set to YES in which case full is used.
    lists:
      - - name the name of the file without extension
        - extension the extension of the file
        - filename the filename i.e. name plus extension
        - directory the directory of the given file
        - full the full path and filename of the given file.
    definition_lists:
      - - term: Note
          description: the command \fileinfo cannot be used as argument to the \file command
      - - term: See also
          description: section \lineinfo
    preformatted: []
    text: |-
      \fileinfo['{'option'}']

      Shows (part) of the file name in which this command is placed. The option can be name, extension, filename, directory or, full, with

      In case no option is specified the filename is used unless FULL_PATH_NAMES is set to YES in which case full is used.

      name the name of the file without extension

      extension the extension of the file

      filename the filename i.e. name plus extension

      directory the directory of the given file

      full the full path and filename of the given file.

      Note

      the command \fileinfo cannot be used as argument to the \file command

      See also

      section \lineinfo
  - id: cmdlineinfo
    title: "\\lineinfo"
    paragraphs:
      - Shows the line number inside the file at which this command is placed.
    lists: []
    definition_lists:
      - - term: See also
          description: section \fileinfo
    preformatted: []
    text: |-
      \lineinfo

      Shows the line number inside the file at which this command is placed.

      See also

      section \fileinfo
  - id: cmdfn
    title: "\\fn (function declaration)"
    paragraphs:
      - "Indicates that a comment \nblock contains documentation for a function (either global or as a \nmember of a class). This command is only needed if a comment block is not placed in front (or behind) the function declaration or definition."
      - If your comment block 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 \fn command on a single line, since the argument ends at the end of the line!
      - This command is equivalent to \var, \typedef, and \property.
    lists: []
    definition_lists:
      - - term: Warning
          description: Do not use this command if it is not absolutely needed, since it will lead to duplication of information and thus to errors.
      - - term: 'Example:'
          description: "class Fn_Test\n{\n public:\n const char *member(char,int) throw(std::out_of_range);\n};\n\nconst char *Fn_Test::member(char c,int n) throw(std::out_of_range) {}\n\n/*! \\class Fn_Test\n * \\brief Fn_Test class.\n *\n * Details about Fn_Test.\n */\n\n/*! \\fn const char *Fn_Test::member(char c,int n) \n * \\brief A member function.\n * \\param c a character.\n * \\param n an integer.\n * \\exception std::out_of_range parameter is out of range.\n * \\return a character pointer.\n */\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
      - - term: See also
          description: sections \var, \property, and \typedef.
    preformatted: []
    text: "\\fn (function declaration)\n\nIndicates that a comment \nblock contains documentation for a function (either global or as a \nmember of a class). This command is only needed if a comment block is not placed in front (or behind) the function declaration or definition.\n\nIf your comment block is in front of the function declaration or definition this command can (and to avoid redundancy should) be omitted.\n\nA full function declaration including arguments should be specified after the \\fn command on a single line, since the argument ends at the end of the line!\n\nThis command is equivalent to \\var, \\typedef, and \\property.\n\nWarning\n\nDo not use this command if it is not absolutely needed, since it will lead to duplication of information and thus to errors.\n\nExample:\n\nclass Fn_Test\n{\n public:\n const char *member(char,int) throw(std::out_of_range);\n};\n\nconst char *Fn_Test::member(char c,int n) throw(std::out_of_range) {}\n\n/*! \\class Fn_Test\n * \\brief Fn_Test class.\n *\n * Details about Fn_Test.\n */\n\n/*! \\fn const char *Fn_Test::member(char c,int n) \n * \\brief A member function.\n * \\param c a character.\n * \\param n an integer.\n * \\exception std::out_of_range parameter is out of range.\n * \\return a character pointer.\n */\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen.\n\nSee also\n\nsections \\var, \\property, and \\typedef."
  - id: cmdheaderfile
    title: "\\headerfile <header-file> [<header-name>]"
    paragraphs:
      - "Intended to\n be used for class, struct, or union documentation, where the \ndocumentation is in front of the definition. The arguments of this \ncommand are the same as the second and third argument of \\class.\n The <header-file> name refers to the file that should be included\n by the application to obtain the definition of the class, struct, or \nunion. The <header-name> argument can be used to overwrite the \nname of the link that is used in the class documentation to something \nother than <header-file>. This can be useful if the include name \nis not located on the default include path (like <X11/X.h>)."
      - "With the <header-name> argument you can also specify how the \ninclude statement should look like, by adding either double quotes or \nsharp brackets around the name. By default sharp brackets are used if \njust the name is given."
      - "If a pair of double quotes is given for either the \n<header-file> or <header-name> argument, the current file \n(in which the command was found) will be used but with quotes. So for a \ncomment block with a \\headerfile command inside a file test.h, the following three commands are equivalent:"
      - '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:'
      - To globally reverse the default include representation to local includes you can set FORCE_LOCAL_INCLUDES to YES.
      - To disable the include information altogether set SHOW_HEADERFILE to NO.
    lists: []
    definition_lists: []
    preformatted:
      - |2-
          \headerfile test.h "test.h"
          \headerfile test.h ""
          \headerfile ""
      - |2-
          \headerfile test.h <test.h>
          \headerfile test.h <>
          \headerfile <>
    text: "\\headerfile <header-file> [<header-name>]\n\nIntended to\n be used for class, struct, or union documentation, where the \ndocumentation is in front of the definition. The arguments of this \ncommand are the same as the second and third argument of \\class.\n The <header-file> name refers to the file that should be included\n by the application to obtain the definition of the class, struct, or \nunion. The <header-name> argument can be used to overwrite the \nname of the link that is used in the class documentation to something \nother than <header-file>. This can be useful if the include name \nis not located on the default include path (like <X11/X.h>).\n\nWith the <header-name> argument you can also specify how the \ninclude statement should look like, by adding either double quotes or \nsharp brackets around the name. By default sharp brackets are used if \njust the name is given.\n\nIf a pair of double quotes is given for either the \n<header-file> or <header-name> argument, the current file \n(in which the command was found) will be used but with quotes. So for a \ncomment block with a \\headerfile command inside a file test.h, the following three commands are equivalent:\n\nTo get sharp brackets you do not need to specify anything, but if you want to be explicit you could use any of the following:\n\nTo globally reverse the default include representation to local includes you can set FORCE_LOCAL_INCLUDES to YES.\n\nTo disable the include information altogether set SHOW_HEADERFILE to NO.\n\n \\headerfile test.h \"test.h\"\n \\headerfile test.h \"\"\n \\headerfile \"\"\n\n \\headerfile test.h <test.h>\n \\headerfile test.h <>\n \\headerfile <>"
  - id: cmdhideinitializer
    title: "\\hideinitializer"
    paragraphs:
      - "By default the value of a define and the initializer of a variable are \ndisplayed unless they are longer than 30 lines. By putting this command \nin a comment block of a define or variable, the initializer is always \nhidden. The maximum number of initialization lines can be changed by \nmeans of the configuration parameter MAX_INITIALIZER_LINES, the default value is 30."
    lists: []
    definition_lists:
      - - term: See also
          description: section \showinitializer.
    preformatted: []
    text: "\\hideinitializer\n\nBy default the value of a define and the initializer of a variable are \ndisplayed unless they are longer than 30 lines. By putting this command \nin a comment block of a define or variable, the initializer is always \nhidden. The maximum number of initialization lines can be changed by \nmeans of the configuration parameter MAX_INITIALIZER_LINES, the default value is 30.\n\nSee also\n\nsection \\showinitializer."
  - id: cmdidlexcept
    title: "\\idlexcept <name>"
    paragraphs:
      - Indicates that a comment block contains documentation for a IDL exception with name <name>.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \idlexcept <name>

      Indicates that a comment block contains documentation for a IDL exception with name <name>.
  - id: cmdimplements
    title: "\\implements <name>"
    paragraphs:
      - "This \ncommand can be used to manually indicate an inheritance relation, when \nthe programming language does not support this concept natively (e.g. \nC)."
      - The file manual.c in the example directory shows how to use this command (see also \memberof for the complete file).
      - |-
        Click here
         for the corresponding HTML documentation that is generated by Doxygen.
    lists: []
    definition_lists:
      - - term: See also
          description: section \extends and section \memberof
    preformatted: []
    text: "\\implements <name>\n\nThis \ncommand can be used to manually indicate an inheritance relation, when \nthe programming language does not support this concept natively (e.g. \nC).\n\nThe file manual.c in the example directory shows how to use this command (see also \\memberof for the complete file).\n\nClick here\n for the corresponding HTML documentation that is generated by Doxygen.\n\nSee also\n\nsection \\extends and section \\memberof"
  - id: cmdingroup
    title: "\\ingroup (<groupname> [<groupname>]*)"
    paragraphs:
      - "If the \\ingroup\n command is placed in a comment block of a compound entity (like class, \nfile or namespace), then it will be added to the group(s) identified by \nthe <groupname>(s). In case of members \n(like variable, functions, typedefs and enums) the member will be added \nonly to one group (to avoid ambiguous linking targets in case a member \nis not documented in the context of its class, namespace or file, but \nonly visible as part of a group)."
    lists: []
    definition_lists:
      - - term: See also
          description: page Grouping, sections \defgroup, \addtogroup, and \weakgroup
    preformatted: []
    text: "\\ingroup (<groupname> [<groupname>]*)\n\nIf the \\ingroup\n command is placed in a comment block of a compound entity (like class, \nfile or namespace), then it will be added to the group(s) identified by \nthe <groupname>(s). In case of members \n(like variable, functions, typedefs and enums) the member will be added \nonly to one group (to avoid ambiguous linking targets in case a member \nis not documented in the context of its class, namespace or file, but \nonly visible as part of a group).\n\nSee also\n\npage Grouping, sections \\defgroup, \\addtogroup, and \\weakgroup"
  - id: cmdinterface
    title: "\\interface <name> [<header-file>] [<header-name>]"
    paragraphs:
      - "Indicates \nthat a comment block contains documentation for an interface with name \n<name>. The arguments are equal to the arguments of the \\class command."
    lists: []
    definition_lists:
      - - term: See also
          description: section \class.
    preformatted: []
    text: "\\interface <name> [<header-file>] [<header-name>]\n\nIndicates \nthat a comment block contains documentation for an interface with name \n<name>. The arguments are equal to the arguments of the \\class command.\n\nSee also\n\nsection \\class."
  - id: cmdinternal
    title: "\\internal"
    paragraphs:
      - "This command \nstarts a documentation fragment that is meant for internal use only. The\n fragment naturally ends at the end of the comment block. You can also \nforce the internal section to end earlier by using the \\endinternal command."
      - "If the \\internal command is put inside a section (see for example \\section)\n all subsections after the command are considered to be internal as \nwell. Only a new section at the same level will end the fragment that is\n considered internal."
      - You can use INTERNAL_DOCS in the configuration file to show (YES) or hide (NO) the internal documentation.
    lists: []
    definition_lists:
      - - term: See also
          description: section \endinternal.
    preformatted: []
    text: "\\internal\n\nThis command \nstarts a documentation fragment that is meant for internal use only. The\n fragment naturally ends at the end of the comment block. You can also \nforce the internal section to end earlier by using the \\endinternal command.\n\nIf the \\internal command is put inside a section (see for example \\section)\n all subsections after the command are considered to be internal as \nwell. Only a new section at the same level will end the fragment that is\n considered internal.\n\nYou can use INTERNAL_DOCS in the configuration file to show (YES) or hide (NO) the internal documentation.\n\nSee also\n\nsection \\endinternal."
  - id: cmdmainpage
    title: "\\mainpage [(title)]"
    paragraphs:
      - If the \mainpage command is placed in a comment block the block is used to customize the index page (in HTML) or the first chapter (in ).
      - "The title argument is optional and replaces the default title that \nDoxygen normally generates. If you do not want any title you can specify\n notitle as the argument of \\mainpage."
      - 'Here is an example:'
      - 'You can refer to the main page using: \ref index.'
    lists: []
    definition_lists:
      - - term: See also
          description: section \section, section \subsection, and section \page.
    preformatted:
      - |-
        /*! \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...
         */
    text: "\\mainpage [(title)]\n\nIf the \\mainpage command is placed in a comment block the block is used to customize the index page (in HTML) or the first chapter (in ).\n\nThe title argument is optional and replaces the default title that \nDoxygen normally generates. If you do not want any title you can specify\n notitle as the argument of \\mainpage.\n\nHere is an example:\n\nYou can refer to the main page using: \\ref index.\n\n/*! \\mainpage My Personal Index Page\n *\n * \\section intro_sec Introduction\n *\n * This is the introduction.\n *\n * \\section install_sec Installation\n *\n * \\subsection step1 Step 1: Opening the box\n *\n * etc...\n */\n\nSee also\n\nsection \\section, section \\subsection, and section \\page."
  - id: cmdmemberof
    title: "\\memberof <name>"
    paragraphs:
      - "This command makes a function a member of a class in a similar way as \\relates\n does, only with this command the function is represented as a real \nmember of the class. This can be useful when the programming language \ndoes not support the concept of member functions natively (e.g. C)."
      - It is also possible to use this command together with \public, \protected or \private.
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            The file manual.c in the example directory shows how to use this command: /**
             * \file manual.c
             */

            typedef struct Object Object; //!< Object type
            typedef struct Vehicle Vehicle; //!< Vehicle type
            typedef struct Car Car; //!< Car type
            typedef struct Truck Truck; //!< Truck type

            /*!
             * Base object class.
             */
            struct Object
            {
             int ref; //!< \private Reference count.
            };

            /*!
             * Increments object reference count by one.
             * \public \memberof Object
             */
            static Object * objRef(Object *obj);

            /*!
             * Decrements object reference count by one.
             * \public \memberof Object
             */
            static Object * objUnref(Object *obj);

            /*!
             * Vehicle class.
             * \extends Object
             */
            struct Vehicle
            {
             Object base; //!< \protected Base class.
            };

            /*!
             * Starts the vehicle.
             * \public \memberof Vehicle
             */
            void vehicleStart(Vehicle *obj);

            /*!
             * Stops the vehicle.
             * \public \memberof Vehicle
             */
            void vehicleStop(Vehicle *obj);

            /*!
             * Car class.
             * \extends Vehicle
             */
            struct Car
            {
             Vehicle base; //!< \protected Base class.
            };

            /*!
             * Truck class.
             * \extends Vehicle
             */
            struct Truck
            {
             Vehicle base; //!< \protected Base class.
            };

            /*!
             * Main function.
             *
             * Ref vehicleStart(), objRef(), objUnref().
             */
            int main(void)
            {
             Car c;
             vehicleStart((Vehicle*) &c);
            }

             Click here
             for the corresponding HTML documentation that is generated by Doxygen.
      - - term: See also
          description: sections \extends, \implements, \public, \protected and \private.
    preformatted: []
    text: "\\memberof <name>\n\nThis command makes a function a member of a class in a similar way as \\relates\n does, only with this command the function is represented as a real \nmember of the class. This can be useful when the programming language \ndoes not support the concept of member functions natively (e.g. C).\n\nIt is also possible to use this command together with \\public, \\protected or \\private.\n\nExample:\n\nThe file manual.c in the example directory shows how to use this command: /**\n * \\file manual.c\n */\n\ntypedef struct Object Object; //!< Object type\ntypedef struct Vehicle Vehicle; //!< Vehicle type\ntypedef struct Car Car; //!< Car type\ntypedef struct Truck Truck; //!< Truck type\n\n/*!\n * Base object class.\n */\nstruct Object\n{\n int ref; //!< \\private Reference count.\n};\n\n/*!\n * Increments object reference count by one.\n * \\public \\memberof Object\n */\nstatic Object * objRef(Object *obj);\n\n/*!\n * Decrements object reference count by one.\n * \\public \\memberof Object\n */\nstatic Object * objUnref(Object *obj);\n\n/*!\n * Vehicle class.\n * \\extends Object\n */\nstruct Vehicle\n{\n Object base; //!< \\protected Base class.\n};\n\n/*!\n * Starts the vehicle.\n * \\public \\memberof Vehicle\n */\nvoid vehicleStart(Vehicle *obj);\n\n/*!\n * Stops the vehicle.\n * \\public \\memberof Vehicle\n */\nvoid vehicleStop(Vehicle *obj);\n\n/*!\n * Car class.\n * \\extends Vehicle\n */\nstruct Car\n{\n Vehicle base; //!< \\protected Base class.\n};\n\n/*!\n * Truck class.\n * \\extends Vehicle\n */\nstruct Truck\n{\n Vehicle base; //!< \\protected Base class.\n};\n\n/*!\n * Main function.\n *\n * Ref vehicleStart(), objRef(), objUnref().\n */\nint main(void)\n{\n Car c;\n vehicleStart((Vehicle*) &c);\n}\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen.\n\nSee also\n\nsections \\extends, \\implements, \\public, \\protected and \\private."
  - id: cmdmodule
    title: "\\module <name>"
    paragraphs:
      - Indicates that a comment block contains documentation for a C++20 module with name <name>.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \module <name>

      Indicates that a comment block contains documentation for a C++20 module with name <name>.
  - id: cmdname
    title: "\\name [(header)]"
    paragraphs:
      - 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 Member Groups for an example.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \name [(header)]

      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 Member Groups for an example.
  - id: cmdnamespace
    title: "\\namespace <name>"
    paragraphs:
      - Indicates that a comment block contains documentation for a namespace with name <name>.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \namespace <name>

      Indicates that a comment block contains documentation for a namespace with name <name>.
  - id: cmdnosubgrouping
    title: "\\nosubgrouping"
    paragraphs:
      - "This \ncommand can be put in the documentation of a class. It can be used in \ncombination with member grouping to avoid that Doxygen puts a member \ngroup as a subgroup of a Public/Protected/Private/... section."
    lists: []
    definition_lists:
      - - term: See also
          description: sections \publicsection, \protectedsection and \privatesection.
    preformatted: []
    text: "\\nosubgrouping\n\nThis \ncommand can be put in the documentation of a class. It can be used in \ncombination with member grouping to avoid that Doxygen puts a member \ngroup as a subgroup of a Public/Protected/Private/... section.\n\nSee also\n\nsections \\publicsection, \\protectedsection and \\privatesection."
  - id: cmdoverload
    title: "\\overload [(function declaration)]"
    paragraphs:
      - '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 \ndiffers from the above function only in what argument(s) it accepts."
      - "If the documentation for the overloaded member function is not \nlocated in front of the function declaration or definition, the optional\n argument should be used to specify the correct declaration of the \noverloaded function. Of course when the \\overload\n command is directly in front of the overloaded member function and the \noptional argument is used this should also be the correct declaration of\n the overloaded function."
      - Any other documentation that is inside the documentation block will by appended after the generated message.
    lists: []
    definition_lists:
      - - term: 'Note 1:'
          description: "You are responsible that \nthere is indeed an earlier documented member that is overloaded by this \none. To prevent that document reorders the documentation you should set SORT_MEMBER_DOCS to NO in this case."
      - - term: 'Note 2:'
          description: Only one \overload command can be present in a comment block.
      - - term: 'Example:'
          description: "class Overload_Test \n{\n public:\n void drawRect(int,int,int,int);\n void drawRect(const Rect &r);\n};\n\nvoid Overload_Test::drawRect(int x,int y,int w,int h) {}\nvoid Overload_Test::drawRect(const Rect &r) {}\n\n/*! \\class Overload_Test\n * \\brief A short description.\n * \n * More text.\n */\n\n/*! \\fn void Overload_Test::drawRect(int x,int y,int w,int h)\n * This command draws a rectangle with a left upper corner at ( \\a x , \\a y ),\n * width \\a w and height \\a h. \n */\n\n/*!\n * \\overload void Overload_Test::drawRect(const Rect &r)\n */\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
    preformatted: []
    text: "\\overload [(function declaration)]\n\nThis command can be used to generate the following standard text for an overloaded member function:\n\nThis is an overloaded member function, provided for convenience. It \ndiffers from the above function only in what argument(s) it accepts.\n\nIf the documentation for the overloaded member function is not \nlocated in front of the function declaration or definition, the optional\n argument should be used to specify the correct declaration of the \noverloaded function. Of course when the \\overload\n command is directly in front of the overloaded member function and the \noptional argument is used this should also be the correct declaration of\n the overloaded function.\n\nAny other documentation that is inside the documentation block will by appended after the generated message.\n\nNote 1:\n\nYou are responsible that \nthere is indeed an earlier documented member that is overloaded by this \none. To prevent that document reorders the documentation you should set SORT_MEMBER_DOCS to NO in this case.\n\nNote 2:\n\nOnly one \\overload command can be present in a comment block.\n\nExample:\n\nclass Overload_Test \n{\n public:\n void drawRect(int,int,int,int);\n void drawRect(const Rect &r);\n};\n\nvoid Overload_Test::drawRect(int x,int y,int w,int h) {}\nvoid Overload_Test::drawRect(const Rect &r) {}\n\n/*! \\class Overload_Test\n * \\brief A short description.\n * \n * More text.\n */\n\n/*! \\fn void Overload_Test::drawRect(int x,int y,int w,int h)\n * This command draws a rectangle with a left upper corner at ( \\a x , \\a y ),\n * width \\a w and height \\a h. \n */\n\n/*!\n * \\overload void Overload_Test::drawRect(const Rect &r)\n */\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
  - id: cmdpackage
    title: "\\package <name>"
    paragraphs:
      - Indicates that a comment block contains documentation for a Java package with name <name>.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \package <name>

      Indicates that a comment block contains documentation for a Java package with name <name>.
  - id: cmdpage
    title: "\\page <name> (title)"
    paragraphs:
      - "Indicates that a \ncomment block contains a piece of documentation that is not directly \nrelated to one specific class, file or member. The HTML generator \ncreates a page containing the documentation. The generator starts a new section in the chapter 'Page documentation'."
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            /*! \page page1 A documentation page
             \tableofcontents
             Leading text.
             \section sec An example section
             This page contains the subsections \ref subsection1 and \ref subsection2.
             For more info see page \ref page2.
             \subsection subsection1 The first subsection
             Text.
             \subsection subsection2 The second subsection
             More text.
            */

            /*! \page page2 Another page
             Even more info.
            */

             Click here
             for the corresponding HTML documentation that is generated by Doxygen.
      - - term: 'Note:'
          description: "The <name> argument consists of a combination of letters and number digits. If you wish to use upper case letters (e.g. MYPAGE1), or mixed case letters (e.g. MyPage1) in the <name> argument, you should set CASE_SENSE_NAMES to YES.\n However, this is advisable only if your file system is case sensitive. \nOtherwise (and for better portability) you should use all lower case \nletters (e.g. mypage1) for <name> in all references to the page."
      - - term: See also
          description: section \section, section \subsection, and section \ref.
    preformatted: []
    text: "\\page <name> (title)\n\nIndicates that a \ncomment block contains a piece of documentation that is not directly \nrelated to one specific class, file or member. The HTML generator \ncreates a page containing the documentation. The generator starts a new section in the chapter 'Page documentation'.\n\nExample:\n\n/*! \\page page1 A documentation page\n \\tableofcontents\n Leading text.\n \\section sec An example section\n This page contains the subsections \\ref subsection1 and \\ref subsection2.\n For more info see page \\ref page2.\n \\subsection subsection1 The first subsection\n Text.\n \\subsection subsection2 The second subsection\n More text.\n*/\n\n/*! \\page page2 Another page\n Even more info.\n*/\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen.\n\nNote:\n\nThe <name> argument consists of a combination of letters and number digits. If you wish to use upper case letters (e.g. MYPAGE1), or mixed case letters (e.g. MyPage1) in the <name> argument, you should set CASE_SENSE_NAMES to YES.\n However, this is advisable only if your file system is case sensitive. \nOtherwise (and for better portability) you should use all lower case \nletters (e.g. mypage1) for <name> in all references to the page.\n\nSee also\n\nsection \\section, section \\subsection, and section \\ref."
  - id: cmdprivate
    title: "\\private"
    paragraphs:
      - "Indicates that \nthe member documented by the comment block is private, i.e., should only\n be accessed by other members in the same class."
      - "Note that Doxygen automatically detects the protection level of \nmembers in object-oriented languages. This command is intended for use \nonly when the language does not support the concept of protection level \nnatively (e.g. C, PHP 4)."
      - For starting a section of private members, in a way similar to the "private:" class marker in C++, use \privatesection.
    lists: []
    definition_lists:
      - - term: See also
          description: sections \memberof, \public, \protected and \privatesection.
    preformatted: []
    text: "\\private\n\nIndicates that \nthe member documented by the comment block is private, i.e., should only\n be accessed by other members in the same class.\n\nNote that Doxygen automatically detects the protection level of \nmembers in object-oriented languages. This command is intended for use \nonly when the language does not support the concept of protection level \nnatively (e.g. C, PHP 4).\n\nFor starting a section of private members, in a way similar to the \"private:\" class marker in C++, use \\privatesection.\n\nSee also\n\nsections \\memberof, \\public, \\protected and \\privatesection."
  - id: cmdprivatesection
    title: "\\privatesection"
    paragraphs:
      - "Starting a section of private members, in a way similar to the \n\"private:\" class marker in C++. Indicates that the member documented by \nthe comment block is private, i.e., should only be accessed by other \nmembers in the same class."
    lists: []
    definition_lists:
      - - term: See also
          description: sections \memberof, \public, \protected and \private.
    preformatted: []
    text: "\\privatesection\n\nStarting a section of private members, in a way similar to the \n\"private:\" class marker in C++. Indicates that the member documented by \nthe comment block is private, i.e., should only be accessed by other \nmembers in the same class.\n\nSee also\n\nsections \\memberof, \\public, \\protected and \\private."
  - id: cmdproperty
    title: "\\property (qualified property name)"
    paragraphs:
      - "Indicates that a\n comment block contains documentation for a property (either global or \nas a member of a class). This command is equivalent to \\fn, \\typedef, and \\var."
    lists: []
    definition_lists:
      - - term: See also
          description: sections \fn, \typedef, and \var.
    preformatted: []
    text: "\\property (qualified property name)\n\nIndicates that a\n comment block contains documentation for a property (either global or \nas a member of a class). This command is equivalent to \\fn, \\typedef, and \\var.\n\nSee also\n\nsections \\fn, \\typedef, and \\var."
  - id: cmdprotected
    title: "\\protected"
    paragraphs:
      - "Indicates \nthat the member documented by the comment block is protected, i.e., \nshould only be accessed by other members in the same or derived classes."
      - "Note that Doxygen automatically detects the protection level of \nmembers in object-oriented languages. This command is intended for use \nonly when the language does not support the concept of protection level \nnatively (e.g. C, PHP 4)."
      - For starting a section of protected members, in a way similar to the "protected:" class marker in C++, use \protectedsection.
    lists: []
    definition_lists:
      - - term: See also
          description: sections \memberof, \public, \private and \protectedsection.
    preformatted: []
    text: "\\protected\n\nIndicates \nthat the member documented by the comment block is protected, i.e., \nshould only be accessed by other members in the same or derived classes.\n\nNote that Doxygen automatically detects the protection level of \nmembers in object-oriented languages. This command is intended for use \nonly when the language does not support the concept of protection level \nnatively (e.g. C, PHP 4).\n\nFor starting a section of protected members, in a way similar to the \"protected:\" class marker in C++, use \\protectedsection.\n\nSee also\n\nsections \\memberof, \\public, \\private and \\protectedsection."
  - id: cmdprotectedsection
    title: "\\protectedsection"
    paragraphs:
      - "Starting a section of protected members, in a way similar to the \n\"protected:\" class marker in C++. Indicates that the member documented \nby the comment block is protected, i.e., should only be accessed by \nother members in the same or derived classes."
    lists: []
    definition_lists:
      - - term: See also
          description: sections \memberof, \public, \private and \protected.
    preformatted: []
    text: "\\protectedsection\n\nStarting a section of protected members, in a way similar to the \n\"protected:\" class marker in C++. Indicates that the member documented \nby the comment block is protected, i.e., should only be accessed by \nother members in the same or derived classes.\n\nSee also\n\nsections \\memberof, \\public, \\private and \\protected."
  - id: cmdprotocol
    title: "\\protocol <name> [<header-file>] [<header-name>]"
    paragraphs:
      - |-
        Indicates that a
         comment block contains documentation for a protocol in Objective-C with
         name <name>. The arguments are equal to the \class command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \class.
    preformatted: []
    text: |-
      \protocol <name> [<header-file>] [<header-name>]

      Indicates that a
       comment block contains documentation for a protocol in Objective-C with
       name <name>. The arguments are equal to the \class command.

      See also

      section \class.
  - id: cmdpublic
    title: "\\public"
    paragraphs:
      - Indicates that the member documented by the comment block is public, i.e., can be accessed by any other class or function.
      - "Note that Doxygen automatically detects the protection level of \nmembers in object-oriented languages. This command is intended for use \nonly when the language does not support the concept of protection level \nnatively (e.g. C, PHP 4)."
      - For starting a section of public members, in a way similar to the "public:" class marker in C++, use \publicsection.
    lists: []
    definition_lists:
      - - term: See also
          description: sections \memberof, \protected, \private and \publicsection.
    preformatted: []
    text: "\\public\n\nIndicates that the member documented by the comment block is public, i.e., can be accessed by any other class or function.\n\nNote that Doxygen automatically detects the protection level of \nmembers in object-oriented languages. This command is intended for use \nonly when the language does not support the concept of protection level \nnatively (e.g. C, PHP 4).\n\nFor starting a section of public members, in a way similar to the \"public:\" class marker in C++, use \\publicsection.\n\nSee also\n\nsections \\memberof, \\protected, \\private and \\publicsection."
  - id: cmdpublicsection
    title: "\\publicsection"
    paragraphs:
      - "Starting a section of public members, in a way similar to the \"public:\" \nclass marker in C++. Indicates that the member documented by the comment\n block is public, i.e., can be accessed by any other class or function."
    lists: []
    definition_lists:
      - - term: See also
          description: sections \memberof, \protected, \private and \public.
    preformatted: []
    text: "\\publicsection\n\nStarting a section of public members, in a way similar to the \"public:\" \nclass marker in C++. Indicates that the member documented by the comment\n block is public, i.e., can be accessed by any other class or function.\n\nSee also\n\nsections \\memberof, \\protected, \\private and \\public."
  - id: cmdpure
    title: "\\pure"
    paragraphs:
      - "Indicates that the \nmember documented by the comment block is pure virtual, i.e., it is \nabstract and has no implementation associated with it."
      - "This command is intended for use only when the language does not \nsupport the concept of pure virtual methods natively (e.g. C, PHP 4)."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\pure\n\nIndicates that the \nmember documented by the comment block is pure virtual, i.e., it is \nabstract and has no implementation associated with it.\n\nThis command is intended for use only when the language does not \nsupport the concept of pure virtual methods natively (e.g. C, PHP 4)."
  - id: cmdrelates
    title: "\\relates <name>"
    paragraphs:
      - "This command can \nbe used in the documentation of a non-member function <name>. It \nputs the function inside the 'related function' section of the class \ndocumentation. This command is useful for documenting non-friend \nfunctions that are nevertheless strongly coupled to a certain class. It \nprevents the need of having to document a file, but only works for \nfunctions."
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: "/*! \n * A String class.\n */ \n\nclass String\n{\n friend int strcmp(const String &,const String &);\n};\n\n/*! \n * Compares two strings.\n */\n\nint strcmp(const String &s1,const String &s2)\n{\n}\n\n/*! \\relates String\n * A string debug function.\n */\nvoid stringDebug()\n{\n}\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
    preformatted: []
    text: "\\relates <name>\n\nThis command can \nbe used in the documentation of a non-member function <name>. It \nputs the function inside the 'related function' section of the class \ndocumentation. This command is useful for documenting non-friend \nfunctions that are nevertheless strongly coupled to a certain class. It \nprevents the need of having to document a file, but only works for \nfunctions.\n\nExample:\n\n/*! \n * A String class.\n */ \n\nclass String\n{\n friend int strcmp(const String &,const String &);\n};\n\n/*! \n * Compares two strings.\n */\n\nint strcmp(const String &s1,const String &s2)\n{\n}\n\n/*! \\relates String\n * A string debug function.\n */\nvoid stringDebug()\n{\n}\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
  - id: cmdrelated
    title: "\\related <name>"
    paragraphs:
      - Equivalent to \relates
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \related <name>

      Equivalent to \relates
  - id: cmdrelatesalso
    title: "\\relatesalso <name>"
    paragraphs:
      - "This \ncommand can be used in the documentation of a non-member function \n<name>. It puts the function both inside the 'related function' \nsection of the class documentation as well as leaving it at its normal \nfile documentation location. This command is useful for documenting \nnon-friend functions that are nevertheless strongly coupled to a certain\n class. It only works for functions."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\relatesalso <name>\n\nThis \ncommand can be used in the documentation of a non-member function \n<name>. It puts the function both inside the 'related function' \nsection of the class documentation as well as leaving it at its normal \nfile documentation location. This command is useful for documenting \nnon-friend functions that are nevertheless strongly coupled to a certain\n class. It only works for functions."
  - id: cmdrelatedalso
    title: "\\relatedalso <name>"
    paragraphs:
      - Equivalent to \relatesalso
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \relatedalso <name>

      Equivalent to \relatesalso
  - id: cmdrequirement
    title: "\\requirement <id> [(title)]"
    paragraphs:
      - "Indicates\n that a comment block contains documentation for a requirement. In the \noutput, all requirements are collected on a single page."
      - A requirement can be referred to by its <id> using the normal linking commands like \ref. There are two special commands to refer to a requirement.
      - Together the \satisfies and \verifies commands help to provide traceability information to show where in the code a requirement has been implemented and/or tested.
      - Requirements can be imported via tag files as well.
    lists:
      - - "\\satisfies can be placed in the comment for a function or class (or any other symbol) that contributes to the implementation of the requirement."
        - "\\verifies can be placed at the function or class that tests the requirement."
    definition_lists:
      - - term: See also
          description: sections \satisfies and \verifies
    preformatted: []
    text: "\\requirement <id> [(title)]\n\nIndicates\n that a comment block contains documentation for a requirement. In the \noutput, all requirements are collected on a single page.\n\nA requirement can be referred to by its <id> using the normal linking commands like \\ref. There are two special commands to refer to a requirement.\n\nTogether the \\satisfies and \\verifies commands help to provide traceability information to show where in the code a requirement has been implemented and/or tested.\n\nRequirements can be imported via tag files as well.\n\n\\satisfies can be placed in the comment for a function or class (or any other symbol) that contributes to the implementation of the requirement.\n\n\\verifies can be placed at the function or class that tests the requirement.\n\nSee also\n\nsections \\satisfies and \\verifies"
  - id: cmdshowinitializer
    title: "\\showinitializer"
    paragraphs:
      - "By default the value of a define and the initializer of a variable are \nonly displayed if they are less than 30 lines long. By putting this \ncommand in a comment block of a define or variable, the initializer is \nshown unconditionally. The maximum number of initialization lines can be\n changed by means of the configuration parameter MAX_INITIALIZER_LINES, the default value is 30."
    lists: []
    definition_lists:
      - - term: See also
          description: section \hideinitializer.
    preformatted: []
    text: "\\showinitializer\n\nBy default the value of a define and the initializer of a variable are \nonly displayed if they are less than 30 lines long. By putting this \ncommand in a comment block of a define or variable, the initializer is \nshown unconditionally. The maximum number of initialization lines can be\n changed by means of the configuration parameter MAX_INITIALIZER_LINES, the default value is 30.\n\nSee also\n\nsection \\hideinitializer."
  - id: cmdstatic
    title: "\\static"
    paragraphs:
      - "Indicates that the \nmember documented by the comment block is static, i.e., it works on a \nclass, instead of on an instance of the class."
      - This command is intended for use only when the language does not support the concept of static methods natively (e.g. C).
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\static\n\nIndicates that the \nmember documented by the comment block is static, i.e., it works on a \nclass, instead of on an instance of the class.\n\nThis command is intended for use only when the language does not support the concept of static methods natively (e.g. C)."
  - id: cmdstruct
    title: "\\struct <name> [<header-file>] [<header-name>]"
    paragraphs:
      - "Indicates that a \ncomment block contains documentation for a struct with name \n<name>. The arguments are equal to the arguments of the \\class command."
    lists: []
    definition_lists:
      - - term: See also
          description: section \class.
    preformatted: []
    text: "\\struct <name> [<header-file>] [<header-name>]\n\nIndicates that a \ncomment block contains documentation for a struct with name \n<name>. The arguments are equal to the arguments of the \\class command.\n\nSee also\n\nsection \\class."
  - id: cmdtypedef
    title: "\\typedef (typedef declaration)"
    paragraphs:
      - "Indicates that a \ncomment block contains documentation for a typedef (either global or as a\n member of a class). This command is equivalent to \\fn, \\property, and \\var."
    lists: []
    definition_lists:
      - - term: See also
          description: section \fn, \property, and \var.
    preformatted: []
    text: "\\typedef (typedef declaration)\n\nIndicates that a \ncomment block contains documentation for a typedef (either global or as a\n member of a class). This command is equivalent to \\fn, \\property, and \\var.\n\nSee also\n\nsection \\fn, \\property, and \\var."
  - id: cmdunion
    title: "\\union <name> [<header-file>] [<header-name>]"
    paragraphs:
      - "Indicates that a \ncomment block contains documentation for a union with name <name>.\n The arguments are equal to the arguments of the \\class command."
    lists: []
    definition_lists:
      - - term: See also
          description: section \class.
    preformatted: []
    text: "\\union <name> [<header-file>] [<header-name>]\n\nIndicates that a \ncomment block contains documentation for a union with name <name>.\n The arguments are equal to the arguments of the \\class command.\n\nSee also\n\nsection \\class."
  - id: cmdvar
    title: "\\var (variable declaration)"
    paragraphs:
      - "Indicates that a comment \nblock contains documentation for a variable or enum value (either global\n or as a member of a class). This command is equivalent to \\fn, \\property, and \\typedef."
      - Note that for PHP one can also specify the type of the variable. The syntax is similar as for the phpDocumentor but the description has to start at the next line, i.e.
    lists: []
    definition_lists:
      - - term: See also
          description: section \fn, \property, and \typedef.
    preformatted:
      - |-
        @var  datatype $varname
        Description
    text: "\\var (variable declaration)\n\nIndicates that a comment \nblock contains documentation for a variable or enum value (either global\n or as a member of a class). This command is equivalent to \\fn, \\property, and \\typedef.\n\nNote that for PHP one can also specify the type of the variable. The syntax is similar as for the phpDocumentor but the description has to start at the next line, i.e.\n\n@var datatype $varname\nDescription\n\nSee also\n\nsection \\fn, \\property, and \\typedef."
  - id: cmdvhdlflow
    title: "\\vhdlflow [(title for the flow chart)]"
    paragraphs:
      - "This is a VHDL \nspecific command, which can be put in the documentation of a process to \nproduce a flow chart of the logic in the process. Optionally a title for\n the flow chart can be given."
    lists: []
    definition_lists:
      - - term: Note
          description: Currently the flow chart will only appear in the HTML output.
    preformatted: []
    text: "\\vhdlflow [(title for the flow chart)]\n\nThis is a VHDL \nspecific command, which can be put in the documentation of a process to \nproduce a flow chart of the logic in the process. Optionally a title for\n the flow chart can be given.\n\nNote\n\nCurrently the flow chart will only appear in the HTML output."
  - id: cmdweakgroup
    title: "\\weakgroup <name> [(title)]"
    paragraphs:
      - Can be used exactly like \addtogroup, but has a lower priority when it comes to resolving conflicting grouping definitions.
      - "--- Section indicators ---"
    lists: []
    definition_lists:
      - - term: See also
          description: page Grouping and section \addtogroup.
    preformatted: []
    text: |-
      \weakgroup <name> [(title)]

      Can be used exactly like \addtogroup, but has a lower priority when it comes to resolving conflicting grouping definitions.

      --- Section indicators ---

      See also

      page Grouping and section \addtogroup.
  - id: cmdattention
    title: "\\attention { attention text }"
    paragraphs:
      - "Starts a \nparagraph where a message that needs attention may be entered. The \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. All visual enhancement commands may be used inside \nthe paragraph. Multiple adjacent \\attention commands will be joined into a single paragraph. The \\attention command ends when a blank line or some other sectioning command is encountered."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\attention { attention text }\n\nStarts a \nparagraph where a message that needs attention may be entered. The \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. All visual enhancement commands may be used inside \nthe paragraph. Multiple adjacent \\attention commands will be joined into a single paragraph. The \\attention command ends when a blank line or some other sectioning command is encountered."
  - id: cmdauthor
    title: "\\author { list of authors }"
    paragraphs:
      - "Starts a paragraph \nwhere one or more author names may be entered. The paragraph will be \nindented. The text of the paragraph has no special internal structure. \nAll visual enhancement commands may be used inside the paragraph. \nMultiple adjacent \\author commands will be joined into a single paragraph. Each author description will start a new line. Alternatively, one \\author command may mention several authors. The \\author command ends when a blank line or some other sectioning command is encountered."
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: "/*! \n * \\brief Pretty nice class.\n * \\details This class is used to demonstrate a number of section commands.\n * \\author John Doe\n * \\author Jan Doe\n * \\version 4.1a\n * \\date 1990-2011\n * \\pre First initialize the system.\n * \\bug Not all memory is freed when deleting an object of this class.\n * \\warning Improper use can crash your application\n * \\copyright GNU Public License.\n */\nclass SomeNiceClass {};\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
    preformatted: []
    text: "\\author { list of authors }\n\nStarts a paragraph \nwhere one or more author names may be entered. The paragraph will be \nindented. The text of the paragraph has no special internal structure. \nAll visual enhancement commands may be used inside the paragraph. \nMultiple adjacent \\author commands will be joined into a single paragraph. Each author description will start a new line. Alternatively, one \\author command may mention several authors. The \\author command ends when a blank line or some other sectioning command is encountered.\n\nExample:\n\n/*! \n * \\brief Pretty nice class.\n * \\details This class is used to demonstrate a number of section commands.\n * \\author John Doe\n * \\author Jan Doe\n * \\version 4.1a\n * \\date 1990-2011\n * \\pre First initialize the system.\n * \\bug Not all memory is freed when deleting an object of this class.\n * \\warning Improper use can crash your application\n * \\copyright GNU Public License.\n */\nclass SomeNiceClass {};\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
  - id: cmdauthors
    title: "\\authors { list of authors }"
    paragraphs:
      - Equivalent to \author.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \authors { list of authors }

      Equivalent to \author.
  - id: cmdbrief
    title: "\\brief { brief description }"
    paragraphs:
      - "Starts a paragraph \nthat serves as a brief description. For classes and files the brief \ndescription will be used in lists and at the start of the documentation \npage. For class and file members, the brief description will be placed \nat the declaration of the member and prepended to the detailed \ndescription. A brief description may span several lines (although it is \nadvised to keep it brief!). A brief description ends when a blank line \nor another sectioning command is encountered. If multiple \\brief commands are present they will be joined. See section \\author for an example."
      - Synonymous to \short.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\brief { brief description }\n\nStarts a paragraph \nthat serves as a brief description. For classes and files the brief \ndescription will be used in lists and at the start of the documentation \npage. For class and file members, the brief description will be placed \nat the declaration of the member and prepended to the detailed \ndescription. A brief description may span several lines (although it is \nadvised to keep it brief!). A brief description ends when a blank line \nor another sectioning command is encountered. If multiple \\brief commands are present they will be joined. See section \\author for an example.\n\nSynonymous to \\short."
  - id: cmdbug
    title: "\\bug { bug description }"
    paragraphs:
      - "Starts a paragraph where \none or more bugs may be reported. The paragraph will be indented. The \ntext of the paragraph has no special internal structure. All visual \nenhancement commands may be used inside the paragraph. Multiple adjacent\n \\bug commands will be joined into a single paragraph. Each bug description will start on a new line. Alternatively, one \\bug command may mention several bugs. The \\bug command ends when a blank line or some other sectioning command is encountered. See section \\author for an example."
      - "The description will also add an item to a separate Bug list and the \ntwo instances of the description will be cross-referenced. Each item in \nthe Bug list will be preceded by a header that indicates the origin of \nthe item."
      - The Bug list and the corresponding entries can be disabled by setting the GENERATE_BUGLIST to NO.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\bug { bug description }\n\nStarts a paragraph where \none or more bugs may be reported. The paragraph will be indented. The \ntext of the paragraph has no special internal structure. All visual \nenhancement commands may be used inside the paragraph. Multiple adjacent\n \\bug commands will be joined into a single paragraph. Each bug description will start on a new line. Alternatively, one \\bug command may mention several bugs. The \\bug command ends when a blank line or some other sectioning command is encountered. See section \\author for an example.\n\nThe description will also add an item to a separate Bug list and the \ntwo instances of the description will be cross-referenced. Each item in \nthe Bug list will be preceded by a header that indicates the origin of \nthe item.\n\nThe Bug list and the corresponding entries can be disabled by setting the GENERATE_BUGLIST to NO."
  - id: cmdcond
    title: "\\cond [(section-label)]"
    paragraphs:
      - "Starts a conditional section that ends with a corresponding \\endcond\n command, which is typically found in another comment block. The main \npurpose of this pair of commands is to (conditionally) exclude part of a\n file from processing (in older version of Doxygen this could only be \nachieved using C preprocessor commands)."
      - "The section between \\cond and \\endcond can be included by adding its section label to the ENABLED_SECTIONS\n configuration option. If the section label is omitted, the section will\n be excluded from processing unconditionally. The section label can be a\n logical expression build of section labels, round brackets, && \n(AND), || (OR) and ! (NOT). If you use an expression you need to wrap it\n in round brackets, i.e \\cond (!LABEL1 && LABEL2)."
      - For conditional sections within a comment block one should use a \if ... \endif block. When using \cond and the condition is not satisfied the current comment block is ended and everything until the matching \endcond is removed and a new command block is started there.
      - "Conditional sections can be nested. In this case a nested section \nwill only be shown if it and its containing section are included."
      - 'Here is an example showing the commands in action:'
      - The output will be different depending on whether or not ENABLED_SECTIONS contains TEST, or DEV
    lists: []
    definition_lists:
      - - term: See also
          description: sections \if, \ifnot, \else, \elseif, \endif, \endcond, and ENABLED_SECTIONS.
      - - term: Note
          description: Due to the moment of parsing the \cond and \endcond commands cannot be used in ALIASES.
    preformatted:
      - |-
        /** An interface */
        class Intf
        {
          public:
            /** A method */
            virtual void func() = 0;

            /// @cond TEST

            /** A method used for testing */
            virtual void test() = 0;

            /// @endcond
        };

        /// @cond DEV
        /*
         *  The implementation of the interface
         */
        class Implementation : public Intf
        {
          public:
            void func();

            /// @cond TEST
            void test();
            /// @endcond

            /// @cond
            /** This method is obsolete and does
             *  not show up in the documentation.
             */
            void obsolete();
            /// @endcond
        };

        /// @endcond
    text: "\\cond [(section-label)]\n\nStarts a conditional section that ends with a corresponding \\endcond\n command, which is typically found in another comment block. The main \npurpose of this pair of commands is to (conditionally) exclude part of a\n file from processing (in older version of Doxygen this could only be \nachieved using C preprocessor commands).\n\nThe section between \\cond and \\endcond can be included by adding its section label to the ENABLED_SECTIONS\n configuration option. If the section label is omitted, the section will\n be excluded from processing unconditionally. The section label can be a\n logical expression build of section labels, round brackets, && \n(AND), || (OR) and ! (NOT). If you use an expression you need to wrap it\n in round brackets, i.e \\cond (!LABEL1 && LABEL2).\n\nFor conditional sections within a comment block one should use a \\if ... \\endif block. When using \\cond and the condition is not satisfied the current comment block is ended and everything until the matching \\endcond is removed and a new command block is started there.\n\nConditional sections can be nested. In this case a nested section \nwill only be shown if it and its containing section are included.\n\nHere is an example showing the commands in action:\n\nThe output will be different depending on whether or not ENABLED_SECTIONS contains TEST, or DEV\n\n/** An interface */\nclass Intf\n{\n public:\n /** A method */\n virtual void func() = 0;\n\n /// @cond TEST\n\n /** A method used for testing */\n virtual void test() = 0;\n\n /// @endcond\n};\n\n/// @cond DEV\n/*\n * The implementation of the interface\n */\nclass Implementation : public Intf\n{\n public:\n void func();\n\n /// @cond TEST\n void test();\n /// @endcond\n\n /// @cond\n /** This method is obsolete and does\n * not show up in the documentation.\n */\n void obsolete();\n /// @endcond\n};\n\n/// @endcond\n\nSee also\n\nsections \\if, \\ifnot, \\else, \\elseif, \\endif, \\endcond, and ENABLED_SECTIONS.\n\nNote\n\nDue to the moment of parsing the \\cond and \\endcond commands cannot be used in ALIASES."
  - id: cmdcopyright
    title: "\\copyright { copyright description }"
    paragraphs:
      - "Starts a \nparagraph where the copyright of an entity can be described. This \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. See section \\author for an example."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\copyright { copyright description }\n\nStarts a \nparagraph where the copyright of an entity can be described. This \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. See section \\author for an example."
  - id: cmddate
    title: "\\date { date description }"
    paragraphs:
      - "Starts a paragraph \nwhere one or more dates may be entered. The paragraph will be indented. \nThe text of the paragraph has no special internal structure. All visual \nenhancement commands may be used inside the paragraph. Multiple adjacent\n \\date commands will be joined into a single paragraph. Each date description will start on a new line. Alternatively, one \\date command may mention several dates. The \\date command ends when a blank line or some other sectioning command is encountered. See section \\author for an example."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\date { date description }\n\nStarts a paragraph \nwhere one or more dates may be entered. The paragraph will be indented. \nThe text of the paragraph has no special internal structure. All visual \nenhancement commands may be used inside the paragraph. Multiple adjacent\n \\date commands will be joined into a single paragraph. Each date description will start on a new line. Alternatively, one \\date command may mention several dates. The \\date command ends when a blank line or some other sectioning command is encountered. See section \\author for an example."
  - id: cmdshowdate
    title: \showdate "<format>" [ <date_time> ]
    paragraphs:
      - "Shows the date \nand time based on the given <format> and <date_time>. Where \nthe <format> is a string in which the following tokens have a \nspecial meaning:"
      - "Code Description \n\n%y Year without century as a zero-padded decimal number. \n\n%Y Year with century as a decimal number. \n\n%m Month as a zero-padded decimal number. \n\n%-m The month as a decimal number. \n\n%b Month as locale’s abbreviated name. \n\n%B Month as locale’s full name. \n\n%d Day of the month as a zero-padded decimal number. \n\n%-d Day of the month as a decimal number. \n\n%u The weekday as a decimal number (1-7), where Monday is 1. \n\n%w The weekday as a decimal number (0-6), where Sunday is 0. \n\n%a Weekday as locale’s abbreviated name. \n\n%A Weekday as locale’s full name. \n\n%H Hour (24-hour clock) as a zero-padded decimal number. \n\n%-H Hour (24-hour clock) as a decimal number. \n\n%I Hour (12-hour clock) as a zero-padded decimal number. \n\n%-I Hour (12-hour clock) as a decimal number. \n\n%M Minute as a zero-padded decimal number. \n\n%-M Minute as a decimal number. \n\n%S Second as a zero-padded decimal number. \n\n%-S Second as a decimal number. \n\n%p Locale’s equivalent of either AM or PM. \n\n%% A % character."
      - Note that the <format> has to be between double quotes.
      - 'In case the <date_time> is specified it has to have the following representation:'
      - in case the <date_time> is not specified the current date and time are used.
      - 'Here is an example:'
      - |-
        - \showdate "%A %d-%m-%Y" 2015-3-14
        - \showdate "%a %d-%m-%y" 2015-3-14
        - \showdate "%-m.%d%y" 2015-3-14
        - \showdate "%A %d-%m-%Y %H:%M:%S" 2015-3-14 03:04:15
        - \showdate "%A %d-%m-%Y %H:%M" 2015-3-14 03:04
      - 'In case OUTPUT_LANGUAGE=english this results in:'
      - 'In case OUTPUT_LANGUAGE=dutch this results in:'
    lists:
      - - |-
          optional date where date is:
          4 digits for the year
          a minus sign
          one or 2 digits for the month
          a minus sign
          one or 2 digits for the day
        - 4 digits for the year
        - a minus sign
        - one or 2 digits for the month
        - a minus sign
        - one or 2 digits for the day
        - |-
          optional time where time is:
          whitespace
          one or 2 digits for the hours
          a colon sign
          one or 2 digits for the minutes
          when the format contains %S or %-S
          a colon sign
          2 digits for the seconds
        - whitespace
        - one or 2 digits for the hours
        - a colon sign
        - one or 2 digits for the minutes
        - |-
          when the format contains %S or %-S
          a colon sign
          2 digits for the seconds
        - a colon sign
        - 2 digits for the seconds
      - - Saturday 14-03-2015
        - Sat 14-03-15
        - '3.1415'
        - Saturday 14-03-15 03:04:15
        - Saturday 14-03-15 03:04
      - - zaterdag 14-03-15
        - za 14-03-2015
        - '3.1415'
        - zaterdag 14-03-15 03:04:15
        - zaterdag 14-03-15 03:04
    definition_lists: []
    preformatted: []
    text: "\\showdate \"<format>\" [ <date_time> ]\n\nShows the date \nand time based on the given <format> and <date_time>. Where \nthe <format> is a string in which the following tokens have a \nspecial meaning:\n\nCode Description \n\n%y Year without century as a zero-padded decimal number. \n\n%Y Year with century as a decimal number. \n\n%m Month as a zero-padded decimal number. \n\n%-m The month as a decimal number. \n\n%b Month as locale’s abbreviated name. \n\n%B Month as locale’s full name. \n\n%d Day of the month as a zero-padded decimal number. \n\n%-d Day of the month as a decimal number. \n\n%u The weekday as a decimal number (1-7), where Monday is 1. \n\n%w The weekday as a decimal number (0-6), where Sunday is 0. \n\n%a Weekday as locale’s abbreviated name. \n\n%A Weekday as locale’s full name. \n\n%H Hour (24-hour clock) as a zero-padded decimal number. \n\n%-H Hour (24-hour clock) as a decimal number. \n\n%I Hour (12-hour clock) as a zero-padded decimal number. \n\n%-I Hour (12-hour clock) as a decimal number. \n\n%M Minute as a zero-padded decimal number. \n\n%-M Minute as a decimal number. \n\n%S Second as a zero-padded decimal number. \n\n%-S Second as a decimal number. \n\n%p Locale’s equivalent of either AM or PM. \n\n%% A % character.\n\nNote that the <format> has to be between double quotes.\n\nIn case the <date_time> is specified it has to have the following representation:\n\nin case the <date_time> is not specified the current date and time are used.\n\nHere is an example:\n\n- \\showdate \"%A %d-%m-%Y\" 2015-3-14\n- \\showdate \"%a %d-%m-%y\" 2015-3-14\n- \\showdate \"%-m.%d%y\" 2015-3-14\n- \\showdate \"%A %d-%m-%Y %H:%M:%S\" 2015-3-14 03:04:15\n- \\showdate \"%A %d-%m-%Y %H:%M\" 2015-3-14 03:04\n\nIn case OUTPUT_LANGUAGE=english this results in:\n\nIn case OUTPUT_LANGUAGE=dutch this results in:\n\noptional date where date is:\n4 digits for the year\na minus sign\none or 2 digits for the month\na minus sign\none or 2 digits for the day\n\n4 digits for the year\n\na minus sign\n\none or 2 digits for the month\n\na minus sign\n\none or 2 digits for the day\n\noptional time where time is:\nwhitespace\none or 2 digits for the hours\na colon sign\none or 2 digits for the minutes\nwhen the format contains %S or %-S\na colon sign\n2 digits for the seconds\n\nwhitespace\n\none or 2 digits for the hours\n\na colon sign\n\none or 2 digits for the minutes\n\nwhen the format contains %S or %-S\na colon sign\n2 digits for the seconds\n\na colon sign\n\n2 digits for the seconds\n\nSaturday 14-03-2015\n\nSat 14-03-15\n\n3.1415\n\nSaturday 14-03-15 03:04:15\n\nSaturday 14-03-15 03:04\n\nzaterdag 14-03-15\n\nza 14-03-2015\n\n3.1415\n\nzaterdag 14-03-15 03:04:15\n\nzaterdag 14-03-15 03:04"
  - id: cmddeprecated
    title: "\\deprecated { description }"
    paragraphs:
      - "Starts a \nparagraph indicating that this documentation block belongs to a \ndeprecated entity. Can be used to describe alternatives, expected life \nspan, etc. The paragraph will be indented. The text of the paragraph has\n no special internal structure. All visual enhancement commands may be \nused inside the paragraph. Multiple adjacent \\deprecated commands will be joined into a single paragraph. Each deprecation description will start on a new line. The \\deprecated command ends when a blank line or some other sectioning command is encountered."
      - "The description will also add an item to a separate Deprecated list \nand the two instances of the description will be cross-referenced. Each \nitem in the Deprecated list will be preceded by a header that indicates \nthe origin of the item."
      - The Deprecated list and the corresponding entries can be disabled by setting the GENERATE_DEPRECATEDLIST to NO.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\deprecated { description }\n\nStarts a \nparagraph indicating that this documentation block belongs to a \ndeprecated entity. Can be used to describe alternatives, expected life \nspan, etc. The paragraph will be indented. The text of the paragraph has\n no special internal structure. All visual enhancement commands may be \nused inside the paragraph. Multiple adjacent \\deprecated commands will be joined into a single paragraph. Each deprecation description will start on a new line. The \\deprecated command ends when a blank line or some other sectioning command is encountered.\n\nThe description will also add an item to a separate Deprecated list \nand the two instances of the description will be cross-referenced. Each \nitem in the Deprecated list will be preceded by a header that indicates \nthe origin of the item.\n\nThe Deprecated list and the corresponding entries can be disabled by setting the GENERATE_DEPRECATEDLIST to NO."
  - id: cmddetails
    title: "\\details { detailed description }"
    paragraphs:
      - Just like \brief starts a brief description, \details starts the detailed description. You can also start a new paragraph (blank line) then the \details command is not needed.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \details { detailed description }

      Just like \brief starts a brief description, \details starts the detailed description. You can also start a new paragraph (blank line) then the \details command is not needed.
  - id: cmdnoop
    title: "\\noop ( text to be ignored )"
    paragraphs:
      - |-
        All the text, including
         the command, till the end of the line is ignored. The command will most
         commonly be used in combination with ALIASES to ignore not supported commands that are present for e.g. other processing tools.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \noop ( text to be ignored )

      All the text, including
       the command, till the end of the line is ignored. The command will most
       commonly be used in combination with ALIASES to ignore not supported commands that are present for e.g. other processing tools.
  - id: cmdraisewarning
    title: "\\raisewarning ( text to be shown as warning )"
    paragraphs:
      - "All the\n text, excluding the command, till the end of the line is literally \nshown as a documentation warning. The text, including the command, is \nremoved from the output. The command will most commonly be used in \ncombination with ALIASES to show a specific warning."
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            \raisewarning My specific warning

            \warnNoDoc

            \warnNoDoc{My specific warning}
             together with: ALIASES = warnNoDoc="\raisewarning Missing documentation"
            ALIASES += warnNoDoc{1}="\raisewarning Incomplete documentation: \1"
             will result in: ex_1.md:1: warning: My specific warning
             ex_1.md:3: warning: Missing documentation
             ex_1.md:5: warning: Incomplete documentation: My specific warning
    preformatted: []
    text: "\\raisewarning ( text to be shown as warning )\n\nAll the\n text, excluding the command, till the end of the line is literally \nshown as a documentation warning. The text, including the command, is \nremoved from the output. The command will most commonly be used in \ncombination with ALIASES to show a specific warning.\n\nExample:\n\n\\raisewarning My specific warning\n\n\\warnNoDoc\n\n\\warnNoDoc{My specific warning}\n together with: ALIASES = warnNoDoc=\"\\raisewarning Missing documentation\"\nALIASES += warnNoDoc{1}=\"\\raisewarning Incomplete documentation: \\1\"\n will result in: ex_1.md:1: warning: My specific warning\n ex_1.md:3: warning: Missing documentation\n ex_1.md:5: warning: Incomplete documentation: My specific warning"
  - id: cmdelse
    title: "\\else"
    paragraphs:
      - "Starts a conditional \nsection if the previous conditional section was not enabled. The \nprevious section should have been started with a \\if, \\ifnot, or \\elseif command."
    lists: []
    definition_lists:
      - - term: See also
          description: sections \if, \ifnot, \elseif, \endif.
    preformatted: []
    text: "\\else\n\nStarts a conditional \nsection if the previous conditional section was not enabled. The \nprevious section should have been started with a \\if, \\ifnot, or \\elseif command.\n\nSee also\n\nsections \\if, \\ifnot, \\elseif, \\endif."
  - id: cmdelseif
    title: "\\elseif (section-label)"
    paragraphs:
      - "Starts a \nconditional documentation section if the previous section was not \nenabled. A conditional section is disabled by default. To enable it you \nmust put the section-label after the ENABLED_SECTIONS\n tag in the configuration file. The section label can be a logical \nexpression build of section names, round brackets, && (AND), || \n(OR) and ! (NOT). Conditional blocks can be nested. A nested section is \nonly enabled if all enclosing sections are enabled as well."
    lists: []
    definition_lists:
      - - term: See also
          description: sections \if, \ifnot, \else, \endif.
    preformatted: []
    text: "\\elseif (section-label)\n\nStarts a \nconditional documentation section if the previous section was not \nenabled. A conditional section is disabled by default. To enable it you \nmust put the section-label after the ENABLED_SECTIONS\n tag in the configuration file. The section label can be a logical \nexpression build of section names, round brackets, && (AND), || \n(OR) and ! (NOT). Conditional blocks can be nested. A nested section is \nonly enabled if all enclosing sections are enabled as well.\n\nSee also\n\nsections \\if, \\ifnot, \\else, \\endif."
  - id: cmdendcond
    title: "\\endcond"
    paragraphs:
      - Ends a conditional section that was started by \cond.
    lists: []
    definition_lists:
      - - term: See also
          description: section \cond.
      - - term: Note
          description: Due to the moment of parsing the \endcond and \cond commands cannot be used in ALIASES.
    preformatted: []
    text: |-
      \endcond

      Ends a conditional section that was started by \cond.

      See also

      section \cond.

      Note

      Due to the moment of parsing the \endcond and \cond commands cannot be used in ALIASES.
  - id: cmdendif
    title: "\\endif"
    paragraphs:
      - Ends a conditional section that was started by \if or \ifnot For each \if or \ifnot one and only one matching \endif must follow.
    lists: []
    definition_lists:
      - - term: See also
          description: sections \if, \ifnot, \else, \elseif.
    preformatted: []
    text: |-
      \endif

      Ends a conditional section that was started by \if or \ifnot For each \if or \ifnot one and only one matching \endif must follow.

      See also

      sections \if, \ifnot, \else, \elseif.
  - id: cmdexception
    title: "\\exception <exception-object> { exception description }"
    paragraphs:
      - "Starts an \nexception description for an exception object with name \n<exception-object>. Followed by a description of the exception. \nThe existence of the exception object is not checked. The text of the \nparagraph has no special internal structure. All visual enhancement \ncommands may be used inside the paragraph. Multiple adjacent \\exception commands will be joined into a single paragraph. Each exception description will start on a new line. The \\exception description ends when a blank line or some other sectioning command is encountered. See section \\fn for an example."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\exception <exception-object> { exception description }\n\nStarts an \nexception description for an exception object with name \n<exception-object>. Followed by a description of the exception. \nThe existence of the exception object is not checked. The text of the \nparagraph has no special internal structure. All visual enhancement \ncommands may be used inside the paragraph. Multiple adjacent \\exception commands will be joined into a single paragraph. Each exception description will start on a new line. The \\exception description ends when a blank line or some other sectioning command is encountered. See section \\fn for an example."
  - id: cmdif
    title: "\\if (section-label)"
    paragraphs:
      - Starts a conditional documentation section. The section ends with a matching \endif command. A conditional section is disabled by default. To enable it you must put the section-label after the ENABLED_SECTIONS tag in the configuration file.
      - "The section label can be a logical expression build of section names,\n round brackets, && (AND), || (OR) and ! (NOT). If you use an \nexpression you need to wrap it in round brackets, i.e \\if (!LABEL1 && LABEL2)."
      - Conditional blocks can be nested. A nested section is only enabled if all enclosing sections are enabled as well.
      - The \if and corresponding \endif have to be in the same comment block. When a conditional block needs to span more than one comment block one has to use \cond ... \endcond.
      - 'You can also use conditional commands inside aliases. To document a class in two languages you could for instance use:'
      - 'Where the following aliases are defined in the configuration file:'
      - and ENABLED_SECTIONS can be used to enable either english or dutch.
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            /*! Unconditionally shown documentation.
             * \if Cond1
             * Only included if Cond1 is set.
             * \endif
             * \if Cond2
             * Only included if Cond2 is set.
             * \if Cond3
             * Only included if Cond2 and Cond3 are set.
             * \endif
             * More text.
             * \endif
             * Unconditional text.
             */
      - - term: 'Example 2:'
          description: |-
            /*! \english
             * This is English.
             * \endenglish
             * \dutch
             * Dit is Nederlands.
             * \enddutch
             */
            class Example
            {
            };
      - - term: See also
          description: sections \endif, \ifnot, \else, \elseif, \cond, \endcond, and ENABLED_SECTIONS.
    preformatted:
      - |-
        ALIASES  = "english=\if english" \
                   "endenglish=\endif" \
                   "dutch=\if dutch" \
                   "enddutch=\endif"
    text: "\\if (section-label)\n\nStarts a conditional documentation section. The section ends with a matching \\endif command. A conditional section is disabled by default. To enable it you must put the section-label after the ENABLED_SECTIONS tag in the configuration file.\n\nThe section label can be a logical expression build of section names,\n round brackets, && (AND), || (OR) and ! (NOT). If you use an \nexpression you need to wrap it in round brackets, i.e \\if (!LABEL1 && LABEL2).\n\nConditional blocks can be nested. A nested section is only enabled if all enclosing sections are enabled as well.\n\nThe \\if and corresponding \\endif have to be in the same comment block. When a conditional block needs to span more than one comment block one has to use \\cond ... \\endcond.\n\nYou can also use conditional commands inside aliases. To document a class in two languages you could for instance use:\n\nWhere the following aliases are defined in the configuration file:\n\nand ENABLED_SECTIONS can be used to enable either english or dutch.\n\nALIASES = \"english=\\if english\" \\\n \"endenglish=\\endif\" \\\n \"dutch=\\if dutch\" \\\n \"enddutch=\\endif\"\n\nExample:\n\n/*! Unconditionally shown documentation.\n * \\if Cond1\n * Only included if Cond1 is set.\n * \\endif\n * \\if Cond2\n * Only included if Cond2 is set.\n * \\if Cond3\n * Only included if Cond2 and Cond3 are set.\n * \\endif\n * More text.\n * \\endif\n * Unconditional text.\n */\n\nExample 2:\n\n/*! \\english\n * This is English.\n * \\endenglish\n * \\dutch\n * Dit is Nederlands.\n * \\enddutch\n */\nclass Example\n{\n};\n\nSee also\n\nsections \\endif, \\ifnot, \\else, \\elseif, \\cond, \\endcond, and ENABLED_SECTIONS."
  - id: cmdifnot
    title: "\\ifnot (section-label)"
    paragraphs:
      - "Starts a conditional documentation section. The section ends with a matching \\endif command. This conditional section is enabled by default. To disable it you must put the section-label after the ENABLED_SECTIONS\n tag in the configuration file. The section label can be a logical \nexpression build of section names, round brackets, && (AND), || \n(OR) and ! (NOT)."
    lists: []
    definition_lists:
      - - term: See also
          description: sections \endif, \if, \else, and \elseif, \cond, \endcond, and ENABLED_SECTIONS.
    preformatted: []
    text: "\\ifnot (section-label)\n\nStarts a conditional documentation section. The section ends with a matching \\endif command. This conditional section is enabled by default. To disable it you must put the section-label after the ENABLED_SECTIONS\n tag in the configuration file. The section label can be a logical \nexpression build of section names, round brackets, && (AND), || \n(OR) and ! (NOT).\n\nSee also\n\nsections \\endif, \\if, \\else, and \\elseif, \\cond, \\endcond, and ENABLED_SECTIONS."
  - id: cmdimportant
    title: "\\important { important text }"
    paragraphs:
      - "Starts a \nparagraph where a message that needs important may be entered. The \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. All visual enhancement commands may be used inside \nthe paragraph. Multiple adjacent \\important commands will be joined into a single paragraph. The \\important command ends when a blank line or some other sectioning command is encountered."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\important { important text }\n\nStarts a \nparagraph where a message that needs important may be entered. The \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. All visual enhancement commands may be used inside \nthe paragraph. Multiple adjacent \\important commands will be joined into a single paragraph. The \\important command ends when a blank line or some other sectioning command is encountered."
  - id: cmdinvariant
    title: "\\invariant { description of invariant }"
    paragraphs:
      - "Starts a \nparagraph where the invariant of an entity can be described. The \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. All visual enhancement commands may be used inside \nthe paragraph. Multiple adjacent \\invariant commands will be joined into a single paragraph. Each invariant description will start on a new line. Alternatively, one \\invariant command may mention several invariants. The \\invariant command ends when a blank line or some other sectioning command is encountered."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\invariant { description of invariant }\n\nStarts a \nparagraph where the invariant of an entity can be described. The \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. All visual enhancement commands may be used inside \nthe paragraph. Multiple adjacent \\invariant commands will be joined into a single paragraph. Each invariant description will start on a new line. Alternatively, one \\invariant command may mention several invariants. The \\invariant command ends when a blank line or some other sectioning command is encountered."
  - id: cmdnote
    title: "\\note { text }"
    paragraphs:
      - "Starts a paragraph \nwhere a note can be entered. The paragraph will be indented. The text of\n the paragraph has no special internal structure. All visual enhancement\n commands may be used inside the paragraph. Multiple adjacent \\note commands will be joined into a single paragraph. Each note description will start on a new line. Alternatively, one \\note command may mention several notes. The \\note command ends when a blank line or some other sectioning command is encountered. See section \\par for an example."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\note { text }\n\nStarts a paragraph \nwhere a note can be entered. The paragraph will be indented. The text of\n the paragraph has no special internal structure. All visual enhancement\n commands may be used inside the paragraph. Multiple adjacent \\note commands will be joined into a single paragraph. Each note description will start on a new line. Alternatively, one \\note command may mention several notes. The \\note command ends when a blank line or some other sectioning command is encountered. See section \\par for an example."
  - id: cmdpar
    title: "\\par [(paragraph title)] { paragraph }"
    paragraphs:
      - "If a paragraph title is \ngiven this command starts a paragraph with a user defined heading. The \nheading extends until the end of the line. The paragraph following the \ncommand will be indented."
      - "If no paragraph title is given this command will start a new \nparagraph. This will also work inside other paragraph commands (like \\param or \\warning) without ending that command."
      - "The text of the paragraph has no special internal structure. All \nvisual enhancement commands may be used inside the paragraph. The \\par command ends when a blank line or some other sectioning command is encountered."
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: "/*! \\class Par_Test\n * Normal text.\n *\n * \\par User defined paragraph:\n * Contents of the paragraph.\n *\n * \\par\n * New paragraph under the same heading.\n *\n * \\note\n * This note consists of two paragraphs.\n * This is the first paragraph.\n *\n * \\par\n * And this is the second paragraph.\n *\n * More normal text. \n */\n\nclass Par_Test {};\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
    preformatted: []
    text: "\\par [(paragraph title)] { paragraph }\n\nIf a paragraph title is \ngiven this command starts a paragraph with a user defined heading. The \nheading extends until the end of the line. The paragraph following the \ncommand will be indented.\n\nIf no paragraph title is given this command will start a new \nparagraph. This will also work inside other paragraph commands (like \\param or \\warning) without ending that command.\n\nThe text of the paragraph has no special internal structure. All \nvisual enhancement commands may be used inside the paragraph. The \\par command ends when a blank line or some other sectioning command is encountered.\n\nExample:\n\n/*! \\class Par_Test\n * Normal text.\n *\n * \\par User defined paragraph:\n * Contents of the paragraph.\n *\n * \\par\n * New paragraph under the same heading.\n *\n * \\note\n * This note consists of two paragraphs.\n * This is the first paragraph.\n *\n * \\par\n * And this is the second paragraph.\n *\n * More normal text. \n */\n\nclass Par_Test {};\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
  - id: cmdparam
    title: "\\param[<dir>] <parameter-name> { parameter description }"
    paragraphs:
      - "Starts a parameter \ndescription for a function parameter with name <parameter-name>, \nfollowed by a description of the parameter. The existence of the \nparameter is checked and a warning is given if the documentation of this\n (or any other) parameter is missing or not present in the function \ndeclaration or definition."
      - "The \\param command has an optional attribute, \n<dir>, specifying the direction of the parameter. Possible values \nare \"[in]\", \"[out]\", and \"[in,out]\"; note the [square] brackets in this \ndescription. For the bidirectional values, directions \"in\" and \"out\" can\n be specified in any order, and they can either be written together \n(without separator), or separated with a comma (,)\n or a space. That means that for example values \"[outin]\" or \"[in out]\" \nare also valid. Note that it is also possible to put whitespace between \nthe command and the <dir>. When a parameter is both input and \noutput, [in,out] is used as attribute. Here is an example for the \nfunction memcpy:"
      - |-
        /*!
         * Copies bytes from a source memory area to a destination memory area,
         * where both areas may not overlap.
         * \param[out] dest The memory area to copy to.
         * \param[in] src The memory area to copy from.
         * \param[in] n The number of bytes to copy
         */
        void memcpy(void *dest, const void *src, size_t n);
      - "The parameter description is a paragraph with \nno special internal structure. All visual enhancement commands may be \nused inside the paragraph."
      - Multiple adjacent \param commands will be joined into a single paragraph. Each parameter description will start on a new line. The \param description ends when a blank line or some other sectioning command is encountered. See section \fn for an example.
      - "The parameter name is normally the name given in the function \nsignature. For unnamed parameters, a positional index can also be used \n(starting with 1 for the first parameter)."
      - |-
        /** Base */
        class Base
        {
         public:
         /** Method
         * \param 1 First parameter docs
         * \param 2 Second parameter docs
         */
         virtual void method(int, int) = 0;
        };

        /** Derived */
        class Derived : public Base
        {
         public:
         void method(int x, int y) override;
        };
      - Alternatively, a minus sign (-) can be used as placeholder for the name of an unnamed parameter.
      - |-
        /** Function docs.
         * \param - First parameter
         * \param - Second parameter
         */
        void foo(int, int)
        {
        }
      - "Both ordinal position (numeric) and dash (-) \nparameter names are rendered as a dash in the output, unless a later \ndefinition or overriding method provides the actual parameter names, as \nis the case in the Derived class in the example above."
      - 'Note that you can also document multiple parameters with a single \param command using a comma-separated list. Here is an example:'
      - |-
        /** Sets the position.
         * \param x,y,z Coordinates of the position in 3D space.
         */
        void setPosition(double x, double y, double z)
        {
        }
      - "Note that for PHP one can also specify the \ntype (or types if you separate them with a pipe symbol) which are \nallowed for a parameter (as this is not part of the definition). The \nsyntax is the same as for the phpDocumentor, i.e."
    lists: []
    definition_lists: []
    preformatted:
      - "\\param  datatype1|datatype2 $paramname description"
    text: "\\param[<dir>] <parameter-name> { parameter description }\n\nStarts a parameter \ndescription for a function parameter with name <parameter-name>, \nfollowed by a description of the parameter. The existence of the \nparameter is checked and a warning is given if the documentation of this\n (or any other) parameter is missing or not present in the function \ndeclaration or definition.\n\nThe \\param command has an optional attribute, \n<dir>, specifying the direction of the parameter. Possible values \nare \"[in]\", \"[out]\", and \"[in,out]\"; note the [square] brackets in this \ndescription. For the bidirectional values, directions \"in\" and \"out\" can\n be specified in any order, and they can either be written together \n(without separator), or separated with a comma (,)\n or a space. That means that for example values \"[outin]\" or \"[in out]\" \nare also valid. Note that it is also possible to put whitespace between \nthe command and the <dir>. When a parameter is both input and \noutput, [in,out] is used as attribute. Here is an example for the \nfunction memcpy:\n\n/*!\n * Copies bytes from a source memory area to a destination memory area,\n * where both areas may not overlap.\n * \\param[out] dest The memory area to copy to.\n * \\param[in] src The memory area to copy from.\n * \\param[in] n The number of bytes to copy\n */\nvoid memcpy(void *dest, const void *src, size_t n);\n\nThe parameter description is a paragraph with \nno special internal structure. All visual enhancement commands may be \nused inside the paragraph.\n\nMultiple adjacent \\param commands will be joined into a single paragraph. Each parameter description will start on a new line. The \\param description ends when a blank line or some other sectioning command is encountered. See section \\fn for an example.\n\nThe parameter name is normally the name given in the function \nsignature. For unnamed parameters, a positional index can also be used \n(starting with 1 for the first parameter).\n\n/** Base */\nclass Base\n{\n public:\n /** Method\n * \\param 1 First parameter docs\n * \\param 2 Second parameter docs\n */\n virtual void method(int, int) = 0;\n};\n\n/** Derived */\nclass Derived : public Base\n{\n public:\n void method(int x, int y) override;\n};\n\nAlternatively, a minus sign (-) can be used as placeholder for the name of an unnamed parameter.\n\n/** Function docs.\n * \\param - First parameter\n * \\param - Second parameter\n */\nvoid foo(int, int)\n{\n}\n\nBoth ordinal position (numeric) and dash (-) \nparameter names are rendered as a dash in the output, unless a later \ndefinition or overriding method provides the actual parameter names, as \nis the case in the Derived class in the example above.\n\nNote that you can also document multiple parameters with a single \\param command using a comma-separated list. Here is an example:\n\n/** Sets the position.\n * \\param x,y,z Coordinates of the position in 3D space.\n */\nvoid setPosition(double x, double y, double z)\n{\n}\n\nNote that for PHP one can also specify the \ntype (or types if you separate them with a pipe symbol) which are \nallowed for a parameter (as this is not part of the definition). The \nsyntax is the same as for the phpDocumentor, i.e.\n\n\\param datatype1|datatype2 $paramname description"
  - id: cmdparblock
    title: "\\parblock"
    paragraphs:
      - For commands that expect a single paragraph as argument (such as \par, \param and \warning), the \parblock command allows to start a description that covers multiple paragraphs, which then ends with \endparblock.
      - 'Example:'
      - Note that the \parblock command may also appear directly after \param's first argument.
    lists: []
    definition_lists: []
    preformatted:
      - |-
        /** Example of a param command with a description consisting of two paragraphs
         *  \param p
         *  \parblock
         *  First paragraph of the param description.
         *
         *  Second paragraph of the param description.
         *  \endparblock
         *  Rest of the comment block continues.
         */
    text: |-
      \parblock

      For commands that expect a single paragraph as argument (such as \par, \param and \warning), the \parblock command allows to start a description that covers multiple paragraphs, which then ends with \endparblock.

      Example:

      Note that the \parblock command may also appear directly after \param's first argument.

      /** Example of a param command with a description consisting of two paragraphs
       * \param p
       * \parblock
       * First paragraph of the param description.
       *
       * Second paragraph of the param description.
       * \endparblock
       * Rest of the comment block continues.
       */
  - id: cmdendparblock
    title: "\\endparblock"
    paragraphs:
      - This ends a block of paragraphs started with \parblock.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \endparblock

      This ends a block of paragraphs started with \parblock.
  - id: cmdtparam
    title: "\\tparam <template-parameter-name> { description }"
    paragraphs:
      - "Starts a template \nparameter for a class or function template parameter with name \n<template-parameter-name>, followed by a description of the \ntemplate parameter."
      - Otherwise similar to \param.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\tparam <template-parameter-name> { description }\n\nStarts a template \nparameter for a class or function template parameter with name \n<template-parameter-name>, followed by a description of the \ntemplate parameter.\n\nOtherwise similar to \\param."
  - id: cmdpost
    title: "\\post { description of the postcondition }"
    paragraphs:
      - "Starts a paragraph \nwhere the postcondition of an entity can be described. The paragraph \nwill be indented. The text of the paragraph has no special internal \nstructure. All visual enhancement commands may be used inside the \nparagraph. Multiple adjacent \\post commands will be joined into a single paragraph. Each postcondition will start on a new line. Alternatively, one \\post command may mention several postconditions. The \\post command ends when a blank line or some other sectioning command is encountered."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\post { description of the postcondition }\n\nStarts a paragraph \nwhere the postcondition of an entity can be described. The paragraph \nwill be indented. The text of the paragraph has no special internal \nstructure. All visual enhancement commands may be used inside the \nparagraph. Multiple adjacent \\post commands will be joined into a single paragraph. Each postcondition will start on a new line. Alternatively, one \\post command may mention several postconditions. The \\post command ends when a blank line or some other sectioning command is encountered."
  - id: cmdpre
    title: "\\pre { description of the precondition }"
    paragraphs:
      - "Starts a paragraph where \nthe precondition of an entity can be described. The paragraph will be \nindented. The text of the paragraph has no special internal structure. \nAll visual enhancement commands may be used inside the paragraph. \nMultiple adjacent \\pre commands will be joined into a single paragraph. Each precondition will start on a new line. Alternatively, one \\pre command may mention several preconditions. The \\pre command ends when a blank line or some other sectioning command is encountered."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\pre { description of the precondition }\n\nStarts a paragraph where \nthe precondition of an entity can be described. The paragraph will be \nindented. The text of the paragraph has no special internal structure. \nAll visual enhancement commands may be used inside the paragraph. \nMultiple adjacent \\pre commands will be joined into a single paragraph. Each precondition will start on a new line. Alternatively, one \\pre command may mention several preconditions. The \\pre command ends when a blank line or some other sectioning command is encountered."
  - id: cmdremark
    title: "\\remark { remark text }"
    paragraphs:
      - "Starts a paragraph \nwhere one or more remarks may be entered. The paragraph will be \nindented. The text of the paragraph has no special internal structure. \nAll visual enhancement commands may be used inside the paragraph. \nMultiple adjacent \\remark commands will be joined into a single paragraph. Each remark will start on a new line. Alternatively, one \\remark command may mention several remarks. The \\remark command ends when a blank line or some other sectioning command is encountered."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\remark { remark text }\n\nStarts a paragraph \nwhere one or more remarks may be entered. The paragraph will be \nindented. The text of the paragraph has no special internal structure. \nAll visual enhancement commands may be used inside the paragraph. \nMultiple adjacent \\remark commands will be joined into a single paragraph. Each remark will start on a new line. Alternatively, one \\remark command may mention several remarks. The \\remark command ends when a blank line or some other sectioning command is encountered."
  - id: cmdremarks
    title: "\\remarks { remark text }"
    paragraphs:
      - Equivalent to \remark.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \remarks { remark text }

      Equivalent to \remark.
  - id: cmdresult
    title: "\\result { description of the result value }"
    paragraphs:
      - Equivalent to \return.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \result { description of the result value }

      Equivalent to \return.
  - id: cmdreturn
    title: "\\return { description of the return value }"
    paragraphs:
      - "Starts a return \nvalue description for a function. The text of the paragraph has no \nspecial internal structure. All visual enhancement commands may be used \ninside the paragraph. Multiple adjacent \\return commands will be joined into a single paragraph. The \\return description ends when a blank line or some other sectioning command is encountered. See section \\fn for an example."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\return { description of the return value }\n\nStarts a return \nvalue description for a function. The text of the paragraph has no \nspecial internal structure. All visual enhancement commands may be used \ninside the paragraph. Multiple adjacent \\return commands will be joined into a single paragraph. The \\return description ends when a blank line or some other sectioning command is encountered. See section \\fn for an example."
  - id: cmdreturns
    title: "\\returns { description of the return value }"
    paragraphs:
      - Equivalent to \return.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \returns { description of the return value }

      Equivalent to \return.
  - id: cmdretval
    title: "\\retval <return value> { description }"
    paragraphs:
      - "Starts a \ndescription for a function's return value with name <return \nvalue>, followed by a description of the return value. The text of \nthe paragraph that forms the description has no special internal \nstructure. All visual enhancement commands may be used inside the \nparagraph. Multiple adjacent \\retval commands will be joined into a single paragraph. Each return value description will start on a new line. The \\retval description ends when a blank line or some other sectioning command is encountered."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\retval <return value> { description }\n\nStarts a \ndescription for a function's return value with name <return \nvalue>, followed by a description of the return value. The text of \nthe paragraph that forms the description has no special internal \nstructure. All visual enhancement commands may be used inside the \nparagraph. Multiple adjacent \\retval commands will be joined into a single paragraph. Each return value description will start on a new line. The \\retval description ends when a blank line or some other sectioning command is encountered."
  - id: cmdsa
    title: "\\sa { references }"
    paragraphs:
      - "Starts a paragraph where \none or more cross-references to classes, functions, methods, variables, \nfiles or URL may be specified. Two names joined by either :: or #\n are understood as referring to a class and one of its members. One of \nseveral overloaded methods or constructors may be selected by including a\n parenthesized list of argument types after the method name."
      - Synonymous to \see.
    lists: []
    definition_lists:
      - - term: See also
          description: section autolink for information on how to create links to objects.
    preformatted: []
    text: "\\sa { references }\n\nStarts a paragraph where \none or more cross-references to classes, functions, methods, variables, \nfiles or URL may be specified. Two names joined by either :: or #\n are understood as referring to a class and one of its members. One of \nseveral overloaded methods or constructors may be selected by including a\n parenthesized list of argument types after the method name.\n\nSynonymous to \\see.\n\nSee also\n\nsection autolink for information on how to create links to objects."
  - id: cmdsee
    title: "\\see { references }"
    paragraphs:
      - Equivalent to \sa. Introduced for compatibility with Javadoc.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \see { references }

      Equivalent to \sa. Introduced for compatibility with Javadoc.
  - id: cmdshort
    title: "\\short { short description }"
    paragraphs:
      - Equivalent to \brief.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \short { short description }

      Equivalent to \brief.
  - id: cmdsince
    title: "\\since { text }"
    paragraphs:
      - This command can be used to specify since when (version or time) an entity is available. The paragraph that follows \since does not have any special internal structure. All visual enhancement commands may be used inside the paragraph. The \since description ends when a blank line or some other sectioning command is encountered.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \since { text }

      This command can be used to specify since when (version or time) an entity is available. The paragraph that follows \since does not have any special internal structure. All visual enhancement commands may be used inside the paragraph. The \since description ends when a blank line or some other sectioning command is encountered.
  - id: cmdtest
    title: "\\test { paragraph describing a test case }"
    paragraphs:
      - "Starts a paragraph \nwhere one or more test cases can be described. The paragraph will be \nindented. The text of the paragraph has no special internal structure. \nAll visual enhancement commands may be used inside the paragraph. \nMultiple adjacent \\test commands will be joined into a single paragraph. Each test case description will start on a new line. Alternatively, one \\test command may mention several test cases. The \\test command ends when a blank line or some other sectioning command is encountered."
      - |-
        The description will also add an item to a separate Test list and the
         two instances of the description will be cross-referenced. Each item in
         the Test list will be preceded by a header that indicates the origin of
         the item.
      - The Test list and the corresponding entries can be disabled by setting the GENERATE_TESTLIST to NO.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\test { paragraph describing a test case }\n\nStarts a paragraph \nwhere one or more test cases can be described. The paragraph will be \nindented. The text of the paragraph has no special internal structure. \nAll visual enhancement commands may be used inside the paragraph. \nMultiple adjacent \\test commands will be joined into a single paragraph. Each test case description will start on a new line. Alternatively, one \\test command may mention several test cases. The \\test command ends when a blank line or some other sectioning command is encountered.\n\nThe description will also add an item to a separate Test list and the\n two instances of the description will be cross-referenced. Each item in\n the Test list will be preceded by a header that indicates the origin of\n the item.\n\nThe Test list and the corresponding entries can be disabled by setting the GENERATE_TESTLIST to NO."
  - id: cmdthrow
    title: "\\throw <exception-object> { exception description }"
    paragraphs:
      - Synonymous \exception.
    lists: []
    definition_lists:
      - - term: 'Note:'
          description: the command \throws is a synonym for this command.
      - - term: See also
          description: section \exception
    preformatted: []
    text: |-
      \throw <exception-object> { exception description }

      Synonymous \exception.

      Note:

      the command \throws is a synonym for this command.

      See also

      section \exception
  - id: cmdthrows
    title: "\\throws <exception-object> { exception description }"
    paragraphs:
      - Equivalent to \throw.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \throws <exception-object> { exception description }

      Equivalent to \throw.
  - id: cmdtodo
    title: "\\todo { paragraph describing what is to be done }"
    paragraphs:
      - "Starts a paragraph \nwhere one or more todo items are described. The paragraph will be \nindented. The text of the paragraph has no special internal structure. \nAll visual enhancement commands may be used inside the paragraph. \nMultiple adjacent \\todo commands will be joined into a single paragraph. Each todo description will start on a new line. Alternatively, one \\todo command may mention several todo descriptions. The \\todo command ends when a blank line or some other sectioning command is encountered."
      - |-
        The description will also add an item to a separate Todo list and the
         two instances of the description will be cross-referenced. Each item in
         the Todo list will be preceded by a header that indicates the origin of
         the item.
      - The Todo list and the corresponding entries can be disabled by setting the GENERATE_TODOLIST to NO.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\todo { paragraph describing what is to be done }\n\nStarts a paragraph \nwhere one or more todo items are described. The paragraph will be \nindented. The text of the paragraph has no special internal structure. \nAll visual enhancement commands may be used inside the paragraph. \nMultiple adjacent \\todo commands will be joined into a single paragraph. Each todo description will start on a new line. Alternatively, one \\todo command may mention several todo descriptions. The \\todo command ends when a blank line or some other sectioning command is encountered.\n\nThe description will also add an item to a separate Todo list and the\n two instances of the description will be cross-referenced. Each item in\n the Todo list will be preceded by a header that indicates the origin of\n the item.\n\nThe Todo list and the corresponding entries can be disabled by setting the GENERATE_TODOLIST to NO."
  - id: cmdversion
    title: "\\version { version number }"
    paragraphs:
      - "Starts a \nparagraph where one or more version strings may be entered. The \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. All visual enhancement commands may be used inside \nthe paragraph. Multiple adjacent \\version commands will be joined into a single paragraph. Each version description will start on a new line. Alternatively, one \\version\n command may mention several version strings. The \\version command ends \nwhen a blank line or some other sectioning command is encountered. See \nsection \\author for an example."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\version { version number }\n\nStarts a \nparagraph where one or more version strings may be entered. The \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. All visual enhancement commands may be used inside \nthe paragraph. Multiple adjacent \\version commands will be joined into a single paragraph. Each version description will start on a new line. Alternatively, one \\version\n command may mention several version strings. The \\version command ends \nwhen a blank line or some other sectioning command is encountered. See \nsection \\author for an example."
  - id: cmdwarning
    title: "\\warning { warning message }"
    paragraphs:
      - "Starts a \nparagraph where one or more warning messages may be entered. The \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. All visual enhancement commands may be used inside \nthe paragraph. Multiple adjacent \\warning commands will be joined into a single paragraph. Each warning description will start on a new line. Alternatively, one \\warning command may mention several warnings. The \\warning command ends when a blank line or some other sectioning command is encountered. See section \\author for an example."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\warning { warning message }\n\nStarts a \nparagraph where one or more warning messages may be entered. The \nparagraph will be indented. The text of the paragraph has no special \ninternal structure. All visual enhancement commands may be used inside \nthe paragraph. Multiple adjacent \\warning commands will be joined into a single paragraph. Each warning description will start on a new line. Alternatively, one \\warning command may mention several warnings. The \\warning command ends when a blank line or some other sectioning command is encountered. See section \\author for an example."
  - id: cmdxrefitem
    title: \xrefitem <key> "heading" "list title" { text }
    paragraphs:
      - "This command is a generalization of commands such as \\todo and \\bug.\n It can be used to create user-defined text sections which are \nautomatically cross-referenced between the place of occurrence and a \nrelated page, which will be generated. On the related page all sections \nof the same type will be collected."
      - "The first argument <key> is an identifier uniquely representing\n the type of the section. The second argument is a quoted string \nrepresenting the heading of the section under which text passed as the \nfourth argument is put. The third argument (list title) is used as the \ntitle for the related page containing all items with the same key. The \nsecond and third string argument cannot contain a newline. The keys \"todo\", \"test\", \"bug\" and \"deprecated\" are predefined."
      - To get an idea on how to use the \xrefitem command and what its effect is, consider the todo list, which (for English output) can be seen an alias for the command
      - "Since\n it is very tedious and error-prone to repeat the first three parameters\n of the command for each section, the command is meant to be used in \ncombination with the ALIASES option in the configuration file. To define a new command \\reminder, for instance, one should add the following line to the configuration file:"
      - Note the use of escaped quotes for the second and third argument of the \xrefitem command.
      - In case parameter "(heading)" is the empty string no heading is generated. This can be useful when used in combination with the \page command e.g.
      - with \error defined as
      - "--- Commands to create links ---"
    lists: []
    definition_lists: []
    preformatted:
      - \xrefitem todo "Todo" "Todo List"
      - ALIASES += "reminder=\xrefitem reminders \"Reminder\" \"Reminders\""
      - |-
        /** @page my_errors My Errors
         *  @brief Errors page
         *
         *  Errors page contents.
         */

        /** \error ERROR 101: in case a file can not be opened.
            Check about file system read/write access. */
        #define MY_ERR_CANNOT_OPEN_FILE                   101

        /** \error ERROR 102: in case a file can not be closed.
            Check about file system read/write access. */
        #define MY_ERR_CANNOT_CLOSE_FILE                  102
      - ALIASES += "error=\xrefitem my_errors \"\" \"\""
    text: "\\xrefitem <key> \"heading\" \"list title\" { text }\n\nThis command is a generalization of commands such as \\todo and \\bug.\n It can be used to create user-defined text sections which are \nautomatically cross-referenced between the place of occurrence and a \nrelated page, which will be generated. On the related page all sections \nof the same type will be collected.\n\nThe first argument <key> is an identifier uniquely representing\n the type of the section. The second argument is a quoted string \nrepresenting the heading of the section under which text passed as the \nfourth argument is put. The third argument (list title) is used as the \ntitle for the related page containing all items with the same key. The \nsecond and third string argument cannot contain a newline. The keys \"todo\", \"test\", \"bug\" and \"deprecated\" are predefined.\n\nTo get an idea on how to use the \\xrefitem command and what its effect is, consider the todo list, which (for English output) can be seen an alias for the command\n\nSince\n it is very tedious and error-prone to repeat the first three parameters\n of the command for each section, the command is meant to be used in \ncombination with the ALIASES option in the configuration file. To define a new command \\reminder, for instance, one should add the following line to the configuration file:\n\nNote the use of escaped quotes for the second and third argument of the \\xrefitem command.\n\nIn case parameter \"(heading)\" is the empty string no heading is generated. This can be useful when used in combination with the \\page command e.g.\n\nwith \\error defined as\n\n--- Commands to create links ---\n\n\\xrefitem todo \"Todo\" \"Todo List\"\n\nALIASES += \"reminder=\\xrefitem reminders \\\"Reminder\\\" \\\"Reminders\\\"\"\n\n/** @page my_errors My Errors\n * @brief Errors page\n *\n * Errors page contents.\n */\n\n/** \\error ERROR 101: in case a file can not be opened.\n Check about file system read/write access. */\n#define MY_ERR_CANNOT_OPEN_FILE 101\n\n/** \\error ERROR 102: in case a file can not be closed.\n Check about file system read/write access. */\n#define MY_ERR_CANNOT_CLOSE_FILE 102\n\nALIASES += \"error=\\xrefitem my_errors \\\"\\\" \\\"\\\"\""
  - id: cmdaddindex
    title: "\\addindex (text)"
    paragraphs:
      - This command adds (text) to the , DocBook and RTF index.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \addindex (text)

      This command adds (text) to the , DocBook and RTF index.
  - id: cmdanchor
    title: "\\anchor <word>"
    paragraphs:
      - This command places an invisible, named anchor into the documentation to which you can refer with the \ref command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \ref.
    preformatted: []
    text: |-
      \anchor <word>

      This command places an invisible, named anchor into the documentation to which you can refer with the \ref command.

      See also

      section \ref.
  - id: cmdcite
    title: "\\cite['{'[option]'}'] <label>"
    paragraphs:
      - "Adds a bibliographic \nreference in the text and in the list of bibliographic references. The \n<label> must be a valid BibTeX label that can be found in one of \nthe .bib files listed in CITE_BIB_FILES. For the output the formatting of the reference in the text can be configured with LATEX_BIB_STYLE. For other output formats a fixed representation is used. Note that using this command requires the bibtex tool to be present in the search path."
      - 'There are a number of options possible:'
    lists:
      - - |-
          number, shortauthor, year, these options are mutually exclusive, in case none of these is specified number is assumed.
          number create a numerical reference
          shortauthor just the surname of the first author is given, and in case multiple authors are present the text "et al." is added
          year, the year of publication is mentioned (when specified in the bibtex file).
        - number create a numerical reference
        - shortauthor just the surname of the first author is given, and in case multiple authors are present the text "et al." is added
        - year, the year of publication is mentioned (when specified in the bibtex file).
        - nopar, no (square) brackets are added
        - nocite, no link to a citation in the bibliography is made (and the reference is not added to the bibliography based on this item)
    definition_lists: []
    preformatted: []
    text: "\\cite['{'[option]'}'] <label>\n\nAdds a bibliographic \nreference in the text and in the list of bibliographic references. The \n<label> must be a valid BibTeX label that can be found in one of \nthe .bib files listed in CITE_BIB_FILES. For the output the formatting of the reference in the text can be configured with LATEX_BIB_STYLE. For other output formats a fixed representation is used. Note that using this command requires the bibtex tool to be present in the search path.\n\nThere are a number of options possible:\n\nnumber, shortauthor, year, these options are mutually exclusive, in case none of these is specified number is assumed.\nnumber create a numerical reference\nshortauthor just the surname of the first author is given, and in case multiple authors are present the text \"et al.\" is added\nyear, the year of publication is mentioned (when specified in the bibtex file).\n\nnumber create a numerical reference\n\nshortauthor just the surname of the first author is given, and in case multiple authors are present the text \"et al.\" is added\n\nyear, the year of publication is mentioned (when specified in the bibtex file).\n\nnopar, no (square) brackets are added\n\nnocite, no link to a citation in the bibliography is made (and the reference is not added to the bibliography based on this item)"
  - id: cmdendlink
    title: "\\endlink"
    paragraphs:
      - This command ends a link that is started with the \link command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \link.
    preformatted: []
    text: |-
      \endlink

      This command ends a link that is started with the \link command.

      See also

      section \link.
  - id: cmdlink
    title: "\\link <link-object>"
    paragraphs:
      - The links that are automatically generated by Doxygen always have the name of the object they point to as link-text.
      - "The \\link command can be used to create a link to an \nobject (a file, class, or member) with a user specified link-text. The \nlink command should end with an \\endlink command. All text between the \\link and \\endlink commands serves as text for a link to the <link-object> specified as the first argument of \\link."
    lists: []
    definition_lists:
      - - term: See also
          description: Section autolink for more information on automatically generated links and valid link-objects.
    preformatted: []
    text: "\\link <link-object>\n\nThe links that are automatically generated by Doxygen always have the name of the object they point to as link-text.\n\nThe \\link command can be used to create a link to an \nobject (a file, class, or member) with a user specified link-text. The \nlink command should end with an \\endlink command. All text between the \\link and \\endlink commands serves as text for a link to the <link-object> specified as the first argument of \\link.\n\nSee also\n\nSection autolink for more information on automatically generated links and valid link-objects."
  - id: cmdref
    title: \ref <name> ["(text)"]
    paragraphs:
      - Creates a reference to a named symbol, file, section, subsection, page or anchor.
      - "For HTML documentation the reference command will generate a link to \nthe section. For a section or subsection the title of the section will \nbe used as the text of the link. For an anchor the optional text between\n quotes will be used or <name> if no text is specified."
      - "In case <name> has spaces (for instance if it refers a file \nname containing spaces) you need to add double quotes around the \n<name>, e.g. \"my file.md\"."
      - |-
        For documentation the reference command will be the same unless the PDF_HYPERLINKS option has been set to NO,
         in this case it generates the section title for sections or the text if
         <name> refers to an anchor followed by a page number.
    lists: []
    definition_lists:
      - - term: See also
          description: Section \page for an example of the \ref command.
    preformatted: []
    text: "\\ref <name> [\"(text)\"]\n\nCreates a reference to a named symbol, file, section, subsection, page or anchor.\n\nFor HTML documentation the reference command will generate a link to \nthe section. For a section or subsection the title of the section will \nbe used as the text of the link. For an anchor the optional text between\n quotes will be used or <name> if no text is specified.\n\nIn case <name> has spaces (for instance if it refers a file \nname containing spaces) you need to add double quotes around the \n<name>, e.g. \"my file.md\".\n\nFor documentation the reference command will be the same unless the PDF_HYPERLINKS option has been set to NO,\n in this case it generates the section title for sections or the text if\n <name> refers to an anchor followed by a page number.\n\nSee also\n\nSection \\page for an example of the \\ref command."
  - id: cmdrefitem
    title: "\\refitem <name>"
    paragraphs:
      - Just like the \ref command, this command creates a reference to a named section, but this reference appears in a list that is started by \secreflist and ends with \endsecreflist. An example of such a list can be seen at the top of the page.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \refitem <name>

      Just like the \ref command, this command creates a reference to a named section, but this reference appears in a list that is started by \secreflist and ends with \endsecreflist. An example of such a list can be seen at the top of the page.
  - id: cmdsatisfies
    title: "\\satisfies <req-id> [(short description)]"
    paragraphs:
      - "Creates a \nreference to a requirement with an optional short description for the \nlink text. The function, class, or other symbol that contain such \nreference is considered to contribute to the implementation of the \nrequirement. A comment can contain multiple satisfies references \npointing to different requirements. There can also be multiple \ncontributors to the implementation of a single requirement, in which \ncase the satisfies command should be mentioned in the documentation of \neach contributing party."
    lists: []
    definition_lists:
      - - term: See also
          description: sections \verifies and \requirement
    preformatted: []
    text: "\\satisfies <req-id> [(short description)]\n\nCreates a \nreference to a requirement with an optional short description for the \nlink text. The function, class, or other symbol that contain such \nreference is considered to contribute to the implementation of the \nrequirement. A comment can contain multiple satisfies references \npointing to different requirements. There can also be multiple \ncontributors to the implementation of a single requirement, in which \ncase the satisfies command should be mentioned in the documentation of \neach contributing party.\n\nSee also\n\nsections \\verifies and \\requirement"
  - id: cmdverifies
    title: "\\verifies <req-id> [(short description)]"
    paragraphs:
      - "Creates a \nreference to a requirement with an optional short description for the \nlink text. The function, class, or other symbol that contain such \nreference is considered to contribute to testing/verifying the \nrequirement. A comment can contain multiple verifies references pointing\n to different requirements. There can also be multiple contributors to \ntest/verify a single requirement, in which case the verifies command \nshould be mentioned in the documentation of each contributing party."
    lists: []
    definition_lists:
      - - term: See also
          description: sections \satisfies and \requirement
    preformatted: []
    text: "\\verifies <req-id> [(short description)]\n\nCreates a \nreference to a requirement with an optional short description for the \nlink text. The function, class, or other symbol that contain such \nreference is considered to contribute to testing/verifying the \nrequirement. A comment can contain multiple verifies references pointing\n to different requirements. There can also be multiple contributors to \ntest/verify a single requirement, in which case the verifies command \nshould be mentioned in the documentation of each contributing party.\n\nSee also\n\nsections \\satisfies and \\requirement"
  - id: cmdsecreflist
    title: "\\secreflist"
    paragraphs:
      - Starts an index list of item, created with \refitem that each link to a named section.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \secreflist

      Starts an index list of item, created with \refitem that each link to a named section.
  - id: cmdendsecreflist
    title: "\\endsecreflist"
    paragraphs:
      - End an index list started with \secreflist.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \endsecreflist

      End an index list started with \secreflist.
  - id: cmdsubpage
    title: \subpage <name> ["(text)"]
    paragraphs:
      - This command can be used to create a hierarchy of pages. The same structure can be made using the \defgroup and \ingroup commands, but for pages the \subpage command is often more convenient. The main page (see \mainpage) is typically the root of hierarchy.
      - |-
        This command behaves similar as \ref
         in the sense that it creates a reference to a page labeled <name>
         with the optional link text as specified in the second argument.
      - "It differs from the \\ref\n command in that it only works for pages, and creates a parent-child \nrelation between pages, where the child page (or sub page) is identified\n by label <name>."
      - See the \section and \subsection commands if you want to add structure without creating multiple pages.
      - 'Here is an example:'
    lists: []
    definition_lists:
      - - term: Note
          description: "Each page can be the sub page \nof only one other page and no cyclic relations are allowed, i.e. the \npage hierarchy must have a tree structure."
    preformatted:
      - |-
        /*! \mainpage A simple manual

        Some general info.

        This manual is divided in the following sections:
        - \subpage intro
        - \subpage advanced "Advanced usage"
        */

        //-----------------------------------------------------------

        /*! \page intro Introduction
        This page introduces the user to the topic.
        Now you can proceed to the \ref advanced "advanced section".
        */

        //-----------------------------------------------------------

        /*! \page advanced Advanced Usage
        This page is for advanced users.
        Make sure you have first read \ref intro "the introduction".
        */
    text: "\\subpage <name> [\"(text)\"]\n\nThis command can be used to create a hierarchy of pages. The same structure can be made using the \\defgroup and \\ingroup commands, but for pages the \\subpage command is often more convenient. The main page (see \\mainpage) is typically the root of hierarchy.\n\nThis command behaves similar as \\ref\n in the sense that it creates a reference to a page labeled <name>\n with the optional link text as specified in the second argument.\n\nIt differs from the \\ref\n command in that it only works for pages, and creates a parent-child \nrelation between pages, where the child page (or sub page) is identified\n by label <name>.\n\nSee the \\section and \\subsection commands if you want to add structure without creating multiple pages.\n\nHere is an example:\n\n/*! \\mainpage A simple manual\n\nSome general info.\n\nThis manual is divided in the following sections:\n- \\subpage intro\n- \\subpage advanced \"Advanced usage\"\n*/\n\n//-----------------------------------------------------------\n\n/*! \\page intro Introduction\nThis page introduces the user to the topic.\nNow you can proceed to the \\ref advanced \"advanced section\".\n*/\n\n//-----------------------------------------------------------\n\n/*! \\page advanced Advanced Usage\nThis page is for advanced users.\nMake sure you have first read \\ref intro \"the introduction\".\n*/\n\nNote\n\nEach page can be the sub page \nof only one other page and no cyclic relations are allowed, i.e. the \npage hierarchy must have a tree structure."
  - id: cmdtableofcontents
    title: "\\tableofcontents['{'[option[:level]][,option[:level]]*'}']"
    paragraphs:
      - Creates a table of contents at the top of a page, listing all sections and subsections in the page. The option can be HTML or LaTeX or XML or DocBook. When a level is specified this means the maximum nesting level that is shown. The value of level should be in the range 1..6, values outside this range are considered to be 6. In case no level is specified level is set to 6 (show all) In case no option. is specified \tableofcontents acts as if just the option HTML and XML was specified. In case of multiple \tableofcontents commands in a page the option(s) will be used additional to the already specified option(s), but only the last level of an option is valid.
    lists: []
    definition_lists:
      - - term: Warning
          description: This command only works inside related page documentation and not in other documentation blocks and only has effect in the specified output!
    preformatted: []
    text: |-
      \tableofcontents['{'[option[:level]][,option[:level]]*'}']

      Creates a table of contents at the top of a page, listing all sections and subsections in the page. The option can be HTML or LaTeX or XML or DocBook. When a level is specified this means the maximum nesting level that is shown. The value of level should be in the range 1..6, values outside this range are considered to be 6. In case no level is specified level is set to 6 (show all) In case no option. is specified \tableofcontents acts as if just the option HTML and XML was specified. In case of multiple \tableofcontents commands in a page the option(s) will be used additional to the already specified option(s), but only the last level of an option is valid.

      Warning

      This command only works inside related page documentation and not in other documentation blocks and only has effect in the specified output!
  - id: cmdsection
    title: "\\section <section-name> (section title)"
    paragraphs:
      - Creates a section with name <section-name>. The title of the section should be specified as the second argument of the \section command.
    lists: []
    definition_lists:
      - - term: Warning
          description: This command only works inside related page documentation and not in other documentation blocks!
      - - term: See also
          description: Section \page for an example of the \section command.
    preformatted: []
    text: |-
      \section <section-name> (section title)

      Creates a section with name <section-name>. The title of the section should be specified as the second argument of the \section command.

      Warning

      This command only works inside related page documentation and not in other documentation blocks!

      See also

      Section \page for an example of the \section command.
  - id: cmdsubsection
    title: "\\subsection <subsection-name> (subsection title)"
    paragraphs:
      - "Creates a \nsubsection with name <subsection-name>. The title of the \nsubsection should be specified as the second argument of the \\subsection command."
    lists: []
    definition_lists:
      - - term: Warning
          description: This command only works inside a section of a related page documentation block and not in other documentation blocks!
      - - term: See also
          description: Section \page for an example of the \subsection command.
    preformatted: []
    text: "\\subsection <subsection-name> (subsection title)\n\nCreates a \nsubsection with name <subsection-name>. The title of the \nsubsection should be specified as the second argument of the \\subsection command.\n\nWarning\n\nThis command only works inside a section of a related page documentation block and not in other documentation blocks!\n\nSee also\n\nSection \\page for an example of the \\subsection command."
  - id: cmdsubsubsection
    title: "\\subsubsection <subsubsection-name> (subsubsection title)"
    paragraphs:
      - "Creates a subsubsection with name <subsubsection-name>. The title \nof the subsubsection should be specified as the second argument of the \\subsubsection command."
    lists: []
    definition_lists:
      - - term: Warning
          description: This command only works inside a subsection of a related page documentation block and not in other documentation blocks!
      - - term: See also
          description: Section \page for an example of the \section command and \subsection command.
    preformatted: []
    text: "\\subsubsection <subsubsection-name> (subsubsection title)\n\nCreates a subsubsection with name <subsubsection-name>. The title \nof the subsubsection should be specified as the second argument of the \\subsubsection command.\n\nWarning\n\nThis command only works inside a subsection of a related page documentation block and not in other documentation blocks!\n\nSee also\n\nSection \\page for an example of the \\section command and \\subsection command."
  - id: cmdparagraph
    title: "\\paragraph <paragraph-name> (paragraph title)"
    paragraphs:
      - "Creates a \nnamed paragraph with name <paragraph-name>. The title of the \nparagraph should be specified as the second argument of the \\paragraph command."
    lists: []
    definition_lists:
      - - term: Warning
          description: This command only works inside a subsubsection of a related page documentation block and not in other documentation blocks!
    preformatted: []
    text: "\\paragraph <paragraph-name> (paragraph title)\n\nCreates a \nnamed paragraph with name <paragraph-name>. The title of the \nparagraph should be specified as the second argument of the \\paragraph command.\n\nWarning\n\nThis command only works inside a subsubsection of a related page documentation block and not in other documentation blocks!"
  - id: cmdsubparagraph
    title: "\\subparagraph <subparagraph-name> (subparagraph title)"
    paragraphs:
      - "Creates\n a named subparagraph with name <subparagraph-name>. The title of \nthe subparagraph should be specified as the second argument of the \\subparagraph command."
    lists: []
    definition_lists:
      - - term: Warning
          description: This command only works inside a paragraph of a related page documentation block and not in other documentation blocks!
    preformatted: []
    text: "\\subparagraph <subparagraph-name> (subparagraph title)\n\nCreates\n a named subparagraph with name <subparagraph-name>. The title of \nthe subparagraph should be specified as the second argument of the \\subparagraph command.\n\nWarning\n\nThis command only works inside a paragraph of a related page documentation block and not in other documentation blocks!"
  - id: cmdsubsubparagraph
    title: "\\subsubparagraph <subsubparagraph-name> (subsubparagraph title)"
    paragraphs:
      - "Creates a named subsubparagraph with name <subsubparagraph-name>. \nThe title of the subsubparagraph should be specified as the second \nargument of the \\subsubparagraph command."
      - "--- Commands for displaying examples ---"
    lists: []
    definition_lists:
      - - term: Warning
          description: This command only works inside a subparagraph of a related page documentation block and not in other documentation blocks!
    preformatted: []
    text: "\\subsubparagraph <subsubparagraph-name> (subsubparagraph title)\n\nCreates a named subsubparagraph with name <subsubparagraph-name>. \nThe title of the subsubparagraph should be specified as the second \nargument of the \\subsubparagraph command.\n\n--- Commands for displaying examples ---\n\nWarning\n\nThis command only works inside a subparagraph of a related page documentation block and not in other documentation blocks!"
  - id: cmddontinclude
    title: "\\dontinclude['{lineno}'] <file-name>"
    paragraphs:
      - "This command can be used to parse a source file without actually verbatim including it in the documentation (as the \\include\n command does). This is useful if you want to divide the source file \ninto smaller pieces and add documentation between the pieces. Source \nfiles or directories can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file."
      - You can add the option lineno to enable line numbers for the included code if desired.
      - You can add the option strip that will always hide any special comments from the included code, overruling the STRIP_CODE_COMMENTS setting, or add the option nostrip to always show the special comments.
      - "The class and member declarations and definitions inside the code \nfragment are 'remembered' during the parsing of the comment block that \ncontained the \\dontinclude command."
      - For line by line descriptions of source files, one or more lines of the example can be displayed using the \line, \skip, \skipline, and \until commands. An internal pointer is used for these commands. The \dontinclude command sets the pointer to the first line of the example.
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: "/*! A test class. */\n\nclass Include_Test\n{\n public:\n /// a member function\n void example();\n};\n\n/*! \\page pag_example\n * \\dontinclude include_test.cpp\n * Our main function starts like this:\n * \\skip main\n * \\until {\n * First we create an object \\c t of the Include_Test class.\n * \\skipline Include_Test\n * Then we call the example member function \n * \\line example\n * After that our little test routine ends.\n * \\line }\n */\n Where the example file include_test.cpp looks as follows: void main()\n{\n Include_Test t;\n t.example();\n}\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen."
      - - term: See also
          description: sections \line, \skip, \skipline, \until, and \include.
    preformatted: []
    text: "\\dontinclude['{lineno}'] <file-name>\n\nThis command can be used to parse a source file without actually verbatim including it in the documentation (as the \\include\n command does). This is useful if you want to divide the source file \ninto smaller pieces and add documentation between the pieces. Source \nfiles or directories can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.\n\nYou can add the option lineno to enable line numbers for the included code if desired.\n\nYou can add the option strip that will always hide any special comments from the included code, overruling the STRIP_CODE_COMMENTS setting, or add the option nostrip to always show the special comments.\n\nThe class and member declarations and definitions inside the code \nfragment are 'remembered' during the parsing of the comment block that \ncontained the \\dontinclude command.\n\nFor line by line descriptions of source files, one or more lines of the example can be displayed using the \\line, \\skip, \\skipline, and \\until commands. An internal pointer is used for these commands. The \\dontinclude command sets the pointer to the first line of the example.\n\nExample:\n\n/*! A test class. */\n\nclass Include_Test\n{\n public:\n /// a member function\n void example();\n};\n\n/*! \\page pag_example\n * \\dontinclude include_test.cpp\n * Our main function starts like this:\n * \\skip main\n * \\until {\n * First we create an object \\c t of the Include_Test class.\n * \\skipline Include_Test\n * Then we call the example member function \n * \\line example\n * After that our little test routine ends.\n * \\line }\n */\n Where the example file include_test.cpp looks as follows: void main()\n{\n Include_Test t;\n t.example();\n}\n\n Click here\n for the corresponding HTML documentation that is generated by Doxygen.\n\nSee also\n\nsections \\line, \\skip, \\skipline, \\until, and \\include."
  - id: cmdinclude
    title: "\\include['{'option'}'] <file-name>"
    paragraphs:
      - "This command can \nbe used to include a source file as a block of code. The command takes \nthe name of an include file as an argument. Source files or directories \ncan be specified using the EXAMPLE_PATH tag of Doxygen's configuration file."
      - If <file-name> itself is not unique for the set of example files specified by the EXAMPLE_PATH tag, you can include part of the absolute path to disambiguate it.
      - Using the \include command is equivalent to inserting the file into the documentation block and surrounding it with \code and \endcode commands.
      - The main purpose of the \include command is to avoid code duplication in case of example blocks that consist of multiple source and header files.
      - For a line by line description of a source files use the \dontinclude command in combination with the \line, \skip, \skipline, and \until commands.
      - Alternatively, the \snippet command can be used to include only a fragment of a source file. For this to work the fragment has to be marked.
      - The option can either be lineno, or doc, and additionally local can be specified.
      - When using option doc, there is also the option raise that can be specified to raise all sections found in the referenced file by a certain amount. For example
      - 'will treat any level 1 \section found in file.dox as a level 2 \subsection, and any level 2 \subsection into a level 3 \subsubsection, etc. Similarly, for Markdown a # section will be treated as a ## section.'
      - 'Furthermore, there is the option prefix that can be used to add a prefix to each label of the included sections, so that they remain unique. For example:'
      - will treat e.g. \section s1 found in file.dox as if it was specified as \section fn_s1.
    lists:
      - - The option lineno can be used to enable line numbers for the included code if desired.
        - The option doc can be used to treat the file as documentation rather than code.
        - "The option local can\n be used make Doxygen interpret the code as if it was in the class or \nnamespace in which the include command appears, rather than the global \nnamespace."
        - The option strip can be used to always hide any special comments from the included code, overruling the STRIP_CODE_COMMENTS setting, and option nostrip can be used to always show the special comments. These options have no effect in combination with the option doc.
    definition_lists:
      - - term: Note
          description: Doxygen's special commands do not work inside blocks of code. It is allowed to nest C-style comments inside a code block though.
      - - term: Note
          description: The included documentation should not have comment signs in it as they will appear in the documentation as well.
      - - term: See also
          description: sections \example, \dontinclude, \verbatim, \includedoc, and \snippet.
    preformatted:
      - "  \\include{doc,raise=1} file.dox"
      - "  \\include{doc,prefix=fn_} file.dox"
    text: "\\include['{'option'}'] <file-name>\n\nThis command can \nbe used to include a source file as a block of code. The command takes \nthe name of an include file as an argument. Source files or directories \ncan be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.\n\nIf <file-name> itself is not unique for the set of example files specified by the EXAMPLE_PATH tag, you can include part of the absolute path to disambiguate it.\n\nUsing the \\include command is equivalent to inserting the file into the documentation block and surrounding it with \\code and \\endcode commands.\n\nThe main purpose of the \\include command is to avoid code duplication in case of example blocks that consist of multiple source and header files.\n\nFor a line by line description of a source files use the \\dontinclude command in combination with the \\line, \\skip, \\skipline, and \\until commands.\n\nAlternatively, the \\snippet command can be used to include only a fragment of a source file. For this to work the fragment has to be marked.\n\nThe option can either be lineno, or doc, and additionally local can be specified.\n\nWhen using option doc, there is also the option raise that can be specified to raise all sections found in the referenced file by a certain amount. For example\n\nwill treat any level 1 \\section found in file.dox as a level 2 \\subsection, and any level 2 \\subsection into a level 3 \\subsubsection, etc. Similarly, for Markdown a # section will be treated as a ## section.\n\nFurthermore, there is the option prefix that can be used to add a prefix to each label of the included sections, so that they remain unique. For example:\n\nwill treat e.g. \\section s1 found in file.dox as if it was specified as \\section fn_s1.\n\nThe option lineno can be used to enable line numbers for the included code if desired.\n\nThe option doc can be used to treat the file as documentation rather than code.\n\nThe option local can\n be used make Doxygen interpret the code as if it was in the class or \nnamespace in which the include command appears, rather than the global \nnamespace.\n\nThe option strip can be used to always hide any special comments from the included code, overruling the STRIP_CODE_COMMENTS setting, and option nostrip can be used to always show the special comments. These options have no effect in combination with the option doc.\n\n \\include{doc,raise=1} file.dox\n\n \\include{doc,prefix=fn_} file.dox\n\nNote\n\nDoxygen's special commands do not work inside blocks of code. It is allowed to nest C-style comments inside a code block though.\n\nNote\n\nThe included documentation should not have comment signs in it as they will appear in the documentation as well.\n\nSee also\n\nsections \\example, \\dontinclude, \\verbatim, \\includedoc, and \\snippet."
  - id: cmdincludelineno
    title: "\\includelineno <file-name>"
    paragraphs:
      - This command is obsolete and is still supported for backward compatibility reasons, it works the same way as \include{lineno}
    lists: []
    definition_lists:
      - - term: See also
          description: sections \include{lineno}.
    preformatted: []
    text: |-
      \includelineno <file-name>

      This command is obsolete and is still supported for backward compatibility reasons, it works the same way as \include{lineno}

      See also

      sections \include{lineno}.
  - id: cmdincludedoc
    title: "\\includedoc['{'option'}'] <file-name>"
    paragraphs:
      - This command is obsolete and is still supported for backward compatibility reasons, it works the same way as \include{doc}
      - The options are the same options that can be used with the \include when using there the option doc.
    lists: []
    definition_lists:
      - - term: See also
          description: section \include{doc}.
    preformatted: []
    text: |-
      \includedoc['{'option'}'] <file-name>

      This command is obsolete and is still supported for backward compatibility reasons, it works the same way as \include{doc}

      The options are the same options that can be used with the \include when using there the option doc.

      See also

      section \include{doc}.
  - id: cmdline
    title: "\\line ( pattern )"
    paragraphs:
      - This command searches line by line through the example that was last included using \include or \dontinclude until it finds a non-blank line. If that line contains the specified pattern, it is written to the output.
      - "The internal pointer that is used to keep track of the current line \nin the example, is set to the start of the line following the non-blank \nline that was found (or to the end of the example if no such line could \nbe found)."
      - See section \dontinclude for an example.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\line ( pattern )\n\nThis command searches line by line through the example that was last included using \\include or \\dontinclude until it finds a non-blank line. If that line contains the specified pattern, it is written to the output.\n\nThe internal pointer that is used to keep track of the current line \nin the example, is set to the start of the line following the non-blank \nline that was found (or to the end of the example if no such line could \nbe found).\n\nSee section \\dontinclude for an example."
  - id: cmdskip
    title: "\\skip ( pattern )"
    paragraphs:
      - This command searches line by line through the example that was last included using \include or \dontinclude until it finds a line that contains the specified pattern.
      - "The internal pointer that is used to keep track of the current line \nin the example, is set to the start of the line that contains the \nspecified pattern (or to the end of the example if the pattern could not\n be found)."
      - See section \dontinclude for an example.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\skip ( pattern )\n\nThis command searches line by line through the example that was last included using \\include or \\dontinclude until it finds a line that contains the specified pattern.\n\nThe internal pointer that is used to keep track of the current line \nin the example, is set to the start of the line that contains the \nspecified pattern (or to the end of the example if the pattern could not\n be found).\n\nSee section \\dontinclude for an example."
  - id: cmdskipline
    title: "\\skipline ( pattern )"
    paragraphs:
      - This command searches line by line through the example that was last included using \include or \dontinclude until it finds a line that contains the specified pattern. It then writes the line to the output.
      - "The internal pointer that is used to keep track of the current line \nin the example, is set to the start of the line following the line that \nis written (or to the end of the example if the pattern could not be \nfound)."
      - See section \dontinclude for an example.
    lists: []
    definition_lists:
      - - term: 'Note:'
          description: |-
            The command: \skipline pattern is equivalent to: \skip pattern
            \line pattern
    preformatted: []
    text: "\\skipline ( pattern )\n\nThis command searches line by line through the example that was last included using \\include or \\dontinclude until it finds a line that contains the specified pattern. It then writes the line to the output.\n\nThe internal pointer that is used to keep track of the current line \nin the example, is set to the start of the line following the line that \nis written (or to the end of the example if the pattern could not be \nfound).\n\nSee section \\dontinclude for an example.\n\nNote:\n\nThe command: \\skipline pattern is equivalent to: \\skip pattern\n\\line pattern"
  - id: cmdsnippet
    title: "\\snippet['{'option'}'] <file-name> ( block_id )"
    paragraphs:
      - "Where the \\include\n command can be used to include a complete file as source code, this \ncommand can be used to quote only a fragment of a source file. In case this is used as <file-name> the current file is taken as file to take the snippet from."
      - For example, the putting the following command in the documentation, references a snippet in file example.cpp residing in a subdirectory which should be pointed to by EXAMPLE_PATH.
      - "The text following the file name is the unique identifier for \nthe snippet. This is used to delimit the quoted code in the relevant \nsnippet file as shown in the following example that corresponds to the \nabove \\snippet command:"
      - |-
        QImage image(64, 64, QImage::Format_RGB32);
         image.fill(qRgb(255, 160, 128));

        //! [Adding a resource]
         document->addResource(QTextDocument::ImageResource,
         QUrl("mydata://image.png"), QVariant(image));
        //! [Adding a resource]
         ...
      - 'Note that the lines containing the block markers will not be included, so the output will be:'
      - |-
        document->addResource(QTextDocument::ImageResource,
         QUrl("mydata://image.png"), QVariant(image));
      - Note also that the [block_id] markers should appear exactly twice in the source file.
      - The option can either be lineno, trimleft or doc, and additionally local can be specified.
      - When using option doc, there is also the option raise that can be specified to raise all sections found in the referenced file by a certain amount. For example
      - 'will treat any level 1 \section found the snippet as a level 2 \subsection, and any level 2 \subsection into a level 3 \subsubsection, etc. Similarly, for Markdown a # section will be treated as a ## section.'
      - 'Furthermore, there is the option prefix that can be used to add a prefix to each label of the included sections, so that they remain unique. For example:'
      - will treat e.g. \section s1 found in file.dox as if it was specified as \section fn_s1.
      - see section \dontinclude for an alternative way to include fragments of a source file that does not require markers.
    lists:
      - - The option lineno can be used to enable line numbers for the included code if desired.
        - The option trimleft can be used to remove the common spacing in front of all lines (also taking in account the setting of the TAB_SIZE tag).
        - The option doc can be used to treat the file as documentation rather than code.
        - "The option local can\n be used make Doxygen interpret the code as if it was in the class or \nnamespace in which the include command appears, rather than the global \nnamespace."
        - The option strip can be used to always hide any special comments from the included code, overruling the STRIP_CODE_COMMENTS setting, and option nostrip can be used to always show the special comments. These options have no effect in combination with the option doc.
    definition_lists:
      - - term: Note
          description: The included documentation should not have comment signs in it as they will appear in the documentation as well.
    preformatted:
      - "  \\snippet snippets/example.cpp Adding a resource"
      - " \\snippet{doc,raise=1} file.dox XXX"
      - " \\include{doc,prefix=fn_} file.dox"
    text: "\\snippet['{'option'}'] <file-name> ( block_id )\n\nWhere the \\include\n command can be used to include a complete file as source code, this \ncommand can be used to quote only a fragment of a source file. In case this is used as <file-name> the current file is taken as file to take the snippet from.\n\nFor example, the putting the following command in the documentation, references a snippet in file example.cpp residing in a subdirectory which should be pointed to by EXAMPLE_PATH.\n\nThe text following the file name is the unique identifier for \nthe snippet. This is used to delimit the quoted code in the relevant \nsnippet file as shown in the following example that corresponds to the \nabove \\snippet command:\n\nQImage image(64, 64, QImage::Format_RGB32);\n image.fill(qRgb(255, 160, 128));\n\n//! [Adding a resource]\n document->addResource(QTextDocument::ImageResource,\n QUrl(\"mydata://image.png\"), QVariant(image));\n//! [Adding a resource]\n ...\n\nNote that the lines containing the block markers will not be included, so the output will be:\n\ndocument->addResource(QTextDocument::ImageResource,\n QUrl(\"mydata://image.png\"), QVariant(image));\n\nNote also that the [block_id] markers should appear exactly twice in the source file.\n\nThe option can either be lineno, trimleft or doc, and additionally local can be specified.\n\nWhen using option doc, there is also the option raise that can be specified to raise all sections found in the referenced file by a certain amount. For example\n\nwill treat any level 1 \\section found the snippet as a level 2 \\subsection, and any level 2 \\subsection into a level 3 \\subsubsection, etc. Similarly, for Markdown a # section will be treated as a ## section.\n\nFurthermore, there is the option prefix that can be used to add a prefix to each label of the included sections, so that they remain unique. For example:\n\nwill treat e.g. \\section s1 found in file.dox as if it was specified as \\section fn_s1.\n\nsee section \\dontinclude for an alternative way to include fragments of a source file that does not require markers.\n\nThe option lineno can be used to enable line numbers for the included code if desired.\n\nThe option trimleft can be used to remove the common spacing in front of all lines (also taking in account the setting of the TAB_SIZE tag).\n\nThe option doc can be used to treat the file as documentation rather than code.\n\nThe option local can\n be used make Doxygen interpret the code as if it was in the class or \nnamespace in which the include command appears, rather than the global \nnamespace.\n\nThe option strip can be used to always hide any special comments from the included code, overruling the STRIP_CODE_COMMENTS setting, and option nostrip can be used to always show the special comments. These options have no effect in combination with the option doc.\n\n \\snippet snippets/example.cpp Adding a resource\n\n \\snippet{doc,raise=1} file.dox XXX\n\n \\include{doc,prefix=fn_} file.dox\n\nNote\n\nThe included documentation should not have comment signs in it as they will appear in the documentation as well."
  - id: cmdsnippetlineno
    title: "\\snippetlineno <file-name> ( block_id )"
    paragraphs:
      - This command is obsolete and is still supported for backward compatibility reasons, it works the same way as \snippet{lineno}
    lists: []
    definition_lists:
      - - term: See also
          description: sections \snippet{lineno}
    preformatted: []
    text: |-
      \snippetlineno <file-name> ( block_id )

      This command is obsolete and is still supported for backward compatibility reasons, it works the same way as \snippet{lineno}

      See also

      sections \snippet{lineno}
  - id: cmdsnippetdoc
    title: "\\snippetdoc['{'option'}'] <file-name> ( block_id )"
    paragraphs:
      - This command is obsolete and is still supported for backward compatibility reasons, it works the same way as \snippet{doc}
      - The options are the same options that can be used with the \snippet when using there the option doc.
    lists: []
    definition_lists:
      - - term: See also
          description: section \snippet{doc} and \include{doc}.
    preformatted: []
    text: |-
      \snippetdoc['{'option'}'] <file-name> ( block_id )

      This command is obsolete and is still supported for backward compatibility reasons, it works the same way as \snippet{doc}

      The options are the same options that can be used with the \snippet when using there the option doc.

      See also

      section \snippet{doc} and \include{doc}.
  - id: cmduntil
    title: "\\until ( pattern )"
    paragraphs:
      - This command writes all lines of the example that was last included using \include or \dontinclude to the output, until it finds a line containing the specified pattern. The line containing the pattern will be written as well.
      - "The internal pointer that is used to keep track of the current line \nin the example, is set to the start of the line following last written \nline (or to the end of the example if the pattern could not be found)."
      - See section \dontinclude for an example.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\until ( pattern )\n\nThis command writes all lines of the example that was last included using \\include or \\dontinclude to the output, until it finds a line containing the specified pattern. The line containing the pattern will be written as well.\n\nThe internal pointer that is used to keep track of the current line \nin the example, is set to the start of the line following last written \nline (or to the end of the example if the pattern could not be found).\n\nSee section \\dontinclude for an example."
  - id: cmdverbinclude
    title: "\\verbinclude <file-name>"
    paragraphs:
      - "This \ncommand includes the contents of the file <file-name> verbatim in \nthe documentation. The command is equivalent to pasting the contents of \nthe file in the documentation and placing \\verbatim and \\endverbatim commands around it."
      - Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\verbinclude <file-name>\n\nThis \ncommand includes the contents of the file <file-name> verbatim in \nthe documentation. The command is equivalent to pasting the contents of \nthe file in the documentation and placing \\verbatim and \\endverbatim commands around it.\n\nFiles or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file."
  - id: cmdhtmlinclude
    title: "\\htmlinclude['[block]'] <file-name>"
    paragraphs:
      - This command includes the contents of the file <file-name> as is in the HTML documentation and tagged with <htmlonly> in the generated XML output. The command is equivalent to pasting the contents of the file in the documentation and placing \htmlonly and \endhtmlonly commands around it.
      - "Normally the contents of the file indicated by \\htmlinclude\n is inserted as-is. When you want to insert a HTML fragment that has \nblock scope like a table or list which should appear outside \n<p>..</p>, this can lead to invalid HTML. You can use \\htmlinclude[block] to make Doxygen end the current paragraph and restart after the file is included."
      - Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.
    lists: []
    definition_lists:
      - - term: See also
          description: section \htmlonly, \latexinclude, \rtfinclude, \maninclude, \docbookinclude and \xmlinclude.
    preformatted: []
    text: "\\htmlinclude['[block]'] <file-name>\n\nThis command includes the contents of the file <file-name> as is in the HTML documentation and tagged with <htmlonly> in the generated XML output. The command is equivalent to pasting the contents of the file in the documentation and placing \\htmlonly and \\endhtmlonly commands around it.\n\nNormally the contents of the file indicated by \\htmlinclude\n is inserted as-is. When you want to insert a HTML fragment that has \nblock scope like a table or list which should appear outside \n<p>..</p>, this can lead to invalid HTML. You can use \\htmlinclude[block] to make Doxygen end the current paragraph and restart after the file is included.\n\nFiles or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.\n\nSee also\n\nsection \\htmlonly, \\latexinclude, \\rtfinclude, \\maninclude, \\docbookinclude and \\xmlinclude."
  - id: cmdlatexinclude
    title: "\\latexinclude <file-name>"
    paragraphs:
      - This command includes the contents of the file <file-name> as is in the documentation and tagged with <latexonly> in the generated XML output. The command is equivalent to pasting the contents of the file in the documentation and placing \latexonly and \endlatexonly commands around it.
      - Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.
    lists: []
    definition_lists:
      - - term: See also
          description: section \latexonly, \htmlinclude, \rtfinclude, \maninclude, \docbookinclude and \xmlinclude.
    preformatted: []
    text: |-
      \latexinclude <file-name>

      This command includes the contents of the file <file-name> as is in the documentation and tagged with <latexonly> in the generated XML output. The command is equivalent to pasting the contents of the file in the documentation and placing \latexonly and \endlatexonly commands around it.

      Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.

      See also

      section \latexonly, \htmlinclude, \rtfinclude, \maninclude, \docbookinclude and \xmlinclude.
  - id: cmdrtfinclude
    title: "\\rtfinclude <file-name>"
    paragraphs:
      - This command includes the contents of the file <file-name> as is in the RTF documentation and tagged with <rtfonly> in the generated XML output. The command is equivalent to pasting the contents of the file in the documentation and placing \rtfonly and \endrtfonly commands around it.
      - Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.
    lists: []
    definition_lists:
      - - term: See also
          description: section \rtfonly, \htmlinclude, \latexinclude, \maninclude, \docbookinclude and \xmlinclude.
    preformatted: []
    text: |-
      \rtfinclude <file-name>

      This command includes the contents of the file <file-name> as is in the RTF documentation and tagged with <rtfonly> in the generated XML output. The command is equivalent to pasting the contents of the file in the documentation and placing \rtfonly and \endrtfonly commands around it.

      Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.

      See also

      section \rtfonly, \htmlinclude, \latexinclude, \maninclude, \docbookinclude and \xmlinclude.
  - id: cmdmaninclude
    title: "\\maninclude <file-name>"
    paragraphs:
      - This command includes the contents of the file <file-name> as is in the MAN documentation and tagged with <manonly> in the generated XML output. The command is equivalent to pasting the contents of the file in the documentation and placing \manonly and \endmanonly commands around it.
      - Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.
    lists: []
    definition_lists:
      - - term: See also
          description: section \manonly, \htmlinclude, \latexinclude, \rtfinclude, \docbookinclude and \xmlinclude.
    preformatted: []
    text: |-
      \maninclude <file-name>

      This command includes the contents of the file <file-name> as is in the MAN documentation and tagged with <manonly> in the generated XML output. The command is equivalent to pasting the contents of the file in the documentation and placing \manonly and \endmanonly commands around it.

      Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.

      See also

      section \manonly, \htmlinclude, \latexinclude, \rtfinclude, \docbookinclude and \xmlinclude.
  - id: cmddocbookinclude
    title: "\\docbookinclude <file-name>"
    paragraphs:
      - This command includes the contents of the file <file-name> as is in the DocBook documentation and tagged with <docbookonly> in the generated XML output. The command is equivalent to pasting the contents of the file in the documentation and placing \docbookonly and \enddocbookonly commands around it.
      - Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.
    lists: []
    definition_lists:
      - - term: See also
          description: section \docbookonly, \htmlinclude, \latexinclude, \rtfinclude, \maninclude and \xmlinclude.
    preformatted: []
    text: |-
      \docbookinclude <file-name>

      This command includes the contents of the file <file-name> as is in the DocBook documentation and tagged with <docbookonly> in the generated XML output. The command is equivalent to pasting the contents of the file in the documentation and placing \docbookonly and \enddocbookonly commands around it.

      Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.

      See also

      section \docbookonly, \htmlinclude, \latexinclude, \rtfinclude, \maninclude and \xmlinclude.
  - id: cmdxmlinclude
    title: "\\xmlinclude <file-name>"
    paragraphs:
      - "This \ncommand includes contents of the file <file-name> as is in the XML\n documentation. The command is equivalent to pasting the contents of the\n file in the documentation and placing \\xmlonly and \\endxmlonly commands around it."
      - Files or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.
      - "--- Commands for visual enhancements ---"
    lists: []
    definition_lists:
      - - term: See also
          description: section \xmlonly, \htmlinclude, \latexinclude, \rtfinclude, \maninclude and \docbookinclude.
    preformatted: []
    text: "\\xmlinclude <file-name>\n\nThis \ncommand includes contents of the file <file-name> as is in the XML\n documentation. The command is equivalent to pasting the contents of the\n file in the documentation and placing \\xmlonly and \\endxmlonly commands around it.\n\nFiles or directories that Doxygen should look for can be specified using the EXAMPLE_PATH tag of Doxygen's configuration file.\n\n--- Commands for visual enhancements ---\n\nSee also\n\nsection \\xmlonly, \\htmlinclude, \\latexinclude, \\rtfinclude, \\maninclude and \\docbookinclude."
  - id: cmda
    title: "\\a <word>"
    paragraphs:
      - "Displays the argument \n<word> in italics. Use this command to emphasize words. Use this \ncommand to refer to member arguments in the running text."
      - Equivalent to \e and \em. To emphasize multiple words use <em>multiple words</em>.
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            ... the \a x and \a y coordinates are used to ...
             This will result in the following text:

             ... the x and y coordinates are used to ...
    preformatted: []
    text: "\\a <word>\n\nDisplays the argument \n<word> in italics. Use this command to emphasize words. Use this \ncommand to refer to member arguments in the running text.\n\nEquivalent to \\e and \\em. To emphasize multiple words use <em>multiple words</em>.\n\nExample:\n\n... the \\a x and \\a y coordinates are used to ...\n This will result in the following text:\n\n ... the x and y coordinates are used to ..."
  - id: cmdarg
    title: "\\arg { item-description }"
    paragraphs:
      - This command has one argument that continues until the first blank line or until another \arg is encountered. The command can be used to generate a simple, not nested list of arguments. Each argument should start with a \arg command.
      - Equivalent to \li
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: "Typing: \\arg \\c AlignLeft left alignment.\n \\arg \\c AlignCenter center alignment.\n \\arg \\c AlignRight right alignment\n\n No other types of alignment are supported.\n will result in the following text:\n\nAlignLeft left alignment. \n\nAlignCenter center alignment. \n\nAlignRight right alignment \n\n No other types of alignment are supported."
      - - term: 'Note:'
          description: For nested lists, HTML commands should be used.
    preformatted: []
    text: "\\arg { item-description }\n\nThis command has one argument that continues until the first blank line or until another \\arg is encountered. The command can be used to generate a simple, not nested list of arguments. Each argument should start with a \\arg command.\n\nEquivalent to \\li\n\nExample:\n\nTyping: \\arg \\c AlignLeft left alignment.\n \\arg \\c AlignCenter center alignment.\n \\arg \\c AlignRight right alignment\n\n No other types of alignment are supported.\n will result in the following text:\n\nAlignLeft left alignment. \n\nAlignCenter center alignment. \n\nAlignRight right alignment \n\n No other types of alignment are supported.\n\nNote:\n\nFor nested lists, HTML commands should be used."
  - id: cmdb
    title: "\\b <word>"
    paragraphs:
      - Displays the argument <word> using a bold font. Equivalent to <b>word</b>. To put multiple words in bold use <b>multiple words</b>.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \b <word>

      Displays the argument <word> using a bold font. Equivalent to <b>word</b>. To put multiple words in bold use <b>multiple words</b>.
  - id: cmdc
    title: "\\c <word>"
    paragraphs:
      - Displays the argument <word> using a typewriter font. Use this to refer to a word of code. Equivalent to <tt>word</tt>.
      - Equivalent to \p. To have multiple words in typewriter font use <tt>multiple words</tt>.
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            Typing: ... This function returns \c void and not \c int ...
             will result in the following text:

             ... This function returns void and not int ...
    preformatted: []
    text: |-
      \c <word>

      Displays the argument <word> using a typewriter font. Use this to refer to a word of code. Equivalent to <tt>word</tt>.

      Equivalent to \p. To have multiple words in typewriter font use <tt>multiple words</tt>.

      Example:

      Typing: ... This function returns \c void and not \c int ...
       will result in the following text:

       ... This function returns void and not int ...
  - id: cmdcode
    title: "\\code['{'<word>'}']"
    paragraphs:
      - "Starts a block of code.\n A code block is treated differently from ordinary text. It is \ninterpreted as source code. The names of classes and members and other \ndocumented entities are automatically replaced by links to the \ndocumentation."
      - By default the language that is assumed for syntax highlighting is based on the location where the \code block was found. If this part of a Python file for instance, the syntax highlight will be done according to the Python syntax.
      - "If it is unclear from the context which language is meant (for instance the comment is in a .txt or .markdown\n file) then you can also explicitly indicate the language, by putting \nthe file extension typically that Doxygen associated with the language \nin curly brackets after the code block. Here is an example:"
      - "If the contents of the code block are in a language that \nDoxygen cannot parse, Doxygen will just show the output as-is. You can \nmake this explicit using .unparsed, or by giving some other extension that Doxygen doesn't support, e.g."
    lists: []
    definition_lists:
      - - term: See also
          description: section \endcode and section \verbatim.
    preformatted:
      - |2-
          \code{.py}
          class Python:
             pass
          \endcode

          \code{.cpp}
          class Cpp {};
          \endcode
      - |2-
          \code{.unparsed}
          Show this as-is please
          \endcode

          \code{.sh}
          echo "This is a shell script"
          \endcode
    text: "\\code['{'<word>'}']\n\nStarts a block of code.\n A code block is treated differently from ordinary text. It is \ninterpreted as source code. The names of classes and members and other \ndocumented entities are automatically replaced by links to the \ndocumentation.\n\nBy default the language that is assumed for syntax highlighting is based on the location where the \\code block was found. If this part of a Python file for instance, the syntax highlight will be done according to the Python syntax.\n\nIf it is unclear from the context which language is meant (for instance the comment is in a .txt or .markdown\n file) then you can also explicitly indicate the language, by putting \nthe file extension typically that Doxygen associated with the language \nin curly brackets after the code block. Here is an example:\n\nIf the contents of the code block are in a language that \nDoxygen cannot parse, Doxygen will just show the output as-is. You can \nmake this explicit using .unparsed, or by giving some other extension that Doxygen doesn't support, e.g.\n\n \\code{.py}\n class Python:\n pass\n \\endcode\n\n \\code{.cpp}\n class Cpp {};\n \\endcode\n\n \\code{.unparsed}\n Show this as-is please\n \\endcode\n\n \\code{.sh}\n echo \"This is a shell script\"\n \\endcode\n\nSee also\n\nsection \\endcode and section \\verbatim."
  - id: cmdcopydoc
    title: "\\copydoc <link-object>"
    paragraphs:
      - "Copies a \ndocumentation block from the object specified by <link-object> and\n pastes it at the location of the command. This command can be useful to\n avoid cases where a documentation block would otherwise have to be \nduplicated or it can be used to extend the documentation of an inherited\n member."
      - "The link object can point to a member (of a class, file or group), a \nclass, a namespace, a group, a page, or a file (checked in that order). \nNote that if the object pointed to is a member (function, variable, \ntypedef, etc), the compound (class, file, or group) containing it should\n also be documented for the copying to work."
      - 'To copy the documentation for a member of a class one can, for instance, put the following in the documentation:'
      - 'if the member is overloaded, you should specify the argument types explicitly (without spaces!), like in the following:'
      - Qualified names are only needed if the context in which the documentation block is found requires them.
      - The \copydoc command can be used recursively, but cycles in the \copydoc relation will be broken and flagged as an error.
      - 'Note that \copydoc foo() is roughly equivalent to doing:'
      - See \copybrief and \copydetails for copying only the brief or detailed part of the comment block.
    lists: []
    definition_lists: []
    preformatted:
      - |2-
          /*! @copydoc MyClass::myfunction()
           *  More documentation.
           */
      - "  //! @copydoc MyClass::myfunction(type1,type2)"
      - |2-
          \brief \copybrief foo()
          \details \copydetails foo()
    text: "\\copydoc <link-object>\n\nCopies a \ndocumentation block from the object specified by <link-object> and\n pastes it at the location of the command. This command can be useful to\n avoid cases where a documentation block would otherwise have to be \nduplicated or it can be used to extend the documentation of an inherited\n member.\n\nThe link object can point to a member (of a class, file or group), a \nclass, a namespace, a group, a page, or a file (checked in that order). \nNote that if the object pointed to is a member (function, variable, \ntypedef, etc), the compound (class, file, or group) containing it should\n also be documented for the copying to work.\n\nTo copy the documentation for a member of a class one can, for instance, put the following in the documentation:\n\nif the member is overloaded, you should specify the argument types explicitly (without spaces!), like in the following:\n\nQualified names are only needed if the context in which the documentation block is found requires them.\n\nThe \\copydoc command can be used recursively, but cycles in the \\copydoc relation will be broken and flagged as an error.\n\nNote that \\copydoc foo() is roughly equivalent to doing:\n\nSee \\copybrief and \\copydetails for copying only the brief or detailed part of the comment block.\n\n /*! @copydoc MyClass::myfunction()\n * More documentation.\n */\n\n //! @copydoc MyClass::myfunction(type1,type2)\n\n \\brief \\copybrief foo()\n \\details \\copydetails foo()"
  - id: cmdcopybrief
    title: "\\copybrief <link-object>"
    paragraphs:
      - Works in a similar way as \copydoc but will only copy the brief description, not the detailed documentation.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \copybrief <link-object>

      Works in a similar way as \copydoc but will only copy the brief description, not the detailed documentation.
  - id: cmdcopydetails
    title: "\\copydetails <link-object>"
    paragraphs:
      - Works in a similar way as \copydoc but will only copy the detailed documentation, not the brief description.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \copydetails <link-object>

      Works in a similar way as \copydoc but will only copy the detailed documentation, not the brief description.
  - id: cmddocbookonly
    title: "\\docbookonly"
    paragraphs:
      - Starts a block of text that only will be verbatim included in the generated DocBook documentation and tagged with <docbookonly> in the generated XML output. The block ends with a \enddocbookonly command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \manonly, \latexonly, \rtfonly, \xmlonly, \htmlonly and \docbookinclude.
    preformatted: []
    text: |-
      \docbookonly

      Starts a block of text that only will be verbatim included in the generated DocBook documentation and tagged with <docbookonly> in the generated XML output. The block ends with a \enddocbookonly command.

      See also

      section \manonly, \latexonly, \rtfonly, \xmlonly, \htmlonly and \docbookinclude.
  - id: cmddot
    title: \dot ["caption"] [<sizeindication>=<size>]
    paragraphs:
      - Starts a text fragment which should contain a valid description of a dot graph. The text fragment ends with \enddot. Doxygen will pass the text on to dot and include the resulting image (and image map) into the output.
      - "The first argument is optional and can be used to specify the caption\n that is displayed below the image. This argument has to be specified \nbetween quotes even if it does not contain any spaces. The quotes are \nstripped before the caption is displayed."
      - "The second argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
      - 'The nodes of a graph can be made clickable by using the URL attribute. By using the command \ref inside the URL value you can conveniently link to an item inside Doxygen. Here is an example:'
      - |-
        /*! class B */
        class B {};

        /*! class C */
        class C {};

        /*! \mainpage
         *
         * Class relations expressed via an inline dot graph:
         * \dot
         * digraph example {
         * node [shape=record, fontname=Helvetica, fontsize=10];
         * b [ label="class B" URL="\ref B"];
         * c [ label="class C" URL="\ref C"];
         * b -> c [ arrowhead="open", style="dashed" ];
         * }
         * \enddot
         * Note that the classes in the above graph are clickable
         * (in the HTML output).
         */
    lists: []
    definition_lists:
      - - term: Note
          description: usage of this command requires that HAVE_DOT is set to YES
        - term: Note
          description: Doxygen creates a temporary file that is automatically removed unless the DOT_CLEANUP tag is set to NO.
    preformatted: []
    text: "\\dot [\"caption\"] [<sizeindication>=<size>]\n\nStarts a text fragment which should contain a valid description of a dot graph. The text fragment ends with \\enddot. Doxygen will pass the text on to dot and include the resulting image (and image map) into the output.\n\nThe first argument is optional and can be used to specify the caption\n that is displayed below the image. This argument has to be specified \nbetween quotes even if it does not contain any spaces. The quotes are \nstripped before the caption is displayed.\n\nThe second argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command.\n\nThe nodes of a graph can be made clickable by using the URL attribute. By using the command \\ref inside the URL value you can conveniently link to an item inside Doxygen. Here is an example:\n\n/*! class B */\nclass B {};\n\n/*! class C */\nclass C {};\n\n/*! \\mainpage\n *\n * Class relations expressed via an inline dot graph:\n * \\dot\n * digraph example {\n * node [shape=record, fontname=Helvetica, fontsize=10];\n * b [ label=\"class B\" URL=\"\\ref B\"];\n * c [ label=\"class C\" URL=\"\\ref C\"];\n * b -> c [ arrowhead=\"open\", style=\"dashed\" ];\n * }\n * \\enddot\n * Note that the classes in the above graph are clickable\n * (in the HTML output).\n */\n\nNote\n\nusage of this command requires that HAVE_DOT is set to YES\n\nNote\n\nDoxygen creates a temporary file that is automatically removed unless the DOT_CLEANUP tag is set to NO."
  - id: cmdemoji
    title: \emoji "name"
    paragraphs:
      - This command will produce an emoji character given its name.
      - The supported names are the ones also supported by GitHub and listed here https://gist.github.com/rxaviers/7360908
      - 'You can use the name with or without colons, i.e. \emoji smile is the same as writing \emoji :smile:. When an emoji is not supported the name with by places in the text with in between colons, i.e. \emoji unsupported will produce :unsupported: in the output. Doxygen will also give a warning message.'
      - See also the emoji support page for details.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \emoji "name"

      This command will produce an emoji character given its name.

      The supported names are the ones also supported by GitHub and listed here https://gist.github.com/rxaviers/7360908

      You can use the name with or without colons, i.e. \emoji smile is the same as writing \emoji :smile:. When an emoji is not supported the name with by places in the text with in between colons, i.e. \emoji unsupported will produce :unsupported: in the output. Doxygen will also give a warning message.

      See also the emoji support page for details.
  - id: cmdmsc
    title: \msc ["caption"] [<sizeindication>=<size>]
    paragraphs:
      - Starts a text fragment which should contain a valid description of a message sequence chart. See https://www.mcternan.me.uk/mscgen/ for examples. The text fragment ends with \endmsc.
      - "The first argument is optional and can be used to specify the caption\n that is displayed below the image. This argument has to be specified \nbetween quotes even if it does not contain any spaces. The quotes are \nstripped before the caption is displayed."
      - "The second argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
      - Here is an example of the use of the \msc command.
      - |-
        /** Sender class. Can be used to send a command to the server.
         * The receiver will acknowledge the command by calling Ack().
         * \msc
         * Sender,Receiver;
         * Sender->Receiver [label="Command()", URL="\ref Receiver::Command()"];
         * Sender<-Receiver [label="Ack()", URL="\ref Ack()", ID="1"];
         * \endmsc
         */
        class Sender
        {
         public:
         /** Acknowledgment from server */
         void Ack(bool ok);
        };

        /** Receiver class. Can be used to receive and execute commands.
         * After execution of a command, the receiver will send an acknowledgment
         * \msc
         * Receiver,Sender;
         * Receiver<-Sender [label="Command()", URL="\ref Command()"];
         * Receiver->Sender [label="Ack()", URL="\ref Sender::Ack()", ID="1"];
         * \endmsc
         */
        class Receiver
        {
         public:
         /** Executable a command on the server */
         void Command(int commandId);
        };
    lists: []
    definition_lists:
      - - term: Note
          description: The text fragment should only include the part of the message sequence chart that is within the msc {...} block (this is different from \mscfile).
        - term: Note
          description: mscgen is now built in into Doxygen
        - term: Note
          description: Doxygen creates a temporary file that is automatically removed unless the DOT_CLEANUP tag is set to NO.
      - - term: See also
          description: section \mscfile.
    preformatted: []
    text: "\\msc [\"caption\"] [<sizeindication>=<size>]\n\nStarts a text fragment which should contain a valid description of a message sequence chart. See https://www.mcternan.me.uk/mscgen/ for examples. The text fragment ends with \\endmsc.\n\nThe first argument is optional and can be used to specify the caption\n that is displayed below the image. This argument has to be specified \nbetween quotes even if it does not contain any spaces. The quotes are \nstripped before the caption is displayed.\n\nThe second argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command.\n\nHere is an example of the use of the \\msc command.\n\n/** Sender class. Can be used to send a command to the server.\n * The receiver will acknowledge the command by calling Ack().\n * \\msc\n * Sender,Receiver;\n * Sender->Receiver [label=\"Command()\", URL=\"\\ref Receiver::Command()\"];\n * Sender<-Receiver [label=\"Ack()\", URL=\"\\ref Ack()\", ID=\"1\"];\n * \\endmsc\n */\nclass Sender\n{\n public:\n /** Acknowledgment from server */\n void Ack(bool ok);\n};\n\n/** Receiver class. Can be used to receive and execute commands.\n * After execution of a command, the receiver will send an acknowledgment\n * \\msc\n * Receiver,Sender;\n * Receiver<-Sender [label=\"Command()\", URL=\"\\ref Command()\"];\n * Receiver->Sender [label=\"Ack()\", URL=\"\\ref Sender::Ack()\", ID=\"1\"];\n * \\endmsc\n */\nclass Receiver\n{\n public:\n /** Executable a command on the server */\n void Command(int commandId);\n};\n\nNote\n\nThe text fragment should only include the part of the message sequence chart that is within the msc {...} block (this is different from \\mscfile).\n\nNote\n\nmscgen is now built in into Doxygen\n\nNote\n\nDoxygen creates a temporary file that is automatically removed unless the DOT_CLEANUP tag is set to NO.\n\nSee also\n\nsection \\mscfile."
  - id: cmdmermaid
    title: \mermaid ['{'option'}'] ["caption"] [<sizeindication>=<size>]
    paragraphs:
      - Starts a text fragment which should contain a valid Mermaid diagram definition. See https://mermaid.js.org/intro for examples and syntax documentation. The text fragment ends with \endmermaid.
      - "Mermaid supports multiple diagram types including flowcharts, \nsequence diagrams, class diagrams, state diagrams, Gantt charts, and \nmore."
      - Doxygen supports two rendering modes for Mermaid diagrams, controlled by the MERMAID_RENDER_MODE configuration option.
      - The first argument is optional and can be used to specify the name of the generated image file inside curly brackets, i.e.
      - "When the name is specified, Doxygen will generate an image \nwith that name. Without the name Doxygen will choose a name \nautomatically."
      - "The second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed."
      - "The third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
      - Here is an example of the use of the \mermaid command.
      - |-
        /** Sender class. Can be used to send a command to the server.
         * The receiver will acknowledge the command by calling Ack().
         * \mermaid
         * sequenceDiagram
         * Sender->>Receiver: Command()
         * Receiver-->>Sender: Ack()
         * \endmermaid
         */
        class Sender
        {
         public:
         /** Acknowledgment from server */
         void Ack(bool ok);
        };

        /** Receiver class. Can be used to receive and execute commands.
         * After execution of a command, the receiver will send an acknowledgment
         * \mermaid
         * sequenceDiagram
         * Receiver->>Sender: Command()
         * Sender-->>Receiver: Ack()
         * \endmermaid
         */
        class Receiver
        {
         public:
         /** Execute a command on the server */
         void Command(int commandId);
        };
    lists: []
    definition_lists:
      - - term: Note
          description: |-
            In Markdown files, Mermaid diagrams can also be written using fenced code blocks with the mermaid language identifier: ```mermaid
             flowchart LR
             A --> B
             ```
             These are automatically converted to \mermaid / \endmermaid.
        - term: Note
          description: Doxygen creates a temporary file that is automatically removed unless the DOT_CLEANUP tag is set to NO.
    preformatted:
      - |2-
          @mermaid{mydiagram}
          flowchart LR
            A --> B
          @endmermaid
    text: "\\mermaid ['{'option'}'] [\"caption\"] [<sizeindication>=<size>]\n\nStarts a text fragment which should contain a valid Mermaid diagram definition. See https://mermaid.js.org/intro for examples and syntax documentation. The text fragment ends with \\endmermaid.\n\nMermaid supports multiple diagram types including flowcharts, \nsequence diagrams, class diagrams, state diagrams, Gantt charts, and \nmore.\n\nDoxygen supports two rendering modes for Mermaid diagrams, controlled by the MERMAID_RENDER_MODE configuration option.\n\nThe first argument is optional and can be used to specify the name of the generated image file inside curly brackets, i.e.\n\nWhen the name is specified, Doxygen will generate an image \nwith that name. Without the name Doxygen will choose a name \nautomatically.\n\nThe second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed.\n\nThe third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command.\n\nHere is an example of the use of the \\mermaid command.\n\n/** Sender class. Can be used to send a command to the server.\n * The receiver will acknowledge the command by calling Ack().\n * \\mermaid\n * sequenceDiagram\n * Sender->>Receiver: Command()\n * Receiver-->>Sender: Ack()\n * \\endmermaid\n */\nclass Sender\n{\n public:\n /** Acknowledgment from server */\n void Ack(bool ok);\n};\n\n/** Receiver class. Can be used to receive and execute commands.\n * After execution of a command, the receiver will send an acknowledgment\n * \\mermaid\n * sequenceDiagram\n * Receiver->>Sender: Command()\n * Sender-->>Receiver: Ack()\n * \\endmermaid\n */\nclass Receiver\n{\n public:\n /** Execute a command on the server */\n void Command(int commandId);\n};\n\n @mermaid{mydiagram}\n flowchart LR\n A --> B\n @endmermaid\n\nNote\n\nIn Markdown files, Mermaid diagrams can also be written using fenced code blocks with the mermaid language identifier: ```mermaid\n flowchart LR\n A --> B\n ```\n These are automatically converted to \\mermaid / \\endmermaid.\n\nNote\n\nDoxygen creates a temporary file that is automatically removed unless the DOT_CLEANUP tag is set to NO."
  - id: cmdstartuml
    title: \startuml ['{'option[,option]'}'] ["caption"] [<sizeindication>=<size>]
    paragraphs:
      - Starts a text fragment which should contain a valid description of a PlantUML diagram. See https://plantuml.com/ for examples. The text fragment ends with \enduml.
      - "Not all diagrams can be created with the PlantUML @startuml command but need another PlantUML @start... command. This will look like @start<engine> where currently supported are the following <engine>s: uml, bpm, wire, dot, ditaa, salt, math, latex, gantt, mindmap, wbs, yaml, creole, json, flow, board, git, hcl, regex, ebnf, chart, nwdiag, packetdiag, project, sprites, files, chen and chronology. By default the <engine> is uml. The <engine>\n can be specified as an option. Also the file to write the resulting \nimage to can be specified by means of an option, see the description of \nthe first (optional) argument for details. Of course only one <engine> can be specified and also the filename can only be specified once."
      - "The first argument is optional and is for compatibility with running \nPlantUML as a preprocessing step before running Doxygen, you can also \nadd the name of the image file after \\startuml and inside curly brackets as option, i.e."
      - "When the name of the image is specified, Doxygen will generate\n an image with that name. Without the name Doxygen will choose a name \nautomatically."
      - "The second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed."
      - "The third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
      - Here is an example of the use of the \startuml command.
      - |-
        /** Sender class. Can be used to send a command to the server.
         * The receiver will acknowledge the command by calling Ack().
         * \startuml
         * Sender->Receiver : Command()
         * Sender<--Receiver : Ack()
         * \enduml
         */
        class Sender
        {
         public:
         /** Acknowledgment from server */
         void Ack(bool ok);
        };

        /** Receiver class. Can be used to receive and execute commands.
         * After execution of a command, the receiver will send an acknowledgment
         * \startuml
         * Receiver<-Sender : Command()
         * Receiver-->Sender : Ack()
         * \enduml
         */
        class Receiver
        {
         public:
         /** Executable a command on the server */
         void Command(int commandId);
        };
    lists: []
    definition_lists:
      - - term: Note
          description: You need to install Java and the PlantUML's jar file, if you want to use this command. When using PlantUML in you have to download some more jar files, for details see the PlantUML documentation. This also is valid for the <engine>s latex and math. The location of the PlantUML file should be specified using PLANTUML_JAR_PATH. The other jar files should also reside in this directory.
        - term: Note
          description: The use of the <engine> ditaa is not possible in as PlantUML only supports the png format and Doxygen requires, temporary, eps output.
      - - term: Note
          description: |-
            Doxygen does not support the Plantuml commands like @startjson, by design, directly but the support can be accomplished, by the user, by adding to the Doxygen settings file: ALIASES += startjson=@startuml{json}
             ALIASES += endjson=@enduml
        - term: Note
          description: Doxygen creates a temporary file that is automatically removed unless the DOT_CLEANUP tag is set to NO.
    preformatted:
      - |2-
          @startuml{myimage.png} "Image Caption" width=5cm
          Alice -> Bob : Hello
          @enduml
    text: "\\startuml ['{'option[,option]'}'] [\"caption\"] [<sizeindication>=<size>]\n\nStarts a text fragment which should contain a valid description of a PlantUML diagram. See https://plantuml.com/ for examples. The text fragment ends with \\enduml.\n\nNot all diagrams can be created with the PlantUML @startuml command but need another PlantUML @start... command. This will look like @start<engine> where currently supported are the following <engine>s: uml, bpm, wire, dot, ditaa, salt, math, latex, gantt, mindmap, wbs, yaml, creole, json, flow, board, git, hcl, regex, ebnf, chart, nwdiag, packetdiag, project, sprites, files, chen and chronology. By default the <engine> is uml. The <engine>\n can be specified as an option. Also the file to write the resulting \nimage to can be specified by means of an option, see the description of \nthe first (optional) argument for details. Of course only one <engine> can be specified and also the filename can only be specified once.\n\nThe first argument is optional and is for compatibility with running \nPlantUML as a preprocessing step before running Doxygen, you can also \nadd the name of the image file after \\startuml and inside curly brackets as option, i.e.\n\nWhen the name of the image is specified, Doxygen will generate\n an image with that name. Without the name Doxygen will choose a name \nautomatically.\n\nThe second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed.\n\nThe third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command.\n\nHere is an example of the use of the \\startuml command.\n\n/** Sender class. Can be used to send a command to the server.\n * The receiver will acknowledge the command by calling Ack().\n * \\startuml\n * Sender->Receiver : Command()\n * Sender<--Receiver : Ack()\n * \\enduml\n */\nclass Sender\n{\n public:\n /** Acknowledgment from server */\n void Ack(bool ok);\n};\n\n/** Receiver class. Can be used to receive and execute commands.\n * After execution of a command, the receiver will send an acknowledgment\n * \\startuml\n * Receiver<-Sender : Command()\n * Receiver-->Sender : Ack()\n * \\enduml\n */\nclass Receiver\n{\n public:\n /** Executable a command on the server */\n void Command(int commandId);\n};\n\n @startuml{myimage.png} \"Image Caption\" width=5cm\n Alice -> Bob : Hello\n @enduml\n\nNote\n\nYou need to install Java and the PlantUML's jar file, if you want to use this command. When using PlantUML in you have to download some more jar files, for details see the PlantUML documentation. This also is valid for the <engine>s latex and math. The location of the PlantUML file should be specified using PLANTUML_JAR_PATH. The other jar files should also reside in this directory.\n\nNote\n\nThe use of the <engine> ditaa is not possible in as PlantUML only supports the png format and Doxygen requires, temporary, eps output.\n\nNote\n\nDoxygen does not support the Plantuml commands like @startjson, by design, directly but the support can be accomplished, by the user, by adding to the Doxygen settings file: ALIASES += startjson=@startuml{json}\n ALIASES += endjson=@enduml\n\nNote\n\nDoxygen creates a temporary file that is automatically removed unless the DOT_CLEANUP tag is set to NO."
  - id: cmddotfile
    title: \dotfile <file> ["caption"] [<sizeindication>=<size>]
    paragraphs:
      - Inserts an image generated by dot from <file> into the documentation.
      - "The first argument specifies the file name of the image. Doxygen will\n look for files in the paths (or files) that you specified after the DOTFILE_DIRS\n tag. If the dot file is found it will be used as an input file to the \ndot tool. The resulting image will be put into the correct output \ndirectory. If the dot file name contains spaces you'll have to put \nquotes (\"...\") around it."
      - "The second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed."
      - "The third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
    lists: []
    definition_lists:
      - - term: Note
          description: usage of this command requires that HAVE_DOT is set to YES
      - - term: See also
          description: section \dot.
    preformatted: []
    text: "\\dotfile <file> [\"caption\"] [<sizeindication>=<size>]\n\nInserts an image generated by dot from <file> into the documentation.\n\nThe first argument specifies the file name of the image. Doxygen will\n look for files in the paths (or files) that you specified after the DOTFILE_DIRS\n tag. If the dot file is found it will be used as an input file to the \ndot tool. The resulting image will be put into the correct output \ndirectory. If the dot file name contains spaces you'll have to put \nquotes (\"...\") around it.\n\nThe second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed.\n\nThe third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command.\n\nNote\n\nusage of this command requires that HAVE_DOT is set to YES\n\nSee also\n\nsection \\dot."
  - id: cmdmscfile
    title: \mscfile <file> ["caption"] [<sizeindication>=<size>]
    paragraphs:
      - Inserts an image generated by mscgen from <file> into the documentation. See https://www.mcternan.me.uk/mscgen/ for examples.
      - "The first argument specifies the file name of the image. Doxygen will\n look for files in the paths (or files) that you specified after the MSCFILE_DIRS\n tag. If the msc file is found it will be used as an input file to the \nbuilt in mscgen tool. The resulting image will be put into the correct \noutput directory. If the msc file name contains spaces you'll have to \nput quotes (\"...\") around it."
      - "The second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed."
      - "The third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
    lists: []
    definition_lists:
      - - term: Note
          description: The text fragment should include the part message of the sequence chart as well as the starting msc { and ending } (this is different from \msc).
      - - term: See also
          description: section \msc.
    preformatted: []
    text: "\\mscfile <file> [\"caption\"] [<sizeindication>=<size>]\n\nInserts an image generated by mscgen from <file> into the documentation. See https://www.mcternan.me.uk/mscgen/ for examples.\n\nThe first argument specifies the file name of the image. Doxygen will\n look for files in the paths (or files) that you specified after the MSCFILE_DIRS\n tag. If the msc file is found it will be used as an input file to the \nbuilt in mscgen tool. The resulting image will be put into the correct \noutput directory. If the msc file name contains spaces you'll have to \nput quotes (\"...\") around it.\n\nThe second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed.\n\nThe third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command.\n\nNote\n\nThe text fragment should include the part message of the sequence chart as well as the starting msc { and ending } (this is different from \\msc).\n\nSee also\n\nsection \\msc."
  - id: cmddiafile
    title: \diafile <file> ["caption"] [<sizeindication>=<size>]
    paragraphs:
      - Inserts an image made in dia from <file> into the documentation.
      - "The first argument specifies the file name of the image. Doxygen will\n look for files in the paths (or files) that you specified after the DIAFILE_DIRS\n tag. If the dia file is found it will be used as an input file dia. The\n resulting image will be put into the correct output directory. If the \ndia file name contains spaces you'll have to put quotes (\"...\") around \nit."
      - "The second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed."
      - "The third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\diafile <file> [\"caption\"] [<sizeindication>=<size>]\n\nInserts an image made in dia from <file> into the documentation.\n\nThe first argument specifies the file name of the image. Doxygen will\n look for files in the paths (or files) that you specified after the DIAFILE_DIRS\n tag. If the dia file is found it will be used as an input file dia. The\n resulting image will be put into the correct output directory. If the \ndia file name contains spaces you'll have to put quotes (\"...\") around \nit.\n\nThe second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed.\n\nThe third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
  - id: cmddoxyconfig
    title: "\\doxyconfig <config_option>"
    paragraphs:
      - Displays the value of the configuration option <config_option> as used in Doxygen's configuration file that is in use when this command is processed.
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            When creating this manual the following: ... Project name = \doxyconfig PROJECT_NAME ...
             gives:
             ... Project name = Doxygen ...
    preformatted: []
    text: |-
      \doxyconfig <config_option>

      Displays the value of the configuration option <config_option> as used in Doxygen's configuration file that is in use when this command is processed.

      Example:

      When creating this manual the following: ... Project name = \doxyconfig PROJECT_NAME ...
       gives:
       ... Project name = Doxygen ...
  - id: cmde
    title: "\\e <word>"
    paragraphs:
      - Displays the argument <word> in italics. Use this command to emphasize words.
      - Equivalent to \a and \em. To emphasize multiple words use <em>multiple words</em>.
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            Typing: ... this is a \e really good example ...
             will result in the following text:

             ... this is a really good example ...
    preformatted: []
    text: |-
      \e <word>

      Displays the argument <word> in italics. Use this command to emphasize words.

      Equivalent to \a and \em. To emphasize multiple words use <em>multiple words</em>.

      Example:

      Typing: ... this is a \e really good example ...
       will result in the following text:

       ... this is a really good example ...
  - id: cmdem
    title: "\\em <word>"
    paragraphs:
      - Displays the argument <word> in italics. Use this command to emphasize words.
      - Equivalent to \a and \e. To emphasize multiple words use <em>multiple words</em>.
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            Typing: ... this is a \em really good example ...
             will result in the following text:

             ... this is a really good example ...
    preformatted: []
    text: |-
      \em <word>

      Displays the argument <word> in italics. Use this command to emphasize words.

      Equivalent to \a and \e. To emphasize multiple words use <em>multiple words</em>.

      Example:

      Typing: ... this is a \em really good example ...
       will result in the following text:

       ... this is a really good example ...
  - id: cmdendcode
    title: "\\endcode"
    paragraphs:
      - Ends a block of code.
    lists: []
    definition_lists:
      - - term: See also
          description: section \code
    preformatted: []
    text: |-
      \endcode

      Ends a block of code.

      See also

      section \code
  - id: cmdenddocbookonly
    title: "\\enddocbookonly"
    paragraphs:
      - Ends a block of text that was started with a \docbookonly command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \docbookonly.
    preformatted: []
    text: |-
      \enddocbookonly

      Ends a block of text that was started with a \docbookonly command.

      See also

      section \docbookonly.
  - id: cmdenddot
    title: "\\enddot"
    paragraphs:
      - Ends a block that was started with \dot.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \enddot

      Ends a block that was started with \dot.
  - id: cmdendmsc
    title: "\\endmsc"
    paragraphs:
      - Ends a block that was started with \msc.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \endmsc

      Ends a block that was started with \msc.
  - id: cmdendmermaid
    title: "\\endmermaid"
    paragraphs:
      - Ends a block that was started with \mermaid.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \endmermaid

      Ends a block that was started with \mermaid.
  - id: cmdenduml
    title: "\\enduml"
    paragraphs:
      - Ends a block that was started with \startuml.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \enduml

      Ends a block that was started with \startuml.
  - id: cmdmermaidfile
    title: \mermaidfile <file> ["caption"] [<sizeindication>=<size>]
    paragraphs:
      - Inserts a Mermaid diagram from <file> into the documentation.
      - "The first argument specifies the file name of the Mermaid source \nfile. Doxygen will look for files in the paths (or files) that you \nspecified after the MERMAIDFILE_DIRS\n tag. If the mermaid file is found it will be used as input for \nrendering. The resulting image will be put into the correct output \ndirectory. If the mermaid file name contains spaces you'll have to put \nquotes (\"...\") around it."
      - "The second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed."
      - "The third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
    lists: []
    definition_lists:
      - - term: See also
          description: section \mermaid.
    preformatted: []
    text: "\\mermaidfile <file> [\"caption\"] [<sizeindication>=<size>]\n\nInserts a Mermaid diagram from <file> into the documentation.\n\nThe first argument specifies the file name of the Mermaid source \nfile. Doxygen will look for files in the paths (or files) that you \nspecified after the MERMAIDFILE_DIRS\n tag. If the mermaid file is found it will be used as input for \nrendering. The resulting image will be put into the correct output \ndirectory. If the mermaid file name contains spaces you'll have to put \nquotes (\"...\") around it.\n\nThe second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed.\n\nThe third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command.\n\nSee also\n\nsection \\mermaid."
  - id: cmdplantumlfile
    title: \plantumlfile <file> ["caption"] [<sizeindication>=<size>]
    paragraphs:
      - Inserts an image made in PlantUml from <file> into the documentation.
      - "The first argument specifies the file name of the image. Doxygen will\n look for files in the paths (or files) that you specified after the PLANTUMLFILE_DIRS\n tag. If the plantuml file is found it will be used as an input file for\n the plantuml program. The resulting image will be put into the correct \noutput directory. If the plantuml file name contains spaces you'll have \nto put quotes (\"...\") around it."
      - "The second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed."
      - "The third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\plantumlfile <file> [\"caption\"] [<sizeindication>=<size>]\n\nInserts an image made in PlantUml from <file> into the documentation.\n\nThe first argument specifies the file name of the image. Doxygen will\n look for files in the paths (or files) that you specified after the PLANTUMLFILE_DIRS\n tag. If the plantuml file is found it will be used as an input file for\n the plantuml program. The resulting image will be put into the correct \noutput directory. If the plantuml file name contains spaces you'll have \nto put quotes (\"...\") around it.\n\nThe second argument is optional and can be used to specify the \ncaption that is displayed below the image. This argument has to be \nspecified between quotes even if it does not contain any spaces. The \nquotes are stripped before the caption is displayed.\n\nThe third argument is also optional and can be used to specify the \nwidth or height of the image. For a description of the possibilities see\n the paragraph Size indication with the \\image command."
  - id: cmdendhtmlonly
    title: "\\endhtmlonly"
    paragraphs:
      - Ends a block of text that was started with a \htmlonly command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \htmlonly.
    preformatted: []
    text: |-
      \endhtmlonly

      Ends a block of text that was started with a \htmlonly command.

      See also

      section \htmlonly.
  - id: cmdendlatexonly
    title: "\\endlatexonly"
    paragraphs:
      - Ends a block of text that was started with a \latexonly command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \latexonly.
    preformatted: []
    text: |-
      \endlatexonly

      Ends a block of text that was started with a \latexonly command.

      See also

      section \latexonly.
  - id: cmdendmanonly
    title: "\\endmanonly"
    paragraphs:
      - Ends a block of text that was started with a \manonly command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \manonly.
    preformatted: []
    text: |-
      \endmanonly

      Ends a block of text that was started with a \manonly command.

      See also

      section \manonly.
  - id: cmdendrtfonly
    title: "\\endrtfonly"
    paragraphs:
      - Ends a block of text that was started with a \rtfonly command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \rtfonly.
    preformatted: []
    text: |-
      \endrtfonly

      Ends a block of text that was started with a \rtfonly command.

      See also

      section \rtfonly.
  - id: cmdendverbatim
    title: "\\endverbatim"
    paragraphs:
      - Ends a block of text that was started with a \verbatim command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \verbatim.
    preformatted: []
    text: |-
      \endverbatim

      Ends a block of text that was started with a \verbatim command.

      See also

      section \verbatim.
  - id: cmdendxmlonly
    title: "\\endxmlonly"
    paragraphs:
      - Ends a block of text that was started with a \xmlonly command.
    lists: []
    definition_lists:
      - - term: See also
          description: section \xmlonly.
    preformatted: []
    text: |-
      \endxmlonly

      Ends a block of text that was started with a \xmlonly command.

      See also

      section \xmlonly.
  - id: cmdfdollar
    title: "\\f$"
    paragraphs:
      - Marks the start and end of an in-text formula.
    lists: []
    definition_lists:
      - - term: See also
          description: section formulas for an example.
    preformatted: []
    text: |-
      \f$

      Marks the start and end of an in-text formula.

      See also

      section formulas for an example.
  - id: cmdfrndopen
    title: "\\f("
    paragraphs:
      - Marks the start of an in-text formula, but contrary to \f$ it will not explicitly open the math-mode in .
    lists: []
    definition_lists:
      - - term: See also
          description: section \f) and section formulas.
    preformatted: []
    text: |-
      \f(

      Marks the start of an in-text formula, but contrary to \f$ it will not explicitly open the math-mode in .

      See also

      section \f) and section formulas.
  - id: cmdfrndclose
    title: "\\f)"
    paragraphs:
      - Marks the end of an in-text formula started with \f(.
    lists: []
    definition_lists:
      - - term: See also
          description: section \f( and section formulas.
    preformatted: []
    text: |-
      \f)

      Marks the end of an in-text formula started with \f(.

      See also

      section \f( and section formulas.
  - id: cmdfbropen
    title: "\\f["
    paragraphs:
      - Marks the start of a long formula that is displayed centered on a separate line.
    lists: []
    definition_lists:
      - - term: See also
          description: section \f] and section formulas.
    preformatted: []
    text: |-
      \f[

      Marks the start of a long formula that is displayed centered on a separate line.

      See also

      section \f] and section formulas.
  - id: cmdfbrclose
    title: "\\f]"
    paragraphs:
      - Marks the end of a long formula that is displayed centered on a separate line.
    lists: []
    definition_lists:
      - - term: See also
          description: section \f[ and section formulas.
    preformatted: []
    text: |-
      \f]

      Marks the end of a long formula that is displayed centered on a separate line.

      See also

      section \f[ and section formulas.
  - id: cmdfcurlyopen
    title: "\\f{environment}{"
    paragraphs:
      - Marks the start of a formula that is in a specific environment.
    lists: []
    definition_lists:
      - - term: Note
          description: The second { is optional and is only to help editors (such as Vim) to do proper syntax highlighting by making the number of opening and closing braces the same.
      - - term: See also
          description: section \f} and section formulas.
    preformatted: []
    text: |-
      \f{environment}{

      Marks the start of a formula that is in a specific environment.

      Note

      The second { is optional and is only to help editors (such as Vim) to do proper syntax highlighting by making the number of opening and closing braces the same.

      See also

      section \f} and section formulas.
  - id: cmdfcurlyclose
    title: "\\f}"
    paragraphs:
      - Marks the end of a formula that is in a specific environment.
    lists: []
    definition_lists:
      - - term: See also
          description: section \f{ and section formulas.
    preformatted: []
    text: |-
      \f}

      Marks the end of a formula that is in a specific environment.

      See also

      section \f{ and section formulas.
  - id: cmdhtmlonly
    title: "\\htmlonly['[block]']"
    paragraphs:
      - Starts a block of text that only will be verbatim included in the generated HTML documentation and tagged with <htmlonly> in the generated XML output. The block ends with a \endhtmlonly command.
      - "This command can be used to include HTML code that is too complex for\n Doxygen (i.e. applets, java-scripts, and HTML tags that require \nspecific attributes)."
      - "Normally the contents between \\htmlonly and \\endhtmlonly\n is inserted as-is. When you want to insert a HTML fragment that has \nblock scope like a table or list which should appear outside \n<p>..</p>, this can lead to invalid HTML. You can use \\htmlonly[block] to make Doxygen end the current paragraph and restart it after \\endhtmlonly."
    lists: []
    definition_lists:
      - - term: Note
          description: environment variables (like $(HOME) ) are resolved inside a HTML-only block.
      - - term: See also
          description: section \manonly, \latexonly, \rtfonly, \xmlonly, \docbookonly, and \htmlinclude.
    preformatted: []
    text: "\\htmlonly['[block]']\n\nStarts a block of text that only will be verbatim included in the generated HTML documentation and tagged with <htmlonly> in the generated XML output. The block ends with a \\endhtmlonly command.\n\nThis command can be used to include HTML code that is too complex for\n Doxygen (i.e. applets, java-scripts, and HTML tags that require \nspecific attributes).\n\nNormally the contents between \\htmlonly and \\endhtmlonly\n is inserted as-is. When you want to insert a HTML fragment that has \nblock scope like a table or list which should appear outside \n<p>..</p>, this can lead to invalid HTML. You can use \\htmlonly[block] to make Doxygen end the current paragraph and restart it after \\endhtmlonly.\n\nNote\n\nenvironment variables (like $(HOME) ) are resolved inside a HTML-only block.\n\nSee also\n\nsection \\manonly, \\latexonly, \\rtfonly, \\xmlonly, \\docbookonly, and \\htmlinclude."
  - id: cmdimage
    title: \image['{'option[,option]'}'] <format> <file> ["caption"] [<sizeindication>=<size>]
    paragraphs:
      - "Inserts an image into\n the documentation. This command is format specific, so if you want to \ninsert an image for more than one format you'll have to repeat this \ncommand for each format."
      - "The first argument specifies the output format in which the image \nshould be embedded. Currently, the following values are supported: html, latex, docbook, rtf and xml."
      - "The second argument specifies the file name of the image. Doxygen \nwill look for files in the paths (or files) that you specified after the\n IMAGE_PATH\n tag. If the image is found it will be copied to the correct output \ndirectory. If the image name contains spaces you'll have to put quotes \n(\"...\") around the name. You can also specify an absolute URL instead of\n a file name, but then Doxygen does not copy the image nor check its \nexistence."
      - "The third argument is optional and can be used to specify the caption\n that is displayed below the image. This argument has to be specified on\n a single line and between quotes even if it does not contain any \nspaces. The quotes are stripped before the caption is displayed."
      - The fourth argument is also optional and can be used to specify the width or height of the image. This can be useful for or DocBook output (i.e. format=latex or format=docbook).
      - "Currently only the options inline and anchor are supported. In case the option inline\n is specified the image is placed \"in the line\", when a caption is \npresent it is shown in HTML as tooltip (ignored for the other formats). \nFor the anchor option the syntax is: anchor:<anchorId>."
      - 'Here is example of a comment block:'
      - 'And this is an example of how the relevant part of the configuration file may look:'
    lists: []
    definition_lists:
      - - term: Size indication
          description: The sizeindication can specify the width or height to be used (or a combination). The size specifier in (for example 10cm or 4in or a symbolic width like \textwidth).
      - - term: Warning
          description: "The image format for HTML is limited to what your browser supports.\nFor , the image format must be supported by the \\includegraphics command i.e. Encapsulated PostScript (eps), Portable network graphics (png), Joint photographic experts group (jpg / jpeg). \n\n Doxygen does not check if the image is in the correct format. So you have to make sure this is the case!"
    preformatted:
      - |2-
          /*! Here is a snapshot of my new application:
           *  \image html application.jpg
           *  \image latex application.eps "My application" width=10cm
           */
      - "  IMAGE_PATH     = my_image_dir"
    text: "\\image['{'option[,option]'}'] <format> <file> [\"caption\"] [<sizeindication>=<size>]\n\nInserts an image into\n the documentation. This command is format specific, so if you want to \ninsert an image for more than one format you'll have to repeat this \ncommand for each format.\n\nThe first argument specifies the output format in which the image \nshould be embedded. Currently, the following values are supported: html, latex, docbook, rtf and xml.\n\nThe second argument specifies the file name of the image. Doxygen \nwill look for files in the paths (or files) that you specified after the\n IMAGE_PATH\n tag. If the image is found it will be copied to the correct output \ndirectory. If the image name contains spaces you'll have to put quotes \n(\"...\") around the name. You can also specify an absolute URL instead of\n a file name, but then Doxygen does not copy the image nor check its \nexistence.\n\nThe third argument is optional and can be used to specify the caption\n that is displayed below the image. This argument has to be specified on\n a single line and between quotes even if it does not contain any \nspaces. The quotes are stripped before the caption is displayed.\n\nThe fourth argument is also optional and can be used to specify the width or height of the image. This can be useful for or DocBook output (i.e. format=latex or format=docbook).\n\nCurrently only the options inline and anchor are supported. In case the option inline\n is specified the image is placed \"in the line\", when a caption is \npresent it is shown in HTML as tooltip (ignored for the other formats). \nFor the anchor option the syntax is: anchor:<anchorId>.\n\nHere is example of a comment block:\n\nAnd this is an example of how the relevant part of the configuration file may look:\n\n /*! Here is a snapshot of my new application:\n * \\image html application.jpg\n * \\image latex application.eps \"My application\" width=10cm\n */\n\n IMAGE_PATH = my_image_dir\n\nSize indication\n\nThe sizeindication can specify the width or height to be used (or a combination). The size specifier in (for example 10cm or 4in or a symbolic width like \\textwidth).\n\nWarning\n\nThe image format for HTML is limited to what your browser supports.\nFor , the image format must be supported by the \\includegraphics command i.e. Encapsulated PostScript (eps), Portable network graphics (png), Joint photographic experts group (jpg / jpeg). \n\n Doxygen does not check if the image is in the correct format. So you have to make sure this is the case!"
  - id: cmdlatexonly
    title: "\\latexonly"
    paragraphs:
      - Starts a block of text that only will be verbatim included in the generated documentation and tagged with <latexonly> in the generated XML output. The block ends with a \endlatexonly command.
      - This command can be used to include code that is too complex for Doxygen (i.e. images, formulas, special characters). You can use the \htmlonly and \endhtmlonly pair to provide a proper HTML alternative.
      - 'Note: environment variables (like $(HOME) ) are resolved inside a -only block.'
    lists: []
    definition_lists:
      - - term: See also
          description: sections \rtfonly, \xmlonly, \manonly, \htmlonly, \docbookonly, and \latexinclude.
    preformatted: []
    text: |-
      \latexonly

      Starts a block of text that only will be verbatim included in the generated documentation and tagged with <latexonly> in the generated XML output. The block ends with a \endlatexonly command.

      This command can be used to include code that is too complex for Doxygen (i.e. images, formulas, special characters). You can use the \htmlonly and \endhtmlonly pair to provide a proper HTML alternative.

      Note: environment variables (like $(HOME) ) are resolved inside a -only block.

      See also

      sections \rtfonly, \xmlonly, \manonly, \htmlonly, \docbookonly, and \latexinclude.
  - id: cmdmanonly
    title: "\\manonly"
    paragraphs:
      - Starts a block of text that only will be verbatim included in the generated MAN documentation and tagged with <manonly> in the generated XML output. The block ends with a \endmanonly command.
      - This command can be used to include groff code directly into MAN pages. You can use the \htmlonly and \endhtmlonly and \latexonly and \endlatexonly pairs to provide proper HTML and alternatives.
    lists: []
    definition_lists:
      - - term: See also
          description: sections \htmlonly, \xmlonly, \rtfonly, \latexonly, \docbookonly and \maninclude.
    preformatted: []
    text: |-
      \manonly

      Starts a block of text that only will be verbatim included in the generated MAN documentation and tagged with <manonly> in the generated XML output. The block ends with a \endmanonly command.

      This command can be used to include groff code directly into MAN pages. You can use the \htmlonly and \endhtmlonly and \latexonly and \endlatexonly pairs to provide proper HTML and alternatives.

      See also

      sections \htmlonly, \xmlonly, \rtfonly, \latexonly, \docbookonly and \maninclude.
  - id: cmdli
    title: "\\li { item-description }"
    paragraphs:
      - This command has one argument that continues until the first blank line or until another \li is encountered. The command can be used to generate a simple, not nested list of arguments. Each argument should start with a \li command.
      - Equivalent to \arg
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: "Typing: \\li \\c AlignLeft left alignment.\n \\li \\c AlignCenter center alignment.\n \\li \\c AlignRight right alignment\n\n No other types of alignment are supported.\n will result in the following text:\n\nAlignLeft left alignment. \n\nAlignCenter center alignment. \n\nAlignRight right alignment \n\n No other types of alignment are supported."
      - - term: 'Note:'
          description: For nested lists, HTML commands should be used.
    preformatted: []
    text: "\\li { item-description }\n\nThis command has one argument that continues until the first blank line or until another \\li is encountered. The command can be used to generate a simple, not nested list of arguments. Each argument should start with a \\li command.\n\nEquivalent to \\arg\n\nExample:\n\nTyping: \\li \\c AlignLeft left alignment.\n \\li \\c AlignCenter center alignment.\n \\li \\c AlignRight right alignment\n\n No other types of alignment are supported.\n will result in the following text:\n\nAlignLeft left alignment. \n\nAlignCenter center alignment. \n\nAlignRight right alignment \n\n No other types of alignment are supported.\n\nNote:\n\nFor nested lists, HTML commands should be used."
  - id: cmdn
    title: "\\n"
    paragraphs:
      - Forces a new line. Equivalent to <br> and inspired by the printf function.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \n

      Forces a new line. Equivalent to <br> and inspired by the printf function.
  - id: cmdp
    title: "\\p <word>"
    paragraphs:
      - "Displays the parameter \n<word> using a typewriter font. You can use this command to refer \nto member function parameters in the running text."
      - Equivalent to \c. To have multiple words in typewriter font use <tt>multiple words</tt>.
    lists: []
    definition_lists:
      - - term: 'Example:'
          description: |-
            ... the \p x and \p y coordinates are used to ...
             This will result in the following text:

             ... the x and y coordinates are used to ...
    preformatted: []
    text: "\\p <word>\n\nDisplays the parameter \n<word> using a typewriter font. You can use this command to refer \nto member function parameters in the running text.\n\nEquivalent to \\c. To have multiple words in typewriter font use <tt>multiple words</tt>.\n\nExample:\n\n... the \\p x and \\p y coordinates are used to ...\n This will result in the following text:\n\n ... the x and y coordinates are used to ..."
  - id: cmdrtfonly
    title: "\\rtfonly"
    paragraphs:
      - Starts a block of text that only will be verbatim included in the generated RTF documentation and tagged with <rtfonly> in the generated XML output. The block ends with a \endrtfonly command.
      - This command can be used to include RTF code that is too complex for Doxygen.
      - 'Note: environment variables (like $(HOME) ) are resolved inside a RTF-only block.'
    lists: []
    definition_lists:
      - - term: See also
          description: sections \manonly, \xmlonly, \latexonly, \htmlonly, \docbookonly and \rtfinclude.
    preformatted: []
    text: |-
      \rtfonly

      Starts a block of text that only will be verbatim included in the generated RTF documentation and tagged with <rtfonly> in the generated XML output. The block ends with a \endrtfonly command.

      This command can be used to include RTF code that is too complex for Doxygen.

      Note: environment variables (like $(HOME) ) are resolved inside a RTF-only block.

      See also

      sections \manonly, \xmlonly, \latexonly, \htmlonly, \docbookonly and \rtfinclude.
  - id: cmdverbatim
    title: "\\verbatim"
    paragraphs:
      - Starts a block of text that will be verbatim included in the documentation. The block should end with a \endverbatim command. All commands are disabled in a verbatim block.
    lists: []
    definition_lists:
      - - term: Warning
          description: Make sure you include a \endverbatim command for each \verbatim command or the parser will get confused!
      - - term: See also
          description: sections \code, \endverbatim and \verbinclude.
    preformatted: []
    text: |-
      \verbatim

      Starts a block of text that will be verbatim included in the documentation. The block should end with a \endverbatim command. All commands are disabled in a verbatim block.

      Warning

      Make sure you include a \endverbatim command for each \verbatim command or the parser will get confused!

      See also

      sections \code, \endverbatim and \verbinclude.
  - id: cmdxmlonly
    title: "\\xmlonly"
    paragraphs:
      - Starts a block of text that only will be verbatim included in the generated XML output. The block ends with a \endxmlonly command.
      - This command can be used to include custom XML tags.
    lists: []
    definition_lists:
      - - term: See also
          description: sections \manonly, \rtfonly, \latexonly, \htmlonly, and \docbookonly.
    preformatted: []
    text: |-
      \xmlonly

      Starts a block of text that only will be verbatim included in the generated XML output. The block ends with a \endxmlonly command.

      This command can be used to include custom XML tags.

      See also

      sections \manonly, \rtfonly, \latexonly, \htmlonly, and \docbookonly.
  - id: cmdbackslash
    title: "\\\\"
    paragraphs:
      - This command writes a backslash character (\) to the output. The backslash has to be escaped in some cases because Doxygen uses it to detect commands.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \\

      This command writes a backslash character (\) to the output. The backslash has to be escaped in some cases because Doxygen uses it to detect commands.
  - id: cmdat
    title: "\\@"
    paragraphs:
      - This command writes an at-sign (@) to the output. The at-sign has to be escaped in some cases because Doxygen uses it to detect Javadoc commands.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \@

      This command writes an at-sign (@) to the output. The at-sign has to be escaped in some cases because Doxygen uses it to detect Javadoc commands.
  - id: cmdtilde
    title: "\\~[LanguageId]"
    paragraphs:
      - "This command \nenables/disables a language specific filter. This can be used to put \ndocumentation for different language into one comment block and use the OUTPUT_LANGUAGE tag to filter out only a specific language. Use \\~language_id to enable output for a specific language only and \\~ to enable output for all languages (this is also the default mode)."
      - 'Example:'
    lists: []
    definition_lists: []
    preformatted:
      - |-
        /*! \~english This is English \~dutch Dit is Nederlands \~german Dies ist
            Deutsch. \~ output for all languages.
         */
    text: "\\~[LanguageId]\n\nThis command \nenables/disables a language specific filter. This can be used to put \ndocumentation for different language into one comment block and use the OUTPUT_LANGUAGE tag to filter out only a specific language. Use \\~language_id to enable output for a specific language only and \\~ to enable output for all languages (this is also the default mode).\n\nExample:\n\n/*! \\~english This is English \\~dutch Dit is Nederlands \\~german Dies ist\n Deutsch. \\~ output for all languages.\n */"
  - id: cmdamp
    title: "\\&"
    paragraphs:
      - This command writes the & character to the output. This character has to be escaped because it has a special meaning in HTML.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \&

      This command writes the & character to the output. This character has to be escaped because it has a special meaning in HTML.
  - id: cmddollar
    title: "\\$"
    paragraphs:
      - This command writes the $ character to the output. This character has to be escaped in some cases, because it is used to expand environment variables.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \$

      This command writes the $ character to the output. This character has to be escaped in some cases, because it is used to expand environment variables.
  - id: cmdhash
    title: "\\#"
    paragraphs:
      - 'This command writes the # character to the output. This character has to be escaped in some cases, because it is used to refer to documented entities.'
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \#

      This command writes the # character to the output. This character has to be escaped in some cases, because it is used to refer to documented entities.
  - id: cmdlt
    title: "\\<"
    paragraphs:
      - This command writes the < character to the output. This character has to be escaped because it has a special meaning in HTML.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \<

      This command writes the < character to the output. This character has to be escaped because it has a special meaning in HTML.
  - id: cmdgt
    title: "\\>"
    paragraphs:
      - This command writes the > character to the output. This character has to be escaped because it has a special meaning in HTML.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \>

      This command writes the > character to the output. This character has to be escaped because it has a special meaning in HTML.
  - id: cmdperc
    title: "\\%"
    paragraphs:
      - "This command writes the %\n character to the output. This character has to be escaped in some \ncases, because it is used to prevent auto-linking to a word that is also\n a documented class or struct."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\%\n\nThis command writes the %\n character to the output. This character has to be escaped in some \ncases, because it is used to prevent auto-linking to a word that is also\n a documented class or struct."
  - id: cmdquot
    title: \"
    paragraphs:
      - "This command writes the \"\n character to the output. This character has to be escaped in some \ncases, because it is used in pairs to indicate an unformatted text \nfragment."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\\"\n\nThis command writes the \"\n character to the output. This character has to be escaped in some \ncases, because it is used in pairs to indicate an unformatted text \nfragment."
  - id: cmdchardot
    title: "\\."
    paragraphs:
      - This command writes a dot (.) to the output. This can be useful to prevent ending a brief description when JAVADOC_AUTOBRIEF or QT_AUTOBRIEF is enabled or to prevent starting a numbered list when the dot follows a number at the start of a line.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \.

      This command writes a dot (.) to the output. This can be useful to prevent ending a brief description when JAVADOC_AUTOBRIEF or QT_AUTOBRIEF is enabled or to prevent starting a numbered list when the dot follows a number at the start of a line.
  - id: cmdquest
    title: "\\?"
    paragraphs:
      - This command writes a question mark (?) to the output. This can be useful to prevent ending a brief description when JAVADOC_AUTOBRIEF or QT_AUTOBRIEF is enabled.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \?

      This command writes a question mark (?) to the output. This can be useful to prevent ending a brief description when JAVADOC_AUTOBRIEF or QT_AUTOBRIEF is enabled.
  - id: cmdexclam
    title: "\\!"
    paragraphs:
      - This command writes a exclamation mark (!) to the output. This can be useful to prevent ending a brief description when JAVADOC_AUTOBRIEF or QT_AUTOBRIEF is enabled.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \!

      This command writes a exclamation mark (!) to the output. This can be useful to prevent ending a brief description when JAVADOC_AUTOBRIEF or QT_AUTOBRIEF is enabled.
  - id: cmdeq
    title: "\\="
    paragraphs:
      - This command writes an equal sign (=) to the output. This character sequence has to be escaped in some cases, because it is used in Markdown header processing.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \=

      This command writes an equal sign (=) to the output. This character sequence has to be escaped in some cases, because it is used in Markdown header processing.
  - id: cmddcolon
    title: "\\::"
    paragraphs:
      - |-
        This command writes a double colon (::)
         to the output. This character sequence has to be escaped in some cases,
         because it is used to reference to documented entities.
    lists: []
    definition_lists: []
    preformatted: []
    text: |-
      \::

      This command writes a double colon (::)
       to the output. This character sequence has to be escaped in some cases,
       because it is used to reference to documented entities.
  - id: cmdpipe
    title: "\\|"
    paragraphs:
      - "This command writes a \npipe symbol (|) to the output. This character has to be escaped in some \ncases, because it is used for Markdown tables."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\|\n\nThis command writes a \npipe symbol (|) to the output. This character has to be escaped in some \ncases, because it is used for Markdown tables."
  - id: cmdndash
    title: "\\--"
    paragraphs:
      - "This command writes two \ndashes (--) to the output. This allows writing two consecutive dashes to\n the output instead of one n-dash character (–)."
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\--\n\nThis command writes two \ndashes (--) to the output. This allows writing two consecutive dashes to\n the output instead of one n-dash character (–)."
  - id: cmdmdash
    title: "\\---"
    paragraphs:
      - "This command writes three\n dashes (---) to the output. This allows writing three consecutive \ndashes to the output instead of one m-dash character (—)."
      - |-
        Go to the next section or return to the
         index.
    lists: []
    definition_lists: []
    preformatted: []
    text: "\\---\n\nThis command writes three\n dashes (---) to the output. This allows writing three consecutive \ndashes to the output instead of one m-dash character (—).\n\nGo to the next section or return to the\n index."