diff options
Diffstat (limited to 'doc/config.doc')
| -rw-r--r-- | doc/config.doc | 46 |
1 files changed, 10 insertions, 36 deletions
diff --git a/doc/config.doc b/doc/config.doc index 2ebb6a5..be0c4a5 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -79,6 +79,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_directory_graph DIRECTORY_GRAPH \refitem cfg_disable_index DISABLE_INDEX \refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC +\refitem cfg_dot_graph_max_nodes DOT_GRAPH_MAX_NODES \refitem cfg_dot_image_format DOT_IMAGE_FORMAT \refitem cfg_dot_multi_targets DOT_MULTI_TARGETS \refitem cfg_dot_path DOT_PATH @@ -160,9 +161,6 @@ 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 \refitem cfg_multiline_cpp_is_brief MULTILINE_CPP_IS_BRIEF \refitem cfg_optimize_output_for_c OPTIMIZE_OUTPUT_FOR_C @@ -1728,6 +1726,15 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> in a graphical way. The dependency relations are determined by the \#include relations between the files in the directories. +\anchor cfg_dot_graph_max_nodes +<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. + \anchor cfg_dot_image_format <dt>\c DOT_IMAGE_FORMAT <dd> \addindex DOT_IMAGE_FORMAT @@ -1748,39 +1755,6 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> contain dot files that are included in the documentation (see the \\dotfile command). -\anchor cfg_max_dot_graph_height -<dt>\c MAX_DOT_GRAPH_HEIGHT <dd> - \addindex MAX_DOT_GRAPH_HEIGHT - The \c MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height - (in pixels) of the graphs generated by dot. If a graph becomes larger than - this value, doxygen will try to truncate the graph, so that it fits within - 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 for 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 - The \c MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width - (in pixels) of the graphs generated by dot. If a graph becomes larger than - this value, doxygen will try to truncate the graph, so that it fits within - the specified constraint. Beware that most browsers cannot cope with very - large images. - \anchor cfg_dot_transparent <dt>\c DOT_TRANSPARENT <dd> \addindex DOT_TRANSPARENT |