summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile2
-rw-r--r--doc/config.doc11
-rw-r--r--doc/index.doc10
-rw-r--r--doc/install.doc18
-rw-r--r--doc/language.doc14
-rw-r--r--doc/language.tpl4
-rw-r--r--doc/maintainers.txt4
-rw-r--r--doc/translator.pl2
8 files changed, 32 insertions, 33 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile
index f992010..ca536a7 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -12,7 +12,7 @@
# Documents produced by Doxygen are derivative works derived from the
# input used in their production; they are not affected by this license.
-PROJECT_NAME =
+PROJECT_NAME = "Doxygen manual"
OUTPUT_DIRECTORY = ..
HTML_HEADER =
HTML_FOOTER =
diff --git a/doc/config.doc b/doc/config.doc
index bf5bac2..e4f021d 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -756,11 +756,8 @@ followed by the descriptions of the tags grouped by category.
doxygen generates three additional HTML index files:
\c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a
project file that can be read by
- <a href="http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download_main.htm">
- Microsoft HTML Help Workshop</a>
- \latexonly
- (see http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download\_main.htm)
- \endlatexonly
+ <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp">
+ Microsoft's HTML Help Workshop</a>
on Windows.
The HTML Help Workshop contains a compiler that can convert all HTML output
@@ -1007,7 +1004,7 @@ EXTRA_PACKAGES = times
\anchor cfg_man_links
<dt>\c MAN_LINKS <dd>
- \addindex MAN_LINKs
+ \addindex MAN_LINKS
If the \c MAN_LINKS tag is set to \c YES and doxygen generates man output,
then it will generate one additional man file for each entity documented in
the real man page(s). These additional files only source the real man page,
@@ -1208,7 +1205,7 @@ 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?
+ This tag can be used to cleanup any mess DOT left behind.
If left blank, "NO" is assumed.
</dl>
diff --git a/doc/index.doc b/doc/index.doc
index c260a81..99e6d7c 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -79,7 +79,7 @@ sections.
The first part forms a user manual:
<ul>
<li>Section \ref install discusses how to
- <a href="http://www.stack.nl/~dimitri/doxygen/download.html">download</a>, compile and install
+ <a href="http://www.doxygen.org/download.html">download</a>, compile and install
doxygen for your platform.
<li>Section \ref starting tells you how to generate your first piece of
documentation quickly.
@@ -126,11 +126,11 @@ The second part forms a reference manual:
I have compiled a
\htmlonly
-<a href="http://www.stack.nl/~dimitri/doxygen/projects.html">list of projects</a>
+<a href="http://www.doxygen.org/projects.html">list of projects</a>
that use doxygen.
\endhtmlonly
\latexonly
-list of projects that use doxygen (see {\tt http://www.stack.nl/$\sim$dimitri/doxygen/projects.html}).
+list of projects that use doxygen (see {\tt http://www.doxygen.org/projects.html}).
\endlatexonly
If you know other projects, let me know and I'll add them.
@@ -138,10 +138,10 @@ If you know other projects, let me know and I'll add them.
Although doxygen is used successfully by a lot of people already,
there is always room for improvement. Therefore, I have compiled a
\htmlonly
-<a href="http://www.stack.nl/~dimitri/doxygen/todo.html">todo/wish list</a>
+<a href="http://www.doxygen.org/todo.html">todo/wish list</a>
\endhtmlonly
\latexonly
-todo/wish list (see {\tt http://www.stack.nl/$\sim$dimitri/doxygen/todo.html})
+todo/wish list (see {\tt http://www.doxygen.org/todo.html})
\endlatexonly
of possible and/or requested enhancements.
diff --git a/doc/install.doc b/doc/install.doc
index 557df69..99e8e56 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -147,9 +147,9 @@ Compilation is now done by performing the following steps:
make pdf
\endverbatim
- The postscript manual <code>doxygen_manual.ps</code> will be located
+ 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.
+ PostScript printer to print it or use <code>ghostview</code> to view it.
</ol>
@@ -165,13 +165,14 @@ Compilation is now done by performing the following steps:
\endverbatim
Binaries are installed into the directory <code>\<prefix\>/bin</code>.
- Use <code>make install_docs DOCDIR=\<path\></code> to install the
- documentation and examples into the <code>\<path\></code> directory.
+ Use <code>make install_docs</code> to install the
+ documentation and examples into <code>\<docdir\>/doxygen</code>.
- <code>\<prefix\></code> defaults to /usr but can be changed with
+ <code>\<prefix\></code> defaults to <code>/usr</code> but can be changed with
the <code>--prefix</code> option of the configure script.
- The default <code>DOCDIR</code> directory is
- <code>\<prefix\>/share/doc/packages/doxygen</code>
+ The default <code>\<docdir\></code> directory is
+ <code>\<prefix\>/share/doc/packages</code> and can be changed with
+ the <code>--docdir</code> option of the configure script.
Alternatively, you can also copy the binaries from the <code>bin</code>
directory manually to some <code>bin</code> directory in your search path.
@@ -445,7 +446,7 @@ Here is what is required:
(see \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the
config file, then you need the Microsoft HTML help workshop.
You can download it at:
- http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download_main.htm
+ http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp
<li>If you used WinZip to extract the tar archive it will (apparently) not
create empty folders, so you have to add the folders
@@ -454,6 +455,7 @@ Here is what is required:
<li><a href="http://www.graphviz.org/">
the Graph visualization toolkit version 1.5</a><br>
+ \latexonly(see {\tt http://www.graphviz.org/})\endlatexonly.
Needed for the include dependency graphs, the graphical inheritance graphs,
and the collaboration graphs.
</ul>
diff --git a/doc/language.doc b/doc/language.doc
index 111616c..daf3178 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.8-20010723), 24 languages
+Currently (version 1.2.8-20010726), 24 languages
are supported (sorted alphabetically):
Brazilian Portuguese, Chinese, Croatian, Czech, Danish,
Dutch, English, Finnish, French, German,
@@ -101,13 +101,13 @@ when the translator was updated.
<TR BGCOLOR="#ffffff">
<TD>French</TD>
<TD>Xavier Outhier</TD>
- <TD>xavier.outhier@NOSPAM.anfdata.cz</TD>
+ <TD>xouthier@NOSPAM.yahoo.fr</TD>
<TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
<TD>German</TD>
<TD>Jens Seidel<br>Jens Breitenstein</TD>
- <TD>jensseidel@NOSPAM.users.sourceforge.net<br>Jens.Breitenstein@NOSPAM.tlc.de</TD>
+ <TD>jensseidel@NOSPAM.users.sf.net<br>Jens.Breitenstein@NOSPAM.tlc.de</TD>
<TD>up-to-date</TD>
</TR>
<TR BGCOLOR="#ffffff">
@@ -222,9 +222,9 @@ when the translator was updated.
\hline
Finnish & Olli Korhonen & {\tt Olli.Korhonen@ccc.fi} & 1.0.0 \\
\hline
- French & Xavier Outhier & {\tt xavier.outhier@anfdata.cz} & up-to-date \\
+ French & Xavier Outhier & {\tt xouthier@yahoo.fr} & up-to-date \\
\hline
- German & Jens Seidel & {\tt jensseidel@users.sourceforge.net} & up-to-date \\
+ 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 \\
@@ -295,13 +295,13 @@ Just follow these steps:
\endverbatim
after the <code>if { ... }</code>
<li>Edit libdoxygen.pro.in and add \c translator_xx.h to
- the \c HEADERS line in the file doxygen.pro.
+ the \c HEADERS line.
<li>Edit <code>translator_xx.h</code>:
<ul>
<li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code> twice.
<li>Rename TranslatorEnglish to TranslatorYourLanguage
<li>In the member <code>idLanguage()</code> change "english" into the
- name of the your language (use lower case characters only). Depending
+ name of your language (use lower case characters only). Depending
on the language you may also wish to change the member functions
latexLanguageSupportCommand(), idLanguageCharset() and others
(you will recognize them when you start the work).
diff --git a/doc/language.tpl b/doc/language.tpl
index 7390f02..7497bea 100644
--- a/doc/language.tpl
+++ b/doc/language.tpl
@@ -68,13 +68,13 @@ Just follow these steps:
\endverbatim
after the <code>if { ... }</code>
<li>Edit libdoxygen.pro.in and add \c translator_xx.h to
- the \c HEADERS line in the file doxygen.pro.
+ the \c HEADERS line.
<li>Edit <code>translator_xx.h</code>:
<ul>
<li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code> twice.
<li>Rename TranslatorEnglish to TranslatorYourLanguage
<li>In the member <code>idLanguage()</code> change "english" into the
- name of the your language (use lower case characters only). Depending
+ name of your language (use lower case characters only). Depending
on the language you may also wish to change the member functions
latexLanguageSupportCommand(), idLanguageCharset() and others
(you will recognize them when you start the work).
diff --git a/doc/maintainers.txt b/doc/maintainers.txt
index 7c60bcb..5d654e0 100644
--- a/doc/maintainers.txt
+++ b/doc/maintainers.txt
@@ -27,10 +27,10 @@ Finnish
Olli Korhonen: Olli.Korhonen@ccc.fi
French
-Xavier Outhier: xavier.outhier@anfdata.cz
+Xavier Outhier: xouthier@yahoo.fr
German
-Jens Seidel: jensseidel@users.sourceforge.net
+Jens Seidel: jensseidel@users.sf.net
Jens Breitenstein: Jens.Breitenstein@tlc.de
Hungarian
diff --git a/doc/translator.pl b/doc/translator.pl
index 4c4bdac..a19a6d8 100644
--- a/doc/translator.pl
+++ b/doc/translator.pl
@@ -575,7 +575,7 @@ xxxTABLE_FOOTxxx
##}}}
# Finish the tables, and substitute the mark in the doc
- # template by the contatenation of the tables. Add NOSPAM to
+ # template by the concatenation of the tables. Add NOSPAM to
# email addresses in the HTML table. Replace the special
# character sequences. #{{{
#