summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile8
-rw-r--r--doc/commands.doc19
-rw-r--r--doc/config.doc369
-rw-r--r--doc/doxygen_usage.doc3
-rw-r--r--doc/doxytag_usage.doc65
-rw-r--r--doc/index.doc1
-rw-r--r--doc/infoflow.eps86
-rw-r--r--doc/infoflow.fig32
-rw-r--r--doc/infoflow.gifbin13193 -> 12508 bytes
-rw-r--r--doc/install.doc12
-rw-r--r--doc/language.doc269
-rw-r--r--doc/starting.doc19
-rw-r--r--doc/trouble.doc35
13 files changed, 528 insertions, 390 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile
index acfec34..7af4228 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -34,7 +34,7 @@ IMAGE_PATH = .
INPUT = index.doc install.doc starting.doc docblocks.doc lists.doc \
grouping.doc formulas.doc diagrams.doc preprocessing.doc \
external.doc faq.doc trouble.doc history.doc features.doc \
- doxygen_usage.doc doxytag_usage.doc doxysearch_usage.doc \
+ doxygen_usage.doc doxytag_usage.doc \
doxywizard_usage.doc \
installdox_usage.doc output.doc autolink.doc \
config.doc commands.doc htmlcmds.doc language.doc \
@@ -46,11 +46,5 @@ TAGFILES =
ALLEXTERNALS = NO
PERL_PATH = /usr/local/bin/perl
SEARCHENGINE = NO
-CGI_NAME = search.cgi
-CGI_URL =
-DOC_URL =
-DOC_ABSPATH =
-BIN_ABSPATH = /usr/local/bin/
-EXT_DOC_PATHS =
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
diff --git a/doc/commands.doc b/doc/commands.doc
index 073e3d9..1a6d8e5 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -107,6 +107,7 @@ documentation:
\refitem cmdpre \\pre
\refitem cmdref \\ref
\refitem cmdrelates \\relates
+\refitem cmdrelatesalso \\relatesalso
\refitem cmdremarks \\remarks
\refitem cmdreturn \\return
\refitem cmdretval \\retval
@@ -553,6 +554,24 @@ See section \ref memgroup for an example.
\endhtmlonly
<hr>
+\section cmdrelatesalso \relatesalso <name>
+
+ \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
+ of the class documentation as well as leaving its normal file documentation
+ location. This command is useful for documenting
+ non-friend functions that are nevertheless strongly coupled to a certain
+ class. It only works for functions.
+
+ \par Example:
+ \verbinclude relates.cpp
+ \htmlonly
+ Click <a href="$(DOXYGEN_DOCDIR)/examples/relates/html/globals.html">here</a>
+ for the corresponding HTML documentation that is generated by doxygen.
+ \endhtmlonly
+
+<hr>
\section cmdshowinitializer \showinitializer
\addindex \\showinitializer
diff --git a/doc/config.doc b/doc/config.doc
index 9597871..79690c8 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -59,13 +59,10 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_allexternals ALLEXTERNALS
\refitem cfg_alphabetical_index ALPHABETICAL_INDEX
\refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC
-\refitem cfg_bin_abspath BIN_ABSPATH
\refitem cfg_binary_toc BINARY_TOC
\refitem cfg_brief_member_desc BRIEF_MEMBER_DESC
\refitem cfg_call_graph CALL_GRAPH
\refitem cfg_case_sense_names CASE_SENSE_NAMES
-\refitem cfg_cgi_name CGI_NAME
-\refitem cfg_cgi_url CGI_URL
\refitem cfg_chm_file CHM_FILE
\refitem cfg_class_diagrams CLASS_DIAGRAMS
\refitem cfg_class_graph CLASS_GRAPH
@@ -76,8 +73,6 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_details_at_top DETAILS_AT_TOP
\refitem cfg_disable_index DISABLE_INDEX
\refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC
-\refitem cfg_doc_abspath DOC_ABSPATH
-\refitem cfg_doc_url DOC_URL
\refitem cfg_dot_image_format DOT_IMAGE_FORMAT
\refitem cfg_dot_path DOT_PATH
\refitem cfg_dotfile_dirs DOTFILE_DIRS
@@ -92,7 +87,6 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_exclude_symlinks EXCLUDE_SYMLINKS
\refitem cfg_expand_as_defined EXPAND_AS_DEFINED
\refitem cfg_expand_only_predef EXPAND_ONLY_PREDEF
-\refitem cfg_ext_doc_paths EXT_DOC_PATHS
\refitem cfg_external_groups EXTERNAL_GROUPS
\refitem cfg_extra_packages EXTRA_PACKAGES
\refitem cfg_extract_all EXTRACT_ALL
@@ -209,7 +203,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_xml_schema XML_SCHEMA
\endsecreflist
-\section config_general General options
+\section config_project Project related options
\anchor cfg_project_name
<dl>
@@ -258,72 +252,6 @@ followed by the descriptions of the tags grouped by category.
whereas setting the tag to \c NO uses a Unix-style encoding (the default for
all platforms other than Windows).
-\anchor cfg_extract_all
-<dt>\c EXTRACT_ALL <dd>
- \addindex EXTRACT_ALL
- If the \c EXTRACT_ALL tag is set to \c YES doxygen will assume all
- entities in documentation are documented, even if no documentation was
- available. Private class members and static file members will be hidden
- unless the \c EXTRACT_PRIVATE and \c EXTRACT_STATIC tags are set to \c YES
-
- \par Note:
- This will also disable the warnings about undocumented members
- that are normally produced when \c WARNINGS is set to \c YES
-
-\anchor cfg_extract_private
-<dt>\c EXTRACT_PRIVATE <dd>
- \addindex EXTRACT_PRIVATE
- If the \c EXTRACT_PRIVATE tag is set to \c YES all private members of a
- class will be included in the documentation.
-
-\anchor cfg_extract_static
-<dt>\c EXTRACT_STATIC <dd>
- \addindex EXTRACT_STATIC
- If the \c EXTRACT_STATIC tag is set to \c YES all static members of a file
- will be included in the documentation.
-
-\anchor cfg_extract_local_classes
-<dt>\c EXTRACT_LOCAL_CLASSES <dd>
- \addindex EXTRACT_LOCAL_CLASSES
- If the \c EXTRACT_LOCAL_CLASSES tag is set to \c YES classes (and structs)
- defined locally in source files will be included in the documentation.
- If set to NO only classes defined in header files are included. Does not
- have any effect for Java sources.
-
-\anchor cfg_hide_undoc_members
-<dt>\c HIDE_UNDOC_MEMBERS <dd>
- \addindex HIDE_UNDOC_MEMBERS
- If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, doxygen will hide all
- undocumented members inside documented classes or files.
- If set to \c NO (the default) these members will be included in the
- various overviews, but no documentation section is generated.
- This option has no effect if \c EXTRACT_ALL is enabled.
-
-\anchor cfg_hide_undoc_classes
-<dt>\c HIDE_UNDOC_CLASSES <dd>
- \addindex HIDE_UNDOC_CLASSES
- If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, doxygen will hide all
- undocumented classes.
- If set to \c NO (the default) these classes will be included in the
- various overviews.
- This option has no effect if \c EXTRACT_ALL is enabled.
-
-\anchor cfg_hide_friend_compounds
-<dt>\c HIDE_FRIEND_COMPOUNDS <dd>
- \addindex HIDE_FRIEND_COMPOUNDS
- If the \c HIDE_FRIEND_COMPOUNDS tag is set to \c YES, Doxygen will hide all
- friend (class|struct|union) declarations.
- If set to \c NO (the default) these declarations will be included in the
- documentation.
-
-\anchor cfg_hide_in_body_docs
-<dt>\c HIDE_IN_BODY_DOCS <dd>
- \addindex HIDE_IN_BODY_DOCS
-If the \c HIDE_IN_BODY_DOCS tag is set to \c YES, Doxygen will hide any
-documentation blocks found inside the body of a function.
-If set to \c NO (the default) these blocks will be appended to the
-function's detailed documentation block.
-
\anchor cfg_brief_member_desc
<dt>\c BRIEF_MEMBER_DESC <dd>
\addindex BRIEF_MEMBER_DESC
@@ -373,14 +301,6 @@ function's detailed documentation block.
only done if one of the specified strings matches the left-hand part of the
path.
-\anchor cfg_internal_docs
-<dt>\c INTERNAL_DOCS <dd>
- \addindex INTERNAL_DOCS
- The \c INTERNAL_DOCS tag determines if documentation
- that is typed after a \ref cmdinternal "\\internal" command is included. If the tag is set
- to \c NO (the default) then the documentation will be excluded.
- Set it to \c YES to include the internal documentation.
-
\anchor cfg_case_sense_names
<dt>\c CASE_SENSE_NAMES <dd>
\addindex CASE_SENSE_NAMES
@@ -397,13 +317,6 @@ function's detailed documentation block.
(but less readable) file names. This can be useful is your file systems
doesn't support long names like on DOS, Mac, or CD-ROM.
-\anchor cfg_hide_scope_names
-<dt>\c HIDE_SCOPE_NAMES <dd>
- \addindex HIDE_SCOPE_NAMES
- If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then doxygen
- will show members with their full class and namespace scopes in the
- documentation. If set to \c YES the scope will be hidden.
-
\anchor cfg_verbatim_headers
<dt>\c VERBATIM_HEADERS <dd>
\addindex VERBATIM_HEADERS
@@ -412,13 +325,6 @@ function's detailed documentation block.
which an include is specified. Set to NO to disable this.
\sa Section \ref cmdclass "\\class".
-\anchor cfg_show_include_files
-<dt>\c SHOW_INCLUDE_FILES <dd>
- \addindex SHOW_INCLUDE_FILES
- If the SHOW_INCLUDE_FILES tag is set to YES (the default) then doxygen
- will put a list of the files that are included by a file in the documentation
- of that file.
-
\anchor cfg_javadoc_autobrief
<dt>\c JAVADOC_AUTOBRIEF <dd>
\addindex JAVADOC_AUTOBRIEF
@@ -453,20 +359,6 @@ function's detailed documentation block.
member inherits the documentation from any documented member that it
reimplements.
-\anchor cfg_inline_info
-<dt>\c INLINE_INFO <dd>
- \addindex INLINE_INFO
- If the \c INLINE_INFO tag is set to \c YES (the default) then a tag [inline]
- is inserted in the documentation for inline members.
-
-\anchor cfg_sort_member_docs
-<dt>\c SORT_MEMBER_DOCS <dd>
- \addindex SORT_MEMBER_DOCS
- If the \c SORT_MEMBER_DOCS tag is set to \c YES (the default) then doxygen
- will sort the (detailed) documentation of file and class members
- alphabetically by member name. If set to \c NO the members will appear in
- declaration order.
-
\anchor cfg_distribute_group_doc
<dt>\c DISTRIBUTE_GROUP_DOC <dd>
\addindex DISTRIBUTE_GROUP_DOC
@@ -481,12 +373,154 @@ function's detailed documentation block.
the \c TAB_SIZE tag can be used to set the number of spaces in a tab.
Doxygen uses this value to replace tabs by spaces in code fragments.
-\anchor cfg_enabled_sections
-<dt>\c ENABLED_SECTIONS <dd>
- \addindex ENABLED_SECTIONS
- The \c ENABLED_SECTIONS tag can be used to enable conditional
- documentation sections, marked by \ref cmdif "\\if" \<section-label\> ...
- \ref cmdendif "\\endif" blocks.
+\anchor cfg_aliases
+<dt>\c ALIASES <dd>
+ \addindex ALIASES
+ This tag can be used to specify a number of aliases that acts
+ as commands in the documentation. An alias has the form
+\verbatim
+ name=value
+\endverbatim
+ For example adding
+\verbatim
+ "sideeffect=\par Side Effects:\n"
+\endverbatim
+ will allow you to
+ put the command \\sideeffect (or \@sideeffect) in the documentation, which
+ will result in a user-defined paragraph with heading "Side Effects:".
+ You can put \\n's in the value part of an alias to insert newlines.
+
+\anchor cfg_optimize_output_for_c
+<dt>\c OPTIMIZE_OUTPUT_FOR_C <dd>
+ \addindex OPTIMIZE_OUTPUT_FOR_C
+ Set the \c OPTIMIZE_OUTPUT_FOR_C tag to \c YES if your project consists
+ of C sources only. Doxygen will then generate output that is more tailored
+ for C. For instance, some of the names that are used will be different.
+ The list of all members will be omitted, etc.
+
+\anchor cfg_optimize_output_java
+<dt>\c OPTIMIZE_OUTPUT_JAVA <dd>
+ \addindex OPTIMIZE_OUTPUT_JAVA
+ Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
+ only. Doxygen will then generate output that is more tailored for Java.
+ For instance, namespaces will be presented as packages, qualified scopes
+ will look different, etc.
+
+\anchor cfg_subgrouping
+<dt>\c SUBGROUPING <dd>
+ \addindex SUBGROUPING
+ Set the \c SUBGROUPING tag to \c YES (the default) to allow class member groups of
+ the same type (for instance a group of public functions) to be put as a
+ subgroup of that type (e.g. under the Public Functions section). Set it to
+ \c NO to prevent subgrouping. Alternatively, this can be done per class using
+ the \ref cmdnosubgrouping "\\nosubgrouping" command.
+
+</dl>
+
+\section config_build Build related options
+\anchor cfg_extract_all
+<dl>
+
+<dt>\c EXTRACT_ALL <dd>
+ \addindex EXTRACT_ALL
+ If the \c EXTRACT_ALL tag is set to \c YES doxygen will assume all
+ entities in documentation are documented, even if no documentation was
+ available. Private class members and static file members will be hidden
+ unless the \c EXTRACT_PRIVATE and \c EXTRACT_STATIC tags are set to \c YES
+
+ \par Note:
+ This will also disable the warnings about undocumented members
+ that are normally produced when \c WARNINGS is set to \c YES
+
+\anchor cfg_extract_private
+<dt>\c EXTRACT_PRIVATE <dd>
+ \addindex EXTRACT_PRIVATE
+ If the \c EXTRACT_PRIVATE tag is set to \c YES all private members of a
+ class will be included in the documentation.
+
+\anchor cfg_extract_static
+<dt>\c EXTRACT_STATIC <dd>
+ \addindex EXTRACT_STATIC
+ If the \c EXTRACT_STATIC tag is set to \c YES all static members of a file
+ will be included in the documentation.
+
+\anchor cfg_extract_local_classes
+<dt>\c EXTRACT_LOCAL_CLASSES <dd>
+ \addindex EXTRACT_LOCAL_CLASSES
+ If the \c EXTRACT_LOCAL_CLASSES tag is set to \c YES classes (and structs)
+ defined locally in source files will be included in the documentation.
+ If set to NO only classes defined in header files are included. Does not
+ have any effect for Java sources.
+
+\anchor cfg_hide_undoc_members
+<dt>\c HIDE_UNDOC_MEMBERS <dd>
+ \addindex HIDE_UNDOC_MEMBERS
+ If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, doxygen will hide all
+ undocumented members inside documented classes or files.
+ If set to \c NO (the default) these members will be included in the
+ various overviews, but no documentation section is generated.
+ This option has no effect if \c EXTRACT_ALL is enabled.
+
+\anchor cfg_hide_undoc_classes
+<dt>\c HIDE_UNDOC_CLASSES <dd>
+ \addindex HIDE_UNDOC_CLASSES
+ If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, doxygen will hide all
+ undocumented classes.
+ If set to \c NO (the default) these classes will be included in the
+ various overviews.
+ This option has no effect if \c EXTRACT_ALL is enabled.
+
+\anchor cfg_hide_friend_compounds
+<dt>\c HIDE_FRIEND_COMPOUNDS <dd>
+ \addindex HIDE_FRIEND_COMPOUNDS
+ If the \c HIDE_FRIEND_COMPOUNDS tag is set to \c YES, Doxygen will hide all
+ friend (class|struct|union) declarations.
+ If set to \c NO (the default) these declarations will be included in the
+ documentation.
+
+\anchor cfg_hide_in_body_docs
+<dt>\c HIDE_IN_BODY_DOCS <dd>
+ \addindex HIDE_IN_BODY_DOCS
+If the \c HIDE_IN_BODY_DOCS tag is set to \c YES, Doxygen will hide any
+documentation blocks found inside the body of a function.
+If set to \c NO (the default) these blocks will be appended to the
+function's detailed documentation block.
+
+\anchor cfg_internal_docs
+<dt>\c INTERNAL_DOCS <dd>
+ \addindex INTERNAL_DOCS
+ The \c INTERNAL_DOCS tag determines if documentation
+ that is typed after a \ref cmdinternal "\\internal" command is included. If the tag is set
+ to \c NO (the default) then the documentation will be excluded.
+ Set it to \c YES to include the internal documentation.
+
+\anchor cfg_hide_scope_names
+<dt>\c HIDE_SCOPE_NAMES <dd>
+ \addindex HIDE_SCOPE_NAMES
+ If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then doxygen
+ will show members with their full class and namespace scopes in the
+ documentation. If set to \c YES the scope will be hidden.
+
+\anchor cfg_show_include_files
+<dt>\c SHOW_INCLUDE_FILES <dd>
+ \addindex SHOW_INCLUDE_FILES
+ If the SHOW_INCLUDE_FILES tag is set to YES (the default) then doxygen
+ will put a list of the files that are included by a file in the documentation
+ of that file.
+
+\anchor cfg_inline_info
+<dt>\c INLINE_INFO <dd>
+ \addindex INLINE_INFO
+ If the \c INLINE_INFO tag is set to \c YES (the default) then a tag [inline]
+ is inserted in the documentation for inline members.
+
+\anchor cfg_sort_member_docs
+<dt>\c SORT_MEMBER_DOCS <dd>
+ \addindex SORT_MEMBER_DOCS
+ If the \c SORT_MEMBER_DOCS tag is set to \c YES (the default) then doxygen
+ will sort the (detailed) documentation of file and class members
+ alphabetically by member name. If set to \c NO the members will appear in
+ declaration order.
\anchor cfg_generate_deprecatedlist
<dt>\c GENERATE_DEPRECATEDLIST <dd>
@@ -518,22 +552,12 @@ function's detailed documentation block.
disable (NO) the bug list. This list is created by
putting \ref cmdbug "\\bug" commands in the documentation.
-\anchor cfg_aliases
-<dt>\c ALIASES <dd>
- \addindex ALIASES
- This tag can be used to specify a number of aliases that acts
- as commands in the documentation. An alias has the form
-\verbatim
- name=value
-\endverbatim
- For example adding
-\verbatim
- "sideeffect=\par Side Effects:\n"
-\endverbatim
- will allow you to
- put the command \\sideeffect (or \@sideeffect) in the documentation, which
- will result in a user-defined paragraph with heading "Side Effects:".
- You can put \\n's in the value part of an alias to insert newlines.
+\anchor cfg_enabled_sections
+<dt>\c ENABLED_SECTIONS <dd>
+ \addindex ENABLED_SECTIONS
+ The \c ENABLED_SECTIONS tag can be used to enable conditional
+ documentation sections, marked by \ref cmdif "\\if" \<section-label\> ...
+ \ref cmdendif "\\endif" blocks.
\anchor cfg_max_initializer_lines
<dt>\c MAX_INITIALIZER_LINES <dd>
@@ -545,22 +569,6 @@ function's detailed documentation block.
individual variables and defines can be controlled using \ref cmdshowinitializer "\\showinitializer"
or \ref cmdhideinitializer "\\hideinitializer" command in the documentation.
-\anchor cfg_optimize_output_for_c
-<dt>\c OPTIMIZE_OUTPUT_FOR_C <dd>
- \addindex OPTIMIZE_OUTPUT_FOR_C
- Set the \c OPTIMIZE_OUTPUT_FOR_C tag to \c YES if your project consists
- of C sources only. Doxygen will then generate output that is more tailored
- for C. For instance, some of the names that are used will be different.
- The list of all members will be omitted, etc.
-
-\anchor cfg_optimize_output_java
-<dt>\c OPTIMIZE_OUTPUT_JAVA <dd>
- \addindex OPTIMIZE_OUTPUT_JAVA
- Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
- only. Doxygen will then generate output that is more tailored for Java.
- For instance, namespaces will be presented as packages, qualified scopes
- will look different, etc.
-
\anchor cfg_show_used_files
<dt>\c SHOW_USED_FILES <dd>
\addindex SHOW_USED_FILES
@@ -568,15 +576,6 @@ function's detailed documentation block.
at the bottom of the documentation of classes and structs. If set to \c YES the
list will mention the files that were used to generate the documentation.
-\anchor cfg_subgrouping
-<dt>\c SUBGROUPING <dd>
- \addindex SUBGROUPING
- Set the \c SUBGROUPING tag to \c YES (the default) to allow class member groups of
- the same type (for instance a group of public functions) to be put as a
- subgroup of that type (e.g. under the Public Functions section). Set it to
- \c NO to prevent subgrouping. Alternatively, this can be done per class using
- the \ref cmdnosubgrouping "\\nosubgrouping" command.
-
</dl>
\section messages_input Options related to warning and progress messages
@@ -1568,52 +1567,13 @@ remove the intermediate dot files that are used to generate the various graphs.
<dt>\c SEARCHENGINE <dd>
\addindex SEARCHENGINE
- The \c SEARCHENGINE tag specifies whether or not a
- search should be used. Possible values are \c YES and \c NO.
- If set to \c NO or left blank, the values of all other tags in this section
- will be ignored.
-
-\anchor cfg_cgi_name
-<dt>\c CGI_NAME <dd>
- \addindex CGI_NAME
- The \c CGI_NAME tag should be the name of the CGI script that
- starts the search engine (<tt>doxysearch</tt>) with the correct parameters.
- A script with this name will be generated by doxygen.
-
-\anchor cfg_cgi_url
-<dt>\c CGI_URL <dd>
- \addindex CGI_URL
- The \c CGI_URL tag should be the absolute URL to the directory where the
- cgi binaries are located. See the documentation of your HTTP daemon for
- details.
-
-\anchor cfg_doc_url
-<dt>\c DOC_URL <dd>
- \addindex DOC_URL
- The \c DOC_URL tag should be the absolute URL to the directory where the
- documentation is located. If left blank the absolute path to the
- documentation, with \c file:// prepended to it, will be used.
- This is correct for local viewing only.
-
-\anchor cfg_doc_abspath
-<dt>\c DOC_ABSPATH <dd>
- \addindex DOC_ABSPATH
- The \c DOC_ABSPATH tag should be the absolute path to the directory where the
- documentation is located. If left blank the directory on the local machine
- will be used.
-
-\anchor cfg_bin_abspath
-<dt>\c BIN_ABSPATH <dd>
- \addindex BIN_ABSPATH
- The \c BIN_ABSPATH tag must point to the directory where the doxysearch binary
- is installed.
-
-\anchor cfg_ext_doc_paths
-<dt>\c EXT_DOC_PATHS <dd>
- \addindex EXT_DOC_PATHS
- The \c EXT_DOC_PATHS tag can be used to specify one or more paths to
- documentation generated for other projects. This allows doxysearch to search
- the documentation for these projects as well. All paths must be absolute.
+ The \c SEARCHENGINE tag specifies whether or not the HTML output should
+ contain a search facility. Possible values are \c YES and \c NO.
+ If set to YES, doxygen will produce a search index and a PHP script
+ to search through the index. For this to work the documentation should
+ be viewed via a web-server running PHP version 4.1.0 or higher.
+ (See http://www.php.net/manual/en/installation.php for installation
+ instructions).
</dl>
<h2>Examples</h2>
@@ -1649,11 +1609,6 @@ INCLUDE_PATH = examples
TAGFILES = qt.tag
PERL_PATH = /usr/local/bin/perl
SEARCHENGINE = YES
-CGI_NAME = search.cgi
-CGI_URL = http://www.stack.nl/~dimitri/cgi-bin
-DOC_URL = http://www.stack.nl/~dimitri/qdbttabular
-DOC_ABSPATH = /home/dimitri/.html/qdbttabular
-BIN_ABSPATH = /home/dimitri/bin
\endverbatim
To regenerate the Qt-1.44 documentation from the sources, you could use the
diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc
index 0fdff93..47e5aec 100644
--- a/doc/doxygen_usage.doc
+++ b/doc/doxygen_usage.doc
@@ -91,7 +91,4 @@ doxygen -w rtf rtfstyle.cfg
a file, use \c - for the file name.
</ul>
-If you also want to use the search engine, you should look
-at section \ref doxysearch_usage.
-
*/
diff --git a/doc/doxytag_usage.doc b/doc/doxytag_usage.doc
index 6d7a5e1..b4472d8 100644
--- a/doc/doxytag_usage.doc
+++ b/doc/doxytag_usage.doc
@@ -17,38 +17,26 @@
/*! \page doxytag_usage Doxytag usage
Doxytag is a small command line based utility.
-It has two functions:
-<ul>
-<li>
- Doxytag 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.
-<li>
- Doxytag can generate a <em>search index</em> for the documentation
- generated with doxygen or for the Qt documentation. See the documentation of
- <a href="doxysearch_usage.html">doxysearch</a> for more information on how
- to do this.
- A search index contains information about all the words (and all substrings
- thereof) that are contained in the documentation.
- For each string the index contains the set of documentation blocks that
- contain the string and the frequency of occurrence. This way
- <code>doxysearch</code> can search for words very quickly
- (most queries are processed within a few milliseconds on my system.)
-</ul>
-In both cases the input of doxytag consists of a set of HTML files.
+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 or use a search engine, the links that
+ 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.
@@ -58,10 +46,10 @@ In both cases the input of doxytag consists of a set of HTML files.
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.
+ 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
@@ -106,13 +94,4 @@ doxytag -t example.tag example/html
doxytag -t qt.tag $QTDIR/doc/html
\endverbatim
-A typical example to use doxytag to generate a search index is:
-\verbatim
-doxytag -s search.idx
-\endverbatim
-
-\par Note:
-In the current version of doxygen, the search index must be
-called \c search.idx.
-
*/
diff --git a/doc/index.doc b/doc/index.doc
index 9aeba8b..065800c 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -84,7 +84,6 @@ The second part forms a reference manual:
of doxygen and what still has to be done.
<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 doxysearch_usage shows how to use the \c doxysearch 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.
diff --git a/doc/infoflow.eps b/doc/infoflow.eps
index 68735e9..740c1e4 100644
--- a/doc/infoflow.eps
+++ b/doc/infoflow.eps
@@ -1,9 +1,9 @@
%!PS-Adobe-2.0 EPSF-2.0
%%Title: infoflow.eps
%%Creator: fig2dev Version 3.2 Patchlevel 3c
-%%CreationDate: Tue Dec 31 19:32:56 2002
+%%CreationDate: Fri Aug 8 17:06:41 2003
%%For: dimitri@pandora.home.nl (Dimitri van Heesch)
-%%BoundingBox: 0 0 673 585
+%%BoundingBox: 0 0 659 583
%%Magnification: 1.0000
%%EndComments
/$F2psDict 200 dict def
@@ -47,8 +47,8 @@ $F2psDict /mtrx matrix put
end
save
-newpath 0 585 moveto 0 0 lineto 673 0 lineto 673 585 lineto closepath clip newpath
--39.0 602.0 translate
+newpath 0 583 moveto 0 0 lineto 659 0 lineto 659 583 lineto closepath clip newpath
+-53.0 600.0 translate
1 -1 scale
/cp {closepath} bind def
@@ -142,16 +142,6 @@ gs 1 -1 sc (Config file) col0 sh gr
3900 2550 m
gs 1 -1 sc (Doxyfile) col0 sh gr
% Polyline
-n 900 7500 m 1200 7200 l 2100 7200 l 2100 8700 l 900 8700 l 900 7500 l
- 1200 7500 l
- 1200 7200 l gs col0 s gr
-/Times-Roman-iso ff 180.00 scf sf
-1200 7950 m
-gs 1 -1 sc (search) col0 sh gr
-/Times-Roman-iso ff 180.00 scf sf
-1200 8175 m
-gs 1 -1 sc (index) col0 sh gr
-% Polyline
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
@@ -469,15 +459,6 @@ n 10875 9150 m
% arrowhead
n 11264 9180 m 11384 9150 l 11264 9120 l 11264 9180 l cp gs 0.00 setgray ef gr col0 s
% Polyline
-gs clippath
-4455 7110 m 4395 7110 l 4395 7261 l 4425 7141 l 4455 7261 l cp
-eoclip
-n 4425 8850 m
- 4425 7125 l gs col0 s gr gr
-
-% arrowhead
-n 4455 7261 m 4425 7141 l 4395 7261 l 4455 7261 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
@@ -490,42 +471,18 @@ n 6675 9300 m
% arrowhead
n 5236 9270 m 5116 9300 l 5236 9330 l 5236 9270 l cp gs 0.00 setgray ef gr col0 s
% Polyline
-n 675 9300 m 2475 9300 l 2475 9975 l 675 9975 l
- cp gs col32 1.00 shd ef gr gs col0 s gr
-% Polyline
-gs clippath
-2085 7995 m 2085 8055 l 2236 8055 l 2116 8025 l 2236 7995 l cp
-eoclip
-n 3900 8850 m 3900 8025 l
- 2100 8025 l gs col0 s gr gr
-
-% arrowhead
-n 2236 7995 m 2116 8025 l 2236 8055 l 2236 7995 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-1470 9315 m 1530 9315 l 1530 9164 l 1500 9284 l 1470 9164 l cp
-eoclip
-n 1500 8700 m
- 1500 9300 l gs col0 s gr gr
-
-% arrowhead
-n 1470 9164 m 1500 9284 l 1530 9164 l 1470 9164 l cp gs 0.00 setgray ef gr col0 s
+ [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
-6690 9780 m 6690 9720 l 6539 9720 l 6659 9750 l 6539 9780 l cp
-2460 9720 m 2460 9780 l 2611 9780 l 2491 9750 l 2611 9720 l cp
+4305 7110 m 4245 7110 l 4245 7261 l 4275 7141 l 4305 7261 l cp
eoclip
-n 2475 9750 m
- 6675 9750 l gs col0 s gr gr
+n 4275 8850 m
+ 4275 7125 l gs col0 s gr gr
% arrowhead
-n 2611 9720 m 2491 9750 l 2611 9780 l 2611 9720 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 6539 9780 m 6659 9750 l 6539 9720 l 6539 9780 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
+n 4305 7261 m 4275 7141 l 4245 7261 l 4305 7261 l cp gs 0.00 setgray ef gr col0 s
/Times-Roman-iso ff 180.00 scf sf
4500 3525 m
gs 1 -1 sc (generate/update) col0 sh gr
@@ -626,33 +583,15 @@ gs 1 -1 sc (Man pages) col0 sh gr
5475 9525 m
gs 1 -1 sc (parse) col0 sh gr
/Times-Roman-iso ff 180.00 scf sf
-4575 8100 m
-gs 1 -1 sc (generate) col0 sh gr
-/Times-Roman-iso ff 180.00 scf sf
3825 9300 m
gs 1 -1 sc (Doxytag) col0 sh gr
/Times-Roman-iso ff 180.00 scf sf
-1050 9750 m
-gs 1 -1 sc (Doxysearch) col0 sh gr
-/Times-Roman-iso ff 180.00 scf sf
-1575 9075 m
-gs 1 -1 sc (uses) col0 sh gr
-/Times-Roman-iso ff 180.00 scf sf
-2700 9975 m
-gs 1 -1 sc (used from) col0 sh gr
-/Times-Roman-iso ff 180.00 scf sf
-5700 9975 m
-gs 1 -1 sc (generates) col0 sh gr
-/Times-Roman-iso ff 180.00 scf sf
8325 9075 m
gs 1 -1 sc (read) col0 sh gr
/Times-Roman-iso ff 180.00 scf sf
8775 6675 m
gs 1 -1 sc (Windows only) col0 sh gr
/Times-Roman-iso ff 180.00 scf sf
-2700 8250 m
-gs 1 -1 sc (generate) col0 sh gr
-/Times-Roman-iso ff 180.00 scf sf
8250 1200 m
gs 1 -1 sc (read) col0 sh gr
/Times-Roman-iso ff 180.00 scf sf
@@ -661,5 +600,8 @@ gs 1 -1 sc (Sources) col0 sh gr
/Times-Roman-iso ff 180.00 scf sf
1275 5775 m
gs 1 -1 sc (Custom) col0 sh gr
+/Times-Roman-iso ff 180.00 scf sf
+4350 8175 m
+gs 1 -1 sc (generate) col0 sh gr
$F2psEnd
rs
diff --git a/doc/infoflow.fig b/doc/infoflow.fig
index 01ede9a..501b81b 100644
--- a/doc/infoflow.fig
+++ b/doc/infoflow.fig
@@ -16,13 +16,6 @@ Single
4 0 0 50 0 0 12 0.0000 4 180 780 3900 2250 Config file\001
4 0 0 50 0 0 12 0.0000 4 180 645 3900 2550 Doxyfile\001
-6
-6 900 7200 2100 8700
-2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8
- 900 7500 1200 7200 2100 7200 2100 8700 900 8700 900 7500
- 1200 7500 1200 7200
-4 0 0 50 0 0 12 0.0000 4 135 510 1200 7950 search\001
-4 0 0 50 0 0 12 0.0000 4 135 405 1200 8175 index\001
--6
6 900 3150 2325 4875
2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8
900 3675 1200 3375 2100 3375 2100 4875 900 4875 900 3675
@@ -181,28 +174,16 @@ 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
10875 9150 11400 9150
-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
- 4425 8850 4425 7125
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 0 1 0 32 50 0 20 0.000 0 0 -1 0 0 5
- 675 9300 2475 9300 2475 9975 675 9975 675 9300
-2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 3
- 1 1 1.00 60.00 120.00
- 3900 8850 3900 8025 2100 8025
-2 1 0 1 0 7 50 0 -1 4.000 0 0 -1 1 0 2
- 1 1 1.00 60.00 120.00
- 1500 8700 1500 9300
-2 1 0 1 0 7 50 0 -1 4.000 0 0 -1 1 1 2
- 1 1 1.00 60.00 120.00
- 1 1 1.00 60.00 120.00
- 2475 9750 6675 9750
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
4 0 0 50 0 0 12 0.0000 4 180 1215 4500 3525 generate/update\001
4 0 0 50 0 0 12 0.0000 4 135 330 3600 3525 read\001
4 0 0 50 0 0 12 0.0000 4 135 330 2850 3975 read\001
@@ -236,15 +217,10 @@ Single
4 0 0 50 0 0 12 0.0000 4 135 315 11100 9000 chm\001
4 0 0 50 0 0 12 0.0000 4 180 840 6825 5625 Man pages\001
4 0 0 50 0 0 12 0.0000 4 135 420 5475 9525 parse\001
-4 0 0 50 0 0 12 0.0000 4 150 660 4575 8100 generate\001
4 0 0 50 0 0 12 0.0000 4 180 645 3825 9300 Doxytag\001
-4 0 0 50 0 0 12 0.0000 4 180 915 1050 9750 Doxysearch\001
-4 0 0 50 0 0 12 0.0000 4 90 360 1575 9075 uses\001
-4 0 0 50 0 0 12 0.0000 4 135 750 2700 9975 used from\001
-4 0 0 50 0 0 12 0.0000 4 150 750 5700 9975 generates\001
4 0 0 50 0 0 12 0.0000 4 135 330 8325 9075 read\001
4 0 0 50 0 0 12 0.0000 4 180 1080 8775 6675 Windows only\001
-4 0 0 50 0 0 12 0.0000 4 150 660 2700 8250 generate\001
4 0 0 50 0 0 12 0.0000 4 135 330 8250 1200 read\001
4 0 0 50 0 0 12 0.0000 4 135 615 1200 4200 Sources\001
4 0 0 50 0 0 12 0.0000 4 135 585 1275 5775 Custom\001
+4 0 0 50 0 0 12 0.0000 4 150 660 4350 8175 generate\001
diff --git a/doc/infoflow.gif b/doc/infoflow.gif
index ae6bebb..f26763e 100644
--- a/doc/infoflow.gif
+++ b/doc/infoflow.gif
Binary files differ
diff --git a/doc/install.doc b/doc/install.doc
index 3dfc2e7..489dbea 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -368,6 +368,18 @@ graphviz (\>=1.8.8). The effect of this incompatibility is that
generated graphs in HTML are not properly clickable. For doxygen 1.3
it is recommended to use at least graphviz 1.8.10 or higher.
+<b>Red Hat 9.0 problems</b>
+
+If you get the following error after running make
+\verbatim
+tmake error: qtools.pro:70: Syntax error
+\endverbatim
+then first type
+\verbatim
+export LANG=
+\endverbatim
+before running make.
+
\section install_src_windows Compiling from source on Windows
Currently, I have only compiled doxygen for Windows using Microsoft's
diff --git a/doc/language.doc b/doc/language.doc
index 97f481a..ffc74b8 100644
--- a/doc/language.doc
+++ b/doc/language.doc
@@ -1,6 +1,8 @@
/******************************************************************************
- * <notice>This is the template for generating language.doc.
- * Edit manually this file, not the language.doc!</notice>
+ * Warning: this file was generated from the language.tpl template
+ * and the maintainers.txt files by the translator.pl script.
+ *
+ * Do not edit this file. Edit the above mentioned files!
*
*
* Copyright (C) 1997-2002 by Dimitri van Heesch.
@@ -23,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 unknown), 28 languages
+Currently (version 1.3.3), 28 languages
are supported (sorted alphabetically):
Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian,
Czech, Danish, Dutch, English, Finnish,
@@ -37,7 +39,261 @@ It is sorted by language alphabetically. The <b>Status</b> column
was generated from sources and shows approximately the last version
when the translator was updated.
-$information_table
+\htmlonly
+<TABLE ALIGN=center CELLSPACING=0 CELLPADDING=0 BORDER=0>
+<TR BGCOLOR="#000000">
+<TD>
+ <TABLE CELLSPACING=1 CELLPADDING=2 BORDER=0>
+ <TR BGCOLOR="#4040c0">
+ <TD ><b><font size=+1 color="#ffffff"> Language </font></b></TD>
+ <TD ><b><font size=+1 color="#ffffff"> Maintainer </font></b></TD>
+ <TD ><b><font size=+1 color="#ffffff"> Contact address </font>
+ <font size=-2 color="#ffffff">(remove the NOSPAM.)</font></b></TD>
+ <TD ><b><font size=+1 color="#ffffff"> Status </font></b></TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Brazilian Portuguese</TD>
+ <TD>Fabio "FJTC" Jun Takada Chino</TD>
+ <TD>chino@NOSPAM.icmc.sc.usp.br</TD>
+ <TD>1.3.3</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Catalan</TD>
+ <TD>Albert Mora</TD>
+ <TD>amora@NOSPAM.iua.upf.es</TD>
+ <TD>1.2.17</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Chinese</TD>
+ <TD>Wei Liu<br>Wang Weihan</TD>
+ <TD>liuwei@NOSPAM.asiainfo.com<br>wangweihan@NOSPAM.capinfo.com.cn</TD>
+ <TD>1.2.13</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Chinese Traditional</TD>
+ <TD>Daniel YC Lin<br>Gary Lee</TD>
+ <TD>daniel@NOSPAM.twpda.com<br>garylee@NOSPAM.ecosine.com.tw</TD>
+ <TD>1.3.3</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Croatian</TD>
+ <TD>Boris Bralo</TD>
+ <TD>boris.bralo@NOSPAM.zg.tel.hr</TD>
+ <TD>1.3.1</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Czech</TD>
+ <TD>Petr P&#x0159;ikryl</TD>
+ <TD>prikrylp@NOSPAM.skil.cz</TD>
+ <TD>1.3.3</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Danish</TD>
+ <TD>Erik S&oslash;e S&oslash;rensen</TD>
+ <TD>erik@NOSPAM.mail.nu</TD>
+ <TD>strange</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Dutch</TD>
+ <TD>Dimitri van Heesch</TD>
+ <TD>dimitri@NOSPAM.stack.nl</TD>
+ <TD>up-to-date</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>English</TD>
+ <TD>Dimitri van Heesch</TD>
+ <TD>dimitri@NOSPAM.stack.nl</TD>
+ <TD>up-to-date</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Finnish</TD>
+ <TD>Olli Korhonen</TD>
+ <TD>Olli.Korhonen@NOSPAM.ccc.fi</TD>
+ <TD>obsolete</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>French</TD>
+ <TD>Xavier Outhier</TD>
+ <TD>xouthier@NOSPAM.yahoo.fr</TD>
+ <TD>1.3.3</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>German</TD>
+ <TD>Jens Seidel</TD>
+ <TD>jensseidel@NOSPAM.users.sf.net</TD>
+ <TD>1.3.1</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Greek</TD>
+ <TD>Harry Kalogirou</TD>
+ <TD>harkal@NOSPAM.rainbow.cs.unipi.gr</TD>
+ <TD>1.2.11</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Hungarian</TD>
+ <TD>F&ouml;ldv&aacute;ri Gy&ouml;rgy</TD>
+ <TD>foldvari@NOSPAM.diatronltd.com</TD>
+ <TD>1.2.1</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Italian</TD>
+ <TD>Alessandro Falappa<br>Ahmed Aldo Faisal</TD>
+ <TD>alessandro@NOSPAM.falappa.net<br>aaf23@NOSPAM.cam.ac.uk</TD>
+ <TD>1.3.3</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Japanese</TD>
+ <TD>Ryunosuke Satoh<br>Kenji Nagamatsu</TD>
+ <TD>sun594@NOSPAM.hotmail.com<br>naga@NOSPAM.joyful.club.ne.jp</TD>
+ <TD>obsolete</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Korean</TD>
+ <TD>Richard Kim</TD>
+ <TD>ryk@NOSPAM.dspwiz.com</TD>
+ <TD>strange</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Norwegian</TD>
+ <TD>Lars Erik Jordet</TD>
+ <TD>lej@NOSPAM.circuitry.no</TD>
+ <TD>1.2.2</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Polish</TD>
+ <TD>Piotr Kaminski<br>Grzegorz Kowal</TD>
+ <TD>Piotr.Kaminski@NOSPAM.ctm.gdynia.pl<br>g_kowal@NOSPAM.poczta.onet.pl</TD>
+ <TD>strange</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Portuguese</TD>
+ <TD>Rui Godinho Lopes</TD>
+ <TD>ruiglopes@NOSPAM.yahoo.com</TD>
+ <TD>1.3.3</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Romanian</TD>
+ <TD>Alexandru Iosup</TD>
+ <TD>aiosup@NOSPAM.yahoo.com</TD>
+ <TD>1.2.16</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Russian</TD>
+ <TD>Alexandr Chelpanov</TD>
+ <TD>cav@NOSPAM.cryptopro.ru</TD>
+ <TD>strange</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Serbian</TD>
+ <TD>Dejan Milosavljevic</TD>
+ <TD>dmilos@NOSPAM.email.com</TD>
+ <TD>1.3.3</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Slovak</TD>
+ <TD>Stanislav Kudl&aacute;&#x010d;</TD>
+ <TD>skudlac@NOSPAM.pobox.sk</TD>
+ <TD>1.2.18</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Slovene</TD>
+ <TD>Matjaz Ostroversnik</TD>
+ <TD>matjaz.ostroversnik@NOSPAM.zrs-tk.si</TD>
+ <TD>1.2.16</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Spanish</TD>
+ <TD>Francisco Oltra Thennet</TD>
+ <TD>foltra@NOSPAM.puc.cl</TD>
+ <TD>1.2.7</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Swedish</TD>
+ <TD>XeT Erixon</TD>
+ <TD>xet@NOSPAM.hem.passagen.se</TD>
+ <TD>1.3.3</TD>
+ </TR>
+ <TR BGCOLOR="#ffffff">
+ <TD>Ukrainian</TD>
+ <TD>Olexij Tkatchenko</TD>
+ <TD>olexij.tkatchenko@NOSPAM.gmx.de</TD>
+ <TD>1.2.11</TD>
+ </TR>
+ </TABLE>
+</TD>
+</TR>
+</TABLE>
+\endhtmlonly
+\latexonly
+\begin{tabular}{|l|l|l|l|}
+ \hline
+ {\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\
+ \hline
+ \hline
+ Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt chino@icmc.sc.usp.br} & 1.3.3 \\
+ \hline
+ Catalan & Albert Mora & {\tt amora@iua.upf.es} & 1.2.17 \\
+ \hline
+ Chinese & Wei Liu & {\tt liuwei@asiainfo.com} & 1.2.13 \\
+ & Wang Weihan & {\tt wangweihan@capinfo.com.cn} & \\
+ \hline
+ Chinese Traditional & Daniel YC Lin & {\tt daniel@twpda.com} & 1.3.3 \\
+ & Gary Lee & {\tt garylee@ecosine.com.tw} & \\
+ \hline
+ Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & 1.3.1 \\
+ \hline
+ Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & 1.3.3 \\
+ \hline
+ Danish & Erik S\o{}e S\o{}rensen & {\tt erik@mail.nu} & strange \\
+ \hline
+ Dutch & Dimitri van Heesch & {\tt dimitri@stack.nl} & up-to-date \\
+ \hline
+ English & Dimitri van Heesch & {\tt dimitri@stack.nl} & up-to-date \\
+ \hline
+ Finnish & Olli Korhonen & {\tt Olli.Korhonen@ccc.fi} & obsolete \\
+ \hline
+ French & Xavier Outhier & {\tt xouthier@yahoo.fr} & 1.3.3 \\
+ \hline
+ German & Jens Seidel & {\tt jensseidel@users.sf.net} & 1.3.1 \\
+ \hline
+ Greek & Harry Kalogirou & {\tt harkal@rainbow.cs.unipi.gr} & 1.2.11 \\
+ \hline
+ Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt foldvari@diatronltd.com} & 1.2.1 \\
+ \hline
+ Italian & Alessandro Falappa & {\tt alessandro@falappa.net} & 1.3.3 \\
+ & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & \\
+ \hline
+ Japanese & Ryunosuke Satoh & {\tt sun594@hotmail.com} & obsolete \\
+ & Kenji Nagamatsu & {\tt naga@joyful.club.ne.jp} & \\
+ \hline
+ Korean & Richard Kim & {\tt ryk@dspwiz.com} & strange \\
+ \hline
+ Norwegian & Lars Erik Jordet & {\tt lej@circuitry.no} & 1.2.2 \\
+ \hline
+ Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & strange \\
+ & Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} & \\
+ \hline
+ Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & 1.3.3 \\
+ \hline
+ Romanian & Alexandru Iosup & {\tt aiosup@yahoo.com} & 1.2.16 \\
+ \hline
+ Russian & Alexandr Chelpanov & {\tt cav@cryptopro.ru} & strange \\
+ \hline
+ Serbian & Dejan Milosavljevic & {\tt dmilos@email.com} & 1.3.3 \\
+ \hline
+ Slovak & Stanislav Kudl\'{a}\v{c} & {\tt skudlac@pobox.sk} & 1.2.18 \\
+ \hline
+ Slovene & Matjaz Ostroversnik & {\tt matjaz.ostroversnik@zrs-tk.si} & 1.2.16 \\
+ \hline
+ Spanish & Francisco Oltra Thennet & {\tt foltra@puc.cl} & 1.2.7 \\
+ \hline
+ Swedish & XeT Erixon & {\tt xet@hem.passagen.se} & 1.3.3 \\
+ \hline
+ Ukrainian & Olexij Tkatchenko & {\tt olexij.tkatchenko@gmx.de} & 1.2.11 \\
+ \hline
+\end{tabular}
+\endlatexonly
+
Most people on the list have indicated that they were also busy
doing other things, so if you want to help to speed things up please
@@ -258,9 +514,10 @@ script was developed (located in \c doxygen/doc directory).
It extracts the important information about obsolete and
new methods from the source files for each of the languages.
The information is stored in the <em>translator report</em> ASCII file
-($translator_report_file_name). \htmlonly If you compiled this documentation
+(<code>doxygen/doc/translator_report.txt</code>). \htmlonly If you compiled this documentation
from sources and if you have also doxygen sources available the
-link $translator_report_link should be valid.\endhtmlonly
+link <a href="../doc/translator_report.txt">
+ <code>doxygen/doc/translator_report.txt</code></a> should be valid.\endhtmlonly
Looking at the base class of the language translator, the script
guesses also the status of the translator -- see the last column of
diff --git a/doc/starting.doc b/doc/starting.doc
index e2335e3..534d339 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -22,15 +22,12 @@ 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 or to create a search index for
-the search engine. See section \ref doxytag_usage for more detailed usage
-information.
+for which you do not have the sources. See section \ref doxytag_usage
+for more detailed usage information.
-The executable \c doxysearch is only needed if you want to use the search
-engine. See section \ref doxysearch_usage for more detailed usage information.
-
-Optionally, the executable \c doxywizard is a graphical front-end for editing
-the configuration files that are used by doxygen.
+Optionally, the executable \c doxywizard can be used, which is a
+graphical front-end for editing the configuration file that is used by
+doxygen.
The following figure shows the relation between the tools and the flow
of information between them:
@@ -46,8 +43,8 @@ of a single source file, but can also be an entire source tree that is
recursively scanned.
To simplify the creation of a configuration file, doxygen can create a
-template configuration file for you. To do this call \c doxygen with the \c -g
-option:
+template configuration file for you. To do this call \c doxygen
+from the command line with the \c -g option:
\verbatim
doxygen -g <config-file>
\endverbatim
@@ -70,7 +67,7 @@ You can probably leave the values of most tags in a generated template
configuration file to their default value. See section \ref config for
more details about the configuration file.
-If you do not like to edit the config file with a text editor, you should
+If you do not wish to edit the config file with a text editor, you should
have a look at \ref doxywizard_usage "doxywizard", which is a GUI
front-end that can create, read and write doxygen configuration files,
and allows setting configuration options by entering them via dialogs.
diff --git a/doc/trouble.doc b/doc/trouble.doc
index 0fca3b2..541d6cf 100644
--- a/doc/trouble.doc
+++ b/doc/trouble.doc
@@ -18,6 +18,8 @@
<h2>Known problems:</h2>
<ul>
+<li>If you have problems building doxygen from sources, please
+ read \ref unix_problems "this section" first.
<li>Doxygen is <em>not</em> a real compiler, it is only a lexical scanner.
This means that it can and will not detect errors in your source code.
<li>Since it impossible to test all possible code fragments, it is
@@ -60,8 +62,8 @@
documentation, because of possible ambiguities or lack of
information about the context in which the code fragment is found.
<li>It is not possible to insert a non-member function f in a class A
- using the \\relates command, if class A already has a member with name f
- and the same argument list.
+ using the \\relates or \\relatesalso command, if class A already
+ has a member with name f and the same argument list.
<li>There is only very limited support for member specialization at the
moment. It only works if there is a specialized template class as
well.
@@ -82,7 +84,15 @@ know why.
\anchor bug_reports
<h2>How to report a bug</h2>
-If you find a bug please send an e-mail to: dimitri@stack.nl.
+Bugs are tracked in GNOME's <a href="http://bugzilla.gnome.org">bugzilla</a> database.
+Before submitting a
+<a href="http://bugzilla.gnome.org/enter_bug.cgi?product=doxygen">new bug</a>,
+first
+<a href="http://bugzilla.gnome.org/buglist.cgi?product=doxygen&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=NEEDINFO&bug_status=REOPENED&bug_status=VERIFIED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&bug_file_loc=&bug_file_loc_type=substring&status_whiteboard=&status_whiteboard_type=substring&keywords=&keywords_type=anywords&op_sys_details=&op_sys_details_type=substring&version_details=&version_details_type=substring&cmdtype=doit&namedcmd=gnome-libs+past+20+days&newqueryname=&order=Reuse+same+sort+as+last+time&form_name=query">
+check</a> if the same bug has already been submitted by others.
+If you believe you have found a new bug,
+please <a href="http://bugzilla.gnome.org/enter_bug.cgi?product=doxygen">file it</a>.
+
If you are unsure whether or not something is a bug, please ask help
on the <a href="http://sourceforge.net/mail/?group_id=5971">users mailing list</a>
first (subscription is required).
@@ -105,21 +115,22 @@ always try to include the following information in your bug report:
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!). If you intend to send more than one file please zip or tar
- the files together into a single attachment for easier processing.
+ the files together into a single file for easier processing.
+ When reporting a new bug you'll get a chance to attach a file to it
+ immediately \e after opening the bug.
+
+You can (and are encouraged to) add a patch for a bug. If you do so
+please use PATCH as a keyword in the bug entry form.
-If you have ideas (or even better some code or a patch)
-how to fix existing bugs and limitations please discuss them on
-the <a href="http://sourceforge.net/mail/?group_id=5971">developers mailing list</a>.
-Patches can also send directly to dimitri@stack.nl.
+If you have ideas how to fix existing bugs and limitations please discuss them on
+the <a href="http://sourceforge.net/mail/?group_id=5971">developers mailing list</a>
+(subscription required). Patches can also be sent directly to dimitri@stack.nl if
+you prefer not to send them via the bug tracker or mailing list.
For patches please use
"diff -uN" 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.
-Note that you can also post bug reports via the bug tracker at
-sourceforge, but I do not really like this because of its web
-interface, which I find rather clumpsy to use.
-
*/
generated by cgit v0.12 at 2024-11-07 07:13:16 (GMT)