doxygen_manual-1.8.1 (1035109), страница 30
Текст из файла (страница 30)
. .\bug . . . .\c . . . . . .\callgraph .\callergraph\category . .\cite . . . .\class . . .\code . . . .\cond . . . .\copybrief .\copydetails\copydoc . .\copyright .\date . . . .\def . . . .\defgroup .\deprecated\details . . .\dir . . . . .\dontinclude\dot . . .
........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................21.11121.8921.221.9021.11221.4821.4921.5021.11321.5121.5221.11421.321.421.521.9121.621.11521.5321.11721.11821.11621.5421.5521.721.821.5621.5721.921.10121.119\dotfile .
. . .\e . . . . . .\else . . . . .\elseif . . . .\em . . . . . .\endcode . . .\endcond . . .\enddot . . .\endhtmlonly .\endif . . . . .\endinternal .\endlatexonly\endlink . . .\endmanonly .\endmsc . . .\endrtfonly . .\endverbatim .\endxmlonly .\enum . . .
.\example . . .\exception . .\extends . . .\f$ . . . . . .\f[ . . . . . .\f] . . . . . .\f{ . . . . . .\f} . . . . . .\file . . . . . .\fn . . . . . .\headerfile . .\hideinitializer........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................21.12121.12321.5821.5921.12421.12521.6021.12621.12821.6121.1221.12921.9221.13021.12721.13121.13221.13321.1021.1121.6221.1321.13421.13521.13621.13721.13821.1421.1521.1621.17116\htmlinclude .
. .\htmlonly . . . . .\if . . . . . . . . .\ifnot . . . . . . .\image . . . . . .\implements . . .\include . . . . .\includelineno . .\ingroup . . . . .\internal . . . . .\invariant . . . . .\interface . . . . .\latexonly . . . .\li . . . . . . . . .\line . . . . . . .\link . .
. . . . .\mainpage . . . .\manonly . . . . .\memberof . . . .\msc . . . . . . .\mscfile . . . . .\n . . . . . . . .\name . . . . . .\namespace . . .\nosubgrouping .\note . . . . . . .\overload . . . . .\p . . . . . . . .\package . . . . .\page . .
. . . .\par . . . . . . .\paragraph . . . .\param . . . . . .\post . . . . . . .\pre . . . . . . .\private . . . . . .\privatesection . .\property . . . . .\protected . . . .\protectedsection\protocol . . . . .\public . . . . . .\publicsection . .\ref . . . . . . . .\related . . . . .\relates . . . . . .\relatedalso . . .\relatesalso . . .\remark . . . . .Special Commands......................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................21.11021.13921.6321.6421.14021.1821.10221.10321.1921.2121.6521.2021.14121.14321.10421.9321.2221.14221.2321.12021.12221.14421.2421.2521.2621.6621.2721.14521.2821.2921.6721.10021.6821.7021.7121.3021.3021.3221.3321.3321.3521.3621.3621.9421.3921.3821.4121.4021.72\remarks .
. . .\result . . . . .\return . . . . .\returns . . . .\retval . . . . .\rtfonly . . . . .\sa . . . . . . .\section . . . .\see . . . . . .\short . . . . .\showinitializer .\since . . . . .\skip . . . . . .\skipline . . . .\snippet . . . .\struct . .
. . .\subpage . . . .\subsection . .\subsubsection\tableofcontents\test . . . . . .\throw . . . . .\throws . . . . .\todo . . . . . .\tparam . . . .\typedef . . . .\union . . . . .\until . . . . . .\var . . . . . . .\verbatim . . . .\verbinclude . .\version . . . .\warning . . . .\weakgroup . .\xmlonly . . . .\xrefitem . . . .\$ . . . .
. . .\@ . . . . . . .\\ . . . . . . . .\& . . . . . . .\∼ . . . . . . .\< . . . . . . .\> . . . . . . .\# . . . . . . .\% . . . . . . .\" . . . . . . . .\. . . . . . . . .\:: . . . . . . .................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................21.7321.7421.7521.7621.7721.14621.7821.9721.7921.8021.4221.8121.10521.10621.10721.4321.9521.9821.9921.9621.8221.8321.8421.8521.6921.4421.4521.10821.4621.14721.10921.8621.8721.4721.14821.8821.15321.15021.14921.15221.15121.15521.15621.15421.15721.15821.15921.160The following subsections provide a list of all commands that are recognized by doxygen.
Unrecognized commandsare treated as normal text.Structural indicators21.2 \addtogroup <name> [(title)]Defines a group just like \defgroup, but in contrast to that command using the same <name> more than once willnot result in a warning, but rather one group with a merged documentation and the first title found in any of thecommands.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:/*! \addtogroup mygrp* Additional documentation for group ’mygrp’* @{Generated by Doxygen21.3 \callgraph117*//*!* A function*/void func1(){}/*! Another function */void func2(){}/*! @} */See alsopage Grouping, sections \defgroup, \ingroup, and \weakgroup.21.3 \callgraphWhen this command is put in a comment block of a function or method and HAVE_DOT is set to YES, then doxygen will generate a call graph for that function (provided the implementation of the function or method calls otherdocumented functions). The call graph will be generated regardless of the value of CALL_GRAPH.NoteThe completeness (and correctness) of the call graph depends on the doxygen code parser which is not perfect.See alsosection \callergraph.21.4 \callergraphWhen this command is put in a comment block of a function or method and HAVE_DOT is set to YES, then doxygenwill generate a caller graph for that function (provided the implementation of the function or method calls otherdocumented functions).
The caller graph will be generated regardless of the value of CALLER_GRAPH.NoteThe completeness (and correctness) of the caller graph depends on the doxygen code parser which is notperfect.See alsosection \callgraph.21.5 \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 alsosection \class.Generated by Doxygen118Special Commands21.6 \class <name> [<header-file>] [<header-name>]Indicates that a comment block contains documentation for a class with name <name>. Optionally a header fileand a header name can be specified. If the header-file is specified, a link to a verbatim copy of the header willbe included in the HTML documentation.