summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2003-03-30 19:53:04 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2003-03-30 19:53:04 (GMT)
commitb69146af8dce22431fc50dc3fcea6c7fd5fb1063 (patch)
treedcb3e2354df7b19ebd9458aca416a61d4922bc5c /doc
parentfc0deb3d8c9dad128e1d5f5c90a5dfc0b9d60eea (diff)
downloadDoxygen-b69146af8dce22431fc50dc3fcea6c7fd5fb1063.zip
Doxygen-b69146af8dce22431fc50dc3fcea6c7fd5fb1063.tar.gz
Doxygen-b69146af8dce22431fc50dc3fcea6c7fd5fb1063.tar.bz2
Release-1.3-rc3-20030330
Diffstat (limited to 'doc')
-rw-r--r--doc/config.doc21
-rw-r--r--doc/install.doc5
-rw-r--r--doc/language.doc2
3 files changed, 24 insertions, 4 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
diff --git a/doc/install.doc b/doc/install.doc
index a816e8b..9b2f6ac 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -344,7 +344,7 @@ $(TARGET): $(OBJECTS) $(OBJMOC)
$(LINK) $(LFLAGS) -o $(TARGET) $(OBJECTS) $(OBJMOC) $(LIBS) -Bdynamic
\endverbatim
-<b>GNU 2.7.2.x compiler problems</b>
+<b>GCC compiler problems</b>
Older versions of the GNU compiler have problems with constant strings
containing characters with character codes larger than 127. Therefore
@@ -357,6 +357,9 @@ On some platforms (such as OpenBSD) using some versions of gcc with
such as config.cpp. As a workaround use --debug as a configure option
or omit the -O2 for the particular files in the Makefile.
+Gcc versions before 2.95 may produce broken binaries due to bugs in
+these compilers.
+
<b>Dot problems</b>
Due to a change in the way image maps are generated, older versions
diff --git a/doc/language.doc b/doc/language.doc
index 149686f..52a3396 100644
--- a/doc/language.doc
+++ b/doc/language.doc
@@ -25,7 +25,7 @@ Doxygen has built-in support for multiple languages. This means
that the text fragments that doxygen generates can be produced in
languages other than English (the default) at configuration time.
-Currently (version 1.2.14-20020317), 28 languages
+Currently (version 1.3-rc3-20030327), 28 languages
are supported (sorted alphabetically):
Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian,
Czech, Danish, Dutch, English, Finnish,