summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2015-02-26 19:26:15 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2015-02-26 19:26:15 (GMT)
commit5e5615a9d2da8b923565c1bcadc9db48efbc75d0 (patch)
tree3e53070ae9b2bb683c6b27b5c4edf5cf9151d850 /doc
parent80d09775da9a99a3bc58704ffd055547c6b03043 (diff)
parent073e9482a516c24a3d045da049941bfd432f3354 (diff)
downloadDoxygen-5e5615a9d2da8b923565c1bcadc9db48efbc75d0.zip
Doxygen-5e5615a9d2da8b923565c1bcadc9db48efbc75d0.tar.gz
Doxygen-5e5615a9d2da8b923565c1bcadc9db48efbc75d0.tar.bz2
Merge pull request #302 from albert-github/feature/bug_callgraph
Adding commands \hidecallgraph and \hidecallergraph
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc46
-rw-r--r--doc/diagrams.doc8
2 files changed, 49 insertions, 5 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 12fe9a6..e492982 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -49,8 +49,8 @@ documentation:
\refitem cmdbrief \\brief
\refitem cmdbug \\bug
\refitem cmdc \\c
-\refitem cmdcallgraph \\callgraph
\refitem cmdcallergraph \\callergraph
+\refitem cmdcallgraph \\callgraph
\refitem cmdcategory \\category
\refitem cmdcite \\cite
\refitem cmdclass \\class
@@ -104,6 +104,8 @@ documentation:
\refitem cmdfile \\file
\refitem cmdfn \\fn
\refitem cmdheaderfile \\headerfile
+\refitem cmdhidecallergraph \\hidecallergraph
+\refitem cmdhidecallgraph \\hidecallgraph
\refitem cmdhideinitializer \\hideinitializer
\refitem cmdhtmlinclude \\htmlinclude
\refitem cmdhtmlonly \\htmlonly
@@ -273,7 +275,26 @@ Structural indicators
\note The completeness (and correctness) of the call graph depends on the
doxygen code parser which is not perfect.
- \sa section \ref cmdcallergraph "\\callergraph".
+ \sa section \ref cmdcallergraph "\\callergraph",
+ section \ref cmdhidecallgraph "\\hidecallgraph",
+ section \ref cmdhidecallergraph "\\hidecallergraph" and
+ option \ref cfg_call_graph "CALL_GRAPH"
+
+<hr>
+\section cmdhidecallgraph \\hidecallgraph
+
+ \addindex \\hidecallgraph
+ When this command is put in a comment block of a function or method
+ and then doxygen will not generate a call graph for that function. The
+ call graph will not be 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.
+
+ \sa section \ref cmdcallergraph "\\callergraph",
+ section \ref cmdcallgraph "\\callgraph",
+ section \ref cmdhidecallergraph "\\hidecallergraph" and
+ option \ref cfg_call_graph "CALL_GRAPH"
<hr>
\section cmdcallergraph \\callergraph
@@ -287,7 +308,26 @@ Structural indicators
\note The completeness (and correctness) of the caller graph depends on the
doxygen code parser which is not perfect.
- \sa section \ref cmdcallgraph "\\callgraph".
+ \sa section \ref cmdcallgraph "\\callgraph",
+ section \ref cmdhidecallgraph "\\hidecallgraph",
+ section \ref cmdhidecallergraph "\\hidecallergraph" and
+ option \ref cfg_caller_graph "CALLER_GRAPH"
+
+<hr>
+\section cmdhidecallergraph \\hidecallergraph
+
+ \addindex \\hidecallergraph
+ When this command is put in a comment block of a function or method
+ and then doxygen will not generate a caller graph for that function. The
+ caller graph will not 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.
+
+ \sa section \ref cmdcallergraph "\\callergraph",
+ section \ref cmdcallgraph "\\callgraph",
+ section \ref cmdhidecallgraph "\\hidecallgraph" and
+ option \ref cfg_caller_graph "CALLER_GRAPH"
<hr>
\section cmdcategory \\category <name> [<header-file>] [<header-name>]
diff --git a/doc/diagrams.doc b/doc/diagrams.doc
index bafb21d..ce00fec 100644
--- a/doc/diagrams.doc
+++ b/doc/diagrams.doc
@@ -52,10 +52,14 @@
</ul>
<li>if \ref cfg_call_graph "CALL_GRAPH" is set to YES, a
graphical call graph is drawn for each function showing the
- functions that the function directly or indirectly calls.
+ functions that the function directly or indirectly calls
+ (see also section \ref cmdcallgraph "\\callgraph" and
+ section \ref cmdhidecallgraph "\\hidecallgraph").
<li>if \ref cfg_caller_graph "CALLER_GRAPH" is set to YES, a
graphical caller graph is drawn for each function showing the
- functions that the function is directly or indirectly called by.
+ functions that the function is directly or indirectly called by
+ (see also section \ref cmdcallergraph "\\callergraph" and
+ section \ref cmdhidecallergraph "\\hidecallergraph").
</ul>
Using a \ref customize "layout file" you can determine which of the