summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/config.doc8
-rw-r--r--doc/install.doc2
-rw-r--r--doc/language.doc6
-rw-r--r--doc/starting.doc11
4 files changed, 23 insertions, 4 deletions
diff --git a/doc/config.doc b/doc/config.doc
index b2f5ebf..8300a84 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -83,6 +83,7 @@ followed by the descriptions of the tags grouped by category.
<li> \refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC
<li> \refitem cfg_doc_abspath DOC_ABSPATH
<li> \refitem cfg_doc_url DOC_URL
+<li> \refitem cfg_dot_image_format DOT_IMAGE_FORMAT
<li> \refitem cfg_dot_path DOT_PATH
<li> \refitem cfg_dotfile_dirs DOTFILE_DIRS
<li> \refitem cfg_enable_preprocessing ENABLE_PREPROCESSING
@@ -1273,6 +1274,13 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
If the \c GRAPHICAL_HIERARCHY and \c HAVE_DOT tags are set to \c YES then
doxygen will graphical hierarchy of all classes instead of a textual one.
+\anchor cfg_dot_image_format
+<dt>\c DOT_IMAGE_FORMAT <dd>
+ \addindex DOT_IMAGE_FORMAT
+ The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+ generated by dot. Possible values are gif, jpg, and png.
+ If left blank gif will be used.
+
\anchor cfg_dot_path
<dt>\c DOT_PATH <dd>
\addindex DOT_PATH
diff --git a/doc/install.doc b/doc/install.doc
index 0f32e75..78a61cf 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -533,9 +533,11 @@ To install doxygen, just copy the binaries from the <code>bin</code> directory
to a location somewhere in the path. Alternatively, you can include
the <code>bin</code> directory of the distribution to the path.
+<!--
For running doxywizard you need to install the non-commercial version of
the Qt library first. This library can be downloaded from
http://www.trolltech.com/products/download/qt-win-noncomm.html
+-->
\subsection build_tools Tools used to develop doxygen
diff --git a/doc/language.doc b/doc/language.doc
index 369bba0..966fc6a 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.13-20020203), 25 languages
+Currently (version 1.2.13-20020210), 25 languages
are supported (sorted alphabetically):
Brazilian Portuguese, Chinese, Croatian, Czech, Danish,
Dutch, English, Finnish, French, German,
@@ -108,7 +108,7 @@ when the translator was updated.
<TD>German</TD>
<TD>Jens Seidel<br>Jens Breitenstein</TD>
<TD>jensseidel@NOSPAM.users.sf.net<br>Jens.Breitenstein@NOSPAM.tlc.de</TD>
- <TD>1.2.13</TD>
+ <TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>Greek</TD>
@@ -230,7 +230,7 @@ when the translator was updated.
\hline
French & Xavier Outhier & {\tt xouthier@yahoo.fr} & up-to-date \\
\hline
- German & Jens Seidel & {\tt jensseidel@users.sf.net} & 1.2.13 \\
+ German & Jens Seidel & {\tt jensseidel@users.sf.net} & up-to-date \\
& Jens Breitenstein & {\tt Jens.Breitenstein@tlc.de} & \\
\hline
Greek & Harry Kalogirou & {\tt harkal@rainbow.cs.unipi.gr} & 1.2.11 \\
diff --git a/doc/starting.doc b/doc/starting.doc
index dd68d55..f7578c9 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -63,6 +63,12 @@ Makefile. It contains of a number of assignments (tags) of the form:
You can probably leave the values of most tags in a generated template
configuration file to their default value. See section \ref config for
more details about the configuration file.
+
+If you do not like to edit the config file with a text editor, you should
+have a look at \ref doxywizard_usage "doxywizard", which is a GUI
+front-end that can create, read and write doxygen configuration files,
+and allows setting configuration options by entering them via dialogs.
+
For a small project consisting of a few C and/or C++ source
and header files, you can leave
\ref cfg_input "INPUT" tag empty and doxygen will search for sources in
@@ -79,6 +85,9 @@ For recursive parsing of a source tree you must set
the \ref cfg_recursive "RECURSIVE" tag to \c YES. To further fine-tune the
list of files that is parsed the \ref cfg_exclude "EXCLUDE" and
\ref cfg_exclude_patterns "EXCLUDE_PATTERNS" tags can be used.
+To omit all \c test directories from a source tree for instance, one could use:
+\verbatim EXCLUDE_PATTERNS = */test/*
+\endverbatim
If you start using doxygen for an existing project (thus without any
documentation that doxygen is aware of), you can still get an idea of
@@ -94,7 +103,7 @@ a (documented) entity with its definition in the source files. Doxygen will
generate such cross-references if you set
the \ref cfg_source_browser "SOURCE_BROWSER" tag to \c YES.
It can also include the sources directly into the documentation by setting
-\ref cfg_inline_sources "INLINE_SOURCES" to \c YES (this can be handly for
+\ref cfg_inline_sources "INLINE_SOURCES" to \c YES (this can be handy for
code reviews for instance).
\subsection step2 Step 2: Running doxygen