From ebf4b3641c9149eaf4468aa8df64e1c7517e5f0c Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Tue, 2 Apr 2013 19:27:49 +0000 Subject: Release-1.8.3.1-20130402 --- CVSROOT/checkoutlist | 13 - CVSROOT/commitinfo | 15 -- CVSROOT/config | 9 - CVSROOT/cvswrappers | 23 -- CVSROOT/editinfo | 21 -- CVSROOT/loginfo | 26 -- CVSROOT/modules | 27 -- CVSROOT/notify | 12 - CVSROOT/rcsinfo | 13 - CVSROOT/taginfo | 20 -- CVSROOT/verifymsg | 21 -- INSTALL | 4 +- README | 4 +- addon/doxywizard/config.l | 2 +- configure | 2 +- doc/arch.doc | 4 +- doc/config.doc | 161 +++++++----- doc/diagrams.doc | 1 + doc/docblocks.doc | 4 +- doc/doxygen_usage.doc | 8 +- doc/faq.doc | 36 +-- doc/features.doc | 2 +- doc/htmlcmds.doc | 6 +- doc/index.doc | 6 +- doc/install.doc | 10 +- doc/language.doc | 41 ++-- doc/language.tpl | 9 +- doc/markdown.doc | 2 +- doc/output.doc | 22 +- doc/perlmod.doc | 89 +++---- doc/searching.doc | 10 +- doc/translator.py | 2 +- doc/translator_report.txt | 614 ++++++++++++++++++++++++++++++++++++++-------- doc/trouble.doc | 5 +- qtools/Doxyfile | 2 + src/.gitignore | 47 ++++ src/clangparser.cpp | 19 +- src/classdef.cpp | 60 ++++- src/classdef.h | 12 +- src/commentcnv.l | 26 +- src/commentscan.l | 8 +- src/compound.xsd | 18 ++ src/compound_xsd.h | 18 ++ src/config.h | 51 +++- src/config.l | 57 ++++- src/config.xml | 19 +- src/configoptions.cpp | 16 +- src/defgen.cpp | 4 + src/dirdef.cpp | 2 + src/docbookgen.cpp | 19 +- src/docsets.cpp | 4 + src/doctokenizer.l | 6 +- src/dot.cpp | 12 + src/doxygen.cpp | 214 ++++++++++++++-- src/doxygen.css | 3 +- src/doxygen.md | 2 +- src/doxygen.pro.in | 2 +- src/doxygen_css.h | 3 +- src/entry.h | 117 +++++---- src/filedef.cpp | 14 +- src/filedef.h | 3 +- src/fortranscanner.l | 85 +++++-- src/groupdef.cpp | 2 + src/growbuf.h | 28 ++- src/htags.cpp | 2 +- src/htmldocvisitor.cpp | 6 +- src/htmlgen.cpp | 37 ++- src/htmlgen.h | 1 + src/latexgen.cpp | 8 + src/latexgen.h | 1 + src/layout.cpp | 24 +- src/layout.h | 6 +- src/layout_default.h | 6 + src/layout_default.xml | 6 + src/mandocvisitor.cpp | 2 +- src/mangen.cpp | 40 ++- src/mangen.h | 3 +- src/markdown.cpp | 20 ++ src/marshal.cpp | 17 +- src/marshal.h | 2 + src/memberdef.cpp | 160 +++++++++++- src/memberdef.h | 16 +- src/memberlist.cpp | 9 + src/namespacedef.cpp | 93 ++++++- src/namespacedef.h | 17 +- src/outputgen.h | 1 + src/outputlist.h | 2 + src/perlmodgen.cpp | 2 + src/pre.l | 114 +++++---- src/pycode.l | 4 +- src/rtfgen.cpp | 10 + src/rtfgen.h | 1 + src/scanner.l | 166 ++++++++++++- src/translator.h | 12 + src/translator_adapter.h | 45 +++- src/translator_am.h | 108 ++++---- src/translator_ar.h | 2 + src/translator_br.h | 4 + src/translator_ca.h | 4 + src/translator_cn.h | 8 +- src/translator_cz.h | 6 +- src/translator_de.h | 6 +- src/translator_dk.h | 4 + src/translator_en.h | 60 +++++ src/translator_eo.h | 6 +- src/translator_es.h | 6 +- src/translator_fa.h | 4 + src/translator_fi.h | 4 + src/translator_fr.h | 4 + src/translator_gr.h | 10 +- src/translator_hr.h | 37 +-- src/translator_hu.h | 2 + src/translator_id.h | 4 + src/translator_it.h | 6 +- src/translator_jp.h | 4 + src/translator_kr.h | 4 + src/translator_lt.h | 2 + src/translator_mk.h | 4 + src/translator_nl.h | 6 +- src/translator_no.h | 2 + src/translator_pl.h | 4 + src/translator_pt.h | 4 + src/translator_ro.h | 10 +- src/translator_ru.h | 7 + src/translator_sc.h | 56 +++-- src/translator_si.h | 4 +- src/translator_sk.h | 6 +- src/translator_sr.h | 4 + src/translator_sv.h | 4 + src/translator_tr.h | 4 + src/translator_tw.h | 4 + src/translator_ua.h | 9 +- src/translator_vi.h | 4 + src/translator_za.h | 4 + src/translatordecoder.h | 22 ++ src/types.h | 13 +- src/util.cpp | 74 +++++- src/vhdldocgen.cpp | 127 +++++----- src/vhdldocgen.h | 17 +- src/vhdlparser.y | 10 +- src/xmlgen.cpp | 56 ++++- 141 files changed, 2699 insertions(+), 1001 deletions(-) delete mode 100644 CVSROOT/checkoutlist delete mode 100644 CVSROOT/commitinfo delete mode 100644 CVSROOT/config delete mode 100644 CVSROOT/cvswrappers delete mode 100644 CVSROOT/editinfo delete mode 100644 CVSROOT/loginfo delete mode 100644 CVSROOT/modules delete mode 100644 CVSROOT/notify delete mode 100644 CVSROOT/rcsinfo delete mode 100644 CVSROOT/taginfo delete mode 100644 CVSROOT/verifymsg create mode 100644 src/.gitignore diff --git a/CVSROOT/checkoutlist b/CVSROOT/checkoutlist deleted file mode 100644 index b04b350..0000000 --- a/CVSROOT/checkoutlist +++ /dev/null @@ -1,13 +0,0 @@ -# The "checkoutlist" file is used to support additional version controlled -# administrative files in $CVSROOT/CVSROOT, such as template files. -# -# The first entry on a line is a filename which will be checked out from -# the corresponding RCS file in the $CVSROOT/CVSROOT directory. -# The remainder of the line is an error message to use if the file cannot -# be checked out. -# -# File format: -# -# [] -# -# comment lines begin with '#' diff --git a/CVSROOT/commitinfo b/CVSROOT/commitinfo deleted file mode 100644 index b19e7b7..0000000 --- a/CVSROOT/commitinfo +++ /dev/null @@ -1,15 +0,0 @@ -# The "commitinfo" file is used to control pre-commit checks. -# The filter on the right is invoked with the repository and a list -# of files to check. A non-zero exit of the filter program will -# cause the commit to be aborted. -# -# The first entry on a line is a regular expression which is tested -# against the directory that the change is being committed to, relative -# to the $CVSROOT. For the first match that is found, then the remainder -# of the line is the name of the filter to run. -# -# If the repository name does not match any of the regular expressions in this -# file, the "DEFAULT" line is used, if it is specified. -# -# If the name "ALL" appears as a regular expression it is always used -# in addition to the first matching regex or "DEFAULT". diff --git a/CVSROOT/config b/CVSROOT/config deleted file mode 100644 index 8817419..0000000 --- a/CVSROOT/config +++ /dev/null @@ -1,9 +0,0 @@ -# Set this to "no" if pserver shouldn't check system users/passwords -#SystemAuth=no - -# Set `PreservePermissions' to `yes' to save file status information -# in the repository. -#PreservePermissions=no - -TopLevelAdmin=yes -#LockDir=/u/kp3softd/cvslocks/ diff --git a/CVSROOT/cvswrappers b/CVSROOT/cvswrappers deleted file mode 100644 index 0c725ea..0000000 --- a/CVSROOT/cvswrappers +++ /dev/null @@ -1,23 +0,0 @@ -# This file affects handling of files based on their names. -# -# The -t/-f options allow one to treat directories of files -# as a single file, or to transform a file in other ways on -# its way in and out of CVS. -# -# The -m option specifies whether CVS attempts to merge files. -# -# The -k option specifies keyword expansion (e.g. -kb for binary). -# -# Format of wrapper file ($CVSROOT/CVSROOT/cvswrappers or .cvswrappers) -# -# wildcard [option value][option value]... -# -# where option is one of -# -f from cvs filter value: path to filter -# -t to cvs filter value: path to filter -# -m update methodology value: MERGE or COPY -# -k expansion mode value: b, o, kkv, &c -# -# and value is a single-quote delimited value. -# For example: -*.gif -k 'b' -m 'COPY' diff --git a/CVSROOT/editinfo b/CVSROOT/editinfo deleted file mode 100644 index d78886c..0000000 --- a/CVSROOT/editinfo +++ /dev/null @@ -1,21 +0,0 @@ -# The "editinfo" file is used to allow verification of logging -# information. It works best when a template (as specified in the -# rcsinfo file) is provided for the logging procedure. Given a -# template with locations for, a bug-id number, a list of people who -# reviewed the code before it can be checked in, and an external -# process to catalog the differences that were code reviewed, the -# following test can be applied to the code: -# -# Making sure that the entered bug-id number is correct. -# Validating that the code that was reviewed is indeed the code being -# checked in (using the bug-id number or a seperate review -# number to identify this particular code set.). -# -# If any of the above test failed, then the commit would be aborted. -# -# Actions such as mailing a copy of the report to each reviewer are -# better handled by an entry in the loginfo file. -# -# One thing that should be noted is the the ALL keyword is not -# supported. There can be only one entry that matches a given -# repository. diff --git a/CVSROOT/loginfo b/CVSROOT/loginfo deleted file mode 100644 index 5a59f0a..0000000 --- a/CVSROOT/loginfo +++ /dev/null @@ -1,26 +0,0 @@ -# The "loginfo" file controls where "cvs commit" log information -# is sent. The first entry on a line is a regular expression which must match -# the directory that the change is being made to, relative to the -# $CVSROOT. If a match is found, then the remainder of the line is a filter -# program that should expect log information on its standard input. -# -# If the repository name does not match any of the regular expressions in this -# file, the "DEFAULT" line is used, if it is specified. -# -# If the name ALL appears as a regular expression it is always used -# in addition to the first matching regex or DEFAULT. -# -# You may specify a format string as part of the -# filter. The string is composed of a `%' followed -# by a single format character, or followed by a set of format -# characters surrounded by `{' and `}' as separators. The format -# characters are: -# -# s = file name -# V = old version number (pre-checkin) -# v = new version number (post-checkin) -# -# For example: -#DEFAULT (echo ""; id; echo %s; date; cat) >> $CVSROOT/CVSROOT/commitlog -# or -#DEFAULT (echo ""; id; echo %{sVv}; date; cat) >> $CVSROOT/CVSROOT/commitlog diff --git a/CVSROOT/modules b/CVSROOT/modules deleted file mode 100644 index 581582c..0000000 --- a/CVSROOT/modules +++ /dev/null @@ -1,27 +0,0 @@ -# Three different line formats are valid: -# key -a aliases... -# key [options] directory -# key [options] directory files... -# -# Where "options" are composed of: -# -i prog Run "prog" on "cvs commit" from top-level of module. -# -o prog Run "prog" on "cvs checkout" of module. -# -e prog Run "prog" on "cvs export" of module. -# -t prog Run "prog" on "cvs rtag" of module. -# -u prog Run "prog" on "cvs update" of module. -# -d dir Place module in directory "dir" instead of module name. -# -l Top-level directory only -- do not recurse. -# -# NOTE: If you change any of the "Run" options above, you'll have to -# release and re-checkout any working directories of these modules. -# -# And "directory" is a path to a directory relative to $CVSROOT. -# -# The "-a" option specifies an alias. An alias is interpreted as if -# everything on the right of the "-a" had been typed on the command line. -# -# You can encode a module within a module by using the special '&' -# character to interpose another module into the current module. This -# can be useful for creating a module that consists of many directories -# spread out over the entire source repository. -doxygen -a addon bin doc examples html lib objects packages qtools src tmake wintools libpng libmd5 diff --git a/CVSROOT/notify b/CVSROOT/notify deleted file mode 100644 index 34f0bc2..0000000 --- a/CVSROOT/notify +++ /dev/null @@ -1,12 +0,0 @@ -# The "notify" file controls where notifications from watches set by -# "cvs watch add" or "cvs edit" are sent. The first entry on a line is -# a regular expression which is tested against the directory that the -# change is being made to, relative to the $CVSROOT. If it matches, -# then the remainder of the line is a filter program that should contain -# one occurrence of %s for the user to notify, and information on its -# standard input. -# -# "ALL" or "DEFAULT" can be used in place of the regular expression. -# -# For example: -#ALL mail %s -s "CVS notification" diff --git a/CVSROOT/rcsinfo b/CVSROOT/rcsinfo deleted file mode 100644 index 49e59f4..0000000 --- a/CVSROOT/rcsinfo +++ /dev/null @@ -1,13 +0,0 @@ -# The "rcsinfo" file is used to control templates with which the editor -# is invoked on commit and import. -# -# The first entry on a line is a regular expression which is tested -# against the directory that the change is being made to, relative to the -# $CVSROOT. For the first match that is found, then the remainder of the -# line is the name of the file that contains the template. -# -# If the repository name does not match any of the regular expressions in this -# file, the "DEFAULT" line is used, if it is specified. -# -# If the name "ALL" appears as a regular expression it is always used -# in addition to the first matching regex or "DEFAULT". diff --git a/CVSROOT/taginfo b/CVSROOT/taginfo deleted file mode 100644 index 274a46d..0000000 --- a/CVSROOT/taginfo +++ /dev/null @@ -1,20 +0,0 @@ -# The "taginfo" file is used to control pre-tag checks. -# The filter on the right is invoked with the following arguments: -# -# $1 -- tagname -# $2 -- operation "add" for tag, "mov" for tag -F, and "del" for tag -d -# $3 -- repository -# $4-> file revision [file revision ...] -# -# A non-zero exit of the filter program will cause the tag to be aborted. -# -# The first entry on a line is a regular expression which is tested -# against the directory that the change is being committed to, relative -# to the $CVSROOT. For the first match that is found, then the remainder -# of the line is the name of the filter to run. -# -# If the repository name does not match any of the regular expressions in this -# file, the "DEFAULT" line is used, if it is specified. -# -# If the name "ALL" appears as a regular expression it is always used -# in addition to the first matching regex or "DEFAULT". diff --git a/CVSROOT/verifymsg b/CVSROOT/verifymsg deleted file mode 100644 index 86f747c..0000000 --- a/CVSROOT/verifymsg +++ /dev/null @@ -1,21 +0,0 @@ -# The "verifymsg" file is used to allow verification of logging -# information. It works best when a template (as specified in the -# rcsinfo file) is provided for the logging procedure. Given a -# template with locations for, a bug-id number, a list of people who -# reviewed the code before it can be checked in, and an external -# process to catalog the differences that were code reviewed, the -# following test can be applied to the code: -# -# Making sure that the entered bug-id number is correct. -# Validating that the code that was reviewed is indeed the code being -# checked in (using the bug-id number or a seperate review -# number to identify this particular code set.). -# -# If any of the above test failed, then the commit would be aborted. -# -# Actions such as mailing a copy of the report to each reviewer are -# better handled by an entry in the loginfo file. -# -# One thing that should be noted is the the ALL keyword is not -# supported. There can be only one entry that matches a given -# repository. diff --git a/INSTALL b/INSTALL index c24819c..54ef1f1 100644 --- a/INSTALL +++ b/INSTALL @@ -1,7 +1,7 @@ -DOXYGEN Version 1.8.3.1-20130324 +DOXYGEN Version 1.8.3.1-20130402 Please read the installation section of the manual (http://www.doxygen.org/install.html) for instructions. -------- -Dimitri van Heesch (24 March 2013) +Dimitri van Heesch (02 April 2013) diff --git a/README b/README index 19253fe..e0063f7 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -DOXYGEN Version 1.8.3.1_20130324 +DOXYGEN Version 1.8.3.1_20130402 Please read INSTALL for compilation instructions. @@ -26,4 +26,4 @@ forum. Enjoy, -Dimitri van Heesch (dimitri@stack.nl) (24 March 2013) +Dimitri van Heesch (dimitri@stack.nl) (02 April 2013) diff --git a/addon/doxywizard/config.l b/addon/doxywizard/config.l index 0f25903..48d233e 100644 --- a/addon/doxywizard/config.l +++ b/addon/doxywizard/config.l @@ -408,7 +408,7 @@ static void substEnvVarsInStrList(QStringList &sl) if (!wasQuoted) /* as a result of the expansion, a single string may have expanded into a list, which we'll - add to sl. If the orginal string already + add to sl. If the original string already contained multiple elements no further splitting is done to allow quoted items with spaces! */ { diff --git a/configure b/configure index 5efb26a..623ffe1 100755 --- a/configure +++ b/configure @@ -20,7 +20,7 @@ doxygen_version_minor=8 doxygen_version_revision=3.1 #NOTE: Setting version_mmn to "NO" will omit mmn info from the package. -doxygen_version_mmn=20130324 +doxygen_version_mmn=20130402 bin_dirs=`echo $PATH | sed -e "s/:/ /g"` diff --git a/doc/arch.doc b/doc/arch.doc index c68d2f8..62661bc 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -58,7 +58,7 @@ of macros. This is to allow macro names to appear in the type of function parameters for instance. Another difference is that the preprocessor parses, but not actually includes -code when it encounters a \#include (with the exception of \#include +code when it encounters a \c \#include (with the exception of \c \#include found inside { ... } blocks). The reasons behind this deviation from the standard is to prevent feeding multiple definitions of the same functions/classes to doxygen's parser. If all source files would @@ -67,7 +67,7 @@ definitions (and their documentation) would be present in each translation unit. The preprocessor is written using \c flex and can be found in -\c src/pre.l. For condition blocks (\#if) evaluation of constant expressions +\c src/pre.l. For condition blocks (\c \#if) evaluation of constant expressions is needed. For this a \c yacc based parser is used, which can be found in \c src/constexp.y and \c src/constexp.l. diff --git a/doc/config.doc b/doc/config.doc index 8ceef96..c5aca26 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -24,6 +24,10 @@ that is similar to that of a Makefile, with the default name \c Doxyfile. It is parsed by \c doxygen. The file may contain tabs and newlines for formatting purposes. The statements in the file are case-sensitive. Comments may be placed anywhere within the file (except within quotes). +Comments beginning with two hash characters (\#\#) are kept when updating +the configuration file and are placed in front of the TAG are in front of. +Comments beginning with two hash characters (\#\#) at the end of the +configuration file are also kept and placed at the end of the file. Comments begin with the \# character and end at the end of the line. The file essentially consists of a list of assignment statements. @@ -218,6 +222,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_mathjax_extensions MATHJAX_EXTENSIONS \refitem cfg_mathjax_format MATHJAX_FORMAT \refitem cfg_mathjax_relpath MATHJAX_RELPATH +\refitem cfg_mathjax_codefile MATHJAX_CODEFILE \refitem cfg_max_dot_graph_depth MAX_DOT_GRAPH_DEPTH \refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES \refitem cfg_mscfile_dirs MSCFILE_DIRS @@ -383,7 +388,7 @@ followed by the descriptions of the tags grouped by category. If the \c BRIEF_MEMBER_DESC tag is set to \c YES (the default) doxygen will include brief member descriptions after the members that are listed in the file and class documentation (similar to JavaDoc). - Set to NO to disable this. + Set to \c NO to disable this. \anchor cfg_repeat_brief
\c REPEAT_BRIEF
@@ -411,7 +416,8 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_always_detailed_sec
\c ALWAYS_DETAILED_SEC
\addindex ALWAYS_DETAILED_SEC - If the \c ALWAYS_DETAILED_SEC and \c REPEAT_BRIEF tags are both set to \c YES then + If the \c ALWAYS_DETAILED_SEC and \ref cfg_repeat_brief "REPEAT_BRIEF" tags + are both set to \c YES then doxygen will generate a detailed section even if there is only a brief description. @@ -428,7 +434,7 @@ followed by the descriptions of the tags grouped by category. \addindex FULL_PATH_NAMES If the \c FULL_PATH_NAMES tag is set to \c YES doxygen will prepend the full path before files name in the file list and in the header files. If set - to NO the shortest path that makes the file name unique will be used + to \c NO the shortest path that makes the file name unique will be used \anchor cfg_strip_from_path
\c STRIP_FROM_PATH
@@ -448,7 +454,7 @@ followed by the descriptions of the tags grouped by category. the reader which header file to include in order to use a class. If left blank only the name of the header file containing the class definition is used. Otherwise one should specify the include paths that - are normally passed to the compiler using the -I flag. + are normally passed to the compiler using the `-I` flag. \anchor cfg_short_names
\c SHORT_NAMES
@@ -462,16 +468,16 @@ followed by the descriptions of the tags grouped by category. \addindex JAVADOC_AUTOBRIEF If the \c JAVADOC_AUTOBRIEF is set to \c YES then doxygen will interpret the first line (until the first dot) of a JavaDoc-style - comment as the brief description. If set to NO (the default), the + comment as the brief description. If set to \c NO (the default), the Javadoc-style will behave just like regular Qt-style comments - (thus requiring an explicit \@brief command for a brief description.) + (thus requiring an explicit \ref cmdbrief "\@brief" command for a brief description.) \anchor cfg_qt_autobrief
\c QT_AUTOBRIEF
\addindex QT_AUTOBRIEF If the \c QT_AUTOBRIEF is set to \c YES then doxygen will interpret the first line (until the first dot) of a Qt-style - comment as the brief description. If set to NO (the default), the + comment as the brief description. If set to \c NO (the default), the Qt-style will behave just like regular Qt-style comments (thus requiring an explicit \\brief command for a brief description.) @@ -486,33 +492,33 @@ followed by the descriptions of the tags grouped by category. Disable only in case of backward compatibilities issues. \anchor cfg_autolink_support -
'c AUTOLINK_SUPPORT
+
\c AUTOLINK_SUPPORT
\addindex AUTOLINK_SUPPORT When enabled doxygen tries to link words that correspond to documented classes, or namespaces to their corresponding documentation. Such a link can be prevented in individual cases by by putting a % sign in front of the word or - globally by setting AUTOLINK_SUPPORT to NO. + globally by setting \c AUTOLINK_SUPPORT to \c NO. \anchor cfg_builtin_stl_support
\c BUILTIN_STL_SUPPORT
\addindex BUILTIN_STL_SUPPORT - If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to + If you use STL classes (i.e. `std::string`, `std::vector`, etc.) but do not want to include (a tag file for) the STL sources as input, then you should set this tag to \c YES in order to let doxygen match functions declarations and - definitions whose arguments contain STL classes (e.g. func(std::string); versus - func(std::string) {}). This also make the inheritance and collaboration + definitions whose arguments contain STL classes (e.g. `func(std::string`); versus + `func(std::string) {}`). This also make the inheritance and collaboration diagrams that involve STL classes more complete and accurate. \anchor cfg_cpp_cli_support
\c CPP_CLI_SUPPORT
\addindex CPP_CLI_SUPPORT - If you use Microsoft's C++/CLI language, you should set this option to YES to + If you use Microsoft's C++/CLI language, you should set this option to \c YES to enable parsing support. \anchor cfg_sip_support
\c SIP_SUPPORT
\addindex OPTIMIZE_OUTPUT_SIP - Set the SIP_SUPPORT tag to YES if your project consists + Set the \c SIP_SUPPORT tag to \c YES if your project consists of sip sources only. Doxygen will parse them like normal C++ but will assume all classes use public instead of private inheritance when no explicit protection keyword is present. @@ -530,29 +536,29 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_distribute_group_doc
\c DISTRIBUTE_GROUP_DOC
\addindex DISTRIBUTE_GROUP_DOC - If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC - tag is set to YES, then doxygen will reuse the documentation of the first + If member grouping is used in the documentation and the \c DISTRIBUTE_GROUP_DOC + tag is set to \c YES, then doxygen will reuse the documentation of the first member in the group (if any) for the other members of the group. By default all members of a group must be documented explicitly. \anchor cfg_multiline_cpp_is_brief
\c MULTILINE_CPP_IS_BRIEF
\addindex MULTILINE_CPP_IS_BRIEF - The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen + The \c MULTILINE_CPP_IS_BRIEF tag can be set to \c YES to make Doxygen treat a multi-line C++ special comment block (i.e. a block of //! or /// comments) as a brief description. This used to be the default behavior. The new default is to treat a multi-line C++ comment block as a detailed - description. Set this tag to YES if you prefer the old behavior instead. - Note that setting this tag to YES also means that rational rose comments + description. Set this tag to \c YES if you prefer the old behavior instead. + Note that setting this tag to \c YES also means that rational rose comments are not recognized any more. @@ -604,7 +610,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_optimize_output_java
\c OPTIMIZE_OUTPUT_JAVA
\addindex OPTIMIZE_OUTPUT_JAVA - Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or + Set the OPTIMIZE_OUTPUT_JAVA tag to \c YES if your project consists of Java or Python sources only. Doxygen will then generate output that is more tailored for that language. For instance, namespaces will be presented as packages, qualified scopes will look different, etc. @@ -662,7 +668,7 @@ When the \c INLINE_SIMPLE_STRUCTS tag is set to \c YES, structs, classes, and unions with only public data fields or simple typedef fields will be shown inline in the documentation of the scope in which they are defined (i.e. file, namespace, or group documentation), provided this scope is documented. If set -to NO (the default), structs, classes, and unions are shown on a separate +to \c NO (the default), structs, classes, and unions are shown on a separate page (for HTML and Man pages) or section (for LaTeX and RTF). \anchor cfg_typedef_hides_struct @@ -739,13 +745,13 @@ page (for HTML and Man pages) or section (for LaTeX and RTF). \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 + If set to \c NO only classes defined in header files are included. Does not have any effect for Java sources. \anchor cfg_extract_anon_nspaces
\c EXTRACT_ANON_NSPACES
\addindex EXTRACT_ANON_NSPACES - If this flag is set to YES, the members of anonymous namespaces will be extracted + If this flag is set to \c YES, the members of anonymous namespaces will be extracted and appear in the documentation as a namespace called 'anonymous_namespace{file}', where file will be replaced with the base name of the file that contains the anonymous namespace. By default anonymous namespace are hidden. @@ -808,7 +814,7 @@ function's detailed documentation block. \c YES upper-case letters are also allowed. This is useful if you have classes or files whose names only differ in case and if your file system supports case sensitive file names. Windows users are advised to set this - option to NO. + option to \c NO. \anchor cfg_hide_scope_names
\c HIDE_SCOPE_NAMES
@@ -877,7 +883,7 @@ function's detailed documentation block. \addindex SORT_MEMBERS_CTORS_1ST If the \c SORT_MEMBERS_CTORS_1ST tag is set to \c YES then doxygen will sort the (brief and detailed) documentation of class members so that - constructors and destructors are listed first. If set to NO (the default) + constructors and destructors are listed first. If set to \c NO (the default) the constructors will appear in the respective orders defined by \c SORT_MEMBER_DOCS and \c SORT_BRIEF_DOCS. @note If \c SORT_BRIEF_DOCS is set to \c NO this option is ignored for @@ -1005,7 +1011,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" doxygen's defaults, run doxygen with the -l option. You can optionally specify a file name after the option, if omitted DoxygenLayout.xml will be used as the name of the layout file. Note that if you run doxygen from a directory containing - a file called DoxygenLayout.xml, doxygen will parse it automatically even if + a file called `DoxygenLayout.xml`, doxygen will parse it automatically even if the \c LAYOUT_FILE tag is left empty. \anchor cfg_cite_bib_files @@ -1094,15 +1100,14 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" \c myfile.cpp or directories like \c /usr/src/myproject. Separate the files or directories with spaces.
- \b Note: - If this tag is empty the current directory is searched. + \note Note If this tag is empty the current directory is searched. \anchor cfg_input_encoding
\c INPUT_ENCODING
\addindex INPUT_ENCODING This tag can be used to specify the character encoding of the source files that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default - input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. + input encoding. Doxygen uses `libiconv` (or the `iconv` built into `libc`) for the transcoding. See the libiconv documentation for the list of possible encodings. @@ -1111,7 +1116,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" \addindex FILE_PATTERNS If the value of the \c INPUT tag contains directories, you can use the \c FILE_PATTERNS tag to specify one or more wildcard patterns - (like \c *.cpp and \c *.h ) to filter out the source-files + (like `*.cpp` and `*.h`) to filter out the source-files in the directories. If left blank the following patterns are tested: *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh @@ -1152,8 +1157,8 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" The \c EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names (namespaces, classes, functions, etc.) that should be excluded from the output. The symbol name can be a fully qualified name, a word, or if the -wildcard * is used, a substring. Examples: ANamespace, AClass, -AClass::ANamespace, ANamespace::*Test +wildcard `*` is used, a substring. Examples: `ANamespace`, `AClass`, +`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 @@ -1164,20 +1169,21 @@ AClass::ANamespace, ANamespace::*Test \addindex EXAMPLE_PATH The \c EXAMPLE_PATH tag can be used to specify one or more files or directories that contain example code fragments that are included (see - the \\include command in section \ref cmdinclude "\\include"). + the \ref cmdinclude "\\include" command). \anchor cfg_example_recursive
\c EXAMPLE_RECURSIVE
\addindex EXAMPLE_RECURSIVE If the \c EXAMPLE_RECURSIVE tag is set to \c YES then subdirectories will be searched for input files to be used with the \\include or \\dontinclude - commands irrespective of the value of the \c RECURSIVE tag. + commands irrespective of the value of the \ref cfg_recursive "RECURSIVE" tag. Possible values are \c YES and \c NO. If left blank \c NO is used. \anchor cfg_example_patterns
\c EXAMPLE_PATTERNS
\addindex EXAMPLE_PATTERNS - If the value of the \c EXAMPLE_PATH tag contains directories, you can use the + If the value of the \ref cfg_example_path "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 blank all files are included. @@ -1209,9 +1215,10 @@ 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 `*.cpp=my_cpp_filter`). See \c INPUT_FILTER for further + pattern=filter (like `*.cpp=my_cpp_filter`). See \ref cfg_input_filter "INPUT_FILTER" for further info on how filters are used. If \c FILTER_PATTERNS is empty or if - none of the patterns match the file name, \c INPUT_FILTER is applied. + none of the patterns match the file name, \ref cfg_input_filter "INPUT_FILTER" is + applied. \anchor cfg_filter_source_files
\c FILTER_SOURCE_FILES
@@ -1219,22 +1226,23 @@ AClass::ANamespace, ANamespace::*Test If the \c FILTER_SOURCE_FILES tag is set to \c YES, the input filter (if set using \ref cfg_input_filter "INPUT_FILTER" ) will also be used to filter the input files that are used for producing the source files to browse - (i.e. when SOURCE_BROWSER is set to YES). + (i.e. when \ref cfg_source_browser "SOURCE_BROWSER" is set to \c YES). \anchor cfg_filter_source_patterns
\c FILTER_SOURCE_PATTERNS
\addindex FILTER_SOURCE_PATTERNS 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) + file pattern. A pattern will override the setting + for \ref cfg_filter_patterns "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 - \c FILTER_SOURCE_FILES is enabled. + \ref cfg_filter_source_files "FILTER_SOURCE_FILES" is enabled. \anchor cfg_use_mdfile_as_mainpage
\c USE_MDFILE_AS_MAINPAGE
\addindex USE_MDFILE_AS_MAINPAGE If the \c USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that -is part of the input, its contents will be placed on the main page (index.html). +is part of the input, its contents will be placed on the main page (`index.html`). This can be useful if you have a project on for instance GitHub and want reuse the introduction page also for the doxygen output. @@ -1249,7 +1257,7 @@ the introduction page also for the doxygen output. If the \c SOURCE_BROWSER tag is set to \c YES then a list of source files will be generated. Documented entities will be cross-referenced with these sources. Note: To get rid of all source code in the generated output, make sure also - \c VERBATIM_HEADERS is set to NO. + \ref cfg_verbatim_headers "VERBATIM_HEADERS" is set to \c NO. \anchor cfg_inline_sources
\c INLINE_SOURCES
@@ -1291,7 +1299,7 @@ the introduction page also for the doxygen output. \addindex VERBATIM_HEADERS If the \c VERBATIM_HEADERS tag is set the \c YES (the default) then doxygen will generate a verbatim copy of the header file for each class for - which an include is specified. Set to NO to disable this. + which an include is specified. Set to \c NO to disable this. \sa Section \ref cmdclass "\\class". \anchor cfg_use_htags @@ -1571,7 +1579,7 @@ hr.footer { \addindex HTML_TIMESTAMP If the \c HTML_TIMESTAMP tag is set to \c YES then the footer of each generated HTML page will contain the date and time when the page - was generated. Setting this to NO can help when comparing the output of + was generated. Setting this to \c NO can help when comparing the output of multiple runs. \anchor cfg_html_align_members @@ -1703,14 +1711,14 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. \anchor cfg_toc_expand
\c TOC_EXPAND
\addindex TOC_EXPAND - The \c TOC_EXPAND flag can be set to YES to add extra items for + The \c TOC_EXPAND flag can be set to \c YES to add extra items for group members to the table of contents of the HTML help documentation and to the tree view. \anchor cfg_generate_qhp
\c GENERATE_QHP
\addindex GENERATE_QHP - If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE + If the GENERATE_QHP tag is set to \c YES and both \c QHP_NAMESPACE and QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated HTML @@ -1728,38 +1736,38 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. \addindex QHP_NAMESPACE The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help Project output. For more information please see - Qt Help Project / Namespace. + Qt Help Project / Namespace. \anchor cfg_qhp_virtual_folder
\c QHP_VIRTUAL_FOLDER
\addindex QHP_VIRTUAL_FOLDER The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt Help Project output. For more information please see - Qt Help Project / Virtual Folders. + Qt Help Project / Virtual Folders. \anchor cfg_qhp_cust_filter_name
\c QHP_CUST_FILTER_NAME
\addindex QHP_CUST_FILTER_NAME If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. For more information please see - Qt Help Project / Custom Filters. + Qt Help Project / Custom Filters. \anchor cfg_qhp_cust_filter_attrs
\c QHP_CUST_FILTER_ATTRS
\addindex QHP_CUST_FILTER_ATTRS The QHP_CUST_FILTER_ATTRIBUTES tag specifies the list of the attributes of the custom filter to add. For more information please see - Qt Help Project / Custom Filters. + Qt Help Project / Custom Filters. \anchor cfg_qhp_sect_filter_attrs
\c QHP_SECT_FILTER_ATTRS
\addindex QHP_SECT_FILTER_ATTRS The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's filter section matches. - Qt Help Project / Filter Attributes. + Qt Help Project / Filter Attributes. \anchor cfg_qhg_location
\c QHG_LOCATION
\addindex QHG_LOCATION - If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can + If the GENERATE_QHP tag is set to \c YES, the \c QHG_LOCATION tag can be used to specify the location of Qt's qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the generated .qhp file. @@ -1792,7 +1800,7 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. If you want full control over the layout of the generated HTML pages it might be necessary to disable the index and replace it with your own. The \c DISABLE_INDEX tag can be used to turn on/off the condensed index at - top of each page. A value of NO (the default) enables the index and the + top of each page. A value of \c NO (the default) enables the index and the value \c YES disables it. Since the tabs have the same information as the navigation tree you can set this option to \c NO if you already set \ref cfg_generate_treeview "GENERATE_TREEVIEW" to \c YES. @@ -1810,7 +1818,7 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. \addindex GENERATE_TREEVIEW The GENERATE_TREEVIEW tag is used to specify whether a tree-like index structure should be generated to display hierarchical information. - If the tag value is set to YES, a side panel will be generated + If the tag value is set to \c YES, a side panel will be generated containing a tree-like index structure (just like the one that is generated for HTML Help). For this to work a browser that supports JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). @@ -1874,6 +1882,25 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. the MathJax site for more details. +\anchor cfg_mathjax_codefile +
\c MATHJAX_CODEFILE
+ \addindex MATHJAX_CODEFILE + The MATHJAX_CODE_FILE tag can be used to specify a file with javascript + pieces of code that will be used on startup of the MathJax code. + See +the MathJax site + for more details.
+ As an example to disable the "Math Renderer" menu item in the "Math + Settings" menu of MathJax: +\verbatim +MATHJAX_CODEFILE = disableRenderer + with in the file \c disableRenderer: + MathJax.Hub.Config({ + menuSettings: { + showRenderer: false, + } + }); +\endverbatim \anchor cfg_mathjax_relpath
\c MATHJAX_RELPATH
\addindex MATHJAX_RELPATH @@ -2223,7 +2250,9 @@ EXTRA_PACKAGES = times
\c MAN_EXTENSION
\addindex MAX_EXTENSION The \c MAN_EXTENSION tag determines the extension that is added to - the generated man pages (default is the subroutine's section .3) + the generated man pages (default is the subroutine's section .3). In case + the manual section does not start with a number, the number 3 is prepended. + The dot (.) at the beginning of the MAN_EXTENSION is optional. \anchor cfg_man_links
\c MAN_LINKS
@@ -2368,7 +2397,7 @@ front of it. If left blank docbook will be used as the default path. \anchor cfg_expand_only_predef
\c EXPAND_ONLY_PREDEF
\addindex EXPAND_ONLY_PREDEF - If the \c EXPAND_ONLY_PREDEF and \c MACRO_EXPANSION tags are both set to YES + If the \c EXPAND_ONLY_PREDEF and \c MACRO_EXPANSION tags are both set to \c YES then the macro expansion is limited to the macros specified with the \c PREDEFINED and \c EXPAND_AS_DEFINED tags. @@ -2482,8 +2511,8 @@ front of it. If left blank docbook will be used as the default path. \addindex CLASS_DIAGRAMS If the \c CLASS_DIAGRAMS tag is set to \c YES (the default) doxygen will generate a class diagram (in HTML and \f$\mbox{\LaTeX}\f$) for classes with base or -super classes. Setting the tag to NO turns the diagrams off. Note that -this option also works with HAVE_DOT disabled, but it is recommended to +super classes. Setting the tag to \c NO turns the diagrams off. Note that +this option also works with \c HAVE_DOT disabled, but it is recommended to install and use dot, since it yields more powerful graphs. \anchor cfg_mscgen_path @@ -2543,7 +2572,7 @@ The default size is 10pt. If the \c CLASS_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen will generate a graph for each documented class showing the direct and indirect inheritance relations. Setting this tag to \c YES will force - the \c CLASS_DIAGRAMS tag to NO. + the \c CLASS_DIAGRAMS tag to \c NO. \anchor cfg_collaboration_graph
\c COLLABORATION_GRAPH
@@ -2556,13 +2585,13 @@ The default size is 10pt. \anchor cfg_group_graphs
\c GROUP_GRAPHS
\addindex GROUP_GRAPHS - If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen + If the GROUP_GRAPHS and HAVE_DOT tags are set to \c YES then doxygen will generate a graph for groups, showing the direct groups dependencies. \anchor cfg_uml_look
\c UML_LOOK
\addindex UML_LOOK - If the UML_LOOK tag is set to YES doxygen will generate inheritance and + If the UML_LOOK tag is set to \c YES doxygen will generate inheritance and collaboration diagrams in a style similar to the OMG's Unified Modeling Language. @@ -2573,7 +2602,7 @@ The default size is 10pt. the class node. If there are many fields or methods and many nodes the graph may become too big to be useful. The \c UML_LIMIT_NUM_FIELDS threshold limits the number of items for each type to make the size more - managable. Set this to 0 for no limit. Note that the threshold may be + manageable. Set this to 0 for no limit. Note that the threshold may be exceeded by 50% before the limit is enforced. So when you set the threshold to 10, up to 15 fields may appear, but if the number exceeds 15, the total amount of fields shown is limited to 10. @@ -2587,7 +2616,7 @@ The default size is 10pt. \anchor cfg_hide_undoc_relations
\c HIDE_UNDOC_RELATIONS
\addindex HIDE_UNDOC_RELATIONS - If set to YES, the inheritance and collaboration graphs will hide + If set to \c YES, the inheritance and collaboration graphs will hide inheritance and usage relations if the target is undocumented or is not a class. @@ -2673,7 +2702,7 @@ The default size is 10pt. \anchor cfg_interactive_svg
\c INTERACTIVE_SVG
- If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to + If DOT_IMAGE_FORMAT is set to svg, then this option can be set to \c YES to enable generation of interactive SVG images that allow zooming and panning. Note that this requires a modern browser other than Internet Explorer. Tested and working are Firefox, Chrome, Safari, and Opera. diff --git a/doc/diagrams.doc b/doc/diagrams.doc index ec9f329..59a81cc 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -140,6 +140,7 @@ for the corresponding HTML documentation that is generated by doxygen
\endhtmlonly \htmlonly +

Go to the next section or return to the index. \endhtmlonly diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 0363e7e..1b96361 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -433,8 +433,8 @@ config file. For VHDL a comment normally start with "--". Doxygen will extract comments starting with "--!". There are only two types of comment blocks in VHDL; -a one line --! comment representing a brief description, and a multi-line ---! comment (where the --! prefix is repeated for each line) representing +a one line "--!" comment representing a brief description, and a multi-line +"--!" comment (where the "--!" prefix is repeated for each line) representing a detailed description. Comments are always located in front of the item that is being documented diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc index 430846a..ddad5d7 100644 --- a/doc/doxygen_usage.doc +++ b/doc/doxygen_usage.doc @@ -67,11 +67,11 @@ afterwards: \verbatim doxygen -w html header.html footer.html stylesheet.css \endverbatim - The config_file is optional. When omitted doxygen will search for - a file named Doxyfile and process that. When this is also not found it + The `config_file` is optional. When omitted doxygen will search for + a file named `Doxyfile` and process that. When this is also not found it will used the default settings. -
  • For LaTeX output, you can generate the first and last part of \c refman.tex +
  • For \f$\mbox{\LaTeX}\f$ output, you can generate the first and last part of \c refman.tex (see \ref cfg_latex_header "LATEX_HEADER" and \ref cfg_latex_footer "LATEX_FOOTER") and the style sheet included by that header (normally doxygen.sty), using the following @@ -79,7 +79,7 @@ doxygen -w html header.html footer.html stylesheet.css \verbatim doxygen -w latex header.tex footer.tex doxygen.sty \endverbatim -If you need non-default options (for instance to use extra latex packages) +If you need non-default options (for instance to use extra \f$\mbox{\LaTeX}\f$ packages) you need to make a config file with those options set correctly and then specify that config file after the generated files (make a backup of the configuration file first so you don't loose it in case you forget to specify one of the diff --git a/doc/faq.doc b/doc/faq.doc index 8e5d049..79e6585 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -19,7 +19,7 @@
    1. How to get information on the index page in HTML?

      -You should use the \\mainpage command inside a comment block like this: +You should use the \ref cmdmainpage "\\mainpage" command inside a comment block like this: \verbatim /*! \mainpage My Personal Index Page * @@ -41,9 +41,9 @@ You should use the \\mainpage command inside a comment block like this: Check the following:

      1. Is your class / file / namespace documented? If not, it will not - be extracted from the sources unless \c EXTRACT_ALL is set to \c YES + be extracted from the sources unless \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES in the config file. -
      2. Are the members private? If so, you must set \c EXTRACT_PRIVATE to \c YES +
      3. Are the members private? If so, you must set \ref cfg_extract_private "EXTRACT_PRIVATE" to \c YES to make them appear in the documentation.
      4. Is there a function macro in your class that does not end with a semicolon (e.g. MY_MACRO())? If so then you have to instruct @@ -67,12 +67,12 @@ PREDEFINED = MY_MACRO()= In order for global functions, variables, enums, typedefs, and defines to be documented you should document the file in which these commands are -located using a comment block containing a \\file (or \@file) +located using a comment block containing a \ref cmdfile "\\file" (or \ref cmdfile "\@file") command. Alternatively, you can put all members in a group (or module) -using the \\ingroup command and then document the group using a comment -block containing the \\defgroup command. +using the \ref cmdingroup "\\ingroup" command and then document the group using a comment +block containing the \ref cmddefgroup "\\defgroup" command. For member functions or functions that are part of a namespace you should document either the class or namespace. @@ -98,12 +98,13 @@ around the blocks that should be hidden and put: PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \endverbatim in the config file then all blocks should be skipped by Doxygen as long -as PREPROCESSING = YES. +as \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to `YES`. -
      5. How can I change what is after the \#include in the class documentation? +
      6. How can I change what is after the \#include +in the class documentation? -In most cases you can use STRIP_FROM_INC_PATH to strip a user defined -part of a path. +In most cases you can use \ref cfg_strip_from_inc_path "STRIP_FROM_INC_PATH" +to strip a user defined part of a path. You can also document your class as follows @@ -160,9 +161,9 @@ installdox -lb.tag@b.chm::
      7. I don't like the quick index that is put above each HTML page, what do I do? -You can disable the index by setting DISABLE_INDEX to YES. Then you can +You can disable the index by setting \ref cfg_disable_index "DISABLE_INDEX" to `YES`. Then you can put in your own header file by writing your own header and feed that to -HTML_HEADER. +\ref cfg_html_header "HTML_HEADER".
      8. The overall HTML output looks different, while I only wanted to use my own html header file @@ -237,8 +238,8 @@ various buffers and then run "texconfig init".
      9. Why are dependencies via STL classes not shown in the dot graphs? -Doxygen is unaware of the STL classes, unless the option BUILTIN_STL_SUPPORT is -turned on. +Doxygen is unaware of the STL classes, unless the +option \ref cfg_builtin_stl_support "BUILTIN_STL_SUPPORT" is turned on.
      10. I have problems getting the search engine to work with PHP5 and/or windows @@ -248,7 +249,7 @@ Please read this for hints on where to look. Not via command line options, but doxygen can read from stdin, so you can pipe things through it. Here's an example how to override an option -in a configuration file from the command line (assuming a UNIX environment): +in a configuration file from the command line (assuming a UNIX like environment): \verbatim ( cat Doxyfile ; echo "PROJECT_NUMBER=1.0" ) | doxygen - @@ -280,9 +281,10 @@ At the time I was looking into lex and yacc, where a lot of things start with
      11. What was the reason to develop doxygen? I once wrote a GUI widget based on the Qt library (it is still available at -http://qdbttabular.sourceforge.net/ and maintained by Sven Meyer). +http://sourceforge.net/projects/qdbttabular/ but hasn't been updated since 2002). Qt had nicely generated documentation (using an internal tool which -they didn't want to release) and I wrote similar docs by hand. +they didn't want to release) +and I wrote similar docs by hand. This was a nightmare to maintain, so I wanted a similar tool. I looked at Doc++ but that just wasn't good enough (it didn't support signals and slots and did not have the Qt look and feel I had grown to like), diff --git a/doc/features.doc b/doc/features.doc index 3b55ccd..87ca4bc 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -100,7 +100,7 @@ Although doxygen can now be used in any project written in a language that is supported by doxygen, initially it was specifically designed to be used for projects that make use of Qt Software's -Qt toolkit. I have tried to +Qt toolkit. I have tried to make doxygen `Qt-compatible'. That is: Doxygen can read the documentation contained in the Qt source code and create a class browser that looks quite similar to the one that is generated by Qt Software. Doxygen understands the C++ extensions diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 66018d3..6b7172d 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -40,10 +40,10 @@ of a HTML tag are passed on to the HTML output only
      12. \ Starts a caption. Use within a table only.
      13. \ Ends a caption. Use within a table only.
      14. \ Starts a piece of text displayed in a typewriter font. - Note that for C# code, this command is equivalent to - \ref cmdcode "\\code". + Note that only for C# code, this command is equivalent to + \ref cmdcode "\\code".
      15. \ Ends a \ section. - Note that for C# code, this command is equivalent to + Note that only for C# code, this command is equivalent to \ref cmdendcode "\\endcode".
      16. \ Starts an item description.
      17. \ Starts a piece of text displayed in a typewriter font. diff --git a/doc/index.doc b/doc/index.doc index f36e295..55dceff 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -30,7 +30,7 @@ Version: $(VERSION) Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL -(Corba and Microsoft flavors), Fortran, VHDL, Tcl, and to some extent D. +(Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D. Doxygen can help you in three ways:
          @@ -164,8 +164,8 @@ You can submit enhancement requests in the bug tracker. Make sure the severity of the bug report is set to "enhancement". -

          Acknowledgements

          -\addindex acknowledgements +

          Acknowledgments

          +\addindex acknowledgments Thanks go to:
          • \addindex Doc++ diff --git a/doc/install.doc b/doc/install.doc index 566baac..4ec6e66 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -361,7 +361,7 @@ You can now build the Release or Debug flavor of Doxygen by right-clicking the project in the solutions explorer, and selecting Build. Note that compiling Doxywizard currently requires Qt version 4 -(see http://qt.nokia.com/products/platform/qt-for-windows). +(see http://qt-project.org/). Also read the next section for additional tools you may need to install to run doxygen with certain features enabled. @@ -446,7 +446,7 @@ Here is what is required: 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 commercial version of) Qt.
          • If you used WinZip to extract the tar archive it will (apparently) not create empty folders, so you have to add the folders @@ -523,12 +523,12 @@ If you want to produce compressed HTML files (see \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the config file, then you need the Microsoft HTML help workshop. You can download it from -Microsoft. +Microsoft. If you want to produce Qt Compressed Help files (see \ref cfg_qhg_location "QHG_LOCATION") in the config file, then you need qhelpgenerator which is part of Qt. -You can download Qt from Qt Software Downloads. +You can download Qt from Qt Software Downloads. In order to generate PDF output or use scientific formulas you will also need to install LaTeX and @@ -601,7 +601,7 @@ features: cfg_qhelgenerator_loc "QHG_LOCATION") in the config file, then you need qhelpgenerator which is part of Qt. You can download Qt from - Qt Software Downloads. + Qt Software Downloads.
          • the Graph visualization toolkit version 1.8.10
            diff --git a/doc/language.doc b/doc/language.doc index 7321fbe..70a0ace 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -104,7 +104,7 @@ when the translator was updated. Czech Petr Přikryl prikryl at atlas dot cz - up-to-date + 1.8.04 Danish @@ -116,7 +116,7 @@ when the translator was updated. Dutch Dimitri van Heesch dimitri at stack dot nl - up-to-date + 1.8.04 English @@ -128,7 +128,7 @@ when the translator was updated. Esperanto Ander Martínez ander dot basaundi at gmail dot com - up-to-date + 1.8.04 Finnish @@ -146,13 +146,13 @@ when the translator was updated. German Peter Grotrian
            Jens Seidel Peter dot Grotrian at pdv-FS dot de
            jensseidel at users dot sf dot net - up-to-date + 1.8.04 Greek Paul Gessos gessos dot paul at yahoo dot gr - up-to-date + 1.8.04 Hungarian @@ -266,7 +266,7 @@ when the translator was updated. Slovak Kali+Laco Švec
            Petr Přikryl [the Slovak language advisors]
            prikryl at atlas dot cz - up-to-date + 1.8.04 Slovene @@ -278,7 +278,7 @@ when the translator was updated. Spanish Bartomeu
            Francisco Oltra Thennet
            David Vaquero bartomeu at loteria3cornella dot com
            [unreachable]
            david at grupoikusnet dot com - up-to-date + 1.8.04 Swedish @@ -296,7 +296,7 @@ when the translator was updated. Ukrainian Olexij Tkatchenko
            Petro Yermolenko [resigned]
            python at i dot ua - up-to-date + 1.8.04 Vietnamese @@ -341,26 +341,26 @@ when the translator was updated. \hline Croatian & Boris Bralo & {\tt\tiny boris dot bralo at gmail dot com} & 1.8.2 \\ \hline - Czech & Petr Přikryl & {\tt\tiny prikryl at atlas dot cz} & up-to-date \\ + Czech & Petr Přikryl & {\tt\tiny prikryl at atlas dot cz} & 1.8.04 \\ \hline Danish & Poul-Erik Hansen & {\tt\tiny pouhan at gnotometrics dot dk} & 1.8.0 \\ ~ & Erik Søe Sørensen & {\tt\tiny eriksoe+doxygen at daimi dot au dot dk} & ~ \\ \hline - Dutch & Dimitri van Heesch & {\tt\tiny dimitri at stack dot nl} & up-to-date \\ + Dutch & Dimitri van Heesch & {\tt\tiny dimitri at stack dot nl} & 1.8.04 \\ \hline English & Dimitri van Heesch & {\tt\tiny dimitri at stack dot nl} & up-to-date \\ \hline - Esperanto & Ander Martínez & {\tt\tiny ander dot basaundi at gmail dot com} & up-to-date \\ + Esperanto & Ander Martínez & {\tt\tiny ander dot basaundi at gmail dot com} & 1.8.04 \\ \hline Finnish & Antti Laine & {\tt\tiny antti dot a dot laine at tut dot fi} & 1.6.0 \\ \hline French & David Martinet & {\tt\tiny contact at e-concept-applications dot fr} & 1.8.0 \\ ~ & Xavier Outhier & {\tt\tiny xouthier at yahoo dot fr} & ~ \\ \hline - German & Peter Grotrian & {\tt\tiny Peter dot Grotrian at pdv-FS dot de} & up-to-date \\ + German & Peter Grotrian & {\tt\tiny Peter dot Grotrian at pdv-FS dot de} & 1.8.04 \\ ~ & Jens Seidel & {\tt\tiny jensseidel at users dot sf dot net} & ~ \\ \hline - Greek & Paul Gessos & {\tt\tiny gessos dot paul at yahoo dot gr} & up-to-date \\ + Greek & Paul Gessos & {\tt\tiny gessos dot paul at yahoo dot gr} & 1.8.04 \\ \hline Hungarian & Ákos Kiss & {\tt\tiny akiss at users dot sourceforge dot net} & 1.4.6 \\ ~ & Földvári György & {\tt\tiny [unreachable] foldvari lost at cyberspace} & ~ \\ @@ -412,12 +412,12 @@ when the translator was updated. \hline SerbianCyrilic & Nedeljko Stefanovic & {\tt\tiny stenedjo at yahoo dot com} & 1.6.0 \\ \hline - Slovak & Kali+Laco Švec & {\tt\tiny [the Slovak language advisors]} & up-to-date \\ + Slovak & Kali+Laco Švec & {\tt\tiny [the Slovak language advisors]} & 1.8.04 \\ ~ & Petr Přikryl & {\tt\tiny prikryl at atlas dot cz} & ~ \\ \hline Slovene & Matjaž Ostroveršnik & {\tt\tiny matjaz dot ostroversnik at ostri dot org} & 1.4.6 \\ \hline - Spanish & Bartomeu & {\tt\tiny bartomeu at loteria3cornella dot com} & up-to-date \\ + Spanish & Bartomeu & {\tt\tiny bartomeu at loteria3cornella dot com} & 1.8.04 \\ ~ & Francisco Oltra Thennet & {\tt\tiny [unreachable] foltra at puc dot cl} & ~ \\ ~ & David Vaquero & {\tt\tiny david at grupoikusnet dot com} & ~ \\ \hline @@ -425,7 +425,7 @@ when the translator was updated. \hline Turkish & Emin Ilker Cetinbas & {\tt\tiny niw3 at yahoo dot com} & 1.7.5 \\ \hline - Ukrainian & Olexij Tkatchenko & {\tt\tiny [resigned] olexij at tkatchenko dot com} & up-to-date \\ + Ukrainian & Olexij Tkatchenko & {\tt\tiny [resigned] olexij at tkatchenko dot com} & 1.8.04 \\ ~ & Petro Yermolenko & {\tt\tiny python at i dot ua} & ~ \\ \hline Vietnamese & Dang Minh Tuan & {\tt\tiny tuanvietkey at gmail dot com} & 1.6.0 \\ @@ -651,8 +651,8 @@ for the supported languages, the \c translator.py Python 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 translator report ASCII file -(translator_report.txt). +The information is stored in the translator report ASCII file +(\c translator_report.txt). \htmlonly If you compiled this documentation from sources and if you have also doxygen sources available the @@ -751,5 +751,10 @@ used if possible. On the other hand, implementation of adapters for really obsolete translators brings too much maintenance and run-time overhead. +\htmlonly +Go to the next section or return to the + index. +\endhtmlonly + */ diff --git a/doc/language.tpl b/doc/language.tpl index 7ec6621..661e67b 100644 --- a/doc/language.tpl +++ b/doc/language.tpl @@ -254,8 +254,8 @@ for the supported languages, the \c translator.py Python 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 translator report ASCII file -(%(translatorReportFileName)s). +The information is stored in the translator report ASCII file +(\c %(translatorReportFileName)s). \htmlonly If you compiled this documentation from sources and if you have also doxygen sources available the @@ -353,5 +353,10 @@ used if possible. On the other hand, implementation of adapters for really obsolete translators brings too much maintenance and run-time overhead. +\htmlonly +Go to the next section or return to the + index. +\endhtmlonly + */ diff --git a/doc/markdown.doc b/doc/markdown.doc index bd4a3aa..b32cca4 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -520,7 +520,7 @@ stars, so the following will appear as-is: a_nice_identifier -Futhermore, a `*` or `_` only starts an emphasis if +Furthermore, a `*` or `_` only starts an emphasis if - it is followed by an alphanumberical character, and - it is preceded by a space, newline, or one the following characters `<{([,:;` diff --git a/doc/output.doc b/doc/output.doc index 752123b..face02a 100644 --- a/doc/output.doc +++ b/doc/output.doc @@ -21,37 +21,39 @@ The following output formats are \e directly supported by doxygen:
            HTML -
            Generated if \c GENERATE_HTML is set to \c YES in the configuration file. +
            Generated if \ref cfg_generate_html "GENERATE_HTML" is set to \c YES in the configuration file.
            \f$\mbox{\LaTeX}\f$ -
            Generated if \c GENERATE_LATEX is set to \c YES in the configuration file. +
            Generated if \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES in the configuration file.
            Man pages -
            Generated if \c GENERATE_MAN is set to \c YES in the configuration file. +
            Generated if \ref cfg_generate_man "GENERATE_MAN" is set to \c YES in the configuration file.
            RTF -
            Generated if \c GENERATE_RTF is set to \c YES in the configuration file.

            +

            Generated if \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES in the configuration file.

            Note that the RTF output probably only looks nice with Microsoft's Word. If you have success with other programs, please let me know.

            XML -
            Generated if \c GENERATE_XML is set to \c YES in the configuration file.

            +

            Generated if \ref cfg_generate_xml "GENERATE_XML" is set to \c YES in the configuration file.

            +

            Docbook +
            Generated if \ref cfg_generate_docbook "GENERATE_DOCBOOOK" is set to \c YES in the configuration file.

            The following output formats are \e indirectly supported by doxygen:
            Compiled HTML Help (a.k.a. Windows 98 help)
            Generated by Microsoft's HTML Help workshop from the HTML output if - \c GENERATE_HTMLHELP is set to \c YES. + \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES.
            Qt Compressed Help (.qch)
            Generated by Qt's qhelpgenerator tool from the HTML output if - \c GENERATE_QHP is set to \c YES. + \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES.
            Eclipse Help
            Generated from HTML with a special index file that is generated when - \c GENERATE_ECLIPSEHELP is set to \c YES. + \ref cfg_generate_eclipsehelp "GENERATE_ECLIPSEHELP" is set to \c YES.
            XCode DocSets
            Compiled from HTML with a special index file that is generated when - \c GENERATE_DOCSET is set to \c YES. + \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES.
            PostScript
            Generated from the \f$\mbox{\LaTeX}\f$ output by running make ps in the output directory. - For the best results \c PDF_HYPERLINKS should be set to \c NO. + For the best results \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS" should be set to \c NO.
            PDF\htmlonly    \endhtmlonly
            Generated from the \f$\mbox{\LaTeX}\f$ output by running make pdf in the output directory. diff --git a/doc/perlmod.doc b/doc/perlmod.doc index 00bff63..6a04434 100644 --- a/doc/perlmod.doc +++ b/doc/perlmod.doc @@ -23,27 +23,27 @@ doxygen-develop mailing list. Suggestions are welcome as well. \section using_perlmod_fmt Usage -

            When the GENERATE_PERLMOD tag is enabled in the Doxyfile, -running Doxygen generates a number of files in the perlmod/ +

            When the \ref cfg_generate_perlmod "GENERATE_PERLMOD" tag is enabled in the Doxyfile, +running Doxygen generates a number of files in the `perlmod/` subdirectory of your output directory. These files are the following:

              -
            • DoxyDocs.pm. This is the Perl module that actually +
            • `DoxyDocs.pm`: This is the Perl module that actually contains the documentation, in the Perl Module format described \ref doxydocs_format "below". -
            • DoxyModel.pm. This Perl module describes the structure of -DoxyDocs.pm, independently of the actual documentation. See +
            • `DoxyModel.pm`: This Perl module describes the structure of +`DoxyDocs.pm`, independently of the actual documentation. See \ref doxymodel_format "below" for details. -
            • doxyrules.make. This file contains the make rules to build +
            • `doxyrules.make`: This file contains the make rules to build and clean the files that are generated from the Doxyfile. Also contains the paths to those files and other relevant information. This file is intended to be included by your own Makefile. -
            • Makefile. This is a simple Makefile including -doxyrules.make. +
            • `Makefile`: This is a simple Makefile including +`doxyrules.make`.
            @@ -65,70 +65,71 @@ within files and classes and can be customized quite a lot by redefining TeX macros. However, there is still no documentation on how to do this. -

            Setting the PERLMOD_LATEX tag to YES in the Doxyfile -enables the creation of some additional files in the perlmod/ +

            Setting the \ref cfg_perlmod_latex "PERLMOD_LATEX" tag to \c YES in the +\c Doxyfile enables the creation of some additional files in the `perlmod/` subdirectory of your output directory. These files contain the Perl scripts and LaTeX code necessary to generate PDF and DVI output from -the Perl Module output, using PDFLaTeX and LaTeX respectively. Rules +the Perl Module output, using `pdflatex` and `latex` respectively. Rules to automate the use of these files are also added to -doxyrules.make and the Makefile. +`doxyrules.make` and the `Makefile`.

            The additional generated files are the following:

              -
            • doxylatex.pl. This Perl script uses DoxyDocs.pm and -DoxyModel.pm to generate doxydocs.tex, a TeX file containing +
            • `doxylatex.pl`: This Perl script uses `DoxyDocs.pm` and +DoxyModel.pm to generate `doxydocs.tex`, a TeX file containing the documentation in a format that can be accessed by LaTeX code. This file is not directly LaTeXable. -
            • doxyformat.tex. This file contains the LaTeX code that +
            • `doxyformat.tex`: This file contains the \f$\mbox{\LaTeX}\f$ code that transforms the documentation from doxydocs.tex into LaTeX text -suitable to be LaTeX'ed and presented to the user. +suitable to be \f$\mbox{\LaTeX}\f$'ed and presented to the user. -
            • doxylatex-template.pl. This Perl script uses DoxyModel.pm -to generate doxytemplate.tex, a TeX file defining default +
            • `doxylatex-template.pl`: This Perl script uses `DoxyModel.pm` +to generate `doxytemplate.tex`, a \f$\mbox{\TeX}\f$ file defining default values for some macros. doxytemplate.tex is included by doxyformat.tex to avoid the need of explicitly defining some macros. -
            • doxylatex.tex. This is a very simple LaTeX document that +
            • `doxylatex.tex`: This is a very simple \f$\mbox{\LaTeX}\f$ document that loads some packages and includes doxyformat.tex and doxydocs.tex. This -document is LaTeX'ed to produce the PDF and DVI documentation by the -rules added to doxyrules.make. +document is \f$\mbox{\LaTeX}\f$'ed to produce the PDF and DVI documentation by the +rules added to `doxyrules.make`.
            \subsection pm_pdf_gen Creation of PDF and DVI output

            To try this you need to have installed LaTeX, PDFLaTeX and the -packages used by doxylatex.tex. +packages used by `doxylatex.tex`.

              -
            1. Update your Doxyfile to the latest version using: +
            2. Update your `Doxyfile` to the latest version using: 
              doxygen -u Doxyfile
              -
            3. Set both GENERATE_PERLMOD and PERLMOD_LATEX tags to -YES in your Doxyfile. +
            4. Set both \ref cfg_generate_perlmod "GENERATE_PERLMOD" and +\ref cfg_perlmod_latex "PERLMOD_LATEX" tags to +\c YES in your Doxyfile.
            5. Run Doxygen on your Doxyfile: 
              doxygen Doxyfile
              -
            6. A perlmod/ subdirectory should have appeared in your output -directory. Enter the perlmod/ subdirectory and run: +
            7. A `perlmod/` subdirectory should have appeared in your output +directory. Enter the `perlmod/` subdirectory and run: 
              make pdf
              -

              This should generate a doxylatex.pdf with the documentation +

              This should generate a `doxylatex.pdf` with the documentation in PDF format.

            8. Run: 
              make dvi
              -

              This should generate a doxylatex.dvi with the documentation +

              This should generate a `doxylatex.dvi` with the documentation in DVI format.

            @@ -136,29 +137,29 @@ in DVI format. \section doxydocs_format Documentation format.

            The Perl Module documentation generated by Doxygen is stored in -DoxyDocs.pm. This is a very simple Perl module that contains -only two statements: an assignment to the variable $doxydocs and -the customary 1; statement which usually ends Perl modules. -The documentation is stored in the variable $doxydocs, which -can then be accessed by a Perl script using DoxyDocs.pm. +`DoxyDocs.pm`. This is a very simple Perl module that contains +only two statements: an assignment to the variable `$doxydocs` and +the customary `1;` statement which usually ends Perl modules. +The documentation is stored in the variable `$doxydocs`, which +can then be accessed by a Perl script using `DoxyDocs.pm`. -

            $doxydocs contains a tree-like structure composed of three +

            `$doxydocs` contains a tree-like structure composed of three types of nodes: strings, hashes and lists.

              -
            • Strings. These are normal Perl strings. They can be of +
            • `Strings`: These are normal Perl strings. They can be of any length can contain any character. Their semantics depends on their location within the tree. This type of node has no children. -
            • Hashes. These are references to anonymous Perl hashes. A +
            • `Hashes`: These are references to anonymous Perl hashes. A hash can have multiple fields, each with a different key. The value of a hash field can be a string, a hash or a list, and its semantics depends on the key of the hash field and the location of the hash within the tree. The values of the hash fields are the children of the node. -
            • Lists. These are references to anonymous Perl lists. A +
            • `Lists`: These are references to anonymous Perl lists. A list has an undefined number of elements, which are the children of the node. Each element has the same type (string, hash or list) and the same semantics, depending on the location of the list within the @@ -166,12 +167,12 @@ tree.
            -

            As you can see, the documentation contained in $doxydocs +

            As you can see, the documentation contained in `$doxydocs` does not present any special impediment to be processed by a simple Perl script. @@ -179,16 +180,16 @@ present in \ref perlmod_tree "this page". \section doxymodel_format Data structure

            You might be interested in processing the documentation contained -in DoxyDocs.pm without needing to take into account the +in `DoxyDocs.pm` without needing to take into account the semantics of each node of the documentation tree. For this purpose, -Doxygen generates a DoxyModel.pm file which contains a data +Doxygen generates a `DoxyModel.pm` file which contains a data structure describing the type and children of each node in the documentation tree.

            The rest of this section is to be written yet, but in the meantime you can look at the Perl scripts generated by Doxygen (such as -doxylatex.pl or doxytemplate-latex.pl) to get an idea on -how to use DoxyModel.pm. +`doxylatex.pl` or `doxytemplate-latex.pl`) to get an idea on +how to use `DoxyModel.pm`. \htmlonly diff --git a/doc/searching.doc b/doc/searching.doc index 9d3261e..5a9c39e 100644 --- a/doc/searching.doc +++ b/doc/searching.doc @@ -59,7 +59,7 @@ has its own advantages and disadvantages: Advantages over the client side search engine are that it provides full text search and it scales well to medium side projects. - Disadvantages are that it does not work locally (i.e. using a file:// URL) + Disadvantages are that it does not work locally (i.e. using a "file://" URL) and that it does not provide live search capabilities. @note In the future this option will probably be replaced by the next @@ -80,7 +80,7 @@ has its own advantages and disadvantages: \ref cfg_server_based_search "SERVER_BASED_SEARCH" and \ref cfg_external_search "EXTERNAL_SEARCH" all to \c YES. - See \ref extsearch for configuration details. + See \subpage extsearch for configuration details. Advantages over option 2 are that this method (potentially) scales to very large projects. It is also possible to combine multiple doxygen @@ -126,7 +126,7 @@ has its own advantages and disadvantages: options you may want to set. After doxygen has finished you will find a Makefile in the HTML output directory. Running "make install" on this Makefile will compile and install the doc set. - See this + See this article for more info. Advantage of this method is that it nicely integrates with the Xcode @@ -139,7 +139,7 @@ has its own advantages and disadvantages:

            6. Qt Compressed Help

            If you develop for or want to install the Qt application framework, you will get an application - called Qt assistant. + called Qt assistant. This is a help viewer for Qt Compressed Help files (.qch). To enable this feature set \ref cfg_generate_qhp "GENERATE_QHP" to \c YES. @@ -147,7 +147,7 @@ has its own advantages and disadvantages: \ref cfg_qhp_namespace "QHP_NAMESPACE", \ref cfg_qhg_location "QHG_LOCATION", \ref cfg_qhp_virtual_folder "QHP_VIRTUAL_FOLDER". - See this article + See this article for more info. Feature wise the Qt compressed help feature is comparable with the CHM diff --git a/doc/translator.py b/doc/translator.py index 816482b..3550fc7 100644 --- a/doc/translator.py +++ b/doc/translator.py @@ -1714,7 +1714,7 @@ class TrManager: in the Translator class but their identifiers do not appear in source files. The situation should be checked. The .cpp files and .h files excluding the '*translator*' files - in doxygen/src directory were simply searched for occurence + in doxygen/src directory were simply searched for occurrence of the method identifiers:''' f.write('\n' + '=' * 70 + '\n') f.write(fill(s) + '\n\n') diff --git a/doc/translator_report.txt b/doc/translator_report.txt index b7fa558..0bba380 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -10,25 +10,17 @@ Macedonian, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian, and Vietnamese. -Of them, 10 translators are up-to-date, 30 translators are based on +Of them, 2 translators are up-to-date, 38 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- The following translator classes are up-to-date (sorted alphabetically). This means that they derive from the Translator class -and they implement all 242 of the required methods. Anyway, there +and they implement all 250 of the required methods. Anyway, there still may be some details listed even for them: - TranslatorCzech - TranslatorDutch TranslatorEnglish - TranslatorEsperanto - TranslatorGerman - TranslatorGreek TranslatorLatvian -- Reimplementation using UTF-8 suggested. - TranslatorSlovak - TranslatorSpanish - TranslatorUkrainian ---------------------------------------------------------------------- The following translator classes need some maintenance (the most @@ -36,66 +28,90 @@ obsolete at the end). The other info shows the estimation of Doxygen version when the class was last updated and number of methods that must be implemented to become up-to-date: - TranslatorPolish 1.8.2 7 methods to implement (2 %) - TranslatorKorean 1.8.02 7 methods to implement (2 %) + TranslatorUkrainian 1.8.04 8 methods to implement (3 %) + Note: Change the base class to TranslatorAdapter_1_8_4. + + TranslatorSpanish 1.8.04 8 methods to implement (3 %) + Note: Change the base class to TranslatorAdapter_1_8_4. + + TranslatorSlovak 1.8.04 8 methods to implement (3 %) + Note: Change the base class to TranslatorAdapter_1_8_4. + + TranslatorGreek 1.8.04 8 methods to implement (3 %) + Note: Change the base class to TranslatorAdapter_1_8_4. + + TranslatorGerman 1.8.04 8 methods to implement (3 %) + Note: Change the base class to TranslatorAdapter_1_8_4. + + TranslatorEsperanto 1.8.04 8 methods to implement (3 %) + Note: Change the base class to TranslatorAdapter_1_8_4. + + TranslatorDutch 1.8.04 8 methods to implement (3 %) + Note: Change the base class to TranslatorAdapter_1_8_4. + + TranslatorCzech 1.8.04 8 methods to implement (3 %) + Note: Change the base class to TranslatorAdapter_1_8_4. + + TranslatorPolish 1.8.2 14 methods to implement (5 %) + TranslatorKorean 1.8.02 15 methods to implement (6 %) Note: Change the base class to TranslatorAdapter_1_8_2. - TranslatorItalian 1.8.2 7 methods to implement (2 %) - TranslatorCroatian 1.8.2 7 methods to implement (2 %) - TranslatorChinese 1.8.2 7 methods to implement (2 %) - TranslatorPortuguese 1.8.0 14 methods to implement (5 %) - TranslatorIndonesian 1.8.0 14 methods to implement (5 %) + TranslatorItalian 1.8.2 15 methods to implement (6 %) + TranslatorCroatian 1.8.2 15 methods to implement (6 %) + TranslatorChinese 1.8.2 15 methods to implement (6 %) + TranslatorPortuguese 1.8.0 22 methods to implement (8 %) + TranslatorIndonesian 1.8.0 22 methods to implement (8 %) Note: Reimplementation using UTF-8 suggested. - TranslatorFrench 1.8.0 14 methods to implement (5 %) + TranslatorFrench 1.8.0 22 methods to implement (8 %) Note: Reimplementation using UTF-8 suggested. - TranslatorDanish 1.8.0 14 methods to implement (5 %) + TranslatorDanish 1.8.0 22 methods to implement (8 %) Note: Reimplementation using UTF-8 suggested. - TranslatorChinesetraditional 1.8.0 14 methods to implement (5 %) + TranslatorChinesetraditional 1.8.0 22 methods to implement (8 %) Note: Reimplementation using UTF-8 suggested. - TranslatorCatalan 1.8.0 14 methods to implement (5 %) - TranslatorBrazilian 1.8.0 14 methods to implement (5 %) - TranslatorArmenian 1.8.0 14 methods to implement (5 %) - TranslatorTurkish 1.7.5 17 methods to implement (7 %) - TranslatorRussian 1.7.5 17 methods to implement (7 %) + TranslatorCatalan 1.8.0 22 methods to implement (8 %) + TranslatorBrazilian 1.8.0 22 methods to implement (8 %) + TranslatorArmenian 1.8.0 22 methods to implement (8 %) + TranslatorTurkish 1.7.5 25 methods to implement (10 %) + TranslatorRussian 1.7.5 25 methods to implement (10 %) Note: Reimplementation using UTF-8 suggested. - TranslatorPersian 1.7.5 17 methods to implement (7 %) - TranslatorVietnamese 1.6.0 26 methods to implement (10 %) - TranslatorSwedish 1.6.0 26 methods to implement (10 %) + TranslatorPersian 1.7.5 25 methods to implement (10 %) + TranslatorVietnamese 1.6.0 34 methods to implement (13 %) + TranslatorSwedish 1.6.0 34 methods to implement (13 %) Note: Reimplementation using UTF-8 suggested. - TranslatorSerbian 1.6.0 26 methods to implement (10 %) + TranslatorSerbian 1.6.0 34 methods to implement (13 %) Note: Reimplementation using UTF-8 suggested. - TranslatorSerbianCyrilic 1.6.0 26 methods to implement (10 %) - TranslatorRomanian 1.6.0 26 methods to implement (10 %) + TranslatorSerbianCyrilic 1.6.0 34 methods to implement (13 %) + TranslatorRomanian 1.6.0 34 methods to implement (13 %) Note: Reimplementation using UTF-8 suggested. - TranslatorMacedonian 1.6.0 26 methods to implement (10 %) - TranslatorJapanese 1.6.0 26 methods to implement (10 %) + TranslatorMacedonian 1.6.0 34 methods to implement (13 %) + TranslatorJapanese 1.6.0 33 methods to implement (13 %) Note: Reimplementation using UTF-8 suggested. - TranslatorFinnish 1.6.0 26 methods to implement (10 %) - TranslatorAfrikaans 1.6.0 26 methods to implement (10 %) + TranslatorFinnish 1.6.0 34 methods to implement (13 %) + TranslatorAfrikaans 1.6.0 34 methods to implement (13 %) Note: Reimplementation using UTF-8 suggested. - TranslatorSlovene 1.4.6 50 methods to implement (20 %) + TranslatorSlovene 1.4.6 58 methods to implement (23 %) Note: Reimplementation using UTF-8 suggested. - TranslatorNorwegian 1.4.6 49 methods to implement (20 %) + TranslatorNorwegian 1.4.6 56 methods to implement (22 %) Note: Reimplementation using UTF-8 suggested. - TranslatorLithuanian 1.4.6 50 methods to implement (20 %) + TranslatorLithuanian 1.4.6 58 methods to implement (23 %) Note: Reimplementation using UTF-8 suggested. - TranslatorHungarian 1.4.6 50 methods to implement (20 %) + TranslatorHungarian 1.4.6 58 methods to implement (23 %) Note: Reimplementation using UTF-8 suggested. - TranslatorArabic 1.4.6 49 methods to implement (20 %) + TranslatorArabic 1.4.6 56 methods to implement (22 %) Note: Reimplementation using UTF-8 suggested. @@ -113,7 +129,7 @@ WARNING: The following translator methods are declared in the Translator class but their identifiers do not appear in source files. The situation should be checked. The .cpp files and .h files excluding the '*translator*' files in doxygen/src directory were simply searched -for occurence of the method identifiers: +for occurrence of the method identifiers: QCString idLanguageCharset() QCString trAlphabeticalList() @@ -122,6 +138,7 @@ for occurence of the method identifiers: QCString trFuncProtos() QCString trFunctionPrototypeDocumentation() QCString trSearchForIndex() + QCString trWrittenBy() ====================================================================== @@ -129,10 +146,10 @@ Details for translators (classes sorted alphabetically): -TranslatorAfrikaans (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) +TranslatorAfrikaans (TranslatorAdapter_1_6_0) 34 methods to implement (13 %) ------------------- - Implements 216 of the required methods (89 %). + Implements 216 of the required methods (86 %). Missing methods (should be implemented): @@ -142,12 +159,16 @@ TranslatorAfrikaans (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trNoMatches() virtual QCString trLoading() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trDirRelation(const char * name) virtual QCString trMethodDocumentation() @@ -156,18 +177,22 @@ TranslatorAfrikaans (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorArabic (TranslatorAdapter_1_4_6) 49 methods to implement (20 %) +TranslatorArabic (TranslatorAdapter_1_4_6) 56 methods to implement (22 %) ---------------- - Implements 193 of the required methods (79 %). + Implements 194 of the required methods (77 %). Missing methods (should be implemented): @@ -180,18 +205,22 @@ TranslatorArabic (TranslatorAdapter_1_4_6) 49 methods to implement (20 %) virtual QCString trLoading() virtual QCString trSubprograms() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trModulesListDescription(bool extractAll) virtual QCString trModulesList() virtual QCString trTypeConstraints() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() virtual QCString trMemberFunctionDocumentationFortran() virtual QCString trCompoundListDescriptionFortran() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trTypeDocumentation() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trModuleReference(const char * namespaceName) virtual QCString trModulesMemberDescription(bool extractAll) virtual QCString trModulesMembers() @@ -208,9 +237,11 @@ TranslatorArabic (TranslatorAdapter_1_4_6) 49 methods to implement (20 %) virtual QCString trDirDependency(const char * name) virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) virtual QCString trCompoundIndexFortran() virtual QCString trSubprogram(bool first_capital, bool singular) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trCallerGraph() virtual QCString trExtendsClass() @@ -219,6 +250,7 @@ TranslatorArabic (TranslatorAdapter_1_4_6) 49 methods to implement (20 %) virtual QCString trModule(bool first_capital, bool singular) virtual QCString trCompoundMembersFortran() virtual QCString trSubprogramDocumentation() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() Obsolete methods (should be removed, never used): @@ -228,163 +260,269 @@ TranslatorArabic (TranslatorAdapter_1_4_6) 49 methods to implement (20 %) virtual QCString trPackageDocumentation() virtual QCString trSources() virtual QCString trReimplementedForInternalReasons() - virtual QCString trInterfaces() virtual QCString trHeaderFiles() virtual QCString trBugsAndLimitations() virtual QCString trNoDescriptionAvailable() -TranslatorArmenian (TranslatorAdapter_1_8_0) 14 methods to implement (5 %) +TranslatorArmenian (TranslatorAdapter_1_8_0) 22 methods to implement (8 %) ------------------ - Implements 228 of the required methods (94 %). + Implements 228 of the required methods (91 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorBrazilian (TranslatorAdapter_1_8_0) 14 methods to implement (5 %) +TranslatorBrazilian (TranslatorAdapter_1_8_0) 22 methods to implement (8 %) ------------------- - Implements 228 of the required methods (94 %). + Implements 228 of the required methods (91 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorCatalan (TranslatorAdapter_1_8_0) 14 methods to implement (5 %) +TranslatorCatalan (TranslatorAdapter_1_8_0) 22 methods to implement (8 %) ----------------- - Implements 228 of the required methods (94 %). + Implements 228 of the required methods (91 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorChinese (TranslatorAdapter_1_8_2) 7 methods to implement (2 %) +TranslatorChinese (TranslatorAdapter_1_8_2) 15 methods to implement (6 %) ----------------- - Implements 235 of the required methods (97 %). + Implements 235 of the required methods (94 %). Missing methods (should be implemented): + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorChinesetraditional (TranslatorAdapter_1_8_0) 14 methods to implement (5 %) +TranslatorChinesetraditional (TranslatorAdapter_1_8_0) 22 methods to implement (8 %) ---------------------------- - Implements 228 of the required methods (94 %). + Implements 228 of the required methods (91 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorCroatian (TranslatorAdapter_1_8_2) 7 methods to implement (2 %) +TranslatorCroatian (TranslatorAdapter_1_8_2) 15 methods to implement (6 %) ------------------ - Implements 235 of the required methods (97 %). + Implements 235 of the required methods (94 %). Missing methods (should be implemented): + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorDanish (TranslatorAdapter_1_8_0) 14 methods to implement (5 %) +TranslatorCzech (TranslatorAdapter_1_8_2) 8 methods to implement (3 %) +--------------- + + Implements 242 of the required methods (96 %). + + Missing methods (should be implemented): + + virtual QCString trServices() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) + virtual QCString trConstantGroups() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) + virtual QCString trSingletonReference(const char * sName) + + +TranslatorDanish (TranslatorAdapter_1_8_0) 22 methods to implement (8 %) ---------------- - Implements 228 of the required methods (94 %). + Implements 228 of the required methods (91 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorFinnish (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) +TranslatorDutch (TranslatorAdapter_1_8_2) 8 methods to implement (3 %) +--------------- + + Implements 242 of the required methods (96 %). + + Missing methods (should be implemented): + + virtual QCString trServices() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) + virtual QCString trConstantGroups() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) + virtual QCString trSingletonReference(const char * sName) + + +TranslatorEsperanto (TranslatorAdapter_1_8_2) 8 methods to implement (3 %) +------------------- + + Implements 242 of the required methods (96 %). + + Missing methods (should be implemented): + + virtual QCString trServices() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) + virtual QCString trConstantGroups() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) + virtual QCString trSingletonReference(const char * sName) + + +TranslatorFinnish (TranslatorAdapter_1_6_0) 34 methods to implement (13 %) ----------------- - Implements 216 of the required methods (89 %). + Implements 216 of the required methods (86 %). Missing methods (should be implemented): @@ -394,12 +532,16 @@ TranslatorFinnish (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trNoMatches() virtual QCString trLoading() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trDirRelation(const char * name) virtual QCString trMethodDocumentation() @@ -408,41 +550,87 @@ TranslatorFinnish (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorFrench (TranslatorAdapter_1_8_0) 14 methods to implement (5 %) +TranslatorFrench (TranslatorAdapter_1_8_0) 22 methods to implement (8 %) ---------------- - Implements 228 of the required methods (94 %). + Implements 228 of the required methods (91 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorHungarian (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) +TranslatorGerman (TranslatorAdapter_1_8_2) 8 methods to implement (3 %) +---------------- + + Implements 242 of the required methods (96 %). + + Missing methods (should be implemented): + + virtual QCString trServices() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) + virtual QCString trConstantGroups() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) + virtual QCString trSingletonReference(const char * sName) + + +TranslatorGreek (TranslatorAdapter_1_8_2) 8 methods to implement (3 %) +--------------- + + Implements 242 of the required methods (96 %). + + Missing methods (should be implemented): + + virtual QCString trServices() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) + virtual QCString trConstantGroups() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) + virtual QCString trSingletonReference(const char * sName) + + +TranslatorHungarian (TranslatorAdapter_1_4_6) 58 methods to implement (23 %) ------------------- - Implements 192 of the required methods (79 %). + Implements 192 of the required methods (76 %). Missing methods (should be implemented): @@ -455,18 +643,22 @@ TranslatorHungarian (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) virtual QCString trLoading() virtual QCString trSubprograms() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trModulesListDescription(bool extractAll) virtual QCString trModulesList() virtual QCString trTypeConstraints() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() virtual QCString trMemberFunctionDocumentationFortran() virtual QCString trCompoundListDescriptionFortran() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trTypeDocumentation() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trModuleReference(const char * namespaceName) virtual QCString trModulesMemberDescription(bool extractAll) virtual QCString trModulesMembers() @@ -481,11 +673,14 @@ TranslatorHungarian (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) virtual QCString trCompoundIndexFortran() virtual QCString trSubprogram(bool first_capital, bool singular) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trCallerGraph() virtual QCString trExtendsClass() @@ -495,52 +690,69 @@ TranslatorHungarian (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) virtual QCString trModule(bool first_capital, bool singular) virtual QCString trCompoundMembersFortran() virtual QCString trSubprogramDocumentation() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorIndonesian (TranslatorAdapter_1_8_0) 14 methods to implement (5 %) +TranslatorIndonesian (TranslatorAdapter_1_8_0) 22 methods to implement (8 %) -------------------- - Implements 228 of the required methods (94 %). + Implements 228 of the required methods (91 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorItalian (TranslatorAdapter_1_8_2) 7 methods to implement (2 %) +TranslatorItalian (TranslatorAdapter_1_8_2) 15 methods to implement (6 %) ----------------- - Implements 235 of the required methods (97 %). + Implements 235 of the required methods (94 %). Missing methods (should be implemented): + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorJapanese (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) +TranslatorJapanese (TranslatorAdapter_1_6_0) 33 methods to implement (13 %) ------------------ - Implements 216 of the required methods (89 %). + Implements 217 of the required methods (86 %). Missing methods (should be implemented): @@ -550,12 +762,16 @@ TranslatorJapanese (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trNoMatches() virtual QCString trLoading() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trDirRelation(const char * name) virtual QCString trMethodDocumentation() @@ -566,9 +782,12 @@ TranslatorJapanese (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trDirDependency(const char * name) virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() Obsolete methods (should be removed, never used): @@ -578,13 +797,12 @@ TranslatorJapanese (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trPackageDocumentation() virtual QCString trSources() virtual QCString trReimplementedForInternalReasons() - virtual QCString trInterfaces() virtual QCString trHeaderFiles() virtual QCString trBugsAndLimitations() virtual QCString trNoDescriptionAvailable() -TranslatorJapaneseEn (TranslatorEnglish) 237 methods to implement (97 %) +TranslatorJapaneseEn (TranslatorEnglish) 245 methods to implement (98 %) -------------------- Implements 5 of the required methods (2 %). @@ -598,23 +816,31 @@ TranslatorJapaneseEn (TranslatorEnglish) 237 methods to implement (97 %) virtual QCString latexLanguageSupportCommand() -TranslatorKorean (TranslatorAdapter_1_7_5) 7 methods to implement (2 %) +TranslatorKorean (TranslatorAdapter_1_7_5) 15 methods to implement (6 %) ---------------- - Implements 235 of the required methods (97 %). + Implements 235 of the required methods (94 %). Missing methods (should be implemented): + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorKoreanEn (TranslatorEnglish) 237 methods to implement (97 %) +TranslatorKoreanEn (TranslatorEnglish) 245 methods to implement (98 %) ------------------ Implements 5 of the required methods (2 %). @@ -628,16 +854,27 @@ TranslatorKoreanEn (TranslatorEnglish) 237 methods to implement (97 %) virtual QCString latexLanguageSupportCommand() -TranslatorLatvian (Translator) +TranslatorLatvian (Translator) 8 methods to implement (3 %) ----------------- - Implements 242 of the required methods (100 %). + Implements 242 of the required methods (96 %). + + Missing methods (should be implemented): + + virtual QCString trServices() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) + virtual QCString trConstantGroups() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) + virtual QCString trSingletonReference(const char * sName) -TranslatorLithuanian (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) +TranslatorLithuanian (TranslatorAdapter_1_4_6) 58 methods to implement (23 %) -------------------- - Implements 192 of the required methods (79 %). + Implements 192 of the required methods (76 %). Missing methods (should be implemented): @@ -650,18 +887,22 @@ TranslatorLithuanian (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) virtual QCString trLoading() virtual QCString trSubprograms() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trModulesListDescription(bool extractAll) virtual QCString trModulesList() virtual QCString trTypeConstraints() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() virtual QCString trMemberFunctionDocumentationFortran() virtual QCString trCompoundListDescriptionFortran() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trTypeDocumentation() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trModuleReference(const char * namespaceName) virtual QCString trModulesMemberDescription(bool extractAll) virtual QCString trModulesMembers() @@ -676,11 +917,14 @@ TranslatorLithuanian (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) virtual QCString trCompoundIndexFortran() virtual QCString trSubprogram(bool first_capital, bool singular) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trCallerGraph() virtual QCString trExtendsClass() @@ -690,13 +934,14 @@ TranslatorLithuanian (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) virtual QCString trModule(bool first_capital, bool singular) virtual QCString trCompoundMembersFortran() virtual QCString trSubprogramDocumentation() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorMacedonian (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) +TranslatorMacedonian (TranslatorAdapter_1_6_0) 34 methods to implement (13 %) -------------------- - Implements 216 of the required methods (89 %). + Implements 216 of the required methods (86 %). Missing methods (should be implemented): @@ -706,12 +951,16 @@ TranslatorMacedonian (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trNoMatches() virtual QCString trLoading() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trDirRelation(const char * name) virtual QCString trMethodDocumentation() @@ -720,18 +969,22 @@ TranslatorMacedonian (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorNorwegian (TranslatorAdapter_1_4_6) 49 methods to implement (20 %) +TranslatorNorwegian (TranslatorAdapter_1_4_6) 56 methods to implement (22 %) ------------------- - Implements 193 of the required methods (79 %). + Implements 194 of the required methods (77 %). Missing methods (should be implemented): @@ -744,18 +997,22 @@ TranslatorNorwegian (TranslatorAdapter_1_4_6) 49 methods to implement (20 %) virtual QCString trLoading() virtual QCString trSubprograms() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trModulesListDescription(bool extractAll) virtual QCString trModulesList() virtual QCString trTypeConstraints() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() virtual QCString trMemberFunctionDocumentationFortran() virtual QCString trCompoundListDescriptionFortran() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trTypeDocumentation() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trModuleReference(const char * namespaceName) virtual QCString trModulesMemberDescription(bool extractAll) virtual QCString trModulesMembers() @@ -772,9 +1029,11 @@ TranslatorNorwegian (TranslatorAdapter_1_4_6) 49 methods to implement (20 %) virtual QCString trDirDependency(const char * name) virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) virtual QCString trCompoundIndexFortran() virtual QCString trSubprogram(bool first_capital, bool singular) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trCallerGraph() virtual QCString trExtendsClass() @@ -783,6 +1042,7 @@ TranslatorNorwegian (TranslatorAdapter_1_4_6) 49 methods to implement (20 %) virtual QCString trModule(bool first_capital, bool singular) virtual QCString trCompoundMembersFortran() virtual QCString trSubprogramDocumentation() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() Obsolete methods (should be removed, never used): @@ -792,51 +1052,65 @@ TranslatorNorwegian (TranslatorAdapter_1_4_6) 49 methods to implement (20 %) virtual QCString trPackageDocumentation() virtual QCString trSources() virtual QCString trReimplementedForInternalReasons() - virtual QCString trInterfaces() virtual QCString trHeaderFiles() virtual QCString trBugsAndLimitations() virtual QCString trNoDescriptionAvailable() -TranslatorPersian (TranslatorAdapter_1_7_5) 17 methods to implement (7 %) +TranslatorPersian (TranslatorAdapter_1_7_5) 25 methods to implement (10 %) ----------------- - Implements 225 of the required methods (92 %). + Implements 225 of the required methods (90 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() virtual QCString trCopyright() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorPolish (TranslatorAdapter_1_8_2) 7 methods to implement (2 %) +TranslatorPolish (TranslatorAdapter_1_8_2) 14 methods to implement (5 %) ---------------- - Implements 235 of the required methods (97 %). + Implements 236 of the required methods (94 %). Missing methods (should be implemented): + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() Obsolete methods (should be removed, never used): @@ -846,39 +1120,46 @@ TranslatorPolish (TranslatorAdapter_1_8_2) 7 methods to implement (2 %) virtual QCString trPackageDocumentation() QCString trSources() QCString trReimplementedForInternalReasons() - virtual QCString trInterfaces() QCString trHeaderFiles() QCString trBugsAndLimitations() QCString trNoDescriptionAvailable() -TranslatorPortuguese (TranslatorAdapter_1_8_0) 14 methods to implement (5 %) +TranslatorPortuguese (TranslatorAdapter_1_8_0) 22 methods to implement (8 %) -------------------- - Implements 228 of the required methods (94 %). + Implements 228 of the required methods (91 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorRomanian (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) +TranslatorRomanian (TranslatorAdapter_1_6_0) 34 methods to implement (13 %) ------------------ - Implements 216 of the required methods (89 %). + Implements 216 of the required methods (86 %). Missing methods (should be implemented): @@ -888,12 +1169,16 @@ TranslatorRomanian (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trNoMatches() virtual QCString trLoading() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trDirRelation(const char * name) virtual QCString trMethodDocumentation() @@ -902,44 +1187,56 @@ TranslatorRomanian (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorRussian (TranslatorAdapter_1_7_5) 17 methods to implement (7 %) +TranslatorRussian (TranslatorAdapter_1_7_5) 25 methods to implement (10 %) ----------------- - Implements 225 of the required methods (92 %). + Implements 225 of the required methods (90 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() virtual QCString trCopyright() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorSerbian (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) +TranslatorSerbian (TranslatorAdapter_1_6_0) 34 methods to implement (13 %) ----------------- - Implements 216 of the required methods (89 %). + Implements 216 of the required methods (86 %). Missing methods (should be implemented): @@ -949,12 +1246,16 @@ TranslatorSerbian (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trNoMatches() virtual QCString trLoading() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trDirRelation(const char * name) virtual QCString trMethodDocumentation() @@ -963,18 +1264,22 @@ TranslatorSerbian (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorSerbianCyrilic (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) +TranslatorSerbianCyrilic (TranslatorAdapter_1_6_0) 34 methods to implement (13 %) ------------------------ - Implements 216 of the required methods (89 %). + Implements 216 of the required methods (86 %). Missing methods (should be implemented): @@ -984,12 +1289,16 @@ TranslatorSerbianCyrilic (TranslatorAdapter_1_6_0) 26 methods to implement (1 virtual QCString trNoMatches() virtual QCString trLoading() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trDirRelation(const char * name) virtual QCString trMethodDocumentation() @@ -998,18 +1307,39 @@ TranslatorSerbianCyrilic (TranslatorAdapter_1_6_0) 26 methods to implement (1 virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorSlovene (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) +TranslatorSlovak (TranslatorAdapter_1_8_2) 8 methods to implement (3 %) +---------------- + + Implements 242 of the required methods (96 %). + + Missing methods (should be implemented): + + virtual QCString trServices() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) + virtual QCString trConstantGroups() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) + virtual QCString trSingletonReference(const char * sName) + + +TranslatorSlovene (TranslatorAdapter_1_4_6) 58 methods to implement (23 %) ----------------- - Implements 192 of the required methods (79 %). + Implements 192 of the required methods (76 %). Missing methods (should be implemented): @@ -1022,18 +1352,22 @@ TranslatorSlovene (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) virtual QCString trLoading() virtual QCString trSubprograms() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trModulesListDescription(bool extractAll) virtual QCString trModulesList() virtual QCString trTypeConstraints() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() virtual QCString trMemberFunctionDocumentationFortran() virtual QCString trCompoundListDescriptionFortran() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trTypeDocumentation() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trModuleReference(const char * namespaceName) virtual QCString trModulesMemberDescription(bool extractAll) virtual QCString trModulesMembers() @@ -1048,11 +1382,14 @@ TranslatorSlovene (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) virtual QCString trCompoundIndexFortran() virtual QCString trSubprogram(bool first_capital, bool singular) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trCallerGraph() virtual QCString trExtendsClass() @@ -1062,13 +1399,31 @@ TranslatorSlovene (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) virtual QCString trModule(bool first_capital, bool singular) virtual QCString trCompoundMembersFortran() virtual QCString trSubprogramDocumentation() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorSwedish (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) +TranslatorSpanish (TranslatorAdapter_1_8_2) 8 methods to implement (3 %) ----------------- - Implements 216 of the required methods (89 %). + Implements 242 of the required methods (96 %). + + Missing methods (should be implemented): + + virtual QCString trServices() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) + virtual QCString trConstantGroups() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) + virtual QCString trSingletonReference(const char * sName) + + +TranslatorSwedish (TranslatorAdapter_1_6_0) 34 methods to implement (13 %) +----------------- + + Implements 216 of the required methods (86 %). Missing methods (should be implemented): @@ -1078,12 +1433,16 @@ TranslatorSwedish (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trNoMatches() virtual QCString trLoading() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trDirRelation(const char * name) virtual QCString trMethodDocumentation() @@ -1092,44 +1451,73 @@ TranslatorSwedish (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorTurkish (TranslatorAdapter_1_7_5) 17 methods to implement (7 %) +TranslatorTurkish (TranslatorAdapter_1_7_5) 25 methods to implement (10 %) ----------------- - Implements 225 of the required methods (92 %). + Implements 225 of the required methods (90 %). Missing methods (should be implemented): virtual QCString trDetailLevel() virtual QCString trTemplateParameters() + virtual QCString trServices() virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trMethodDocumentation() virtual QCString trEnumReference(const char * name) virtual QCString trInheritedFrom(const char * members, const char * what) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() + virtual QCString trInterfaces() virtual QCString trCopyright() + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() -TranslatorVietnamese (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) +TranslatorUkrainian (TranslatorAdapter_1_8_2) 8 methods to implement (3 %) +------------------- + + Implements 242 of the required methods (96 %). + + Missing methods (should be implemented): + + virtual QCString trServices() + virtual QCString trSingletonGeneratedFromFiles(bool single) + virtual QCString trServiceReference(const char * sName) + virtual QCString trConstantGroups() + virtual QCString trInterfaces() + virtual QCString trServiceGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) + virtual QCString trSingletonReference(const char * sName) + + +TranslatorVietnamese (TranslatorAdapter_1_6_0) 34 methods to implement (13 %) -------------------- - Implements 216 of the required methods (89 %). + Implements 216 of the required methods (86 %). Missing methods (should be implemented): @@ -1139,12 +1527,16 @@ TranslatorVietnamese (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trNoMatches() virtual QCString trLoading() virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) + virtual QCString trServices() virtual QCString trFileIn(const char * name) virtual QCString trClassMethods() virtual QCString trProvidedByCategory() + virtual QCString trSingletonGeneratedFromFiles(bool single) virtual QCString trGlobalNamespace() + virtual QCString trServiceReference(const char * sName) virtual QCString trDesignOverview() virtual QCString trAndMore(const QCString & number) + virtual QCString trConstantGroups() virtual QCString trDirDepGraph(const char * name) virtual QCString trDirRelation(const char * name) virtual QCString trMethodDocumentation() @@ -1153,9 +1545,13 @@ TranslatorVietnamese (TranslatorAdapter_1_6_0) 26 methods to implement (10 %) virtual QCString trCiteReferences() virtual QCString trAdditionalInheritedMembers() virtual QCString trDirDependency(const char * name) + virtual QCString trInterfaces() virtual QCString trCopyright() virtual QCString trIncludesFileIn(const char * name) + virtual QCString trServiceGeneratedFromFiles(bool single) virtual QCString trEnumGeneratedFromFiles(bool single) + virtual QCString trConstantGroupReference(const char * namespaceName) virtual QCString trPanelSynchronisationTooltip(bool enable) virtual QCString trExtendsClass() + virtual QCString trSingletonReference(const char * sName) virtual QCString trInstanceMethods() \ No newline at end of file diff --git a/doc/trouble.doc b/doc/trouble.doc index 81604a2..133ccaf 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -51,7 +51,7 @@ \endverbatim then doxygen will remove the braces and correctly parse the result.
          • Not all names in code fragments that are included in the documentation - are replaced by links (for instance when using \c SOURCE_BROWSER = \c YES) + are replaced by links (for instance when using \ref cfg_source_browser "SOURCE_BROWSER" = `YES`) and links to overloaded members may point to the wrong member. This also holds for the "Referenced by" list that is generated for each function. @@ -62,7 +62,8 @@ documentation, because of possible ambiguities or lack of information about the context in which the code fragment is found.
          • It is not possible to insert a non-member function f in a class A - using the \\relates or \\relatesalso command, if class A already + using the \ref cmdrelates "\\relates" or \ref cmdrelatesalso "\\relatesalso" + command, if class A already has a member with name f and the same argument list.
          • There is only very limited support for member specialization at the moment. It only works if there is a specialized template class as diff --git a/qtools/Doxyfile b/qtools/Doxyfile index 9c31af8..e194967 100644 --- a/qtools/Doxyfile +++ b/qtools/Doxyfile @@ -128,6 +128,7 @@ REFERENCES_LINK_SOURCE = YES USE_HTAGS = NO VERBATIM_HEADERS = YES CLANG_ASSISTED_PARSING = YES +CLANG_OPTIONS = #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- @@ -184,6 +185,7 @@ USE_MATHJAX = NO MATHJAX_FORMAT = HTML-CSS MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest MATHJAX_EXTENSIONS = +MATHJAX_CODEFILE = SEARCHENGINE = YES SERVER_BASED_SEARCH = NO EXTERNAL_SEARCH = NO diff --git a/src/.gitignore b/src/.gitignore new file mode 100644 index 0000000..3eae438 --- /dev/null +++ b/src/.gitignore @@ -0,0 +1,47 @@ +*~ +.*sw? +\#* +.DS_Store + +*.rej +*.orig + +Makefile +*.pro +/.makeconfig +/.tmakeconfig +/VERSION +/src/libdoxycfg.t +/src/libdoxygen.t +/packages/rpm/doxygen.spec +/libmd5/Makefile.libmd5 +/qtools/Makefile.qtools +/src/Makefile.doxygen +/src/Makefile.libdoxycfg +/src/Makefile.libdoxygen + +/bin +/lib +/objects +/src/ce_lex.cpp +/src/ce_parse.cpp +/src/ce_parse.h +/src/code.cpp +/src/commentcnv.cpp +/src/commentscan.cpp +/src/config.cpp +/src/declinfo.cpp +/src/defargs.cpp +/src/doctokenizer.cpp +/src/fortrancode.cpp +/src/fortranscanner.cpp +/src/pre.cpp +/src/pycode.cpp +/src/pyscanner.cpp +/src/scanner.cpp +/src/tclscanner.cpp +/src/version.cpp +/src/vhdlcode.cpp +/src/vhdlparser.cpp +/src/vhdlparser.h +/src/vhdlscanner.cpp diff --git a/src/clangparser.cpp b/src/clangparser.cpp index c9e192f..08ad05d 100644 --- a/src/clangparser.cpp +++ b/src/clangparser.cpp @@ -122,6 +122,19 @@ static QStrList getClangOptions() return options; } +#if 0 +static void inclusionVisitor(CXFile includedFile, + CXSourceLocation* inclusionStack, + unsigned includeLen, + CXClientData clientData) +{ + const char *fileName = (const char *)clientData; + CXString incFileName = clang_getFileName(includedFile); + printf("--- file %s includes %s\n",fileName,clang_getCString(incFileName)); + clang_disposeString(incFileName); +} +#endif + void ClangParser::start(const char *fileName) { static bool clangAssistedParsing = Config_getBool("CLANG_ASSISTED_PARSING"); @@ -177,6 +190,10 @@ void ClangParser::start(const char *fileName) if (p->tu) { + //clang_getInclusions(p->tu, + // inclusionVisitor, + // (CXClientData)fileName + // ); for (uint i=0, n=clang_getNumDiagnostics(p->tu); i!=n; ++i) { CXDiagnostic diag = clang_getDiagnostic(p->tu, i); @@ -610,7 +627,7 @@ void ClangParser::writeSources(OutputList &ol,FileDef *fd) char const *s = clang_getCString(tokenString); CXCursorKind cursorKind = clang_getCursorKind(p->cursors[i]); CXTokenKind tokenKind = clang_getTokenKind(p->tokens[i]); - printf("%d:%d %s cursorKind=%d tokenKind=%d\n",line,column,s,cursorKind,tokenKind); + //printf("%d:%d %s cursorKind=%d tokenKind=%d\n",line,column,s,cursorKind,tokenKind); switch (tokenKind) { case CXToken_Keyword: diff --git a/src/classdef.cpp b/src/classdef.cpp index bb29882..dd32918 100644 --- a/src/classdef.cpp +++ b/src/classdef.cpp @@ -187,7 +187,7 @@ class ClassDefImpl bool isGeneric; - int spec; + uint64 spec; }; void ClassDefImpl::init(const char *defFileName, const char *name, @@ -435,6 +435,12 @@ void ClassDef::internalInsertMember(MemberDef *md, { switch (md->memberType()) { + case MemberType_Service: // UNO IDL + addMemberToList(MemberListType_services,md,TRUE); + break; + case MemberType_Interface: // UNO IDL + addMemberToList(MemberListType_interfaces,md,TRUE); + break; case MemberType_Signal: // Qt specific addMemberToList(MemberListType_signals,md,TRUE); break; @@ -581,6 +587,12 @@ void ClassDef::internalInsertMember(MemberDef *md, { switch (md->memberType()) { + case MemberType_Service: // UNO IDL + addMemberToList(MemberListType_serviceMembers,md,FALSE); + break; + case MemberType_Interface: // UNO IDL + addMemberToList(MemberListType_interfaceMembers,md,FALSE); + break; case MemberType_Property: addMemberToList(MemberListType_propertyMembers,md,FALSE); break; @@ -1035,6 +1047,14 @@ void ClassDef::showUsedFiles(OutputList &ol) { ol.parseText(theTranslator->trEnumGeneratedFromFiles(m_impl->files.count()==1)); } + else if (m_impl->compType==Service) + { + ol.parseText(theTranslator->trServiceGeneratedFromFiles(m_impl->files.count()==1)); + } + else if (m_impl->compType==Singleton) + { + ol.parseText(theTranslator->trSingletonGeneratedFromFiles(m_impl->files.count()==1)); + } else { ol.parseText(theTranslator->trGeneratedFromFiles( @@ -1811,6 +1831,7 @@ void ClassDef::addClassAttributes(OutputList &ol) if (isFinal()) sl.append("final"); if (isSealed()) sl.append("sealed"); if (isAbstract()) sl.append("abstract"); + if (getLanguage()==SrcLangExt_IDL && isPublished()) sl.append("published"); ol.pushGeneratorState(); ol.disableAllBut(OutputGenerator::Html); @@ -1923,10 +1944,12 @@ void ClassDef::writeDocumentationContents(OutputList &ol,const QCString & /*page writeAuthorSection(ol); break; case LayoutDocEntry::NamespaceNestedNamespaces: + case LayoutDocEntry::NamespaceNestedConstantGroups: case LayoutDocEntry::NamespaceClasses: case LayoutDocEntry::NamespaceInlineClasses: case LayoutDocEntry::FileClasses: case LayoutDocEntry::FileNamespaces: + case LayoutDocEntry::FileConstantGroups: case LayoutDocEntry::FileIncludes: case LayoutDocEntry::FileIncludeGraph: case LayoutDocEntry::FileIncludedByGraph: @@ -1980,6 +2003,14 @@ void ClassDef::writeDocumentation(OutputList &ol) { pageTitle = theTranslator->trEnumReference(displayName()); } + else if (m_impl->compType==Service) + { + pageTitle = theTranslator->trServiceReference(displayName()); + } + else if (m_impl->compType==Singleton) + { + pageTitle = theTranslator->trSingletonReference(displayName()); + } else { pageTitle = theTranslator->trCompoundReference(displayName(), @@ -2288,6 +2319,8 @@ void ClassDef::writeMemberList(OutputList &ol) md->isFriend() || md->isRelated() || md->isExplicit() || md->isMutable() || (md->isInline() && Config_getBool("INLINE_INFO")) || md->isSignal() || md->isSlot() || + (getLanguage()==SrcLangExt_IDL && + (md->isOptional() || md->isAttribute() || md->isUNOProperty())) || md->isStatic() || lang==SrcLangExt_VHDL ) && memberWritten) @@ -2315,6 +2348,18 @@ void ClassDef::writeMemberList(OutputList &ol) if (md->isStatic()) sl.append("static"); if (md->isSignal()) sl.append("signal"); if (md->isSlot()) sl.append("slot"); +// this is the extra member page + if (md->isOptional()) sl.append("optional"); + if (md->isAttribute()) sl.append("attribute"); + if (md->isUNOProperty()) sl.append("property"); + if (md->isReadonly()) sl.append("readonly"); + if (md->isBound()) sl.append("bound"); + if (md->isRemovable()) sl.append("removable"); + if (md->isConstrained()) sl.append("constrained"); + if (md->isTransient()) sl.append("transient"); + if (md->isMaybeVoid()) sl.append("maybevoid"); + if (md->isMaybeDefault()) sl.append("maybedefault"); + if (md->isMaybeAmbiguous())sl.append("maybeambiguous"); } const char *s=sl.first(); while (s) @@ -3159,7 +3204,7 @@ void ClassDef::determineImplUsageRelation() cd=getResolvedClass(getNamespaceDef()->name()+"::"+usedClassName,0,&templSpec); } if (cd==0) cd=getResolvedClass(name()+"::"+usedClassName,0,&templSpec); - if (cd==0) cd=getResolvedClass(usedClassName,0,&templSpec); // TODO: also try inbetween scopes! + if (cd==0) cd=getResolvedClass(usedClassName,0,&templSpec); // TODO: also try in-between scopes! //printf("Search for class %s result=%p\n",usedClassName.data(),cd); if (cd) // class exists { @@ -3221,7 +3266,7 @@ void ClassDef::addUsedInterfaceClasses(MemberDef *md,const char *typeStr) while ((i=re.match(type,p,&l))!=-1) // for each class name in the type { ClassDef *cd=getClass(name()+"::"+type.mid(i,l)); - if (cd==0) cd=getClass(type.mid(i,l)); // TODO: also try inbetween scopes! + if (cd==0) cd=getClass(type.mid(i,l)); // TODO: also try in-between scopes! if (cd && cd!=this && !isBaseClass(cd)) { if (m_impl->usesIntfClassDict==0) @@ -3317,6 +3362,8 @@ QCString ClassDef::compoundTypeString() const case Protocol: return "protocol"; case Category: return "category"; case Exception: return "exception"; + case Service: return "service"; + case Singleton: return "singleton"; default: return "unknown"; } } @@ -4337,6 +4384,11 @@ bool ClassDef::isSealed() const return m_impl->spec&Entry::Sealed; } +bool ClassDef::isPublished() const +{ + return m_impl->spec&Entry::Published; +} + bool ClassDef::isObjectiveC() const { return getLanguage()==SrcLangExt_ObjC; @@ -4537,7 +4589,7 @@ bool ClassDef::isGeneric() const return m_impl->isGeneric; } -void ClassDef::setClassSpecifier(int spec) +void ClassDef::setClassSpecifier(uint64 spec) { m_impl->spec = spec; } diff --git a/src/classdef.h b/src/classdef.h index 9db5cae..f4d5962 100644 --- a/src/classdef.h +++ b/src/classdef.h @@ -48,7 +48,8 @@ class ArgumentList; /** A class representing of a compound symbol. * - * A compound can be a class, struct, union, interface, or exception. + * A compound can be a class, struct, union, interface, service, singleton, + * or exception. * \note This class should be renamed to CompoundDef */ class ClassDef : public Definition @@ -61,7 +62,9 @@ class ClassDef : public Definition Interface, //=Entry::INTERFACE_SEC, Protocol, //=Entry::PROTOCOL_SEC, Category, //=Entry::CATEGORY_SEC, - Exception //=Entry::EXCEPTION_SEC + Exception, //=Entry::EXCEPTION_SEC + Service, //=Entry::CLASS_SEC + Singleton, //=Entry::CLASS_SEC }; /** Creates a new compound definition. @@ -256,6 +259,9 @@ class ClassDef : public Definition /** Returns TRUE if this class is marked as sealed */ bool isSealed() const; + /** Returns TRUE if this class is marked as published */ + bool isPublished() const; + /** Returns TRUE if this class represents an Objective-C 2.0 extension (nameless category) */ bool isExtension() const; @@ -320,7 +326,7 @@ class ClassDef : public Definition void setIsStatic(bool b); void setCompoundType(CompoundType t); void setClassName(const char *name); - void setClassSpecifier(int spec); + void setClassSpecifier(uint64 spec); void setTemplateArguments(ArgumentList *al); void setTemplateBaseClassNames(QDict *templateNames); diff --git a/src/commentcnv.l b/src/commentcnv.l index 97f5194..6e7fa30 100644 --- a/src/commentcnv.l +++ b/src/commentcnv.l @@ -43,12 +43,6 @@ #define ADDCHAR(c) g_outBuf->addChar(c) #define ADDARRAY(a,s) g_outBuf->addArray(a,s) -enum GuardType -{ - Guard_Cond, - Guard_CondNot -}; - struct CondCtx { CondCtx(int line,QCString id,bool b) @@ -85,8 +79,6 @@ static bool g_lastEscaped; static int g_lastBlockContext; static bool g_pythonDocString; -static GuardType guardType; // kind of guard for conditional section - static SrcLangExt g_lang; static bool isFixedForm; // For Fortran @@ -181,22 +173,13 @@ static inline void copyToOutput(const char *s,int len) static void startCondSection(const char *sectId) { + //printf("startCondSection: skip=%d stack=%d\n",g_skip,g_condStack.count()); CondParser prs; bool expResult = prs.parse(g_fileName,g_lineNr,sectId); g_condStack.push(new CondCtx(g_lineNr,sectId,g_skip)); - if (guardType == Guard_Cond) // found @cond + if (!expResult) // not enabled { - if (!expResult) // not enabled - { - g_skip=TRUE; - } - } - else if (guardType == Guard_CondNot) // found @notcond - { - if (expResult) // enabled - { - g_skip=TRUE; - } + g_skip=TRUE; } } @@ -212,6 +195,7 @@ static void endCondSection() CondCtx *ctx = g_condStack.pop(); g_skip=ctx->skip; } + //printf("endCondSection: skip=%d stack=%d\n",g_skip,g_condStack.count()); } /** copies string \a s with length \a len to the output, while @@ -721,7 +705,6 @@ void replaceComment(int offset); } [\\@]"cond"[ \t]+ { // conditional section g_condCtx = YY_START; - guardType = Guard_Cond; BEGIN(CondLine); } [\\@]"endcond"/[^a-z_A-Z0-9] { // end of conditional section @@ -769,7 +752,6 @@ void replaceComment(int offset); [ \t]* [\\@]"cond"[ \t\r]*/\n | . { // forgot section id? - guardType = Guard_Cond; if (YY_START!=CondLine) g_condCtx=YY_START; bool oldSkip=g_skip; startCondSection(" "); // fake section id causing the section to be hidden unconditionally diff --git a/src/commentscan.l b/src/commentscan.l index 9b2994a..4ac850e 100644 --- a/src/commentscan.l +++ b/src/commentscan.l @@ -665,7 +665,7 @@ static void stripTrailingWhiteSpace(QCString &s) while (i>=0 && ((c = s.at(i))==' ' || c=='\t' || c=='\r')) i--; if (i!=(int)len-1) { - s.resize(i+2); // string upto and including char at pos i and \0 terminator + s.resize(i+2); // string up to and including char at pos i and \0 terminator } } @@ -877,7 +877,7 @@ LABELID [a-z_A-Z\x80-\xFF][a-z_A-Z0-9\x80-\xFF\-]* CITEID [a-z_A-Z\x80-\xFF][a-z_A-Z0-9\x80-\xFF\-:/]* SCOPEID {ID}({ID}*{BN}*"::"{BN}*)*({ID}?) SCOPENAME "$"?(({ID}?{BN}*("::"|"."){BN}*)*)((~{BN}*)?{ID}) -MAILADR [a-z_A-Z0-9.+\-]+"@"[a-z_A-Z0-9\-]+("."[a-z_A-Z0-9\-]+)+[a-z_A-Z0-9\-]+ +MAILADDR [a-z_A-Z0-9.+\-]+"@"[a-z_A-Z0-9\-]+("."[a-z_A-Z0-9\-]+)+[a-z_A-Z0-9\-]+ RCSTAG "$"{ID}":"[^\n$]+"$" %option noyywrap @@ -939,7 +939,7 @@ RCSTAG "$"{ID}":"[^\n$]+"$" * words and whitespace and other characters (#,?!, etc). * grouping commands (e.g. @{ and @}) * language switch (e.g. \~english or \~). - * mail adress (e.g. dimitri@stack.nl). + * mail address (e.g. dimitri@stack.nl). * quoted text, such as "foo@bar" * XML commands, */ @@ -950,7 +950,7 @@ RCSTAG "$"{ID}":"[^\n$]+"$" {CMD}{CMD}"~"[a-z_A-Z]* { // escaped command addOutput(yytext); } -{MAILADR} { // mail adress +{MAILADDR} { // mail address addOutput(yytext); } "\""[^"\n]*"\"" { // quoted text diff --git a/src/compound.xsd b/src/compound.xsd index fd24fc9..d623c5f 100644 --- a/src/compound.xsd +++ b/src/compound.xsd @@ -172,6 +172,18 @@ + + + + + + + + + + + + @@ -742,6 +754,8 @@ + + @@ -771,6 +785,10 @@ + + + + diff --git a/src/compound_xsd.h b/src/compound_xsd.h index 7a726ae..8ec3633 100644 --- a/src/compound_xsd.h +++ b/src/compound_xsd.h @@ -172,6 +172,18 @@ " \n" " \n" " \n" +" \n" +" \n" +" \n" +" \n" +" \n" +" \n" +" \n" +" \n" +" \n" +" \n" +" \n" +"\n" " \n" "\n" " \n" @@ -742,6 +754,8 @@ " \n" " \n" " \n" +" \n" +" \n" " \n" " \n" "\n" @@ -771,6 +785,10 @@ " \n" " \n" " \n" +" \n" +" \n" +" \n" +" \n" " \n" " \n" " \n" diff --git a/src/config.h b/src/config.h index a33909c..47bef4c 100644 --- a/src/config.h +++ b/src/config.h @@ -67,6 +67,7 @@ class ConfigOption QCString dependsOn() const { return m_dependency; } void addDependency(const char *dep) { m_dependency = dep; } void setEncoding(const QCString &e) { m_encoding = e; } + void setUserComment(const QCString &u) { m_userComment = u; } protected: virtual void writeTemplate(FTextStream &t,bool sl,bool upd) = 0; @@ -75,7 +76,7 @@ class ConfigOption virtual void writeXML(FTextStream&) {} virtual void init() {} - QCString convertToComment(const QCString &s); + QCString convertToComment(const QCString &s, const QCString &u); void writeBoolValue(FTextStream &t,bool v); void writeIntValue(FTextStream &t,int i); void writeStringValue(FTextStream &t,QCString &s); @@ -86,6 +87,7 @@ class ConfigOption QCString m_doc; QCString m_dependency; QCString m_encoding; + QCString m_userComment; OptionType m_kind; }; @@ -135,9 +137,13 @@ class ConfigList : public ConfigOption if (!sl) { t << endl; - t << convertToComment(m_doc); + t << convertToComment(m_doc, m_userComment); t << endl; } + else if (!m_userComment.isEmpty()) + { + t << convertToComment("", m_userComment); + } t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "="; writeStringList(t,m_value); t << "\n"; @@ -175,9 +181,13 @@ class ConfigEnum : public ConfigOption if (!sl) { t << endl; - t << convertToComment(m_doc); + t << convertToComment(m_doc, m_userComment); t << endl; } + else if (!m_userComment.isEmpty()) + { + t << convertToComment("", m_userComment); + } t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "="; writeStringValue(t,m_value); t << "\n"; @@ -216,9 +226,13 @@ class ConfigString : public ConfigOption if (!sl) { t << endl; - t << convertToComment(m_doc); + t << convertToComment(m_doc, m_userComment); t << endl; } + else if (!m_userComment.isEmpty()) + { + t << convertToComment("", m_userComment); + } t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "="; writeStringValue(t,m_value); t << "\n"; @@ -259,9 +273,13 @@ class ConfigInt : public ConfigOption if (!sl) { t << endl; - t << convertToComment(m_doc); + t << convertToComment(m_doc, m_userComment); t << endl; } + else if (!m_userComment.isEmpty()) + { + t << convertToComment("", m_userComment); + } t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "="; if (upd && !m_valueString.isEmpty()) { @@ -306,9 +324,13 @@ class ConfigBool : public ConfigOption if (!sl) { t << endl; - t << convertToComment(m_doc); + t << convertToComment(m_doc, m_userComment); t << endl; } + else if (!m_userComment.isEmpty()) + { + t << convertToComment("", m_userComment); + } t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "="; if (upd && !m_valueString.isEmpty()) { @@ -570,6 +592,22 @@ class Config */ void create(); + /*! Append user comment + */ + void appendUserComment(const QCString &u) + { + m_userComment += u; + } + /*! Take the user comment and reset it internally + * \returns user comment + */ + QCString takeUserComment() + { + QCString result=m_userComment; + m_userComment.resize(0); + return result; + } + protected: Config() @@ -594,6 +632,7 @@ class Config QList *m_obsolete; QDict *m_dict; static Config *m_instance; + QCString m_userComment; bool m_initialized; }; diff --git a/src/config.l b/src/config.l index b32fd76..0c2bcbf 100644 --- a/src/config.l +++ b/src/config.l @@ -77,11 +77,11 @@ static QCString configStringRecode( /* ----------------------------------------------------------------- */ -QCString ConfigOption::convertToComment(const QCString &s) +QCString ConfigOption::convertToComment(const QCString &s, const QCString &u) { + //printf("convertToComment(%s)=%s\n",s.data(),u.data()); QCString result; - if (s.isEmpty()) return result; - else + if (!s.isEmpty()) { QCString tmp=s.stripWhiteSpace(); char *p=tmp.data(); @@ -101,6 +101,11 @@ QCString ConfigOption::convertToComment(const QCString &s) } result+='\n'; } + if (!u.isEmpty()) + { + if (!result.isEmpty()) result+='\n'; + result+= u; + } return result; } @@ -589,7 +594,8 @@ static void readIncludeFile(const char *incName) %% <*>\0x0d -"#" { BEGIN(SkipComment); } +"##".*"\n" { config->appendUserComment(yytext);} +"#" { BEGIN(SkipComment); } [a-z_A-Z][a-z_A-Z0-9]*[ \t]*"=" { QCString cmd=yytext; cmd=cmd.left(cmd.length()-1).stripWhiteSpace(); ConfigOption *option = config->get(cmd); @@ -601,6 +607,7 @@ static void readIncludeFile(const char *incName) } else // known tag { + option->setUserComment(config->takeUserComment()); option->setEncoding(encoding); switch(option->kind()) { @@ -654,6 +661,7 @@ static void readIncludeFile(const char *incName) } else // known tag { + option->setUserComment(config->takeUserComment()); switch(option->kind()) { case ConfigOption::O_Info: @@ -798,6 +806,8 @@ void Config::writeTemplate(FTextStream &t,bool sl,bool upd) t << "# This file describes the settings to be used by the documentation system\n"; t << "# doxygen (www.doxygen.org) for a project.\n"; t << "#\n"; + t << "# All text after a double hash (##) is considered a comment and is placed\n"; + t << "# in front of the TAG it is preceding .\n"; t << "# All text after a hash (#) is considered a comment and will be ignored.\n"; t << "# The format is:\n"; t << "# TAG = value [value, ...]\n"; @@ -811,6 +821,12 @@ void Config::writeTemplate(FTextStream &t,bool sl,bool upd) option->writeTemplate(t,sl,upd); option = m_options->next(); } + /* print last lines of user comment that were at the end of the file */ + if (m_userComment) + { + t << "\n"; + t << m_userComment; + } } void Config::writeXML(FTextStream &t) @@ -1130,6 +1146,21 @@ void Config::check() exit(1); } } + // Test to see if MathJax code file is valid + if (Config_getBool("USE_MATHJAX")) + { + QCString &MathJaxCodefile = Config_getString("MATHJAX_CODEFILE"); + if (!MathJaxCodefile.isEmpty()) + { + QFileInfo fi(MathJaxCodefile); + if (!fi.exists()) + { + config_err("error: tag MATHJAX_CODEFILE file `%s' " + "does not exist\n",MathJaxCodefile.data()); + exit(1); + } + } + } // Test to see if LaTeX header is valid QCString &latexHeaderFile = Config_getString("LATEX_HEADER"); if (!latexHeaderFile.isEmpty()) @@ -1506,6 +1537,24 @@ void Config::init() option->init(); option = m_options->next(); } + + // sanity check if all depends relations are valid + option = m_options->first(); + while (option) + { + QCString depName = option->dependsOn(); + if (!depName.isEmpty()) + { + ConfigOption * opt = Config::instance()->get(depName); + if (opt==0) + { + config_err("Config option '%s' has invalid depends relation on unknown option '%s'\n", + option->name().data(),depName.data()); + exit(1); + } + } + option = m_options->next(); + } } void Config::create() diff --git a/src/config.xml b/src/config.xml index 53e47da..db51172 100644 --- a/src/config.xml +++ b/src/config.xml @@ -819,7 +819,7 @@ for better parsing at the cost of reduced performance. This can be particularly helpful with template rich C++ code for which doxygen's built-in parser lacks the necessairy type information. ' defval='0'/> - +