summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc6
-rw-r--r--doc/config.doc6
-rw-r--r--doc/language.doc47
-rw-r--r--doc/maintainers.txt3
-rw-r--r--doc/starting.doc27
5 files changed, 45 insertions, 44 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index ee2eb3b..2254a68 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -377,8 +377,10 @@ doxygen. Unrecognized commands are treated as normal text.
\subsection cmdinternal \internal
\addindex \internal
- This command writes the message `For internal use only' to the output.
- All text after a \c \internal command is ignored.
+ This command writes the message `For internal use only' to the output and
+ all text \e after a \c \\internal command is ignored.
+ You can use \ref cfg_internal_docs "INTERNAL_DOCS" in the config file
+ to show or hide the internal documentation.
<hr>
\subsection cmdmainpage \mainpage [(title)]
diff --git a/doc/config.doc b/doc/config.doc
index aa362e2..b0fc9df 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -318,7 +318,7 @@ followed by the descriptions of the tags grouped by category.
<dt>\c INTERNAL_DOCS <dd>
\addindex INTERNAL_DOCS
The \c INTERNAL_DOCS tag determines if documentation
- that is typed after a \\internal command is included. If the tag is set
+ that is typed after a \ref cmdinternal "\\internal" command is included. If the tag is set
to \c NO (the default) then the documentation will be excluded.
Set it to \c YES to include the internal documentation.
@@ -540,7 +540,7 @@ followed by the descriptions of the tags grouped by category.
Separate the files or directories with spaces.<br>
\b Note:
- This tag (and only this tag) is \e required.
+ If this tag is empty the current directory is searched.
\anchor cfg_file_patterns
<dt>\c FILE_PATTERNS <dd>
@@ -1090,7 +1090,7 @@ EXTRA_PACKAGES = times
\anchor cfg_expand_as_defined
<dt>\c EXPAND_AS_DEFINED <dd>
\addindex EXPAND_AS_DEFINED
- If the \c MACRO_EXPANSION and \c EXPAND_PREDEF_ONLY tags are set to \c YES then
+ If the \c MACRO_EXPANSION and \c EXPAND_ONLY_PREDEF tags are set to \c YES then
this tag can be used to specify a list of macro names that should be expanded.
The macro definition that is found in the sources will be used.
Use the \c PREDEFINED tag if you want to use a different macro definition.
diff --git a/doc/language.doc b/doc/language.doc
index 8db2128..59e9e0c 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.11-20011111), 24 languages
+Currently (version 1.2.12-20011125), 24 languages
are supported (sorted alphabetically):
Brazilian Portuguese, Chinese, Croatian, Czech, Danish,
Dutch, English, Finnish, French, German,
@@ -53,8 +53,8 @@ when the translator was updated.
<TR BGCOLOR="#ffffff">
<TD>Brazilian</TD>
<TD>Fabio "FJTC" Jun Takada Chino</TD>
- <TD>chino@NOSPAM.grad.icmc.sc.usp.br</TD>
- <TD>1.2.11</TD>
+ <TD>chino@NOSPAM.icmc.sc.usp.br</TD>
+ <TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>Chinese</TD>
@@ -66,7 +66,7 @@ when the translator was updated.
<TD>Croatian</TD>
<TD>Boris Bralo</TD>
<TD>boris.bralo@NOSPAM.zg.tel.hr</TD>
- <TD>1.2.11</TD>
+ <TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>Czech</TD>
@@ -84,7 +84,7 @@ when the translator was updated.
<TD>Dutch</TD>
<TD>Dimitri van Heesch</TD>
<TD>dimitri@NOSPAM.stack.nl</TD>
- <TD>1.2.11</TD>
+ <TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>English</TD>
@@ -102,13 +102,13 @@ when the translator was updated.
<TD>French</TD>
<TD>Xavier Outhier</TD>
<TD>xouthier@NOSPAM.yahoo.fr</TD>
- <TD>1.2.11</TD>
+ <TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<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.11</TD>
+ <TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>Hungarian</TD>
@@ -120,7 +120,7 @@ when the translator was updated.
<TD>Italian</TD>
<TD>Ahmed Aldo Faisal<br>Alessandro Falappa</TD>
<TD>aaf23@NOSPAM.cam.ac.uk<br>a.falappa@NOSPAM.flashnet.it</TD>
- <TD>1.2.11</TD>
+ <TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>Japanese</TD>
@@ -132,7 +132,7 @@ when the translator was updated.
<TD>Korean</TD>
<TD>Richard Kim</TD>
<TD>ryk@NOSPAM.dspwiz.com</TD>
- <TD>1.1.0</TD>
+ <TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>Norwegian</TD>
@@ -150,7 +150,7 @@ when the translator was updated.
<TD>Portuguese</TD>
<TD>Rui Godinho Lopes</TD>
<TD>ruiglopes@NOSPAM.yahoo.com</TD>
- <TD>1.2.11</TD>
+ <TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>Romanian</TD>
@@ -174,7 +174,7 @@ when the translator was updated.
<TD>Slovene</TD>
<TD>Matjaz Ostroversnik</TD>
<TD>matjaz.ostroversnik@NOSPAM.zrs-tk.si</TD>
- <TD>1.2.11</TD>
+ <TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>Spanish</TD>
@@ -184,8 +184,8 @@ when the translator was updated.
</TR>
<TR BGCOLOR="#ffffff">
<TD>Swedish</TD>
- <TD>Samuel H&auml;agglund<br>XeT Erixon</TD>
- <TD>sahag96@NOSPAM.nts.mh.se<br>xet@NOSPAM.hem.passagen.se</TD>
+ <TD>XeT Erixon</TD>
+ <TD>xet@NOSPAM.hem.passagen.se</TD>
<TD>1.0.0</TD>
</TR>
<TR BGCOLOR="#ffffff">
@@ -205,42 +205,42 @@ when the translator was updated.
{\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\
\hline
\hline
- Brazilian & Fabio "FJTC" Jun Takada Chino & {\tt chino@grad.icmc.sc.usp.br} & 1.2.11 \\
+ Brazilian & Fabio "FJTC" Jun Takada Chino & {\tt chino@icmc.sc.usp.br} & up-to-date \\
\hline
Chinese & Wei Liu & {\tt liuwei@asiainfo.com} & 1.2.11 \\
& Wang Weihan & {\tt wangweihan@capinfo.com.cn} & \\
\hline
- Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & 1.2.11 \\
+ Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & up-to-date \\
\hline
Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & up-to-date \\
\hline
Danish & Erik S\o{}e S\o{}rensen & {\tt erik@mail.nu} & 1.2.7 \\
\hline
- Dutch & Dimitri van Heesch & {\tt dimitri@stack.nl} & 1.2.11 \\
+ Dutch & Dimitri van Heesch & {\tt dimitri@stack.nl} & up-to-date \\
\hline
English & Dimitri van Heesch & {\tt dimitri@stack.nl} & up-to-date \\
\hline
Finnish & Olli Korhonen & {\tt Olli.Korhonen@ccc.fi} & 1.0.0 \\
\hline
- French & Xavier Outhier & {\tt xouthier@yahoo.fr} & 1.2.11 \\
+ French & Xavier Outhier & {\tt xouthier@yahoo.fr} & up-to-date \\
\hline
- German & Jens Seidel & {\tt jensseidel@users.sf.net} & 1.2.11 \\
+ German & Jens Seidel & {\tt jensseidel@users.sf.net} & up-to-date \\
& Jens Breitenstein & {\tt Jens.Breitenstein@tlc.de} & \\
\hline
Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt foldvari@diatronltd.com} & 1.2.1 \\
\hline
- Italian & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & 1.2.11 \\
+ Italian & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & up-to-date \\
& Alessandro Falappa & {\tt a.falappa@flashnet.it} & \\
\hline
Japanese & Kenji Nagamatsu & {\tt naga@joyful.club.ne.jp} & 1.2.5 \\
\hline
- Korean & Richard Kim & {\tt ryk@dspwiz.com} & 1.1.0 \\
+ Korean & Richard Kim & {\tt ryk@dspwiz.com} & up-to-date \\
\hline
Norwegian & Lars Erik Jordet & {\tt larsej@stud.ifd.hibu.no} & 1.2.2 \\
\hline
Polish & Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} & 1.2.1 \\
\hline
- Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & 1.2.11 \\
+ Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & up-to-date \\
\hline
Romanian & Alexandru Iosup & {\tt aiosup@yahoo.com} & 1.2.1 \\
\hline
@@ -248,12 +248,11 @@ when the translator was updated.
\hline
Slovak & Stanislav Kudl\'{a}\v{c} & {\tt qwerty1@pobox.sk} & 1.2.11 \\
\hline
- Slovene & Matjaz Ostroversnik & {\tt matjaz.ostroversnik@zrs-tk.si} & 1.2.11 \\
+ Slovene & Matjaz Ostroversnik & {\tt matjaz.ostroversnik@zrs-tk.si} & up-to-date \\
\hline
Spanish & Francisco Oltra Thennet & {\tt foltra@puc.cl} & 1.2.7 \\
\hline
- Swedish & Samuel H\"{a}agglund & {\tt sahag96@nts.mh.se} & 1.0.0 \\
- & XeT Erixon & {\tt xet@hem.passagen.se} & \\
+ Swedish & XeT Erixon & {\tt xet@hem.passagen.se} & 1.0.0 \\
\hline
Ukrainian & Olexij Tkatchenko & {\tt olexij.tkatchenko@gmx.de} & 1.2.11 \\
\hline
diff --git a/doc/maintainers.txt b/doc/maintainers.txt
index d2c1a65..f4fc5a4 100644
--- a/doc/maintainers.txt
+++ b/doc/maintainers.txt
@@ -37,8 +37,8 @@ Hungarian
F&ouml;ldv&aacute;ri Gy&ouml;rgy: foldvari@diatronltd.com
Italian
+Alessandro Falappa: alessandro@falappa.net
Ahmed Aldo Faisal: aaf23@cam.ac.uk
-Alessandro Falappa: a.falappa@flashnet.it
Japanese
Kenji Nagamatsu: naga@joyful.club.ne.jp
@@ -71,7 +71,6 @@ Spanish
Francisco Oltra Thennet: foltra@puc.cl
Swedish
-Samuel H&auml;agglund: sahag96@nts.mh.se
XeT Erixon: xet@hem.passagen.se
Ukrainian
diff --git a/doc/starting.doc b/doc/starting.doc
index 2ef5775..dd68d55 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -61,20 +61,20 @@ Makefile. It contains of a number of assignments (tags) of the form:
<tt>TAGNAME = VALUE1 VALUE2 ... </tt><br>
You can probably leave the values of most tags in a generated template
-configuration file to their default value.
-
-The \ref cfg_input "INPUT" tag is the only tag for which you are required to
-provide a value. See section \ref config for more details about the
-configuration file. For a small project consisting of a few C and/or C++ source
-and header files, you can add the names of the files after the
-\ref cfg_input "INPUT" tag.
-
-If you have a larger project consisting of a source directory or tree this may
-become tiresome. In this case you should put the root directory or
+configuration file to their default value. See section \ref config for
+more details about the configuration file.
+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
+the current directory.
+
+If you have a larger project consisting of a source directory or tree
+you should put the root directory or
directories after the \ref cfg_input "INPUT" tag, and add one or more file
patterns to the \ref cfg_file_patterns "FILE_PATTERNS" tag
(for instance <code>*.cpp *.h</code>). Only files that match one of the
-patterns will be parsed (if the patterns are omitted all files will be parsed).
+patterns will be parsed (if the patterns are omitted a list of
+source extensions is used).
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
@@ -85,8 +85,9 @@ documentation that doxygen is aware of), you can still get an idea of
what the documented result would be. To do so, you must set
the \ref cfg_extract_all "EXTRACT_ALL" tag in the configuration file
to \c YES. Then, doxygen will pretend everything in your sources is documented.
-Please note that warnings of undocumented members will not be generated as
-long as \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES.
+Please note that as a consequence warnings about undocumented members
+will not be generated as long as \ref cfg_extract_all "EXTRACT_ALL" is
+set to \c YES.
To analyse an existing piece of software it is useful to cross-reference
a (documented) entity with its definition in the source files. Doxygen will