Release-1.5.9-20090814

4 files changed, 273 insertions, 23 deletions

diff --git a/doc/commands.doc b/doc/commands.doc
index 6e9c2e8..43948a4 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -2049,7 +2049,7 @@ class Receiver
   after the \ref cfg_dotfile_dirs "DOTFILE_DIRS" tag. 
   If the dot file is found it will be used as an input file to the dot tool. 
   The resulting image will be put into the correct output directory.
-  If the dot file name contains spaces you'll have to put quotes (") around it.
+  If the dot file name contains spaces you'll have to put quotes ("...") around it.
 
   The second argument is optional and can be used to specify the caption
   that is displayed below the image. This argument has to be specified
@@ -2224,7 +2224,7 @@ class Receiver
   doxygen will look for files in the paths (or files) that you specified 
   after the \ref cfg_image_path "IMAGE_PATH" tag. 
   If the image is found it will be copied to the correct output directory.
-  If the image name contains spaces you'll have to put quotes (") around it.
+  If the image name contains spaces you'll have to put quotes ("...") around it.
   You can also specify an absolute URL instead of a file name, but then
   doxygen does not copy the image nor check its existance.
 
diff --git a/doc/config.doc b/doc/config.doc
index 4679a4c..a826c7a 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -223,6 +223,7 @@ followed by the descriptions of the tags grouped by category.
 \refitem cfg_skip_function_macros SKIP_FUNCTION_MACROS
 \refitem cfg_sort_brief_docs SORT_BRIEF_DOCS
 \refitem cfg_sort_by_scope_name SORT_BY_SCOPE_NAME
+\refitem cfg_sort_members_constructors_first SORT_MEMBERS_CTORS_1ST
 \refitem cfg_sort_group_names SORT_GROUP_NAMES
 \refitem cfg_sort_member_docs SORT_MEMBER_DOCS
 \refitem cfg_source_browser SOURCE_BROWSER
@@ -759,6 +760,18 @@ function's detailed documentation block.
  @note This option applies only to the class list, not to the 
        alphabetical list.
 
+\anchor cfg_sort_members_constructors_first
+<dt>\c SORT_MEMBERS_CTORS_1ST <dd>
+ \addindex SORT_MEMBERS_CTORS_1ST
+ If the \c SORT_MEMBERS_CTORS_1ST tag is set to \c YES then doxygen
+ will sort the (brief and detailed) documentation of class members so that
+ constructors and destructors are listed first. If set to NO (the default)
+ the constructors will appear in the respective orders defined by
+ \c SORT_MEMBER_DOCS and \c SORT_BRIEF_DOCS.
+ @note If \c SORT_BRIEF_DOCS is set to \c NO this option is ignored for
+       sorting brief member documentation.
+ @note If \c SORT_MEMBER_DOCS is set to \c NO this option is ignored for
+       sorting detailed member documentation.
 
 \anchor cfg_generate_deprecatedlist
 <dt>\c GENERATE_DEPRECATEDLIST <dd>
@@ -1080,10 +1093,10 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
 
 <dt>\c SOURCE_BROWSER <dd>
  \addindex SOURCE_BROWSER
- If the \c SOURCE_BROWSER tag is set to \c YES then a list of source files will \n"
- be generated. Documented entities will be cross-referenced with these sources. \n"
- Note: To get rid of all source code in the generated output, make sure also \n"
- \c VERBATIM_HEADERS is set to NO. \n"
+ If the \c SOURCE_BROWSER tag is set to \c YES then a list of source files will
+ be generated. Documented entities will be cross-referenced with these sources.
+ Note: To get rid of all source code in the generated output, make sure also
+ \c VERBATIM_HEADERS is set to NO.
 
 \anchor cfg_inline_sources
 <dt>\c INLINE_SOURCES <dd>
diff --git a/doc/doxygen.sty b/doc/doxygen.sty
index 3d0292b..2ee9f91 100644
--- a/doc/doxygen.sty
+++ b/doc/doxygen.sty
@@ -1,7 +1,7 @@
 %
 % 
 %
-% Copyright (C) 1997-2006 by Dimitri van Heesch.
+% Copyright (C) 1997-2009 by Dimitri van Heesch.
 %
 % Permission to use, copy, modify, and distribute this software and its
 % documentation under the terms of the GNU General Public License is hereby 
@@ -16,6 +16,7 @@
 \ProvidesPackage{doxygen}
 \RequirePackage{calc}
 \RequirePackage{array}
+\RequirePackage{verbatim}
 \pagestyle{fancyplain}
 \addtolength{\headwidth}{\marginparsep}
 \addtolength{\headwidth}{\marginparwidth}
@@ -27,21 +28,257 @@
 \rfoot[\fancyplain{}{\bfseries\scriptsize User Manual for Doxygen $VERSION, written by Dimitri van Heesch \copyright 1997-2006}]{}
 \lfoot[]{\fancyplain{}{\bfseries\scriptsize User Manual for Doxygen $VERSION, written by Dimitri van Heesch \copyright 1997-2006}}
 \cfoot{}
-\newenvironment{Code}
-{\footnotesize}
-{\normalsize}
+
+%---------- Internal commands used in this style file ----------------
+
+% Generic environment used by all paragraph-based environments defined
+% below. Note that the command \title{...} needs to be defined inside
+% those environments!
+\newenvironment{DoxyDesc}[1]{%
+  \begin{list}{}%
+  {%
+    \settowidth{\labelwidth}{40pt}%
+    \setlength{\leftmargin}{\labelwidth}%
+    \setlength{\parsep}{0pt}%
+    \setlength{\itemsep}{-4pt}%
+    \renewcommand{\makelabel}{\entrylabel}%
+  }%
+  \item[#1:]%
+}{%
+  \end{list}%
+}
+
+%---------- Commands used by doxygen LaTeX output generator ----------
+
+% Used by <pre> ... </pre>
+\newenvironment{DoxyPre}{%
+  \small%
+  \begin{alltt}%
+}{%
+  \end{alltt}%
+  \normalsize%
+}
+
+% Used by @code ... @endcode
+\newenvironment{DoxyCode}{%
+  \footnotesize%
+  \verbatim%
+}{%
+  \endverbatim%
+  \normalsize%
+}
+
+% Used by @example, @include, @includelineno and @dontinclude
+\newenvironment{DoxyCodeInclude}{%
+  \DoxyCode%
+}{%
+  \endDoxyCode%
+}
+
+% Used by @verbatim ... @endverbatim
+\newenvironment{DoxyVerb}{%
+  \footnotesize%
+  \verbatim%
+}{%
+  \endverbatim%
+  \normalsize%
+}
+
+% Used by @verbinclude
+\newenvironment{DoxyVerbInclude}{%
+  \DoxyVerb%
+}{%
+  \endDoxyVerb%
+}
+
+% Used by numbered lists (using '-#' or <ol> ... </ol>)
+\newenvironment{DoxyEnumerate}{%
+  \enumerate%
+}{%
+  \endenumerate%
+}
+
+% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
+\newenvironment{DoxyItemize}{%
+  \itemize%
+}{%
+  \enditemize%
+}
+
+% Used by description lists (using <dl> ... </dl>)
+\newenvironment{DoxyDescription}{%
+  \description%
+}{%
+  \enddescription%
+}
+
+% Used by @image, @dotfile, and @dot ... @enddot
+% (only if caption is specified)
+\newenvironment{DoxyImage}{%
+  \begin{figure}[H]%
+  \begin{center}%
+}{%
+  \end{center}%
+  \end{figure}%
+}
+
+% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
+% (only if no caption is specified)
+\newenvironment{DoxyImageNoCaption}{%
+}{%
+}
+
+% Used by @attention
+\newenvironment{DoxyAttention}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @author and @authors
+\newenvironment{DoxyAuthor}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @date
+\newenvironment{DoxyDate}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @invariant
+\newenvironment{DoxyInvariant}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @note
+\newenvironment{DoxyNote}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @post
+\newenvironment{DoxyPostcond}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @pre
+\newenvironment{DoxyPrecond}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @remark
+\newenvironment{DoxyRemark}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @return
+\newenvironment{DoxyReturn}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @since
+\newenvironment{DoxySince}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @see
+\newenvironment{DoxySeeAlso}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @version
+\newenvironment{DoxyVersion}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @warning
+\newenvironment{DoxyWarning}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @internal
+\newenvironment{DoxyInternal}[1]{%
+  \begin{DoxyDesc}{#1}%
+}{%
+  \end{DoxyDesc}%
+}
+
+% Used by @par and @paragraph
+\newenvironment{DoxyParagraph}[1]{%
+  \begin{list}{}%
+  {%
+    \settowidth{\labelwidth}{40pt}%
+    \setlength{\leftmargin}{\labelwidth}%
+    \setlength{\parsep}{0pt}%
+    \setlength{\itemsep}{-4pt}%
+    \renewcommand{\makelabel}{\entrylabel}%
+  }%
+  \item[#1]%
+}{%
+  \end{list}%
+}
+
+% Used by parameter lists
+\newenvironment{DoxyParams}[1]{%
+  \begin{DoxyDesc}{#1}%
+    \begin{description}%
+}{%
+    \end{description}%
+  \end{DoxyDesc}%
+}
+
+% Used by return value lists
+\newenvironment{DoxyRetVals}[1]{%
+  \begin{DoxyDesc}{#1}%
+    \begin{description}%
+}{%
+    \end{description}%
+  \end{DoxyDesc}%
+}
+
+% Used by exception lists
+\newenvironment{DoxyExceptions}[1]{%
+  \begin{DoxyDesc}{#1}%
+    \begin{description}%
+}{%
+    \end{description}%
+  \end{DoxyDesc}%
+}
+
+% Used by template parameter lists
+\newenvironment{DoxyTemplParams}[1]{%
+  \begin{DoxyDesc}{#1}%
+    \begin{description}%
+}{%
+    \end{description}%
+  \end{DoxyDesc}%
+}
+
 \newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})}
-\newenvironment{DocInclude}
-{\footnotesize}
-{\normalsize}
-\newenvironment{VerbInclude}
-{\footnotesize}
-{\normalsize}
-\newenvironment{Image}
-{\begin{figure}[H]}
-{\end{figure}}
-\newenvironment{ImageNoCaption}{}{}
-\newenvironment{CompactList}
+\newenvironment{DoxyCompactList}
 {\begin{list}{}{
   \setlength{\leftmargin}{0.5cm}
   \setlength{\itemsep}{0pt}
@@ -49,7 +286,7 @@
   \setlength{\topsep}{0pt}
   \renewcommand{\makelabel}{}}}
 {\end{list}}
-\newenvironment{CompactItemize}
+\newenvironment{DoxyCompactItemize}
 {
   \begin{itemize}
   \setlength{\itemsep}{-4pt}
diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex
index bb6675e..b47569c 100644
--- a/doc/doxygen_manual.tex
+++ b/doc/doxygen_manual.tex
@@ -64,7 +64,7 @@ Written by Dimitri van Heesch\\[2ex]
 \chapter{Custom Commands}\label{custcmd}\hypertarget{custcmd}{}\input{custcmd}
 \chapter{Link to external documentation}\label{external}\hypertarget{external}{}\input{external}
 \chapter{Frequently Asked Questions}\label{faq}\hypertarget{faq}{}\input{faq}
-\chapter{Troubleshootinh}\label{trouble}\hypertarget{trouble}{}\input{trouble}
+\chapter{Troubleshooting}\label{trouble}\hypertarget{trouble}{}\input{trouble}
 \part{Reference Manual}
 \chapter{Features}\label{features}\hypertarget{features}{}\input{features}
 \chapter{Doxygen History}\label{history}\hypertarget{history}{}\input{history}