summaryrefslogtreecommitdiffstats
path: root/doc/config.doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2007-06-10 20:20:58 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2007-06-10 20:20:58 (GMT)
commit34ca582041237fd0b2c91b58afd2a39dc91cf0a8 (patch)
tree7cff22f841dca9c505e2db2f685ece0fc7d95142 /doc/config.doc
parent23c13fc17365dca77acbe9a992e03ae4a40f6eca (diff)
downloadDoxygen-34ca582041237fd0b2c91b58afd2a39dc91cf0a8.zip
Doxygen-34ca582041237fd0b2c91b58afd2a39dc91cf0a8.tar.gz
Doxygen-34ca582041237fd0b2c91b58afd2a39dc91cf0a8.tar.bz2
Release-1.5.2-20070610
Diffstat (limited to 'doc/config.doc')
-rw-r--r--doc/config.doc22
1 files changed, 18 insertions, 4 deletions
diff --git a/doc/config.doc b/doc/config.doc
index 16fe662..9eaf7a4 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -163,6 +163,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_man_extension MAN_EXTENSION
\refitem cfg_man_links MAN_LINKS
\refitem cfg_man_output MAN_OUTPUT
+\refitem cfg_max_dot_graph_depth MAX_DOT_GRAPH_DEPTH
\refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES
\refitem cfg_mscgen_path MSCGEN_PATH
\refitem cfg_multiline_cpp_is_brief MULTILINE_CPP_IS_BRIEF
@@ -1771,10 +1772,23 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
<dt>\c DOT_GRAPH_MAX_NODES <dd>
\addindex DOT_GRAPH_MAX_NODES
The \c MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
- nodes that will be shown in the graph. If the number of nodes in a graph
- becomes larger than this value, doxygen will truncate the graph, which is
- visualized by representing a node as a red box. Note that doxygen will always
- show the root nodes and its direct children regardless of this setting.
+ nodes that will be shown in the graph. If the number of nodes in a graph
+ becomes larger than this value, doxygen will truncate the graph, which is
+ visualized by representing a node as a red box. Note that doxygen if the number
+ of direct children of the root node in a graph is already larger than
+ \c MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
+ that the size of a graph can be further restricted by \c MAX_DOT_GRAPH_DEPTH.
+
+\anchor cfg_max_dot_graph_depth
+<dt>\c MAX_DOT_GRAPH_DEPTH <dd>
+ \addindex MAX_DOT_GRAPH_DEPTH
+ The \c MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+ graphs generated by dot. A depth value of 3 means that only nodes reachable
+ from the root by following a path via at most 3 edges will be shown. Nodes
+ that lay further from the root node will be omitted. Note that setting this
+ option to 1 or 2 may greatly reduce the computation time needed for large
+ code bases. Also note that the size of a graph can be further restricted by
+ \c DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction (the default).
\anchor cfg_dot_image_format
<dt>\c DOT_IMAGE_FORMAT <dd>