summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2000-10-15 15:32:16 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2000-10-15 15:32:16 (GMT)
commiteb7f0413527724df305245200c56f54ab2853ab7 (patch)
tree7824ba2a5c9f1fe6ddc8633a13cc7d1e7a6c79a3 /doc
parent0d0eec1df129221379625a52e5fe8ff6f21f104c (diff)
downloadDoxygen-eb7f0413527724df305245200c56f54ab2853ab7.zip
Doxygen-eb7f0413527724df305245200c56f54ab2853ab7.tar.gz
Doxygen-eb7f0413527724df305245200c56f54ab2853ab7.tar.bz2
Release-1.2.2-20001015
Diffstat (limited to 'doc')
-rw-r--r--doc/config.doc18
-rw-r--r--doc/install.doc6
-rw-r--r--doc/starting.doc4
3 files changed, 22 insertions, 6 deletions
diff --git a/doc/config.doc b/doc/config.doc
index 9b92688..1d3046f 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -103,6 +103,7 @@ followed by the descriptions of the tags grouped by category.
<li> \refitem cfg_generate_html GENERATE_HTML
<li> \refitem cfg_generate_htmlhelp GENERATE_HTMLHELP
<li> \refitem cfg_generate_latex GENERATE_LATEX
+<li> \refitem cfg_generate_legend GENERATE_LEGEND
<li> \refitem cfg_generate_man GENERATE_MAN
<li> \refitem cfg_generate_rtf GENERATE_RTF
<li> \refitem cfg_generate_tagfile GENERATE_TAGFILE
@@ -163,6 +164,7 @@ followed by the descriptions of the tags grouped by category.
<li> \refitem cfg_verbatim_headers VERBATIM_HEADERS
<li> \refitem cfg_warn_format WARN_FORMAT
<li> \refitem cfg_warn_if_undocumented WARN_IF_UNDOCUMENTED
+<li> \refitem cfg_warn_logfile WARN_LOGFILE
<li> \refitem cfg_warnings WARNINGS
\htmlonly
</ul>
@@ -481,12 +483,19 @@ followed by the descriptions of the tags grouped by category.
\anchor cfg_warn_format
<dt>\c WARN_FORMAT <dd>
\addindex WARN_FORMAT
- The WARN_FORMAT tag determines the format of the warning messages that
+ The \c WARN_FORMAT tag determines the format of the warning messages that
doxygen can produce. The string should contain the <code>\$file</code>,
<code>\$line</code>, and <code>\$text</code>
tags, which will be replaced by the file and line number from which the
warning originated and the warning text.
+\anchor cfg_warn_logfile
+<dt>\c WARN_LOGFILE <dd>
+ \addindex WARN_LOGFILE
+ The \c WARN_LOGFILE tag can be used to specify a file to which warning
+ and error messages should be written. If left blank the output is written
+ to stderr.
+
</dl>
\subsection config_input Input related options
@@ -1061,6 +1070,13 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
the specified constraint. Beware that most browsers cannot cope with very
large images.
+\anchor cfg_generate_legend <dd>
+<dt>\c GENERATE_LEGEND <dd>
+ \addindex GENERATE_LEGEND
+ If the \c GENERATE_LEGEND tag is set to \c YES (the default) Doxygen will
+ generate a legend page explaining the meaning of the various boxes and
+ arrows in the dot generated graphs.
+
</dl>
\subsection config_search Search engine options
\anchor cfg_searchengine
diff --git a/doc/install.doc b/doc/install.doc
index 2d31184..3b0c6b2 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -337,7 +337,7 @@ Here is what is required:
variables (if you did not select to do this automatically during
installation).
<li>Perl 5.0 or higher for Windows. This can be download from:
- http://www.ActiveState.com/pw32
+ http://www.ActiveState.com/Products/ActivePerl/
<li>The GNU tools flex, bison and sed.
To get these working on Windows you should install the
<a href="http://sourceware.cygnus.com/cygwin/">cygwin tools</a>
@@ -351,8 +351,8 @@ Here is what is required:
the directory they are in to the search path.
<li>A professional license of
- <A HREF="http://www.trolltech.com/products/qt.html">Qt for Windows</A><br>
- \latexonly(see {\tt http://www.trolltech.com/products/qt.html})\endlatexonly.
+ <A HREF="http://www.trolltech.com/products/qt.html">Qt for Windows</A>
+ \latexonly\par (see {\tt http://www.trolltech.com/products/qt.html})\endlatexonly.
If you do not have that and you can live without the GUI front-end
you can also download Qt-1.44 for X11. Doxygen only the depends on
diff --git a/doc/starting.doc b/doc/starting.doc
index b518838..70dfc50 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -131,7 +131,7 @@ of compiling the generated
documentation, \c doxygen writes a \c Makefile into the \c latex directory.
By typing \c make in the \c latex directory the dvi file \c refman.dvi
will be generated (provided that you have a make tool called
-<code>make</code> ofcourse). This file can then be viewed using \c xdvi or
+<code>make</code> of course). This file can then be viewed using \c xdvi or
converted into a postscript file \c refman.ps by
typing <code>make ps</code> (this requires <code>dvips</code>).
To put 2 pages on one physical page use <code>make ps_2on1</code> instead.
@@ -152,7 +152,7 @@ capabilities of the man page format, so some information
\subsection step3 Step 3: Documenting the sources
Although documenting the source is presented as step 3, in a new project
-this should ofcourse be step 1. Here I assume
+this should of course be step 1. Here I assume
you already have some code and you want doxygen to generate a nice document
describing the API and maybe the internals as well.