diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 77 |
1 files changed, 74 insertions, 3 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 4930524..e747a57 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -106,6 +106,8 @@ documentation: \refitem cmdheaderfile \\headerfile \refitem cmdhidecallergraph \\hidecallergraph \refitem cmdhidecallgraph \\hidecallgraph +\refitem cmdhiderefby \\hiderefby +\refitem cmdhiderefs \\hiderefs \refitem cmdhideinitializer \\hideinitializer \refitem cmdhtmlinclude \\htmlinclude \refitem cmdhtmlonly \\htmlonly @@ -174,6 +176,8 @@ documentation: \refitem cmdsee \\see \refitem cmdshort \\short \refitem cmdshowinitializer \\showinitializer +\refitem cmdshowrefby \\showrefby +\refitem cmdshowrefs \\showrefs \refitem cmdsince \\since \refitem cmdskip \\skip \refitem cmdskipline \\skipline @@ -307,7 +311,7 @@ Structural indicators When this command is put in a comment block of a function or method and \ref cfg_have_dot "HAVE_DOT" is set to \c YES, then doxygen will generate a caller graph for that function (provided the implementation of the - function or method calls other documented functions). The caller graph will be + function or method is called by other documented functions). The caller graph will be generated regardless of the value of \ref cfg_caller_graph "CALLER_GRAPH". \note The completeness (and correctness) of the caller graph depends on the doxygen code parser which is not perfect. @@ -334,6 +338,74 @@ Structural indicators option \ref cfg_caller_graph "CALLER_GRAPH" <hr> +\section cmdshowrefby \\showrefby + + \addindex \\showrefby + When this command is put in a comment block of a function, method or variable, + then doxygen will generate an overview for that function, method, variable of + the, documented, funcions and methods that call / use it. + The overview will be generated regardless of the value of + \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION". + \note The completeness (and correctness) of the overview depends on the + doxygen code parser which is not perfect. + + \sa section \ref cmdshowrefs "\\showrefs", + section \ref cmdhiderefby "\\hiderefby", + section \ref cmdhiderefs "\\hiderefs" and + option \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" + +<hr> +\section cmdhiderefby \\hiderefby + + \addindex \\hiderefby + When this command is put in a comment block of a function, method or variable + then doxygen will not generate an overview for that function, method or + variable of the functions and methods that call / use it. + The overview will not be generated regardless of the value of + \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION". + \note The completeness (and correctness) of the overview depends on the + doxygen code parser which is not perfect. + + \sa section \ref cmdshowrefs "\\showrefs", + section \ref cmdshowrefby "\\showrefby", + section \ref cmdhiderefs "\\hiderefs" and + option \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" + +<hr> +\section cmdshowrefs \\showrefs + + \addindex \\showrefs + When this command is put in a comment block of a function or method, + then doxygen will generate an overview for that function or method of the + functions and methods that call it. + The overview will be generated regardless of the value of + \ref cfg_references_relation "REFERENCES_RELATION". + \note The completeness (and correctness) of the overview depends on the + doxygen code parser which is not perfect. + + \sa section \ref cmdshowrefby "\\showrefby", + section \ref cmdhiderefby "\\hiderefby", + section \ref cmdhiderefs "\\hiderefs" and + option \ref cfg_references_relation "REFERENCES_RELATION" + +<hr> +\section cmdhiderefs \\hiderefs + + \addindex \\hiderefs + When this command is put in a comment block of a function or method + and then doxygen will not generate an overview for that function or method of + the functions and methods that call it. + The overview will not be generated regardless of the value of + \ref cfg_references_relation "REFERENCES_RELATION". + \note The completeness (and correctness) of the overview depends on the + doxygen code parser which is not perfect. + + \sa section \ref cmdshowrefs "\\showrefs", + section \ref cmdshowrefby "\\showrefby", + section \ref cmdhiderefby "\\hiderefby" and + option \ref cfg_references_relation "REFERENCES_RELATION" + +<hr> \section cmdcategory \\category <name> [<header-file>] [<header-name>] \addindex \\category @@ -3281,7 +3353,7 @@ class Receiver \addindex \\\@ This command writes an at-sign (\c \@) to the output. The at-sign has to be escaped in some cases - because doxygen uses it to detect JavaDoc commands. + because doxygen uses it to detect Javadoc commands. <hr> \section cmdtilde \\~[LanguageId] @@ -3433,4 +3505,3 @@ Go to the <a href="htmlcmds.html">next</a> section or return to the \endhtmlonly */ - |