summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/features.doc2
-rw-r--r--doc/htmlcmds.doc4
-rw-r--r--doc/index.doc2
-rw-r--r--doc/trouble.doc37
4 files changed, 25 insertions, 20 deletions
diff --git a/doc/features.doc b/doc/features.doc
index 3c035a0..68d54f0 100644
--- a/doc/features.doc
+++ b/doc/features.doc
@@ -23,7 +23,7 @@
<li>Requires very little overhead from the writer of the documentation.
Plain text will do, but for more fancy or structured output HTML tags
and/or some of doxygen's special commands can be used.
-<li>Supports C++, (Corba, Microsoft, and KDE-DCOP) IDL and C sources.
+<li>Supports C++, (Corba, Microsoft, and KDE-DCOP) Java, IDL and C sources.
<li>Supports documentation of files, namespaces, classes, structs, unions,
templates, variables, functions, typedefs, enums and defines.
<li>JavaDoc (1.1), Qt-Doc, and KDOC compatible.
diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc
index 3a5177b..8c9c28c 100644
--- a/doc/htmlcmds.doc
+++ b/doc/htmlcmds.doc
@@ -49,8 +49,8 @@ documentation. Note that all attributes of a HTML tag are ignored
<li>\c </H1> Ends an unnumberd section.
<li>\c <H2> Starts an unnumbered subsection.
<li>\c </H2> Ends an unnumbered subsection.
-<li>\c <H?> Where ? is one of {3,4,5,6}, starts an unnumbered subsubsection.
-<li>\c </H?> Where ? is one of {3,4,5,6}, ends an unnumbered subsubsection.
+<li>\c <H?> Where ? is one of {3,4,5,6}, starts an unnumbered subsubsection using \c <H3> in HTML.
+<li>\c </H?> Where ? is one of {3,4,5,6}, ends an unnumbered subsubsection using \c <H3> in HTML.
<li>\c <I> Starts a piece of text displayed in an italic font.
<li>\c <INPUT> Does not generated any output.
<li>\c </I> Ends a \c <I> section.
diff --git a/doc/index.doc b/doc/index.doc
index e116ab9..5687c32 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -45,7 +45,7 @@ Documents produced by Doxygen are derivative works derived from the
input used in their production; they are not affected by this license.
<h2>Introduction</h2>
-Doxygen is a documentation system for C++, IDL
+Doxygen is a documentation system for C++, Java, IDL
(Corba, Microsoft and KDE-DCOP flavors) and C.
It can help you in three ways:
diff --git a/doc/trouble.doc b/doc/trouble.doc
index 9aaf44b..f03eb99 100644
--- a/doc/trouble.doc
+++ b/doc/trouble.doc
@@ -78,26 +78,31 @@ If you are trying Doxygen let me know what you think of it (do you
miss certain features?). Even if you decide not to use it, please let me
know why.
-Furthermore, I would appreciate a mail if you have found
-a bug, or if you have ideas (or even better some code or a patch)
-how to fix existing bugs and limitations. For patches please use
-"diff -u"
-
<h2>How to report a bug</h2>
-If you think you have found a bug in doxygen, please report it so I can
-fix it.
+I would appreciate an e-mail if you have found
+a bug, or if you have ideas (or even better some code or a patch)
+how to fix existing bugs and limitations. For patches please use
+"diff -u" or include the files you modified. If you send more than
+one file please tar or zip everything, so I only have to save and download
+one file.
-Always include the following information in your bug report:
-- The version of doxygen you are using.
-- The name and version number of your operating system
+Always try to include the following information in your bug report:
+- The version of doxygen you are using (for instance 1.2.4).
+- The name and version number of your operating system (for instance
+ SuSE Linux 6.4)
+- It is usually a good idea to send along the configuation file as well,
+ but please use doxygen with the <code>-s</code> flag while generating it
+ to keep it small.
+- The easiest way for me to solve bugs is if you can send me a small example
+ demonstrating the problem you have. Please make sure the example is valid
+ source code (could potentially compile) and that the problem is really
+ captured by the example (I often get examples that do not trigger the
+ actual bug!).
-The easiest way for me to solve bugs is if you can send me a small example
-demonstrating the problem you have. Please make sure the example is valid
-source code (try compiling it) and if the problem is really captured by
-the example.
-It is usually a good idea to send along the configuation file as well,
-but please use doxygen with the <code>-s</code> flag while generating it.
+If you send only a (vague) description of a bug, you are usually not very
+helpful and will costs me much more time to figure out what you mean.
+In the worst-case your bug report may even be completely ignored by me!
My e-mail address: <a href="mailto:dimitri@stack.nl">dimitri@stack.nl</a>
*/