Release-1.2.16

10 files changed, 60 insertions, 42 deletions

diff --git a/doc/Doxyfile b/doc/Doxyfile
index 637b172..e4cb868 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -51,3 +51,4 @@ DOC_ABSPATH       =
 BIN_ABSPATH       = /usr/local/bin/
 EXT_DOC_PATHS     =
 PDF_HYPERLINKS    = YES
+USE_PDFLATEX      = YES
diff --git a/doc/Makefile.latex b/doc/Makefile.latex
index f824b70..07e453f 100644
--- a/doc/Makefile.latex
+++ b/doc/Makefile.latex
@@ -14,18 +14,18 @@
 
 all: doxygen_manual.pdf
 
-doxygen_manual.pdf: doxygen_manual.ps
-	ps2pdf doxygen_manual.ps doxygen_manual.pdf
+#doxygen_manual.pdf: doxygen_manual.ps
+#	ps2pdf doxygen_manual.ps doxygen_manual.pdf
 
-doxygen_manual.ps: doxygen_manual.dvi
-	dvips -o doxygen_manual.ps doxygen_manual.dvi
+#doxygen_manual.ps: doxygen_manual.dvi
+#	dvips -o doxygen_manual.ps doxygen_manual.dvi
 
-doxygen_manual.dvi: doxygen_manual.tex doxygen.sty
+doxygen_manual.pdf: doxygen_manual.tex doxygen.sty
 	echo "Running latex..."
-	latex doxygen_manual.tex 
+	pdflatex doxygen_manual.tex 
 	echo "Running makeindex..."
 	makeindex doxygen_manual.idx
 	echo "Rerunning latex...."
-	latex doxygen_manual.tex
+	pdflatex doxygen_manual.tex
 clean:
-	rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log
+	rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.pdf
diff --git a/doc/config.doc b/doc/config.doc
index d85a7c9..3269d49 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -79,6 +79,7 @@ followed by the descriptions of the tags grouped by category.
 <li> \refitem cfg_cols_in_alpha_index COLS_IN_ALPHA_INDEX
 <li> \refitem cfg_compact_latex COMPACT_LATEX 
 <li> \refitem cfg_compact_rtf COMPACT_RTF
+<li> \refitem cfg_details_at_top DETAILS_AT_TOP 
 <li> \refitem cfg_disable_index DISABLE_INDEX 
 <li> \refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC
 <li> \refitem cfg_doc_abspath DOC_ABSPATH 
@@ -400,6 +401,14 @@ followed by the descriptions of the tags grouped by category.
   comment as the brief description. If set to NO (the default), the 
   Javadoc-style will behave just like the Qt-style comments.
 
+\anchor cfg_details_at_top
+<dt>\c DETAILS_AT_TOP <dd>
+ \addindex DETAILS_AT_TOP
+  If the DETAILS_AT_TOP tag is set to YES then Doxygen
+  will output the detailed description near the top, like JavaDoc.
+  If set to NO, the detailed description appears after the member
+  documentation.
+
 \anchor cfg_inherit_docs
 <dt>\c INHERIT_DOCS <dd>
  \addindex INHERIT_DOCS
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index e0c9161..804187a 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -63,40 +63,32 @@ In both cases the intermediate *'s are optional, so
 is also valid.
 
 <li> A third alternative is to use a block of at least two C++ comment 
-lines, where the first starts with an additional slash or an 
+lines, where each line starts with an additional slash or an 
 exclamation mark. Here are examples of the two cases:
 
 \verbatim
 ///
-// ... text ...
-//
+/// ... text ...
+///
 \endverbatim
 
 or
 
 \verbatim
 //!
-// ... text ...
-//
+//!... text ...
+//!
 \endverbatim
 
 <li>
 
-One could also repeat the special markers for each line as shown in
-the following examples:
-
-\verbatim
-/// 
-/// ... text ....
-///
-\endverbatim
-
-or 
+Some people like to make their comment blocks more visible in the
+documentation. For this purpose you can use the following:
 
 \verbatim
-//!
-//! ... text ...
-//!
+/////////////////////////////////////////////////
+/// ... text ...
+/////////////////////////////////////////////////
 \endverbatim
 
 </ol>
@@ -117,7 +109,8 @@ Here is an example:
  */
 \endverbatim
 
-<li>If \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" is set to YES in the configuration file, 
+<li>If \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" is set to \c YES 
+    in the configuration file, 
     then using JavaDoc style comment
     blocks will automatically start a brief description which ends at the
     first dot followed by a space or new line. Here is an example:
@@ -127,6 +120,11 @@ Here is an example:
  *  here.
  */
 \endverbatim
+The option has the same effect for multi-line special C++ comments:
+\verbatim
+/// Brief description which ends at this dot. Details follow
+/// here.
+\endverbatim
 
 <li>A third option is to use a special C++ style comment which does not 
     span more than one line. Here are two examples:
@@ -145,7 +143,9 @@ or
 \endverbatim
 
 Note the blank line in the last example, which is required to separate the 
-brief description from the block containing the detailed description.
+brief description from the block containing the detailed description. The
+\ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" should also be set to \c NO
+for this case.
 
 </ol>
 
@@ -215,7 +215,7 @@ 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.
 
-\subsection memberdoc Documenting members afterwards
+\subsection memberdoc Putting documentation after members 
 
 If you want to document the members of a file, struct, union, class, or enum,
 and you want to put the documentation for these members inside the compound,
diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex
index 2b718e3..8e9068e 100644
--- a/doc/doxygen_manual.tex
+++ b/doc/doxygen_manual.tex
@@ -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.
 
-\documentclass[a4paper,ps2pdf]{article}
+\documentclass[a4paper]{article}
 \usepackage{a4wide}
 \usepackage{makeidx}
 \usepackage{fancyhdr}
@@ -23,7 +23,8 @@
 \usepackage{multicol}
 \usepackage{times}
 \usepackage{alltt}
-\usepackage[pagebackref=true,
+\usepackage[pdftex,
+            pagebackref=true,
             colorlinks=true,
             linkcolor=blue
            ]{hyperref}
diff --git a/doc/faq.doc b/doc/faq.doc
index 77ba440..b9821bf 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -195,7 +195,10 @@ more than 16K input character in one go. I've seen this happening
 on a very large generated file (>16K lines), where the built-in preprocessor 
 converted it into an empty file (with >16K of newlines). Another case
 where this might happen is if you have lines in your code with more than
-16K characters.
+16K characters. 
+
+If you have ran into such a case and want me to fix it, you
+should send me a code fragment that triggers the message.
 
 <li><b>How did doxygen get it's name?</b>
 
diff --git a/doc/install.doc b/doc/install.doc
index 7472355..979d5e2 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -212,15 +212,14 @@ Now install doxygen as described above.
 
 <b>Bison problems</b>
 
-Versions 1.31 and 1.32 of bison contain a "bug" that results in a 
-compiler error like this:
+Versions 1.31 to 1.34 of bison contain a "bug" that results in a 
+compiler errors like this:
 
 ce_parse.cpp:348: member `class CPPValue yyalloc::yyvs' with 
 constructor not allowed in union
 
-There is no real solution to this problem, but it is discussed on the
-bison mailing list. I recomment to use version 1.29 until the problems 
-with bison are resolved.
+This problem has been solved in version 1.35 (versions before 1.31 
+will also work).
 
 <b>Latex problems</b>
 
diff --git a/doc/language.doc b/doc/language.doc
index 8ed1c95..242f8d3 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.15-20020430), 26 languages 
+Currently (version 1.2.15-20020512), 26 languages 
 are supported (sorted alphabetically): 
 Brazilian Portuguese, Chinese, Chinesetraditional, Croatian, Czech, 
 Danish, Dutch, English, Finnish, French, 
diff --git a/doc/preprocessing.doc b/doc/preprocessing.doc
index 9b7e8bc..ff44316 100644
--- a/doc/preprocessing.doc
+++ b/doc/preprocessing.doc
@@ -28,7 +28,7 @@ So if you have the following code fragment
 #define VERSION 200
 #define CONST_STRING const char *
 
-#if VERSION >= 200
+#if VERSION < 200
   static CONST_STRING version = "2.xx";
 #else
   static CONST_STRING version = "1.xx";
@@ -46,8 +46,13 @@ Then by default doxygen will feed the following to its parser:
 
 You can disable all preprocessing by setting 
 \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" to \c 
-NO in the configuation file. In the case above doxygen will then reads
-both statements!
+NO in the configuation file. In the case above doxygen will then read
+both statements, i.e:
+
+\verbatim
+  static CONST_STRING version = "2.xx";
+  static CONST_STRING version = "1.xx";
+\endverbatim
 
 In case you want to expand the \c CONST_STRING macro, you should set the
 \ref cfg_macro_expansion "MACRO_EXPANSION" tag in the config file 
diff --git a/doc/trouble.doc b/doc/trouble.doc
index bfac14a..fbfe36b 100644
--- a/doc/trouble.doc
+++ b/doc/trouble.doc
@@ -104,6 +104,6 @@ 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> 
+My e-mail address: dimitri@stack.nl 
 */