diff options
Diffstat (limited to 'doc/config.doc')
| -rw-r--r-- | doc/config.doc | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/config.doc b/doc/config.doc index e704dd1..8cb2367 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -153,6 +153,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_dot_graph_height MAX_DOT_GRAPH_HEIGHT \refitem cfg_max_dot_graph_width MAX_DOT_GRAPH_WIDTH \refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES @@ -1493,6 +1494,21 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> the specified constraint. Beware that most browsers cannot cope with very large images. +\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 a graph may be further truncated if the graph's image dimensions are +not sufficient to fit the graph (see +\ref cfg_max_dot_graph_width "MAX_DOT_GRAPH_WIDTH" and +\ref cfg_max_dot_graph_height "MAX_DOT_GRAPH_HEIGHT"). +If 0 is used fot the depth value (the default), the graph is +not depth constraint. + \anchor cfg_max_dot_graph_width <dt>\c MAX_DOT_GRAPH_WIDTH <dd> \addindex MAX_DOT_GRAPH_WIDTH @@ -1512,8 +1528,9 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> \anchor cfg_dot_cleanup <dt>\c DOT_CLEANUP <dd> \addindex DOT_CLEANUP - This tag can be used to cleanup any mess DOT left behind. - If left blank, "NO" is assumed. +If the \c DOT_CLEANUP tag is set to \c YES (the default) doxygen will +remove the intermedate dot files that are used to generate the various graphs. + </dl> \section config_search Search engine options |