summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/config.doc9
-rw-r--r--doc/history.doc2
-rw-r--r--doc/index.doc6
-rw-r--r--doc/install.doc20
-rw-r--r--doc/language.doc30
-rw-r--r--doc/language.tpl6
-rw-r--r--doc/maintainers.txt3
-rw-r--r--doc/starting.doc2
8 files changed, 49 insertions, 29 deletions
diff --git a/doc/config.doc b/doc/config.doc
index 1c3d995..3f38ee0 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -116,6 +116,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_graphical_hierarchy GRAPHICAL_HIERARCHY
\refitem cfg_have_dot HAVE_DOT
\refitem cfg_hhc_location HHC_LOCATION
+\refitem cfg_hide_friend_compounds HIDE_FRIEND_COMPOUNDS
\refitem cfg_hide_scope_names HIDE_SCOPE_NAMES
\refitem cfg_hide_undoc_classes HIDE_UNDOC_CLASSES
\refitem cfg_hide_undoc_members HIDE_UNDOC_MEMBERS
@@ -278,6 +279,14 @@ followed by the descriptions of the tags grouped by category.
various overviews.
This option has no effect if \c EXTRACT_ALL is enabled.
+\anchor cfg_hide_friend_compounds
+<dt>\c HIDE_FRIEND_COMPOUNDS <dd>
+ \addindex HIDE_FRIEND_COMPOUNDS
+ If the \c HIDE_FRIEND_COMPOUNDS tag is set to \c YES, Doxygen will hide all
+ friend (class|struct|union) declarations.
+ If set to \c NO (the default) these declarations will be included in the
+ documentation.
+
\anchor cfg_brief_member_desc
<dt>\c BRIEF_MEMBER_DESC <dd>
\addindex BRIEF_MEMBER_DESC
diff --git a/doc/history.doc b/doc/history.doc
index 96314e8..3b1129a 100644
--- a/doc/history.doc
+++ b/doc/history.doc
@@ -76,7 +76,7 @@
<li>Many new commands (there are now more than 60!) to document
more entities, to make the documentation look nicer, and to include
examples or pieces of examples.
-<li>Enum types, enum values, typedefs, #defines, and files can now be
+<li>Enum types, enum values, typedefs, \#defines, and files can now be
documented.
<li>Completely new documentation, that is now generated by Doxygen.
<li>A lot of small examples are now included.
diff --git a/doc/index.doc b/doc/index.doc
index 6c1aa66..da5246a 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -27,7 +27,7 @@ Version: $(VERSION)
<h2>Introduction</h2>
Doxygen is a documentation system for C++, C, Java, IDL
-(Corba, Microsoft, and KDE-DCOP flavors) and to some extend PHP.
+(Corba, Microsoft, and KDE-DCOP flavors) and to some extent PHP.
It can help you in three ways:
<ol>
@@ -179,8 +179,8 @@ Thanks go to:
<li>Petr Prikryl for coordinating the internationalisation support.
All language maintainers for providing translations into many languages.
<li>Erik Jan Lingen of <a href="http://www.habanera.nl/">Habanera</a>, Mark
- Roddy, Paul Schwartz, Charles Duffy, Vadym Voznyuk, Philip Walton and
- Dwight Browne for donating money.
+ Roddy, Paul Schwartz, Charles Duffy, Vadym Voznyuk, Philip Walton,
+ Dwight Browne, and Andreas Fredriksson for donating money.
<li>The Comms group of <a href="http://www.symbian.com">Symbian</a> for donating
an ultra cool <a href="http://www.psion.com/revoplus">Revo plus</a>
organizer!
diff --git a/doc/install.doc b/doc/install.doc
index fe7fd55..1387f13 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -58,12 +58,12 @@ tools should be installed.
\addindex Qt
This is needed to build the GUI front-end.
<li>A \f$\mbox{\LaTeX}\f$ distribution: for instance
- <a href="http://www.tug.org/">teTeX 1.0</a>.<br>
- \latexonly(see {\tt http://www.tug.org/})\endlatexonly.
+ <a href="http://www.tug.org/">teTeX 1.0</a>
+ \latexonly \\par (see {\tt http://www.tug.org/})\endlatexonly.
This is needed for generating LaTeX, Postscript, and PDF output.
<li><a href="http://www.research.att.com/sw/tools/graphviz/">
- the Graph visualization toolkit version 1.5</a><br>
- \latexonly(see {\tt http://www.research.att.com/sw/tools/graphviz/})\endlatexonly.
+ the Graph visualization toolkit version 1.5</a>
+ \latexonly \\par (see {\tt http://www.research.att.com/sw/tools/graphviz/})\endlatexonly.
Needed for the include dependency graphs,
the graphical inheritance graphs, and the collaboration graphs.
If you compile graphviz yourself, make sure you do include
@@ -142,17 +142,17 @@ Compilation is now done by performing the following steps:
<code>index.html</code> in the
html directory).
-<li>Optional: Generate a PostScript and PDF version of the manual
- (you will need <code>latex</code> and <code>dvips</code> and
- the ghostscript package for this).
+<li>Optional: Generate a PDF version of the manual
+ (you will need <code>pdflatex</code>, <code>makeindex</code>, and
+ <code>egrep</code> for this).
\verbatim
make pdf
\endverbatim
- The PostScript manual <code>doxygen_manual.ps</code> will be located
- in the latex directory of the distribution. Just send it to a
- PostScript printer to print it or use <code>ghostview</code> to view it.
+ The PDF manual <code>doxygen_manual.pdf</code> will be located
+ in the latex directory of the distribution. Just
+ view and print it via the acrobat reader.
</ol>
diff --git a/doc/language.doc b/doc/language.doc
index f850044..5f259fa 100644
--- a/doc/language.doc
+++ b/doc/language.doc
@@ -25,14 +25,14 @@ 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.17-20020804), 27 languages
+Currently (version 1.2.14-20020317), 28 languages
are supported (sorted alphabetically):
-Brazilian Portuguese, Chinese, Chinese Traditional, Croatian, Czech,
-Danish, Dutch, English, Finnish, French,
-German, Greek, Hungarian, Italian, Japanese,
-Korean, Norwegian, Polish, Portuguese, Romanian,
-Russian, Serbian, Slovak, Slovene, Spanish,
-Swedish, and Ukrainian.
+Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian,
+Czech, Danish, Dutch, English, Finnish,
+French, German, Greek, Hungarian, Italian,
+Japanese, Korean, Norwegian, Polish, Portuguese,
+Romanian, Russian, Serbian, Slovak, Slovene,
+Spanish, Swedish, and Ukrainian.
The table of information related to the supported languages follows.
It is sorted by language alphabetically. The <b>Status</b> column
@@ -58,6 +58,12 @@ when the translator was updated.
<TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
+ <TD>Catalan</TD>
+ <TD>Albert Mora</TD>
+ <TD>amora@NOSPAM.iua.upf.es</TD>
+ <TD>up-to-date</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
<TD>Chinese</TD>
<TD>Wei Liu<br>Wang Weihan</TD>
<TD>liuwei@NOSPAM.asiainfo.com<br>wangweihan@NOSPAM.capinfo.com.cn</TD>
@@ -157,7 +163,7 @@ when the translator was updated.
<TD>Polish</TD>
<TD>Piotr Kaminski<br>Grzegorz Kowal</TD>
<TD>Piotr.Kaminski@NOSPAM.ctm.gdynia.pl<br>g_kowal@NOSPAM.poczta.onet.pl</TD>
- <TD>1.2.16</TD>
+ <TD>1.2.17</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>Portuguese</TD>
@@ -181,7 +187,7 @@ when the translator was updated.
<TD>Serbian</TD>
<TD>Dejan Milosavljevic</TD>
<TD>dmilos@NOSPAM.email.com</TD>
- <TD>1.2.16</TD>
+ <TD>1.2.17</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>Slovak</TD>
@@ -226,6 +232,8 @@ when the translator was updated.
\hline
Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt chino@icmc.sc.usp.br} & up-to-date \\
\hline
+ Catalan & Albert Mora & {\tt amora@iua.upf.es} & up-to-date \\
+ \hline
Chinese & Wei Liu & {\tt liuwei@asiainfo.com} & 1.2.13 \\
& Wang Weihan & {\tt wangweihan@capinfo.com.cn} & \\
\hline
@@ -262,7 +270,7 @@ when the translator was updated.
\hline
Norwegian & Lars Erik Jordet & {\tt lej@circuitry.no} & 1.2.2 \\
\hline
- Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & 1.2.16 \\
+ Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & 1.2.17 \\
& Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} & \\
\hline
Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & up-to-date \\
@@ -271,7 +279,7 @@ when the translator was updated.
\hline
Russian & Alexandr Chelpanov & {\tt cav@cryptopro.ru} & up-to-date \\
\hline
- Serbian & Dejan Milosavljevic & {\tt dmilos@email.com} & 1.2.16 \\
+ Serbian & Dejan Milosavljevic & {\tt dmilos@email.com} & 1.2.17 \\
\hline
Slovak & Stanislav Kudl\'{a}\v{c} & {\tt skudlac@pobox.sk} & up-to-date \\
\hline
diff --git a/doc/language.tpl b/doc/language.tpl
index a0dc352..fcf6da0 100644
--- a/doc/language.tpl
+++ b/doc/language.tpl
@@ -62,8 +62,8 @@ Just follow these steps:
defines which language translators will be compiled into doxygen
executable. It is a kind of configuration file. If you are sure that
you do not need some of the languages, you can remove (comment out)
- definitions of symbols for the languages, or you can say \c #undef
- instead of \c #define for them.
+ definitions of symbols for the languages, or you can say \c \#undef
+ instead of \c \#define for them.
<li>Edit language.cpp:
Add a
\verbatim
@@ -93,7 +93,7 @@ Just follow these steps:
<li>Edit <code>translator_xx.h</code>:
<ul>
<li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code>
- twice (i.e. in the \c #ifndef and \c #define preprocessor commands at
+ twice (i.e. in the \c \#ifndef and \c \#define preprocessor commands at
the beginning of the file).
<li>Rename TranslatorEnglish to TranslatorYourLanguage
<li>In the member <code>idLanguage()</code> change "english" into the
diff --git a/doc/maintainers.txt b/doc/maintainers.txt
index 4673c16..44f387c 100644
--- a/doc/maintainers.txt
+++ b/doc/maintainers.txt
@@ -4,6 +4,9 @@
Brazilian
Fabio "FJTC" Jun Takada Chino: chino@icmc.sc.usp.br
+Catalan
+Albert Mora: amora@iua.upf.es
+
Chinese
Wei Liu: liuwei@asiainfo.com
Wang Weihan: wangweihan@capinfo.com.cn
diff --git a/doc/starting.doc b/doc/starting.doc
index 85341e3..39bb117 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -42,10 +42,10 @@ recursively scanned.
To simplify the creation of a configuration file, doxygen can create a
template configuration file for you. To do this call \c doxygen with the \c -g
option:
-
\verbatim
doxygen -g <config-file>
\endverbatim
+
where \<config-file\> is the name of the configuration file. If you omit
the file name, a file named \c Doxyfile will be created. If a file with the
name \<config-file\> already exists, doxygen will rename it to