diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2003-06-07 11:47:47 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2003-06-07 11:47:47 (GMT) |
commit | 0aa47e2a30513b04d1041d528f468d3434a81558 (patch) | |
tree | f17d17b67fdefdfdf992328f3f51dd90812c156e /doc/commands.doc | |
parent | 35c2baedaa68519999af733a87d8e6ff9a89358c (diff) | |
download | Doxygen-0aa47e2a30513b04d1041d528f468d3434a81558.zip Doxygen-0aa47e2a30513b04d1041d528f468d3434a81558.tar.gz Doxygen-0aa47e2a30513b04d1041d528f468d3434a81558.tar.bz2 |
Release-1.3.1-20030607
Diffstat (limited to 'doc/commands.doc')
-rw-r--r-- | doc/commands.doc | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 4557bb3..d7ba4f3 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -47,6 +47,7 @@ documentation: \refitem cmdbrief \\brief \refitem cmdbug \\bug \refitem cmdc \\c +\refitem cmdcallgraph \\callgraph \refitem cmdclass \\class \refitem cmdcode \\code \refitem cmdcopydoc \\copydoc @@ -66,6 +67,7 @@ documentation: \refitem cmdendlatexonly \\endlatexonly \refitem cmdendlink \\endlink \refitem cmdendverbatim \\endverbatim +\refitem cmdendxmlonly \\endxmlonly \refitem cmdenum \\enum \refitem cmdexample \\example \refitem cmdexception \\exception @@ -129,6 +131,7 @@ documentation: \refitem cmdversion \\version \refitem cmdwarning \\warning \refitem cmdweakgroup \\weakgroup +\refitem cmdxmlonly \\xmlonly \refitem cmdxrefitem \\xrefitem \refitem cmddollar \\\$ \refitem cmdat \\\@ @@ -181,6 +184,17 @@ doxygen. Unrecognized commands are treated as normal text. \sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup", \ref cmdingroup "\\ingroup" and \ref cmdweakgroup "\\weakgroup". +\section cmdcallgraph \callgraph + + \addindex \\callgraph + When this command is put in a comment block of a function or method + and \ref cfg_have_dot "HAVE_DOT" is set to YES, then doxygen will + generate a call graph for that function (provided the implementation of the + function or method calls other documented functions). The call graph will + generated regardless of the value of \ref cfg_call_graph "CALL_GRAPH". + \note The completeness (and correctness) of the call graph depends on the + doxygen code parser which is not perfect. + \section cmdclass \class <name> [<header-file>] [<header-name>] \addindex \\class @@ -1552,6 +1566,14 @@ ALIASES = "english=\if english" \ \sa section \ref cmdverbatim "\\verbatim". <hr> +\section cmdendxmlonly \endxmlonly + + \addindex \\endxmlonly + Ends a block of text that was started with a \\xmlonly command. + + \sa section \ref cmdxmlonly "\\xmlonly". + +<hr> \section cmdfdollar \f$ \addindex \\f\$ @@ -1741,6 +1763,19 @@ ALIASES = "english=\if english" \ \\verbatim command or the parser will get confused! <hr> +\section cmdxmlonly \xmlonly + + \addindex \\xmlonly + Starts a block of text that will be verbatim included in the + generated XML output only. The block ends with a + endxmlonly command. + + This command can be used to include custom XML tags. + + \sa section \ref cmdhtmlonly "\\htmlonly" and section + \ref cmdlatexonly "\\latexonly". + +<hr> \section cmdbackslash \\ \addindex \\\\ |