Release-1.2.2-20001001

3 files changed, 25 insertions, 22 deletions

diff --git a/doc/autolink.doc b/doc/autolink.doc
index 50214a7..2c18ee1 100644
--- a/doc/autolink.doc
+++ b/doc/autolink.doc
@@ -69,6 +69,10 @@
   \par Note 2: 
     For JavaDoc compatibility a \# may be used instead of a :: in 
     the patterns above.
+  \par Note 3:
+    In the documentation of a class containing a member foo, 
+    a reference to a global variable is made using ::foo, whereas \#foo
+    will link to the member.
 
   For non overloaded members the argument list may be omitted.
 
@@ -111,7 +115,7 @@ typedef struct StructName TypeName
   \par Example:
   \verbinclude restypedef.cpp
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/restypedef/html/restypedef.cpp.html">here</a> 
+  Click <a href="$(DOXYGEN_DOCDIR)/examples/restypedef/html/restypedef_cpp.html">here</a> 
   for the corresponding HTML documentation that is generated by Doxygen.
   \endhtmlonly
 */
diff --git a/doc/config.doc b/doc/config.doc
index 87488a5..9b92688 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -47,10 +47,10 @@ file using a <code>\@INCLUDE</code> tag as follows:
 \endverbatim 
 The include file is searched in the current working directory. You can 
 also specify a list of directories that should be searched before looking
-in the current working directory. Do this by putting a <code>\@INCLUDEPATH</code> tag 
+in the current working directory. Do this by putting a <code>\@INCLUDE_PATH</code> tag 
 with these paths before the <code>\@INCLUDE</code> tag, e.g:
 \verbatim
-@INCLUDEPATH = my_config_dir
+@INCLUDE_PATH = my_config_dir
 \endverbatim
 
 The configuration options can be divided into several categories.
@@ -370,10 +370,10 @@ followed by the descriptions of the tags grouped by category.
 \anchor cfg_javadoc_autobrief
 <dt>\c JAVADOC_AUTOBRIEF <dd>
  \addindex JAVADOC_AUTOBRIEF
-  If the \c JAVADOC_AUTOBRIEF is set to \c YES (the default) then Doxygen
+  If the \c JAVADOC_AUTOBRIEF is set to \c YES then Doxygen
   will interpret the first line (until the first dot) of a JavaDoc-style
-  comment as the brief description. If set to NO, the Javadoc-style will
-  behave just like the Qt-style comments.
+  comment as the brief description. If set to NO (the default), the 
+  Javadoc-style will behave just like the Qt-style comments.
 
 \anchor cfg_inherit_docs
 <dt>\c INHERIT_DOCS <dd>
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index 3ac2789..7500eb5 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -66,34 +66,33 @@ sentence of the detailed description
 to \c NO). Both the brief and the detailed descriptions are optional 
 for the Qt style. 
 
-Here is the same piece of code, this time documented using the JavaDoc 
-style:
+By default a JavaDoc style documentation block behaves the same way as a
+Qt style documentation block. This is not according the JavaDoc specification
+however, where the first sentence of the documentation block is automatically
+treated as a brief description. To enable this behaviour you should set
+\ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" to YES in the configuration
+file. If you enble this option and want to put a dot in the middle of a
+sentence without ending it, you should put a backslash and a space after it.
+Here is an example:
+\verbatim
+  /** Brief description (e.g.\ using only a few words). Details follow. */
+\endverbatim
+
+Here is the same piece of code as shown above, this time documented using the 
+JavaDoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES:
 \verbinclude jdstyle.cpp
  \htmlonly
  Click <a href="$(DOXYGEN_DOCDIR)/examples/jdstyle/html/class_test.html">here</a>
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly
 
-Note that by default the first sentence of the documentation (until the <tt>.</tt>) 
-is treated as a brief description, whereas the documentation block as a whole 
-forms the detailed description. If you want to put a dot in the middle of a
-sentence you should put a backslash and space behind it. Example:
-\verbatim
-  /** Brief description (e.g.\ using only a few words). Details follow. */
-\endverbatim
-The brief description is required for the JavaDoc style, unless you set
-\ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" to NO. If you do this,
-doxygen treats JavaDoc comments just like Qt comments (i.e. You have
-to insert an explicit \ref cmdbrief "\\brief" command to add a brief description).
-
 Unlike most other documentation systems, doxygen also allows you to put
 the documentation of members (including global functions) in front of 
 the \e definition. This way the documentation can be placed in the source 
 file instead of the header file. This keeps the header file compact, and allows the 
 implementer of the members more direct access to the documentation.
 As a compromise the brief description could be placed before the
-declaration and the detailed description before the member definition
-(assuming you use the Qt style comments).
+declaration and the detailed description before the member definition.
 
 \par Note:
 Each entity can only have \e one brief and \e one detailed description. If you