summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile3
-rw-r--r--doc/commands.doc30
-rw-r--r--doc/config.doc67
-rw-r--r--doc/diagrams.doc2
-rw-r--r--doc/doxygen.12
-rw-r--r--doc/doxygen.sty231
-rw-r--r--doc/doxygen_manual.tex47
-rw-r--r--doc/doxytag.121
-rw-r--r--doc/doxytag_usage.doc97
-rw-r--r--doc/doxywizard.12
-rw-r--r--doc/external.doc36
-rw-r--r--doc/htmlcmds.doc2
-rw-r--r--doc/index.doc3
-rw-r--r--doc/infoflow.eps58
-rw-r--r--doc/infoflow.fig13
-rw-r--r--doc/infoflow.gifbin13383 -> 12857 bytes
-rw-r--r--doc/install.doc18
-rw-r--r--doc/installdox_usage.doc59
-rw-r--r--doc/lists.doc27
-rw-r--r--doc/starting.doc5
20 files changed, 336 insertions, 387 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 5c666af..74ed73d 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -35,8 +35,7 @@ INPUT = index.doc install.doc starting.doc docblocks.doc lists.doc \
grouping.doc formulas.doc diagrams.doc preprocessing.doc \
autolink.doc output.doc searching.doc customize.doc custcmd.doc \
external.doc faq.doc trouble.doc features.doc \
- doxygen_usage.doc doxytag_usage.doc \
- doxywizard_usage.doc installdox_usage.doc \
+ doxygen_usage.doc doxywizard_usage.doc \
config.doc commands.doc htmlcmds.doc xmlcmds.doc language.doc \
perlmod.doc perlmod_tree.doc arch.doc
FILE_PATTERNS = *.cpp *.h *.doc
diff --git a/doc/commands.doc b/doc/commands.doc
index f2c3ddd..0b1db8c 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -192,7 +192,7 @@ documentation:
\refitem cmdhash \\\#
\refitem cmdperc \\\%
\refitem cmdquot \\\"
-\refitem cmddcolon \\\::
+\refitem cmddcolon \::
\endsecreflist
The following subsections provide a list of all commands that are recognized by
@@ -219,7 +219,7 @@ Structural indicators
\verbatim
/*! \addtogroup mygrp
- * Additional documentation for group `mygrp'
+ * Additional documentation for group 'mygrp'
* @{
*/
@@ -699,8 +699,8 @@ Structural indicators
This command can be used to generate the following
standard text for an overloaded member function:
- `This is an overloaded member function, provided for convenience.
- It differs from the above function only in what argument(s) it accepts.'
+ > This is an overloaded member function, provided for convenience.
+ > It differs from the above function only in what argument(s) it accepts.
If the documentation for the overloaded member function is not located
in front of the function declaration or definition, the optional
@@ -738,7 +738,7 @@ Structural indicators
not directly related to one specific class, file or member.
The HTML generator creates a page containing the documentation. The
\f$\mbox{\LaTeX}\f$ generator
- starts a new section in the chapter `Page documentation'.
+ starts a new section in the chapter 'Page documentation'.
\par Example:
\verbinclude page.doc
@@ -878,7 +878,7 @@ Structural indicators
\addindex \\relates
This command can be used in the documentation of a non-member function
- \<name\>. It puts the function inside the `related function' section
+ \<name\>. It puts the function inside the 'related function' section
of the class documentation. This command is useful for documenting
non-friend functions that are nevertheless strongly coupled to a certain
class. It prevents the need of having to document a file, but
@@ -902,7 +902,7 @@ Structural indicators
\addindex \\relatesalso
This command can be used in the documentation of a non-member function
- \<name\>. It puts the function both inside the `related function' section
+ \<name\>. It puts the function both inside the 'related function' section
of the class documentation as well as leaving it at its normal file documentation
location. This command is useful for documenting
non-friend functions that are nevertheless strongly coupled to a certain
@@ -1845,7 +1845,7 @@ Commands for displaying examples
tag of doxygen's configuration file.
The class and member declarations and definitions inside the code fragment
- are `remembered' during the parsing of the comment block that contained
+ are 'remembered' during the parsing of the comment block that contained
the \\dontinclude command.
For line by line descriptions of source files, one or more lines
@@ -2167,7 +2167,7 @@ Commands for visual enhancements
should also be documented for the copying to work.
To copy the documentation for a member of a
- class for instance one can put the following in the documentation
+ class one can, for instance, put the following in the documentation:
\verbatim
/*! @copydoc MyClass::myfunction()
@@ -2179,7 +2179,7 @@ Commands for visual enhancements
explicitly (without spaces!), like in the following:
\verbatim
- /*! @copydoc MyClass::myfunction(type1,type2) */
+ //! @copydoc MyClass::myfunction(type1,type2)
\endverbatim
Qualified names are only needed if the context in which the documentation
@@ -2188,13 +2188,15 @@ Commands for visual enhancements
The \\copydoc command can be used recursively, but cycles in the \\copydoc
relation will be broken and flagged as an error.
- Note that both the brief description and the detailed documentation
- will be copied. See \ref cmdcopybrief "\\copybrief" and
+ Note that <code>\\copydoc foo()</code> is roughly equivalent to doing:
+\verbatim
+ \brief \copybrief foo()
+ \details \copydetails foo()
+\endverbatim
+ See \ref cmdcopybrief "\\copybrief" and
\ref cmdcopydetails "\\copydetails" for copying only the brief or
detailed part of the comment block.
- \sa sections \ref cmdcopybrief "\\copybrief" and \ref cmdcopydetails "\\copydetails"
-
<hr>
\section cmdcopybrief \\copybrief <link-object>
diff --git a/doc/config.doc b/doc/config.doc
index 677b991..9ec918b 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -202,6 +202,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_man_extension MAN_EXTENSION
\refitem cfg_man_links MAN_LINKS
\refitem cfg_man_output MAN_OUTPUT
+\refitem cfg_markdown_support MARKDOWN_SUPPORT
\refitem cfg_mathjax_extensions MATHJAX_EXTENSIONS
\refitem cfg_mathjax_relpath MATHJAX_RELPATH
\refitem cfg_max_dot_graph_depth MAX_DOT_GRAPH_DEPTH
@@ -459,6 +460,16 @@ followed by the descriptions of the tags grouped by category.
Qt-style will behave just like regular Qt-style comments (thus
requiring an explicit \\brief command for a brief description.)
+\anchor cfg_markdown_support
+<dt>\c MARKDOWN_SUPPORT <dd>
+ \addindex MARKDOWN_SUPPORT
+ If \c MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
+ comments according to the Markdown format, which allows for more readable
+ documentation. See http://daringfireball.net/projects/markdown/ for details.
+ The output of markdown processing is further processed by doxygen, so you
+ can mix doxygen, HTML, and XML commands with Markdown formatting.
+ Disable only in case of backward compatibilities issues.
+
\anchor cfg_builtin_stl_support
<dt>\c BUILTIN_STL_SUPPORT <dd>
\addindex BUILTIN_STL_SUPPORT
@@ -1116,7 +1127,7 @@ AClass::ANamespace, ANamespace::*Test
Note that the wildcards are matched against the file with absolute path,
so to exclude all test directories use the pattern
- <code>*</code><code>/test/</code><code>*</code>
+ `*``/test/``*`
\anchor cfg_example_path
<dt>\c EXAMPLE_PATH <dd>
@@ -1137,8 +1148,8 @@ AClass::ANamespace, ANamespace::*Test
<dt>\c EXAMPLE_PATTERNS <dd>
\addindex EXAMPLE_PATTERNS
If the value of the \c EXAMPLE_PATH tag contains directories, you can use the
- \c EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
- and *.h) to filter out the source-files in the directories. If left
+ \c EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like `*.cpp`
+ and `*.h`) to filter out the source-files in the directories. If left
blank all files are included.
\anchor cfg_image_path
@@ -1168,7 +1179,7 @@ AClass::ANamespace, ANamespace::*Test
The \c FILTER_PATTERNS tag can be used to specify filters on a per file pattern
basis. Doxygen will compare the file name with each pattern and apply the
filter if there is a match. The filters are a list of the form:
- pattern=filter (like <code>*.cpp=my_cpp_filter</code>). See \c INPUT_FILTER for further
+ pattern=filter (like `*.cpp=my_cpp_filter`). See \c INPUT_FILTER for further
info on how filters are used. If \c FILTER_PATTERNS is empty or if
non of the patterns match the file name, \c INPUT_FILTER is applied.
@@ -1186,7 +1197,7 @@ AClass::ANamespace, ANamespace::*Test
The \c FILTER_SOURCE_PATTERNS tag can be used to specify source filters per
file pattern. A pattern will override the setting for \c FILTER_PATTERN (if any)
and it is also possible to disable source filtering for a specific pattern
- using *.ext= (so without naming a filter). This option only has effect when
+ using `*.ext=` (so without naming a filter). This option only has effect when
\c FILTER_SOURCE_FILES is enabled.
</dl>
@@ -1308,7 +1319,7 @@ AClass::ANamespace, ANamespace::*Test
\addindex HTML_OUTPUT
The \c HTML_OUTPUT tag is used to specify where the HTML docs will be put.
If a relative path is entered the value of \c OUTPUT_DIRECTORY will be
- put in front of it. If left blank `html' will be used as the default path.
+ put in front of it. If left blank 'html' will be used as the default path.
\anchor cfg_html_file_extension
<dt>\c HTML_FILE_EXTENSION <dd>
@@ -1778,7 +1789,7 @@ and Class Hierarchy pages using a tree view instead of an ordered list.
Use this tag to change the font size of Latex formulas included
as images in the HTML documentation. The default is 10.
when you change the font size after a successful doxygen run you need
- to manually remove any <code>form_*.png</code> images from the HTML
+ to manually remove any `form_*.png` images from the HTML
output directory to force them to be regenerated.
\anchor cfg_formula_transparent
@@ -1787,7 +1798,7 @@ and Class Hierarchy pages using a tree view instead of an ordered list.
Use the \c FORMULA_TRANPARENT tag to determine whether or not the images
generated for formulas are transparent PNGs. Transparent PNGs are
not supported properly for IE 6.0, but are supported on all modern browsers.
- Note that when changing this option you need to delete any form_*.png files
+ Note that when changing this option you need to delete any `form_*.png` files
in the HTML output before the changes have effect.
\anchor cfg_use_mathjax
@@ -1837,13 +1848,13 @@ MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
The \c LATEX_OUTPUT tag is used to specify where the \f$\mbox{\LaTeX}\f$
docs will be put.
If a relative path is entered the value of \c OUTPUT_DIRECTORY will be
- put in front of it. If left blank `latex' will be used as the default path.
+ put in front of it. If left blank 'latex' will be used as the default path.
\anchor cfg_latex_cmd_name
<dt>\c LATEX_CMD_NAME <dd>
\addindex LATEX_CMD_NAME
The \c LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked.
- If left blank `latex' will be used as the default command name.
+ If left blank 'latex' will be used as the default command name.
Note that when enabling USE_PDFLATEX this option is only used for
generating bitmaps for formulas in the HTML output, but not in the
Makefile that is written to the output directory.
@@ -1852,7 +1863,7 @@ MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
<dt>\c MAKEINDEX_CMD_NAME <dd>
\addindex MAKEINDEX_CMD_NAME
The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
- generate index for LaTeX. If left blank `makeindex' will be used as the
+ generate index for LaTeX. If left blank 'makeindex' will be used as the
default command name.
\anchor cfg_compact_latex
@@ -2039,7 +2050,7 @@ EXTRA_PACKAGES = times
\addindex MAN_OUTPUT
The \c MAN_OUTPUT tag is used to specify where the man pages will be put.
If a relative path is entered the value of \c OUTPUT_DIRECTORY will be
- put in front of it. If left blank `man' will be used as the default path.
+ put in front of it. If left blank 'man' will be used as the default path.
A directory man3 will be created inside the directory specified by
\c MAN_OUTPUT.
@@ -2195,7 +2206,7 @@ EXTRA_PACKAGES = times
<dt>\c INCLUDE_FILE_PATTERNS <dd>
\addindex INCLUDE_FILE_PATTERNS
You can use the \c INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
- patterns (like *.h and *.hpp) to filter out the header-files in the
+ patterns (like `*.h` and `*.hpp`) to filter out the header-files in the
directories. If left blank, the patterns specified with \c FILE_PATTERNS will
be used.
@@ -2234,27 +2245,13 @@ EXTRA_PACKAGES = times
<dt>\c TAGFILES <dd>
\addindex TAGFILES
- The \c TAGFILES tag can be used to specify one or more tagfiles.
-
- See section \ref doxytag_usage for more information about the usage of
- tag files.
-
- Optionally an initial location of the external documentation
- can be added for each tagfile.
- The format of a tag file without this location is as follows:
- <pre>
-TAGFILES = file1 file2 ... </pre>
- Adding location for the tag files is done as follows:
- <pre>
-TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
- where \c loc1 and \c loc2 can be relative or absolute paths or URLs,
- If a location is present for each tag, the installdox tool (see
- section \ref installdox_usage for more information) does not
- have to be run to correct the links.
-
- \par Note:
+ The \c TAGFILES tag can be used to specify one or more tag files.
+
+ See \ref external for more information about the use of tag files.
+
+ \note
Each tag file must have a unique name
- (where the name does \e not include the path)
+ (where the name does \e not include the path).
If a tag file is not located in the directory in which doxygen
is run, you must also specify the path to the tagfile here.
@@ -2263,7 +2260,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
\addindex GENERATE_TAGFILE
When a file name is specified after \c GENERATE_TAGFILE, doxygen will create
a tag file that is based on the input files it reads.
- See section \ref doxytag_usage for more information about the usage of
+ See section \ref external for more information about the usage of
tag files.
\anchor cfg_allexternals
@@ -2284,7 +2281,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
<dt>\c PERL_PATH <dd>
\addindex PERL_PATH
The \c PERL_PATH should be the absolute path and name of the perl script
- interpreter (i.e. the result of `<tt>which perl</tt>').
+ interpreter (i.e. the result of '<tt>which perl</tt>').
</dl>
\section config_dot Dot options
diff --git a/doc/diagrams.doc b/doc/diagrams.doc
index 78fcfbd..0f5c607 100644
--- a/doc/diagrams.doc
+++ b/doc/diagrams.doc
@@ -115,7 +115,7 @@
edge of the arrow is labeled with the variable(s) responsible for the
relation.
Class \c A uses class \c B, if class \c A has a member variable \c m
- of type C, where B is a subtype of C (e.g. C could be \c B, \c B*, <code>T\<B\>*</code> ).
+ of type C, where B is a subtype of C (e.g. `C` could be `B`, `B*`, `T\<B\>*`).
</ul>
diff --git a/doc/doxygen.1 b/doc/doxygen.1
index 37e4adb..deb0c20 100644
--- a/doc/doxygen.1
+++ b/doc/doxygen.1
@@ -43,4 +43,4 @@ If configName is omitted `Doxyfile' will be used as a default.
.SH AUTHOR
Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2011
.SH SEE ALSO
-doxytag(1), doxywizard(1).
+doxywizard(1).
diff --git a/doc/doxygen.sty b/doc/doxygen.sty
index 4bd82f1..44becf8 100644
--- a/doc/doxygen.sty
+++ b/doc/doxygen.sty
@@ -1,40 +1,74 @@
-%
-%
-%
-% Copyright (C) 1997-2011 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
-% granted. No representations are made about the suitability of this software
-% for any purpose. It is provided "as is" without express or implied warranty.
-% See the GNU General Public License for more details.
-%
-% Documents produced by Doxygen are derivative works derived from the
-% input used in their production; they are not affected by this license.
-
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{doxygen}
-\RequirePackage{calc}
+
+% Packages used by this style file
+\RequirePackage{alltt}
\RequirePackage{array}
+\RequirePackage{calc}
+\RequirePackage{color}
+\RequirePackage{fancyhdr}
+\RequirePackage{longtable}
\RequirePackage{verbatim}
-\pagestyle{fancyplain}
-\addtolength{\headwidth}{\marginparsep}
-\addtolength{\headwidth}{\marginparwidth}
-\newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}\cleardoublepage}}
-\lhead[\fancyplain{}{\bfseries\thepage}]
- {\fancyplain{}{\bfseries\rightmark}}
-\rhead[\fancyplain{}{\bfseries\leftmark}]
- {\fancyplain{}{\bfseries\thepage}}
-\rfoot[\fancyplain{}{\bfseries\scriptsize User Manual for Doxygen $VERSION, written by Dimitri van Heesch \copyright 1997-2011}]{}
-\lfoot[]{\fancyplain{}{\bfseries\scriptsize User Manual for Doxygen $VERSION, written by Dimitri van Heesch \copyright 1997-2011}}
-\cfoot{}
+\RequirePackage{ifthen}
+\RequirePackage[table]{xcolor}
+% Use helvetica font instead of times roman
+\RequirePackage{helvet}
+\RequirePackage{sectsty}
+\RequirePackage{tocloft}
+\providecommand{\rmdefault}{phv}
+\providecommand{\bfdefault}{bc}
+
+
+% Setup fancy headings
+\pagestyle{fancyplain}
+\newcommand{\clearemptydoublepage}{%
+ \newpage{\pagestyle{empty}\cleardoublepage}%
+}
+\renewcommand{\chaptermark}[1]{%
+ \markboth{#1}{}%
+}
+\renewcommand{\sectionmark}[1]{%
+ \markright{\thesection\ #1}%
+}
+\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
+\fancyhead[CE]{\fancyplain{}{}}
+\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
+\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
+\fancyhead[CO]{\fancyplain{}{}}
+\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
+\fancyfoot[LE]{\fancyplain{}{}}
+\fancyfoot[CE]{\fancyplain{}{}}
+\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated on Fri Dec 16 2011 21\-:40\-:27 for My Project by Doxygen }}
+\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated on Fri Dec 16 2011 21\-:40\-:27 for My Project by Doxygen }}
+\fancyfoot[CO]{\fancyplain{}{}}
+\fancyfoot[RO]{\fancyplain{}{}}
%---------- Internal commands used in this style file ----------------
+\newcommand\tabfill[1]{%
+ \dimen@\linewidth%
+ \advance\dimen@\@totalleftmargin%
+ \advance\dimen@-\dimen\@curtab%
+ \parbox[t]\dimen@{\raggedright #1\ifhmode\strut\fi}%
+}
+
+\newcommand{\ensurespace}[1]{%
+ \begingroup
+ \setlength{\dimen@}{#1}%
+ \vskip\z@\@plus\dimen@
+ \penalty -100\vskip\z@\@plus -\dimen@
+ \vskip\dimen@
+ \penalty 9999%
+ \vskip -\dimen@
+ \vskip\z@skip % hide the previous |\vskip| from |\addvspace|
+ \endgroup
+}
+
% 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]{%
+ \ensurespace{4\baselineskip}%
\begin{list}{}%
{%
\settowidth{\labelwidth}{40pt}%
@@ -43,7 +77,7 @@
\setlength{\itemsep}{-4pt}%
\renewcommand{\makelabel}{\entrylabel}%
}%
- \item[#1:]%
+ \item[#1]%
}{%
\end{list}%
}
@@ -177,6 +211,13 @@
\end{DoxyDesc}%
}
+% Used by @copyright
+\newenvironment{DoxyCopyright}[1]{%
+ \begin{DoxyDesc}{#1}%
+}{%
+ \end{DoxyDesc}%
+}
+
% Used by @remark
\newenvironment{DoxyRemark}[1]{%
\begin{DoxyDesc}{#1}%
@@ -221,9 +262,8 @@
% Used by @internal
\newenvironment{DoxyInternal}[1]{%
- \begin{DoxyDesc}{#1}%
+ \paragraph*{#1}%
}{%
- \end{DoxyDesc}%
}
% Used by @par and @paragraph
@@ -242,19 +282,62 @@
}
% Used by parameter lists
-\newenvironment{DoxyParams}[1]{%
+\newenvironment{DoxyParams}[2][]{%
+ \begin{DoxyDesc}{#2}%
+ \item[] \hspace{\fill} \vspace{-40pt}%
+ \settowidth{\labelwidth}{40pt}%
+ \setlength{\LTleft}{0pt}%
+ \setlength{\tabcolsep}{0.01\textwidth}%
+ \ifthenelse{\equal{#1}{}}%
+ {\begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
+ p{0.815\textwidth}|}}%
+ {\ifthenelse{\equal{#1}{1}}%
+ {\begin{longtable}{|>{\centering}p{0.10\textwidth}|%
+ >{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
+ p{0.685\textwidth}|}}%
+ {\begin{longtable}{|>{\centering}p{0.10\textwidth}|%
+ >{\centering\hspace{0pt}}p{0.15\textwidth}|%
+ >{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
+ p{0.515\textwidth}|}}%
+ }\hline%
+}{%
+ \end{longtable}%
+ \end{DoxyDesc}%
+}
+
+% Used for fields of simple structs
+\newenvironment{DoxyFields}[1]{%
\begin{DoxyDesc}{#1}%
- \begin{description}%
+ \item[] \hspace{\fill} \vspace{-40pt}%
+ \settowidth{\labelwidth}{40pt}%
+ \setlength{\LTleft}{0pt}%
+ \setlength{\tabcolsep}{0.01\textwidth}%
+ \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
+ p{0.15\textwidth}|%
+ p{0.635\textwidth}|}%
+ \hline%
}{%
- \end{description}%
+ \end{longtable}%
\end{DoxyDesc}%
}
+% is used for parameters within a detailed function description
+\newenvironment{DoxyParamCaption}{%
+ \renewcommand{\item}[2][]{##1 {\em ##2}}%
+ }{%
+}
+
% Used by return value lists
\newenvironment{DoxyRetVals}[1]{%
\begin{DoxyDesc}{#1}%
\begin{description}%
+ \item[] \hspace{\fill} \vspace{-25pt}%
+ \setlength{\tabcolsep}{0.01\textwidth}%
+ \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
+ p{0.77\textwidth}|}%
+ \hline%
}{%
+ \end{longtable}%
\end{description}%
\end{DoxyDesc}%
}
@@ -263,7 +346,16 @@
\newenvironment{DoxyExceptions}[1]{%
\begin{DoxyDesc}{#1}%
\begin{description}%
+ \item[] \hspace{\fill} \vspace{-25pt}%
+ \definecolor{tableShade}{HTML}{F8F8F8}%
+ \rowcolors{1}{white}{tableShade}%
+ \arrayrulecolor{gray}%
+ \setlength{\tabcolsep}{0.01\textwidth}%
+ \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
+ p{0.77\textwidth}|}%
+ \hline%
}{%
+ \end{longtable}%
\end{description}%
\end{DoxyDesc}%
}
@@ -272,7 +364,16 @@
\newenvironment{DoxyTemplParams}[1]{%
\begin{DoxyDesc}{#1}%
\begin{description}%
+ \item[] \hspace{\fill} \vspace{-25pt}%
+ \definecolor{tableShade}{HTML}{F8F8F8}%
+ \rowcolors{1}{white}{tableShade}%
+ \arrayrulecolor{gray}%
+ \setlength{\tabcolsep}{0.01\textwidth}%
+ \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
+ p{0.77\textwidth}|}%
+ \hline%
}{%
+ \end{longtable}%
\end{description}%
\end{DoxyDesc}%
}
@@ -284,12 +385,12 @@
\setlength{\itemsep}{0pt}
\setlength{\parsep}{0pt}
\setlength{\topsep}{0pt}
- \renewcommand{\makelabel}{}}}
+ \renewcommand{\makelabel}{\hfill}}}
{\end{list}}
\newenvironment{DoxyCompactItemize}
{
\begin{itemize}
- \setlength{\itemsep}{-4pt}
+ \setlength{\itemsep}{-3pt}
\setlength{\parsep}{0pt}
\setlength{\topsep}{0pt}
\setlength{\partopsep}{0pt}
@@ -306,7 +407,8 @@
}
{\end{tabular*}\par}
\newcommand{\entrylabel}[1]{
- {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\\}}}
+ {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{%
+ \usefont{OT1}{phv}{bc}{n}\color{darkgray}#1}\vspace{1.5\baselineskip}}}}
\newenvironment{Desc}
{\begin{list}{}
{
@@ -318,6 +420,63 @@
}
}
{\end{list}}
+\newsavebox{\xrefbox}
+\newlength{\xreflength}
+\newcommand{\xreflabel}[1]{%
+ \sbox{\xrefbox}{#1}%
+ \setlength{\xreflength}{\wd\xrefbox}%
+ \ifthenelse{\xreflength>\labelwidth}{%
+ \begin{minipage}{\textwidth}%
+ \setlength{\parindent}{0pt}%
+ \hangindent=15pt\bfseries #1\vspace{1.2\itemsep}%
+ \end{minipage}%
+ }{%
+ \parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}%
+ }}%
+\newenvironment{DoxyRefList}{%
+ \begin{list}{}{%
+ \setlength{\labelwidth}{10pt}%
+ \setlength{\leftmargin}{\labelwidth}%
+ \addtolength{\leftmargin}{\labelsep}%
+ \renewcommand{\makelabel}{\xreflabel}%
+ }%
+ }%
+{\end{list}}
+\newenvironment{DoxyRefDesc}[1]
+{\begin{list}{}{%
+ \renewcommand\makelabel[1]{\textbf{##1}}
+ \settowidth\labelwidth{\makelabel{#1}}
+ \setlength\leftmargin{\labelwidth+\labelsep}}}
+{\end{list}}
+\newenvironment{Indent}
+ {\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
+ \item[]\ignorespaces}
+ {\unskip\end{list}}
\setlength{\parindent}{0cm}
\setlength{\parskip}{0.2cm}
-\sloppy
+\addtocounter{secnumdepth}{2}
+\usepackage[T1]{fontenc}
+\makeatletter
+\renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}%
+ {-1.0ex}%
+ {1.0ex}%
+ {\usefont{OT1}{phv}{bc}{n}\color{darkgray}}}
+\renewcommand{\subparagraph}{\@startsection{subparagraph}{5}{0ex}%
+ {-1.0ex}%
+ {1.0ex}%
+ {\usefont{OT1}{phv}{bc}{n}\color{darkgray}}}
+\makeatother
+\allsectionsfont{\usefont{OT1}{phv}{bc}{n}\selectfont\color{darkgray}}
+\stepcounter{secnumdepth}
+\stepcounter{tocdepth}
+\definecolor{comment}{rgb}{0.5,0.0,0.0}
+\definecolor{keyword}{rgb}{0.0,0.5,0.0}
+\definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
+\definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
+\definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
+\definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
+\definecolor{charliteral}{rgb}{0.0,0.5,0.5}
+\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
+\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
+\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
+\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}
diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex
index 9dfd459..010ba4c 100644
--- a/doc/doxygen_manual.tex
+++ b/doc/doxygen_manual.tex
@@ -12,30 +12,55 @@
% Documents produced by Doxygen are derivative works derived from the
% input used in their production; they are not affected by this license.
-\documentclass[a4paper]{report}
+\documentclass[a4paper]{book}
\usepackage{makeidx}
-\usepackage{fancyhdr}
-\usepackage{float}
-\usepackage{longtable}
+\usepackage{natbib}
\usepackage{graphicx}
-\usepackage{epsf}
-\usepackage{doxygen}
\usepackage{multicol}
-\usepackage{times}
+\usepackage{float}
+\usepackage{listings}
+\usepackage{color}
+\usepackage{ifthen}
+\usepackage[table]{xcolor}
+\usepackage{textcomp}
\usepackage{alltt}
-\usepackage{tocloft}
+\usepackage{ifpdf}
+\ifpdf
\usepackage[pdftex,
pagebackref=true,
colorlinks=true,
- linkcolor=blue
+ linkcolor=blue,
+ unicode
]{hyperref}
+\else
+\usepackage[ps2pdf,
+ pagebackref=true,
+ colorlinks=true,
+ linkcolor=blue,
+ unicode
+ ]{hyperref}
+\usepackage{pspicture}
+\fi
+\usepackage[utf8]{inputenc}
+\usepackage{mathptmx}
+\usepackage[scaled=.90]{helvet}
+\usepackage{courier}
+\usepackage{sectsty}
+\usepackage[titles]{tocloft}
+\usepackage{doxygen}
+\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left }
\makeindex
-\setcounter{tocdepth}{1}
+\setcounter{tocdepth}{3}
\renewcommand{\footrulewidth}{0.4pt}
+\renewcommand{\familydefault}{\sfdefault}
\renewcommand{\cftsecindent}{0 em}
\renewcommand{\cftsecnumwidth}{3.2 em}
\renewcommand{\cftsubsecindent}{3.2 em}
\newcommand{\thisyear}{\the\year}
+\hfuzz=15pt
+\setlength{\emergencystretch}{15pt}
+\hbadness=750
+\tolerance=750
\begin{document}
\begin{titlepage}
\includegraphics[width=\textwidth]{doxygen_logo}
@@ -70,9 +95,7 @@ Written by Dimitri van Heesch\\[2ex]
\part{Reference Manual}
\chapter{Features}\label{features}\hypertarget{features}{}\input{features}
\chapter{Doxygen usage}\label{doxygen_usage}\hypertarget{doxygen_usage}{}\input{doxygen_usage}
-\chapter{Doxytag usage}\label{doxytag_usage}\hypertarget{doxytag_usage}{}\input{doxytag_usage}
\chapter{Doxywizard usage}\label{doxywizard_usage}\hypertarget{doxywizard_usage}{}\input{doxywizard_usage}
-\chapter{Installdox usage}\label{installdox_usage}\hypertarget{installdox_usage}{}\input{installdox_usage}
\chapter{Configuration}\label{config}\hypertarget{config}{}\input{config}
\chapter{Special Commands}\label{commands}\hypertarget{commands}{}\input{commands}
\chapter{HTML commands}\label{htmlcmds}\hypertarget{htmlcmds}{}\input{htmlcmds}
diff --git a/doc/doxytag.1 b/doc/doxytag.1
deleted file mode 100644
index a28879a..0000000
--- a/doc/doxytag.1
+++ /dev/null
@@ -1,21 +0,0 @@
-.TH DOXYTAG "1" "DATE" "doxytag VERSION" "User Commands"
-.SH NAME
-doxytag \- generates a tag file and/or a search index for a set of HTML files
-.SH SYNOPSIS
-.B doxytag
-[\fI-t tag_file\fR] [\fI-s index_file\fR] [ \fIhtml_file \fR[\fIhtml_file\fR...] ]
-.SH DESCRIPTION
-Generates a tag file and/or a search index for a set of HTML files. Use
-doxysearch as a CGI program to search the tag file generated by doxytag.
-.SH OPTIONS
-.TP
-\fB\-t\fR <tag_file>
-Generate tag file <tag_file>.
-.TP
-\fB\-s\fR <index_file>
-Generate search index <index_file>.
-.PP
-If no HTML files are given all files in the current dir that
-have a .html extension are parsed.
-.SH SEE ALSO
-doxygen(1), doxywizard(1).
diff --git a/doc/doxytag_usage.doc b/doc/doxytag_usage.doc
deleted file mode 100644
index 25d45fd..0000000
--- a/doc/doxytag_usage.doc
+++ /dev/null
@@ -1,97 +0,0 @@
-/******************************************************************************
- *
- *
- *
- * Copyright (C) 1997-2011 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
- * granted. No representations are made about the suitability of this software
- * for any purpose. It is provided "as is" without express or implied warranty.
- * See the GNU General Public License for more details.
- *
- * Documents produced by Doxygen are derivative works derived from the
- * input used in their production; they are not affected by this license.
- *
- */
-/*! \page doxytag_usage Doxytag usage
-
-Doxytag is a small command line based utility.
-It can generate <em>tag files</em>.
-These tag files can be used with <a href="doxygen_usage.html">doxygen</a>
-to generate references to external documentation
-(i.e. documentation not contained in the input files that are used by
-doxygen).
-
-A tag file contains information about files, classes and members
-documented in external documentation. Doxytag extracts this information
-directly from the HTML files. This has the advantage that you do not need
-to have the sources from which the documentation was extracted.
-
-If you \e do have the sources it is better to let \c doxygen generate the
-tag file by putting the name of the tag file after
-\ref cfg_generate_tagfile "GENERATE_TAGFILE" in
-the configuration file.
-
-The input of doxytag consists of a set of HTML files.
-
-\par Important:
- If you use tag files, the links that
- are generated by doxygen will contain \e dummy links. You have to run
- the \c installdox script to change these dummy links into real links.
- See \ref installdox_usage for more information.
- The use of dummy links may seem redundant, but it is really useful,
- if you want to move the external documentation to another location.
- Then the documentation does not need to be regenerated by \c doxygen,
- only \c installdox has to be run.
-
-\par Note:
- Because the HTML files are expected to have a certain
- structure, only HTML files generated with doxygen or with Qt's class
- browser generator can be used. Doxytag only <em>reads</em> the HTML files,
- they are not altered in any way.
-
-Doxytag expects a list of all HTML files that form the documentation
-or a directory that contains all HTML files. If neither is present doxytag
-will read all files with a <tt>.html</tt> extension from the current directory.
-If doxytag is used with the <code>-t</code> flag it generates a tag file.
-
-\par Example 1:
- Suppose the file \c example.cpp from the \c examples directory that is listed
- below is included in some package for which you do not have the sources.
- Fortunately, the distributor of the packages included the HTML documentation
- that was generated by doxygen in the package.
- \verbinclude example.cpp
- Now you can create a tag file from the HTML files in the package by
- typing:
-\verbatim
-doxytag -t example.tag example/html
-\endverbatim
- from the examples directory.
- Finally you can use this tag file with your own piece of code, such
- as done in the following example:
- \verbinclude tag.cpp
- Doxygen will now include links to the external package in your own
- documentation. Because the tag file does not specify where the
- documentation is located, you will have to specify that by running the
- installdox script that doxygen generates
- (See section \ref installdox_usage for more information).
-
- Note that this is actually a feature because if you (or someone else)
- moves the external documentation to a different
- directory or URL you can simply run the script again and all links in
- the HTML files will be updated.
-
- \htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/tag/html/index.html">here</a>
- for the corresponding HTML documentation that is generated by Doxygen using
- only the tag file and second piece of code.
- \endhtmlonly
-
-\par Example 2:
- To generate a tag file of the Qt documentation you can do the following:
-\verbatim
-doxytag -t qt.tag $QTDIR/doc/html
-\endverbatim
-
-*/
diff --git a/doc/doxywizard.1 b/doc/doxywizard.1
index 4195cbb..a209f21 100644
--- a/doc/doxywizard.1
+++ b/doc/doxywizard.1
@@ -7,4 +7,4 @@ doxywizard \- a tool to configure and run doxygen on your source files
Doxywizard is an interactive frontend to the doxygen tool to configure
and run doxygen on your source files.
.SH SEE ALSO
-doxygen(1), doxytag(1).
+doxygen(1)
diff --git a/doc/external.doc b/doc/external.doc
index a1be8b1..2a6426e 100644
--- a/doc/external.doc
+++ b/doc/external.doc
@@ -58,21 +58,15 @@ To combine the output of one or more external projects with your own project
you should specify the name of the tag files after
the \ref cfg_tagfiles "TAGFILES" option in the configuration file.
-A tag file does not contain information about where the external documentation
-is located. This could be a directory or an URL. So when you include a tag
-file you have to specify where the external documentation is located.
-There are two ways to do this:
-<dl>
-<dt>At configuration time:<dd> just assign the location of the output to the
- tag files specified after the \ref cfg_tagfiles "TAGFILES" configuration
- option. If you use a relative path it should be relative with respect to
- the directory where the HTML output of your project is generated.
-<dt>After compile time:<dd> if you do not assign a location to a tag file,
- doxygen will generate dummy links for all external HTML references. It will
- also generate a perl script called \ref installdox_usage "installdox" in
- the HTML output directory. This script should be run to replace the
- dummy links with real links for all generated HTML files.
-</dl>
+A tag file typically only contains a relative location of the documentation from the
+point where doxygen was run. So when you include a tag file in other project
+you have to specify where the external documentation is located in relation this project.
+You can do this in the configuration file by assigning the (relative) location to the
+tag files specified after the \ref cfg_tagfiles "TAGFILES" configuration
+option. If you use a relative path it should be relative with respect to
+the directory where the HTML output of your project is generated; so a relative path
+from the HTML output directory of a project to the HTML output of the other project that
+is linked to.
\par Example:
Suppose you have a project \c proj that uses two external
@@ -118,18 +112,6 @@ OUTPUT_DIRECTORY = ext2
GENERATE_TAGFILE = ext2/ext2.tag
\endverbatim
-In some (hopefully exceptional) cases you may have the documentation
-generated by doxygen, but not the sources nor a tag file. In this case you
-can use the \ref doxytag_usage "doxytag" tool to extract a tag file from
-the generated HTML sources. Another case where you should use doxytag is
-if you want to create a tag file for the Qt documentation.
-
-The tool \c doxytag depends on the particular structure
-of the generated output and on some special markers that are generated by
-doxygen. Since this type of extraction is brittle and error-prone I
-suggest you only use this approach if there is no alternative. The
-doxytag tool may even become obsolete in the future.
-
\htmlonly
Go to the <a href="faq.html">next</a> section or return to the
<a href="index.html">index</a>.
diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc
index 1327246..aa03498 100644
--- a/doc/htmlcmds.doc
+++ b/doc/htmlcmds.doc
@@ -30,6 +30,8 @@ of a HTML tag are passed on to the HTML output only
<li><tt>\</A\></tt> Ends a link or anchor
<li><tt>\<B\></tt> Starts a piece of text displayed in a bold font.
<li><tt>\</B\></tt> Ends a <tt>\<B\></tt> section.
+<li><tt>\<BLOCKQUOTE\></tt> Starts a quotation block.
+<li><tt>\</BLOCKQUOTE\></tt> Ends the quotation block.
<li><tt>\<BODY\></tt> Does not generate any output.
<li><tt>\</BODY\></tt> Does not generate any output.
<li><tt>\<BR\></tt> Forces a line break.
diff --git a/doc/index.doc b/doc/index.doc
index fca1bd3..9d10829 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -88,10 +88,7 @@ The second part forms a reference manual:
<ul>
<li>Section \ref features presents an overview of what doxygen can do.
<li>Section \ref doxygen_usage shows how to use the \c doxygen program.
-<li>Section \ref doxytag_usage shows how to use the \c doxytag program.
<li>Section \ref doxywizard_usage shows how to use the \c doxywizard program.
-<li>Section \ref installdox_usage shows how to use the \c installdox
- script that is generated by doxygen if you use tag files.
<li>Section \ref config shows how to fine-tune doxygen, so it
generates the documentation you want.
<li>Section \ref commands shows an overview of the special commands that can be
diff --git a/doc/infoflow.eps b/doc/infoflow.eps
index dd7f799..f11b1fc 100644
--- a/doc/infoflow.eps
+++ b/doc/infoflow.eps
@@ -1,11 +1,12 @@
-%!PS-Adobe-2.0 EPSF-2.0
+%!PS-Adobe-3.0 EPSF-3.0
%%Title: infoflow.fig
-%%Creator: fig2dev Version 3.2 Patchlevel 5
-%%CreationDate: Sun Aug 17 14:52:37 2008
-%%For: dimitri@macbook.home.nl (Dimitri Van Heesch)
+%%Creator: fig2dev Version 3.2 Patchlevel 5d
+%%CreationDate: Thu Dec 29 10:46:41 2011
+%%For: dimitri@macbookpro (Dimitri van Heesch)
%%BoundingBox: 0 0 661 582
%Magnification: 1.0000
%%EndComments
+%%BeginProlog
/$F2psDict 200 dict def
$F2psDict begin
$F2psDict /mtrx matrix put
@@ -46,10 +47,6 @@ $F2psDict /mtrx matrix put
/col33 {0.000 0.000 0.000 srgb} bind def
end
-save
-newpath 0 582 moveto 0 0 lineto 661 0 lineto 661 582 lineto closepath clip newpath
--53.3 599.2 translate
-1 -1 scale
/cp {closepath} bind def
/ef {eofill} bind def
@@ -123,10 +120,22 @@ newfontname newfont definefont pop end } def
/$F2psBegin {$F2psDict begin /$F2psEnteredState save def} def
/$F2psEnd {$F2psEnteredState restore end} def
+/pageheader {
+save
+newpath 0 582 moveto 0 0 lineto 661 0 lineto 661 582 lineto closepath clip newpath
+-53.3 599.2 translate
+1 -1 scale
$F2psBegin
10 setmiterlimit
0 slj 0 slc
0.06000 0.06000 sc
+} bind def
+/pagefooter {
+$F2psEnd
+restore
+} bind def
+%%EndProlog
+pageheader
%
% Fig objects follow
%
@@ -412,32 +421,11 @@ n 7875 9150 m
% arrowhead
n 8864 9180 m 8984 9150 l 8864 9120 l 8864 9180 l cp gs 0.00 setgray ef gr col0 s
% Polyline
-n 3300 8850 m 5100 8850 l 5100 9525 l 3300 9525 l
- cp gs col32 1.00 shd ef gr gs col0 s gr
-% Polyline
-gs clippath
-5236 9270 m 5085 9270 l 5085 9330 l 5236 9330 l 5236 9330 l 5116 9300 l 5236 9270 l cp
-eoclip
-n 6675 9300 m
- 5100 9300 l gs col0 s gr gr
-
-% arrowhead
-n 5236 9270 m 5116 9300 l 5236 9330 l 5236 9270 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
[60] 0 sd
n 8700 6450 m 11850 6450 l 11850 9975 l 8700 9975 l
cp gs col0 s gr [] 0 sd
% Polyline
gs clippath
-4305 7261 m 4305 7110 l 4245 7110 l 4245 7261 l 4245 7261 l 4275 7141 l 4305 7261 l cp
-eoclip
-n 4275 8850 m
- 4275 7125 l gs col0 s gr gr
-
-% arrowhead
-n 4305 7261 m 4275 7141 l 4245 7261 l 4305 7261 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
4845 1514 m 4845 1665 l 4905 1665 l 4905 1514 l 4905 1514 l 4875 1634 l 4845 1514 l cp
4905 1186 m 4905 1035 l 4845 1035 l 4845 1186 l 4845 1186 l 4875 1066 l 4905 1186 l cp
eoclip
@@ -551,12 +539,6 @@ gs 1 -1 sc (HTML) col0 sh gr
6975 9300 m
gs 1 -1 sc (pages) col0 sh gr
/Times-Roman-iso ff 200.00 scf sf
-5475 9525 m
-gs 1 -1 sc (parse) col0 sh gr
-/Times-Roman-iso ff 200.00 scf sf
-3825 9300 m
-gs 1 -1 sc (Doxytag) col0 sh gr
-/Times-Roman-iso ff 200.00 scf sf
8775 6675 m
gs 1 -1 sc (Windows only) col0 sh gr
/Times-Roman-iso ff 200.00 scf sf
@@ -569,9 +551,6 @@ gs 1 -1 sc (Sources) col0 sh gr
1275 5775 m
gs 1 -1 sc (Custom) col0 sh gr
/Times-Roman-iso ff 200.00 scf sf
-4350 8175 m
-gs 1 -1 sc (generate) col0 sh gr
-/Times-Roman-iso ff 200.00 scf sf
3675 1350 m
gs 1 -1 sc (generate/edit) col0 sh gr
/Times-Roman-iso ff 200.00 scf sf
@@ -639,8 +618,7 @@ n 900 3675 m 1200 3375 l 2100 3375 l 2100 4875 l 900 4875 l 900 3675 l
1200 3675 l
1200 3375 l gs col0 s gr
% here ends figure;
-$F2psEnd
-rs
+pagefooter
showpage
%%Trailer
%EOF
diff --git a/doc/infoflow.fig b/doc/infoflow.fig
index d09c571..9db91af 100644
--- a/doc/infoflow.fig
+++ b/doc/infoflow.fig
@@ -1,4 +1,4 @@
-#FIG 3.2 Produced by xfig version 3.2.5
+#FIG 3.2 Produced by xfig version 3.2.5b
Landscape
Center
Inches
@@ -158,16 +158,8 @@ Single
2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2
1 1 1.00 60.00 120.00
7875 9150 9000 9150
-2 2 0 1 0 32 50 0 20 0.000 0 0 -1 0 0 5
- 3300 8850 5100 8850 5100 9525 3300 9525 3300 8850
-2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2
- 1 1 1.00 60.00 120.00
- 6675 9300 5100 9300
2 2 1 1 0 7 50 0 -1 4.000 0 0 -1 0 0 5
8700 6450 11850 6450 11850 9975 8700 9975 8700 6450
-2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2
- 1 1 1.00 60.00 120.00
- 4275 8850 4275 7125
2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 1 2
1 1 1.00 60.00 120.00
1 1 1.00 60.00 120.00
@@ -209,13 +201,10 @@ Single
4 0 0 50 0 0 12 0.0000 4 150 390 11025 3825 PDF\001
4 0 0 50 0 0 12 0.0000 4 150 615 6975 9075 HTML\001
4 0 0 50 0 0 12 0.0000 4 150 510 6975 9300 pages\001
-4 0 0 50 0 0 12 0.0000 4 150 480 5475 9525 parse\001
-4 0 0 50 0 0 12 0.0000 4 195 735 3825 9300 Doxytag\001
4 0 0 50 0 0 12 0.0000 4 195 1215 8775 6675 Windows only\001
4 0 0 50 0 0 12 0.0000 4 150 390 8250 1200 read\001
4 0 0 50 0 0 12 0.0000 4 150 705 1200 4200 Sources\001
4 0 0 50 0 0 12 0.0000 4 150 675 1275 5775 Custom\001
-4 0 0 50 0 0 12 0.0000 4 165 765 4350 8175 generate\001
4 0 0 50 0 0 12 0.0000 4 195 1140 3675 1350 generate/edit\001
4 0 0 50 0 0 12 0.0000 4 195 1050 4425 750 Doxywizard\001
4 0 0 50 0 0 12 0.0000 4 150 390 4050 3525 read\001
diff --git a/doc/infoflow.gif b/doc/infoflow.gif
index 4bd30c5..82fc46e 100644
--- a/doc/infoflow.gif
+++ b/doc/infoflow.gif
Binary files differ
diff --git a/doc/install.doc b/doc/install.doc
index b2dd559..6524750 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -130,8 +130,8 @@ Compilation is now done by performing the following steps:
make
\endverbatim
- The program should compile without problems and three binaries
- (<code>doxygen</code> and <code>doxytag</code>)
+ The program should compile without problems and the binaries
+ (<code>doxygen</code> and optionally <code>doxywizard</code>)
should be available in the bin directory of the distribution.
<li>Optional: Generate the user manual.
@@ -319,8 +319,7 @@ dlopen /usr/lib/libc.a(nss_deffinder.o)
\endverbatim
Manually adding <code>-Bdynamic</code> after the target rule in
-<code>Makefile.doxygen</code> and <code>Makefile.doxytag</code>
-will fix this:
+<code>Makefile.doxygen</code> will fix this:
\verbatim
$(TARGET): $(OBJECTS) $(OBJMOC)
@@ -395,7 +394,7 @@ tar xvf doxygen-x.y.z.src.tar
\endverbatim
to unpack the sources.
-Now your environment is setup to build \c doxygen and \c doxytag.
+Now your environment is setup to build \c doxygen.
Inside the \c doxygen-x.y.z directory you will find a \c winbuild directory
containing a \c Doxygen.sln file. Open this file in Visual Studio.
@@ -487,10 +486,10 @@ Here is what is required:
steps.
<li>From Doxygen-1.2.2-20001015 onwards, the distribution includes the part
- of Qt that is needed for to compile doxygen and doxytag,
+ of Qt that is needed for to compile doxygen.
The Windows specific part were also created.
As a result doxygen (without the wizard) can be compiled on systems
- without X11 or the (commerical) version of Qt.
+ without X11 or (the commerical version of) Qt.
<li>If you used WinZip to extract the tar archive it will (apparently) not
create empty folders, so you have to add the folders
@@ -521,9 +520,8 @@ Compilation is now done by performing the following steps:
make.bat msvc
\endverbatim
- This should build the executables
- <code>doxygen.exe</code> and <code>doxytag.exe</code>
- using Microsoft's Visual C++ compiler
+ This should build the executable
+ <code>doxygen.exe</code> using Microsoft's Visual C++ compiler
(The compiler should not produce any serious warnings or errors).
You can use also the <code>bcc</code> argument to build
diff --git a/doc/installdox_usage.doc b/doc/installdox_usage.doc
deleted file mode 100644
index a93ca0a..0000000
--- a/doc/installdox_usage.doc
+++ /dev/null
@@ -1,59 +0,0 @@
-/******************************************************************************
- *
- *
- *
- * Copyright (C) 1997-2011 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
- * granted. No representations are made about the suitability of this software
- * for any purpose. It is provided "as is" without express or implied warranty.
- * See the GNU General Public License for more details.
- *
- * Documents produced by Doxygen are derivative works derived from the
- * input used in their production; they are not affected by this license.
- *
- */
-/*! \page installdox_usage Installdox usage
-
-Installdox is a perl script that is generated by doxygen whenever
-tag files are used (See \c TAGFILES
-in section \ref config_extref). The script is
-located in the same directory where the HTML files are located.
-
-Its purpose is to set the location of the external documentation
-for each tag file at install time.
-
-Calling \c installdox with option <b>-h</b> at the command line
-will give you a brief description of the usage of the program.
-
-The following options are available:
-<dl>
-<dt><b>-l <tt>\<tagfile\>\@\<location\></tt></b><dd>
- Each tag file contains information about the files, classes and members
- documented in a set of HTML files. A user can install these
- HTML files anywhere on his/her hard disk or web site.
- Therefore installdox \e requires the location of the
- documentation for each tag file <tt>\<tagfile\></tt>
- that is used by doxygen. The location <tt>\<location\></tt> can be
- an absolute path or a URL.
-
- \par Note:
- Each \<tagfile\> must be unique and should only be the name of the
- file, not including the path.
-
-<dt><b>-q</b><dd>
- When this option is specified, installdox will generate no output other
- than fatal errors.
-</dl>
-Optionally a list of HTML files may be given.
-These files are scanned and modified if needed.
-If this list is omitted all files in the current directory
-that end with \c .html are used.
-
-The \c installdox script is unique for each generated class browser
-in the sense that it `knows' what tag files are used. It will generate an error if
-the <b>-l</b> option is missing for a tag file or if an invalid tag file
-is given.
-
-*/
diff --git a/doc/lists.doc b/doc/lists.doc
index f5f9f96..f72957e 100644
--- a/doc/lists.doc
+++ b/doc/lists.doc
@@ -4,9 +4,13 @@ Doxygen provides a number of ways to create lists of items.
<b>Using dashes</b>
- By putting a number of column-aligned minus signs at the start of a
- line, a bullet list will automatically be generated.
- Numbered lists can also be generated by using a minus followed by a hash.
+ By putting a number of column-aligned minus (-) signs at the start of a
+ line, a bullet list will automatically be generated. Instead of the minus
+ sign also plus (+) or asterix (\*) can be used.
+
+ Numbered lists can also be generated by using a minus followed by a hash
+ or by using a number followed by a dot.
+
Nesting of lists is allowed and is based on indentation of the items.<p>
Here is an example:
\verbatim
@@ -18,8 +22,8 @@ Doxygen provides a number of ways to create lists of items.
* More info about the click event.
* -# mouse double click event
* - keyboard events
- * -# key down event
- * -# key up event
+ * 1. key down event
+ * 2. key up event
*
* More text here.
*/
@@ -33,8 +37,8 @@ Doxygen provides a number of ways to create lists of items.
More info about the click event.
-# mouse double click event
- keyboard events
- -# key down event
- -# key up event
+ 1. key down event
+ 2. key up event
More text here.
@@ -43,7 +47,7 @@ that \ref cfg_tab_size "TAB_SIZE" in the configuration file is set to
the correct tab size.
You can end a list by starting a new paragraph or
-by putting a dot (.) on an empty line at the same indent level as the
+by putting a dot (.) on an empty line at the same indentation level as the
list you would like to end.
Here is an example that speaks for itself:
@@ -57,9 +61,11 @@ Here is an example that speaks for itself:
* - sub sub item 2
* .
* The dot above ends the sub sub item list.
+ *
* More text for the first sub item
* .
* The dot above ends the first sub item.
+ *
* More text for the first list item
* - sub item 2
* - sub item 3
@@ -74,8 +80,7 @@ Here is an example that speaks for itself:
<b>Using HTML commands</b>
If you like you can also use HTML commands inside the documentation
-blocks. Using these commands has the advantage that it is more natural
-for list items that consist of multiple paragraphs.
+blocks.
Here is the above example with HTML commands:
\verbatim
@@ -85,7 +90,7 @@ Here is the above example with HTML commands:
* <li> mouse events
* <ol>
* <li>mouse move event
- * <li>mouse click event\n
+ * <li>mouse click event<br>
* More info about the click event.
* <li>mouse double click event
* </ol>
diff --git a/doc/starting.doc b/doc/starting.doc
index caed175..4e60d3a 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -20,11 +20,6 @@ The executable \c doxygen is the main program that parses the sources and
generates the documentation. See section \ref doxygen_usage for more
detailed usage information.
-The executable \c doxytag is only needed if you want to generate references
-to external documentation (i.e. documentation that was generated by doxygen)
-for which you do not have the sources. See section \ref doxytag_usage
-for more detailed usage information.
-
Optionally, the executable \c doxywizard can be used, which is a
\ref doxywizard_usage "graphical front-end" for editing the configuration file
that is used by doxygen and for running doxygen in a graphical environment.
generated by cgit v0.12 at 2024-11-05 02:58:11 (GMT)