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 840c3b7..53e6837 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -106,6 +106,8 @@ documentation: \refitem cmdheaderfile \\headerfile \refitem cmdhidecallergraph \\hidecallergraph \refitem cmdhidecallgraph \\hidecallgraph +\refitem cmdhidereferencedbyrelation \\hidereferencedbyrelation +\refitem cmdhidereferencesrelation \\hidereferencesrelation \refitem cmdhideinitializer \\hideinitializer \refitem cmdhtmlinclude \\htmlinclude \refitem cmdhtmlonly \\htmlonly @@ -156,7 +158,9 @@ documentation: \refitem cmdpublicsection \\publicsection \refitem cmdpure \\pure \refitem cmdref \\ref -\refitem cmdrefitem \\refitem +\refitem cmdreferencedbyrelation \\refitem +\refitem cmdrefitem \\referencedbyrelation +\refitem cmdreferencesrelation \\referencesrelation \refitem cmdrelated \\related \refitem cmdrelates \\relates \refitem cmdrelatedalso \\relatedalso @@ -306,7 +310,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. @@ -333,6 +337,74 @@ Structural indicators option \ref cfg_caller_graph "CALLER_GRAPH" <hr> +\section cmdreferencedbyrelation \\referencedbyrelation + + \addindex \\referencedbyrelation + 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 cmdreferencesrelation "\\referencesrelation", + section \ref cmdhidereferencedbyrelation "\\hidereferencedbyrelation", + section \ref cmdhidereferencesrelation "\\hidereferencesrelation" and + option \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" + +<hr> +\section cmdhidereferencedbyrelation \\hidereferencedbyrelation + + \addindex \\hidereferencedbyrelation + 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 cmdreferencesrelation "\\referencesrelation", + section \ref cmdreferencedbyrelation "\\referencedbyrelation", + section \ref cmdhidereferencesrelation "\\hidereferencesrelation" and + option \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" + +<hr> +\section cmdreferencesrelation \\referencesrelation + + \addindex \\referencesrelation + 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 cmdreferencedbyrelation "\\referencedbyrelation", + section \ref cmdhidereferencedbyrelation "\\hidereferencedbyrelation", + section \ref cmdhidereferencesrelation "\\hidereferencesrelation" and + option \ref cfg_references_relation "REFERENCES_RELATION" + +<hr> +\section cmdhidereferencesrelation \\hidereferencesrelation + + \addindex \\hidereferencesrelation + 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 cmdreferencesrelation "\\referencesrelation", + section \ref cmdreferencedbyrelation "\\referencedbyrelation", + section \ref cmdhidereferencedbyrelation "\\hidereferencedbyrelation" and + option \ref cfg_references_relation "REFERENCES_RELATION" + +<hr> \section cmdcategory \\category <name> [<header-file>] [<header-name>] \addindex \\category @@ -3424,4 +3496,3 @@ Go to the <a href="htmlcmds.html">next</a> section or return to the \endhtmlonly */ - |