From 820c90090848a96b959c562209bc3242fee58a53 Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Mon, 17 May 2004 20:19:03 +0000 Subject: Release-1.3.7-20040517 --- INSTALL | 4 +- README | 4 +- VERSION | 2 +- addon/doxywizard/doxywizard.cpp | 1 + configure | 4 +- doc/config.doc | 8 +- doc/language.doc | 18 +- doc/maintainers.txt | 5 + packages/rpm/doxygen.spec | 2 +- qtools/Doxyfile | 1006 ++++++++++++++++++++++++- src/config.l | 1 - src/definition.cpp | 6 +- src/docparser.cpp | 5 +- src/docparser.h | 13 +- src/dot.cpp | 86 +-- src/doxygen.cpp | 45 +- src/doxygen.pro.in | 1 + src/filedef.cpp | 26 +- src/htmldocvisitor.cpp | 2 +- src/htmlgen.h | 2 +- src/index.cpp | 33 +- src/lang_cfg.h | 1 + src/language.cpp | 9 + src/latexgen.h | 2 +- src/mangen.h | 2 +- src/memberdef.cpp | 18 +- src/outputgen.h | 2 +- src/outputlist.cpp | 9 +- src/outputlist.h | 7 +- src/rtfdocvisitor.cpp | 264 +++++-- src/rtfdocvisitor.h | 1 + src/rtfgen.cpp | 40 +- src/rtfgen.h | 10 +- src/rtfstyle.cpp | 4 + src/translator_cz.h | 24 +- src/translator_lt.h | 1546 +++++++++++++++++++++++++++++++++++++++ src/translator_ru.h | 2 +- src/util.cpp | 31 +- 38 files changed, 2953 insertions(+), 293 deletions(-) create mode 100644 src/translator_lt.h diff --git a/INSTALL b/INSTALL index 7d91eb7..655417b 100644 --- a/INSTALL +++ b/INSTALL @@ -1,7 +1,7 @@ -DOXYGEN Version 1.3.7 +DOXYGEN Version 1.3.7-20040517 Please read the installation section of the manual (http://www.doxygen.org/install.html) for instructions. -------- -Dimitri van Heesch (07 May 2004) +Dimitri van Heesch (17 May 2004) diff --git a/README b/README index 7976d6b..d797fa3 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -DOXYGEN Version 1.3.7 +DOXYGEN Version 1.3.7_20040517 Please read INSTALL for compilation instructions. @@ -17,4 +17,4 @@ to subscribe to the lists or to visit the archives. Enjoy, -Dimitri van Heesch (dimitri@stack.nl) (07 May 2004) +Dimitri van Heesch (dimitri@stack.nl) (17 May 2004) diff --git a/VERSION b/VERSION index 3336003..e045738 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.3.7 +1.3.7-20040517 diff --git a/addon/doxywizard/doxywizard.cpp b/addon/doxywizard/doxywizard.cpp index abc119b..799fe4f 100644 --- a/addon/doxywizard/doxywizard.cpp +++ b/addon/doxywizard/doxywizard.cpp @@ -479,6 +479,7 @@ void ConfigFile::addDependency(QDict *switches, { if (!dep.isEmpty()) { + //printf("ConfigFile::addDependency(%s)\n",name.data()); IInput *parent = m_inputWidgets->find(dep); ASSERT(parent!=0); IInput *child = m_inputWidgets->find(name); diff --git a/configure b/configure index 616ee93..3c00bf8 100755 --- a/configure +++ b/configure @@ -27,7 +27,7 @@ f_prefix=/usr/local f_insttool=NO f_english=NO f_wizard=NO -f_langs=nl,se,cz,fr,it,de,jp,je,es,fi,ru,hr,pl,pt,hu,kr,ke,ro,si,cn,no,br,dk,sk,ua,gr,tw,sr,ca +f_langs=nl,se,cz,fr,it,de,jp,je,es,fi,ru,hr,pl,pt,hu,kr,ke,ro,si,cn,no,br,dk,sk,ua,gr,tw,sr,ca,lt while test -n "$1"; do case $1 in @@ -518,7 +518,7 @@ echo -n " Generating src/lang_cfg.h..." echo $f_langs | $f_perl -e '@l=split(/,/,); chomp @l; @allowed=(NL,SE,CZ,FR,IT,DE,JP,JE,ES,FI,RU,HR,PL,PT,HU,KR,KE,RO,SI,CN,NO,BR, - DK,SK,UA,GR,TW,SR,CA); + DK,SK,UA,GR,TW,SR,CA,LT); foreach my $elem (@l){ $elem =~ tr/a-z/A-Z/; $r=0; diff --git a/doc/config.doc b/doc/config.doc index 8c595a5..a465086 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -252,10 +252,10 @@ followed by the descriptions of the tags grouped by category. documentation generated by doxygen is written. Doxygen will use this information to generate all constant output in the proper language. The default language is English, other supported languages are: - Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, - German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, - Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, - and Ukrainian. + Brazilian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, + German, Greek, Hungarian, Italian, Japanese, Korean, Lithuanian, Norwegian, + Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, + Swedish, and Ukrainian. \anchor cfg_use_windows_encoding
\c USE_WINDOWS_ENCODING
diff --git a/doc/language.doc b/doc/language.doc index 56be813..595a75c 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -23,13 +23,13 @@ text fragments, generated by doxygen, can be produced in languages other than English (the default). The output language is chosen through the configuration file (with default name and known as Doxyfile). -Currently (version 1.3.6-20040427), 28 languages +Currently (version 1.3.7), 29 languages are supported (sorted alphabetically): Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, German, Greek, -Hungarian, Italian, Japanese (+En), Korean (+En), Norwegian, Polish, -Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, -Swedish, and Ukrainian.. +Hungarian, Italian, Japanese (+En), Korean (+En), Lithuanian, +Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, +Slovene, Spanish, Swedish, and Ukrainian.. The table of information related to the supported languages follows. It is sorted by language alphabetically. The Status column @@ -165,6 +165,12 @@ when the translator was updated. English based + Lithuanian + Tomas Simonaitis
Mindaugas Radzius
Aidas Berukstis + haden@NOSPAM.homelan.lt
mindaugasradzius@NOSPAM.takas.lt
aidasber@NOSPAM.takas.lt + up-to-date + + Norwegian Lars Erik Jordet lej@NOSPAM.circuitry.no @@ -288,6 +294,10 @@ when the translator was updated. \hline KoreanEn & see the Korean language & {\tt\tiny ~} & English based \\ \hline + Lithuanian & Tomas Simonaitis & {\tt\tiny haden@homelan.lt} & up-to-date \\ + ~ & Mindaugas Radzius & {\tt\tiny mindaugasradzius@takas.lt} & ~ \\ + ~ & Aidas Berukstis & {\tt\tiny aidasber@takas.lt} & ~ \\ + \hline Norwegian & Lars Erik Jordet & {\tt\tiny lej@circuitry.no} & 1.2.2 \\ \hline Polish & Piotr Kaminski & {\tt\tiny Piotr.Kaminski@ctm.gdynia.pl} & 1.3 \\ diff --git a/doc/maintainers.txt b/doc/maintainers.txt index 9985f2e..9d19367 100644 --- a/doc/maintainers.txt +++ b/doc/maintainers.txt @@ -65,6 +65,11 @@ Kenji Nagamatsu: naga@joyful.club.ne.jp TranslatorKorean Richard Kim: ryk@dspwiz.com +TranslatorLithuanian +Tomas Simonaitis: haden@homelan.lt +Mindaugas Radzius: mindaugasradzius@takas.lt +Aidas Berukstis: aidasber@takas.lt + TranslatorNorwegian Lars Erik Jordet: lej@circuitry.no diff --git a/packages/rpm/doxygen.spec b/packages/rpm/doxygen.spec index 0e5e237..15c4fc8 100644 --- a/packages/rpm/doxygen.spec +++ b/packages/rpm/doxygen.spec @@ -1,6 +1,6 @@ Summary: A documentation system for C/C++. Name: doxygen -Version: 1.3.7 +Version: 1.3.7_20040517 Release: 1 Epoch: 1 Source0: ftp://ftp.stack.nl/pub/users/dimitri/%{name}-%{version}.src.tar.gz diff --git a/qtools/Doxyfile b/qtools/Doxyfile index c1f7e45..d32fdca 100644 --- a/qtools/Doxyfile +++ b/qtools/Doxyfile @@ -1,194 +1,1144 @@ -# Doxyfile 1.2.18 +# Doxyfile 1.3.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- -# General configuration options +# Project related configuration options #--------------------------------------------------------------------------- + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + PROJECT_NAME = Doxygen + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + PROJECT_NUMBER = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + OUTPUT_DIRECTORY = ../qtools_docs + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 2 levels of 10 sub-directories under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of source +# files, where putting all generated files in the same directory would otherwise +# cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en +# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, +# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. + OUTPUT_LANGUAGE = English -EXTRACT_ALL = YES -EXTRACT_PRIVATE = YES -EXTRACT_STATIC = YES -EXTRACT_LOCAL_CLASSES = YES -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO + +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for +# all platforms other than Windows). + +USE_WINDOWS_ENCODING = NO + +# If the BRIEF_MEMBER_DESC tag is set to 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. + BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is used +# as the annotated text. Otherwise, the brief description is used as-is. If left +# blank, the following values are used ("$name" is automatically replaced with the +# name of the entity): "The $name class" "The $name widget" "The $name file" +# "is" "provides" "specifies" "contains" "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited +# members of a class in the documentation of that class as if those members were +# ordinary class members. Constructors, destructors and assignment operators of +# the base classes will not be shown. + INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then 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. + FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + STRIP_FROM_PATH = $(PWD)/ -INTERNAL_DOCS = NO -STRIP_CODE_COMMENTS = YES -CASE_SENSE_NAMES = NO + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# 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. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + SHORT_NAMES = NO -HIDE_SCOPE_NAMES = NO -VERBATIM_HEADERS = YES -SHOW_INCLUDE_FILES = YES + +# If the JAVADOC_AUTOBRIEF tag is set to 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 JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an +# explicit @brief command for a brief description. + JAVADOC_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to 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 behaviour. +# 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 behaviour instead. + MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + INHERIT_DOCS = YES -INLINE_INFO = YES -SORT_MEMBER_DOCS = YES + +# 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 +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + DISTRIBUTE_GROUP_DOC = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources +# only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes +# will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to 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. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to 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. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + GENERATE_DEPRECATEDLIST= YES -ALIASES = + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + MAX_INITIALIZER_LINES = 30 -OPTIMIZE_OUTPUT_FOR_C = NO -OPTIMIZE_OUTPUT_JAVA = NO + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + SHOW_USED_FILES = YES + #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. + WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + WARN_LOGFILE = + #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + INPUT = . + +# If the value of the INPUT tag contains directories, you can use the +# FILE_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 the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp +# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm + FILE_PATTERNS = *.h \ *.cpp \ *.doc + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories +# that are symbolic links (a Unix filesystem feature) are excluded from the input. + EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. + EXCLUDE_PATTERNS = + +# The 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). + EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# 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. + EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. + INPUT_FILTER = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + FILTER_SOURCE_FILES = NO + #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to 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 +# VERBATIM_HEADERS is set to NO. + SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + REFERENCES_RELATION = YES + +# If the VERBATIM_HEADERS tag is set to 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. + +VERBATIM_HEADERS = YES + #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + COLS_IN_ALPHA_INDEX = 4 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + IGNORE_PREFIX = Q + #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + HTML_OUTPUT = + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# of the generated HTML documentation. + GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to 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 (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + TREEVIEW_WIDTH = 250 + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + LATEX_OUTPUT = + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + RTF_OUTPUT = + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + RTF_EXTENSIONS_FILE = + #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + MAN_OUTPUT = + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + MAN_LINKS = NO + #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + GENERATE_XML = YES + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + MACRO_EXPANSION = YES + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_PREDEFINED tags. + EXPAND_ONLY_PREDEF = YES + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. + PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse the +# parser if not removed. + SKIP_FUNCTION_MACROS = YES + #--------------------------------------------------------------------------- -# Configuration::addtions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + GENERATE_TAGFILE = ../qtools_docs/qtools.tag + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + PERL_PATH = /usr/bin/perl + #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or +# super classes. Setting the tag to NO turns the diagrams off. Note that this +# option is superseded by the HAVE_DOT option below. This is only a fallback. It is +# recommended to install and use dot, since it yields more powerful graphs. + CLASS_DIAGRAMS = YES + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + HAVE_DOT = YES + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + COLLABORATION_GRAPH = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + TEMPLATE_RELATIONS = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + INCLUDED_BY_GRAPH = NO + +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + GRAPHICAL_HIERARCHY = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found on the path. + DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + MAX_DOT_GRAPH_WIDTH = 2048 + +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + MAX_DOT_GRAPH_HEIGHT = 2048 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes that +# lay further from the root node will be omitted. Note that setting this option to +# 1 or 2 may greatly reduce the computation time needed for large code bases. Also +# note that a graph may be further truncated if the graph's image dimensions are +# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). +# If 0 is used for the depth value (the default), the graph is not depth-constrained. + +MAX_DOT_GRAPH_DEPTH = 0 + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + DOT_CLEANUP = YES + #--------------------------------------------------------------------------- -# Configuration::addtions related to the search engine +# Configuration::additions related to the search engine #--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + SEARCHENGINE = NO -CGI_NAME = search.cgi -CGI_URL = -DOC_URL = -DOC_ABSPATH = -BIN_ABSPATH = /usr/local/bin/ -EXT_DOC_PATHS = diff --git a/src/config.l b/src/config.l index f757a3d..7db22c9 100644 --- a/src/config.l +++ b/src/config.l @@ -1356,7 +1356,6 @@ void Config::create() "cause performance problems for the file system. \n", FALSE ); - cb->addDependency("GENERATE_HTML"); ce = addEnum( "OUTPUT_LANGUAGE", "The OUTPUT_LANGUAGE tag is used to specify the language in which all \n" diff --git a/src/definition.cpp b/src/definition.cpp index 9bf6acd..6581847 100644 --- a/src/definition.cpp +++ b/src/definition.cpp @@ -355,10 +355,6 @@ void Definition::writeSourceDef(OutputList &ol,const char *) //printf("Definition::writeSourceRef %d %p\n",bodyLine,bodyDef); if (Config_getBool("SOURCE_BROWSER") && m_startBodyLine!=-1 && m_bodyDef) { - ol.disable(OutputGenerator::RTF); - ol.newParagraph(); - ol.enableAll(); - QCString refText = theTranslator->trDefinedAtLineInSourceFile(); int lineMarkerPos = refText.find("@0"); int fileMarkerPos = refText.find("@1"); @@ -462,11 +458,11 @@ void Definition::writeInlineCode(OutputList &ol,const char *scopeName) initParseCodeContext(); //printf("Read:\n`%s'\n\n",codeFragment.data()); if (definitionType()==TypeMember) setParameterList((MemberDef *)this); - ol.newParagraph(); ol.startCodeFragment(); parseCode(ol,scopeName,codeFragment,FALSE,0, m_bodyDef,actualStart,actualEnd,TRUE); ol.endCodeFragment(); + ol.newParagraph(); } } ol.popGeneratorState(); diff --git a/src/docparser.cpp b/src/docparser.cpp index d6fcee9..16bbb58 100644 --- a/src/docparser.cpp +++ b/src/docparser.cpp @@ -4807,7 +4807,8 @@ void DocRoot::parse() DocNode *validatingParseDoc(const char *fileName,int startLine, Definition *ctx,MemberDef *md, const char *input,bool indexWords, - bool isExample, const char *exampleName) + bool isExample, const char *exampleName, + bool singleLine) { //printf("validatingParseDoc(%s,%s)\n",ctx?ctx->name().data():"", @@ -4923,7 +4924,7 @@ DocNode *validatingParseDoc(const char *fileName,int startLine, doctokenizerYYinit(input,g_fileName); // build abstract syntax tree - DocRoot *root = new DocRoot; + DocRoot *root = new DocRoot(md!=0,singleLine); root->parse(); if (Debug::isFlagSet(Debug::PrintTree)) diff --git a/src/docparser.h b/src/docparser.h index ff13c46..da57809 100644 --- a/src/docparser.h +++ b/src/docparser.h @@ -51,13 +51,16 @@ void initDocParser(); * search index. * @param isExample TRUE if the documentation belongs to an example. * @param exampleName Base name of the example file (0 if isExample is FALSE). + * @param singleLine Output should be presented on a single line, so without + * starting a new paragraph at the end. * @returns Root node of the abstract syntax tree. Ownership of the * pointer is handed over to the caller. */ DocNode *validatingParseDoc(const char *fileName,int startLine, Definition *context, MemberDef *md, const char *input,bool indexWords, - bool isExample,const char *exampleName=0); + bool isExample,const char *exampleName=0, + bool singleLine=FALSE); /*! Main entry point for parsing simple text fragments. These * fragments are limited to words, whitespace and symbols. @@ -1185,11 +1188,17 @@ class DocText : public CompAccept, public DocNode class DocRoot : public CompAccept, public DocNode { public: - DocRoot() {} + DocRoot(bool indent,bool sl) : m_indent(indent), m_singleLine(sl) {} Kind kind() const { return Kind_Root; } DocNode *parent() const { return 0; } void accept(DocVisitor *v) { CompAccept::accept(this,v); } void parse(); + bool indent() const { return m_indent; } + bool singleLine() const { return m_singleLine; } + + private: + bool m_indent; + bool m_singleLine; }; diff --git a/src/dot.cpp b/src/dot.cpp index 1429645..c9f54d0 100644 --- a/src/dot.cpp +++ b/src/dot.cpp @@ -35,7 +35,7 @@ //-------------------------------------------------------------------- -static const int maxCmdLine = 4096; +static const int maxCmdLine = 40960; /*! mapping from protection levels to color names */ static const char *edgeColorMap[] = @@ -981,9 +981,10 @@ void DotGfxHierarchyTable::writeGraph(QTextStream &out,const char *path) f.close(); QCString dotArgs(maxCmdLine); - dotArgs.sprintf("-T%s \"%s\" -o \"%s\"", - imgExt.data(), dotName.data(),imgName.data()); - //printf("Running: dot -T%s %s -o %s\n",imgExt.data(),dotName.data(),imgName.data()); + dotArgs.sprintf("\"%s\" -T%s -o \"%s\" -Timap -o \"%s\"", + dotName.data(), imgExt.data(), imgName.data(), mapName.data()); + //printf("Running: dot %s -T%s -o %s -Timap -o %s\n", + // dotName.data(),imgExt.data(),imgName.data(),mapName.data()); if (iSystem(Config_getString("DOT_PATH")+"dot",dotArgs)!=0) { err("Problems running dot. Check your installation!\n"); @@ -991,14 +992,6 @@ void DotGfxHierarchyTable::writeGraph(QTextStream &out,const char *path) return; } checkDotResult(imgName); - dotArgs.sprintf("-Timap \"%s\" -o \"%s\"",dotName.data(),mapName.data()); - //printf("Running: dot -Timap %s -o %s\n",dotName.data(),mapName.data()); - if (iSystem(Config_getString("DOT_PATH")+"dot",dotArgs)!=0) - { - err("Problems running dot. Check your installation!\n"); - out << "" << endl; - return; - } if (Config_getBool("DOT_CLEANUP")) thisDir.remove(dotName); } // write image and map in a table row @@ -1673,8 +1666,14 @@ QCString DotClassGraph::writeGraph(QTextStream &out, { QCString dotArgs(maxCmdLine); QCString imgName = baseName+"."+imgExt; - dotArgs.sprintf("-T%s \"%s.dot\" -o \"%s\"", - imgExt.data(),baseName.data(),imgName.data()); + dotArgs.sprintf("\"%s.dot\" -T%s -o \"%s\"", + baseName.data(),imgExt.data(),imgName.data()); + if (generateImageMap) + { + // run dot also to create an image map + dotArgs+=QCString(maxCmdLine).sprintf(" -Timap -o \"%s.map\"", + baseName.data()); + } if (iSystem(Config_getString("DOT_PATH")+"dot",dotArgs)!=0) { err("Error: Problems running dot. Check your installation!\n"); @@ -1682,17 +1681,6 @@ QCString DotClassGraph::writeGraph(QTextStream &out, return baseName; } checkDotResult(imgName); - if (generateImageMap) - { - // run dot again to create an image map - dotArgs.sprintf("-Timap \"%s.dot\" -o \"%s.map\"",baseName.data(),baseName.data()); - if (iSystem(Config_getString("DOT_PATH")+"dot",dotArgs)!=0) - { - err("Error: Problems running dot. Check your installation!\n"); - QDir::setCurrent(oldDir); - return baseName; - } - } } else if (format==EPS) // run dot to create a .eps image { @@ -1942,8 +1930,14 @@ QCString DotInclDepGraph::writeGraph(QTextStream &out, // run dot to create a bitmap image QCString dotArgs(maxCmdLine); QCString imgName=baseName+"."+imgExt; - dotArgs.sprintf("-T%s \"%s.dot\" -o \"%s\"", - imgExt.data(),baseName.data(),imgName.data()); + dotArgs.sprintf("\"%s.dot\" -T%s -o \"%s\"", + baseName.data(),imgExt.data(),imgName.data()); + if (generateImageMap) + { + // run dot also to create an image map + dotArgs+=QCString(maxCmdLine).sprintf(" -Timap -o \"%s.map\"", + baseName.data()); + } if (iSystem(Config_getString("DOT_PATH")+"dot",dotArgs)!=0) { err("Problems running dot. Check your installation!\n"); @@ -1951,21 +1945,6 @@ QCString DotInclDepGraph::writeGraph(QTextStream &out, return baseName; } checkDotResult(imgName); - - if (generateImageMap) - { - // run dot again to create an image map - dotArgs.sprintf("-Timap \"%s.dot\" -o \"%s.map\"", - baseName.data(),baseName.data()); - if (iSystem(Config_getString("DOT_PATH")+"dot",dotArgs)!=0) - { - err("Problems running dot. Check your installation!\n"); - QDir::setCurrent(oldDir); - return baseName; - } - - //thisDir.remove(baseName+".map"); - } } else if (format==EPS) { @@ -2128,8 +2107,14 @@ QCString DotCallGraph::writeGraph(QTextStream &out, GraphOutputFormat format, // run dot to create a bitmap image QCString dotArgs(maxCmdLine); QCString imgName=baseName+"."+imgExt; - dotArgs.sprintf("-T%s \"%s.dot\" -o \"%s\"", - imgExt.data(),baseName.data(),imgName.data()); + dotArgs.sprintf("\"%s.dot\" -T%s -o \"%s\"", + baseName.data(),imgExt.data(),imgName.data()); + if (generateImageMap) + { + // run dot also to create an image map + dotArgs+=QCString(maxCmdLine).sprintf(" -Timap -o \"%s.map\"", + baseName.data()); + } if (iSystem(Config_getString("DOT_PATH")+"dot",dotArgs)!=0) { err("Problems running dot. Check your installation!\n"); @@ -2137,19 +2122,6 @@ QCString DotCallGraph::writeGraph(QTextStream &out, GraphOutputFormat format, return baseName; } checkDotResult(imgName); - - if (generateImageMap) - { - // run dot again to create an image map - dotArgs.sprintf("-Timap \"%s.dot\" -o \"%s.map\"", - baseName.data(),baseName.data()); - if (iSystem(Config_getString("DOT_PATH")+"dot",dotArgs)!=0) - { - err("Problems running dot. Check your installation!\n"); - QDir::setCurrent(oldDir); - return baseName; - } - } } else if (format==EPS) { diff --git a/src/doxygen.cpp b/src/doxygen.cpp index ba10bb9..a91a64e 100644 --- a/src/doxygen.cpp +++ b/src/doxygen.cpp @@ -1608,8 +1608,8 @@ static MemberDef *addVariableToFile( if ( ((nd==0 && md->getFileDef() && root->fileName==md->getFileDef()->absFilePath() - ) - || (nd!=0 && md->getNamespaceDef()==nd) + ) // both variable names in the same file + || (nd!=0 && md->getNamespaceDef()==nd) // both in same namespace ) && !md->isDefine() // function style #define's can be "overloaded" by typedefs or variables ) @@ -1658,15 +1658,17 @@ static MemberDef *addVariableToFile( md->addSectionsToDefinition(root->anchors); md->setFromAnonymousScope(fromAnnScope); md->setFromAnonymousMember(fromAnnMemb); - //md->setIndentDepth(indentDepth); - md->setBodySegment(root->bodyLine,root->endBodyLine); md->setInitializer(root->initializer); md->setMaxInitLines(root->initLines); md->setMemberGroupId(root->mGrpId); - md->setBodyDef(fd); md->setDefinition(def); md->enableCallGraph(root->callGraph); md->setExplicitExternal(root->explicitExternal); + if (!root->explicitExternal) + { + md->setBodySegment(root->bodyLine,root->endBodyLine); + md->setBodyDef(fd); + } addMemberToGroups(root,md); md->setRefItems(root->sli); @@ -1956,7 +1958,7 @@ static void buildVarList(Entry *root) int si=scope.find('@'); //int anonyScopes = 0; bool added=FALSE; - if (si!=-1) + if (si!=-1) // anonymous scope { QCString pScope; ClassDef *pcd=0; @@ -1994,19 +1996,6 @@ static void buildVarList(Entry *root) //printf("Inserting member in global scope %s!\n",scope.data()); addVariableToFile(root,mtype,scope,name,FALSE,/*0,*/0); } - //if (mtype==MemberDef::Typedef) - //{ - // static QRegExp r("[a-z_A-Z][a-z_A-Z0-9]*"); - // int i,l; - // if ((i=r.match(type,8,&l))!=-1) - // { - // //printf(">>> inserting typedef `%s'->`%s'\n",type.mid(i,l).data(),name.data()); - // if (getClass(type.mid(i,l))!=0) - // { - // typedefDict.insert(name,new QCString(type.mid(i,l))); - // } - // } - //} } nextMember: EntryListIterator eli(*root->sublist); @@ -3091,11 +3080,18 @@ static void findUsedClassesForClass(Entry *root, { //printf("Found used class %s\n",usedClassName.data()); // the name could be a type definition, resolve it - // TODO: recursive typedef resolution QCString typeName = resolveTypeDef(masterCd,usedClassName); - //printf("Found resolved class %s\n",typeName.data()); + //printf("*** Found resolved class %s for %s\n",typeName.data(),usedClassName.data()); + + if (!typeName.isEmpty()) // if we could resolve the typedef, use + // the result as the class name. + { + usedClassName=typeName; + } - int si=usedClassName.findRev("::"); + int sp=usedClassName.find('<'); + if (sp==-1) sp=0; + int si=usedClassName.findRev("::",sp); if (si!=-1) { // replace any namespace aliases @@ -8381,8 +8377,9 @@ void generateOutput() Doxygen::tagFile << "" << endl; } - if (Config_getBool("GENERATE_HTML")) writeDoxFont(Config_getString("HTML_OUTPUT")); - if (Config_getBool("GENERATE_RTF")) writeDoxFont(Config_getString("RTF_OUTPUT")); + if (Config_getBool("GENERATE_HTML")) writeDoxFont(Config_getString("HTML_OUTPUT")); + if (Config_getBool("GENERATE_LATEX")) writeDoxFont(Config_getString("LATEX_OUTPUT")); + if (Config_getBool("GENERATE_RTF")) writeDoxFont(Config_getString("RTF_OUTPUT")); //statistics(); diff --git a/src/doxygen.pro.in b/src/doxygen.pro.in index 26de635..8e8d273 100644 --- a/src/doxygen.pro.in +++ b/src/doxygen.pro.in @@ -35,5 +35,6 @@ TARGET = doxygen unix:TARGETDEPS = ../lib/libdoxygen.a ../lib/libdoxycfg.a win32:TARGETDEPS = ..\lib\doxygen.lib ..\lib\doxycfg.lib win32-g++:TARGETDEPS = ../lib/libdoxygen.a ../lib/libdoxycfg.a +win32-mingw:TARGETDEPS = ../lib/libdoxygen.a ../lib/libdoxycfg.a OBJECTS_DIR = ../objects diff --git a/src/filedef.cpp b/src/filedef.cpp index 0c00968..33c418c 100644 --- a/src/filedef.cpp +++ b/src/filedef.cpp @@ -235,28 +235,31 @@ void FileDef::writeDocumentation(OutputList &ol) << "" << endl; } - ol.startTextBlock(); if (Config_getBool("DETAILS_AT_TOP")) { + ol.startTextBlock(); writeDetailedDocumentation(ol); - ol.newParagraph(); + ol.endTextBlock(); } - else if (briefDescription()) + else if (!briefDescription().isEmpty()) { ol.parseDoc(briefFile(),briefLine(),this,0,briefDescription(),TRUE,FALSE); - ol.writeString(" \n"); + //ol.writeString(" \n"); ol.disableAllBut(OutputGenerator::Html); ol.startTextLink(0,"_details"); ol.parseText(theTranslator->trMore()); ol.endTextLink(); ol.enableAll(); + + ol.pushGeneratorState(); ol.disable(OutputGenerator::Man); + ol.disable(OutputGenerator::RTF); ol.newParagraph(); - ol.enable(OutputGenerator::Man); + ol.popGeneratorState(); } ol.writeSynopsis(); - if (Config_getBool("SHOW_INCLUDE_FILES")) + if (Config_getBool("SHOW_INCLUDE_FILES") && includeList->count()>0) { ol.startTextBlock(TRUE); QListIterator ili(*includeList); @@ -323,12 +326,7 @@ void FileDef::writeDocumentation(OutputList &ol) if (isIDLorJava) ol.docify(";"); ol.endTypewriter(); - ol.disable(OutputGenerator::RTF); ol.lineBreak(); - ol.enableAll(); - ol.disableAllBut(OutputGenerator::RTF); - ol.newParagraph(); - ol.enableAll(); } ol.endTextBlock(); } @@ -339,12 +337,14 @@ void FileDef::writeDocumentation(OutputList &ol) DotInclDepGraph incDepGraph(this,Config_getInt("MAX_DOT_GRAPH_DEPTH"),FALSE); if (!incDepGraph.isTrivial()) { + ol.startTextBlock(); ol.disable(OutputGenerator::Man); ol.newParagraph(); ol.startInclDepGraph(); ol.parseText(theTranslator->trInclDepGraph(name())); ol.endInclDepGraph(incDepGraph); ol.enableAll(); + ol.endTextBlock(TRUE); } //incDepGraph.writeGraph(Config_getString("HTML_OUTPUT"),fd->getOutputFileBase()); } @@ -355,12 +355,14 @@ void FileDef::writeDocumentation(OutputList &ol) DotInclDepGraph incDepGraph(this,Config_getInt("MAX_DOT_GRAPH_DEPTH"),TRUE); if (!incDepGraph.isTrivial()) { + ol.startTextBlock(); ol.disable(OutputGenerator::Man); ol.newParagraph(); ol.startInclDepGraph(); ol.parseText(theTranslator->trInclByDepGraph()); ol.endInclDepGraph(incDepGraph); ol.enableAll(); + ol.endTextBlock(TRUE); } //incDepGraph.writeGraph(Config_getString("HTML_OUTPUT"),fd->getOutputFileBase()); } @@ -376,8 +378,6 @@ void FileDef::writeDocumentation(OutputList &ol) ol.enableAll(); } - ol.endTextBlock(); - ol.startMemberSections(); if (namespaceSDict->count()>0) diff --git a/src/htmldocvisitor.cpp b/src/htmldocvisitor.cpp index 62460df..bfb0958 100644 --- a/src/htmldocvisitor.cpp +++ b/src/htmldocvisitor.cpp @@ -249,6 +249,7 @@ void HtmlDocVisitor::visit(DocInclude *inc) m_t << "
";
       parseCode(m_ci,inc->context(),inc->text().latin1(),inc->isExample(),inc->exampleFile());
       m_t << "
"; + break; case DocInclude::IncWithLines: { m_t << "
";
@@ -258,7 +259,6 @@ void HtmlDocVisitor::visit(DocInclude *inc)
          m_t << "
"; } break; - break; case DocInclude::DontInclude: break; case DocInclude::HtmlInclude: diff --git a/src/htmlgen.h b/src/htmlgen.h index 29d7385..e63030a 100644 --- a/src/htmlgen.h +++ b/src/htmlgen.h @@ -190,7 +190,7 @@ class HtmlGenerator : public OutputGenerator void writeGraphicalHierarchy(DotGfxHierarchyTable &g); void startTextBlock(bool) {} - void endTextBlock() {} + void endTextBlock(bool) {} void lastIndexPage() {} void startMemberDocPrefixItem(); diff --git a/src/index.cpp b/src/index.cpp index afc0f1d..6473f9a 100644 --- a/src/index.cpp +++ b/src/index.cpp @@ -961,35 +961,6 @@ void writeFileIndex(OutputList &ol) fullName.prepend(path); } - // --------------- LaTeX/RTF only ------------------------- -#if 0 - if (doc) - { - ol.pushGeneratorState(); - ol.disable(OutputGenerator::Html); - ol.writeStartAnnoItem("file", - fd->getOutputFileBase(), - path, - fd->name() - ); - if (!fd->briefDescription().isEmpty()) - { - ol.docify(" ("); - parseDoc(ol,fd->absFilePath(),1, - 0,0, - abbreviate(fd->briefDescription(),fd->name())); - ol.docify(")"); - } - ol.writeEndAnnoItem(fd->getOutputFileBase()); - ol.popGeneratorState(); - } -#endif - // -------------------------------------------------------- - - // ----------------- HTML only ---------------------------- - //ol.pushGeneratorState(); - //ol.disableAllBut(OutputGenerator::Html); - //ol.writeListItem(); ol.startIndexKey(); ol.docify(path); if (doc) @@ -1041,7 +1012,9 @@ void writeFileIndex(OutputList &ol) fd,0, abbreviate(fd->briefDescription(),fd->name()), FALSE, // index words - FALSE // isExample + FALSE, // isExample + 0, // example name + TRUE // single line ); //ol.docify(")"); } diff --git a/src/lang_cfg.h b/src/lang_cfg.h index 01180c6..085c2a0 100644 --- a/src/lang_cfg.h +++ b/src/lang_cfg.h @@ -27,3 +27,4 @@ #define LANG_TW #define LANG_SR #define LANG_CA +#define LANG_LT diff --git a/src/language.cpp b/src/language.cpp index c73b68c..8cc1214 100644 --- a/src/language.cpp +++ b/src/language.cpp @@ -112,6 +112,9 @@ //#ifdef LANG_JS //#include "translator_js.h" //#endif +#ifdef LANG_LT +#include "translator_lt.h" +#endif #endif #define L_EQUAL(a) !stricmp(langName,a) @@ -307,6 +310,12 @@ bool setTranslator(const char *langName) theTranslator=new TranslatorCatalan; } #endif +#ifdef LANG_LT + else if (L_EQUAL("lithuanian")) + { + theTranslator=new TranslatorLithuanian; + } +#endif #endif // ENGLISH_ONLY else // use the default language (i.e. english) { diff --git a/src/latexgen.h b/src/latexgen.h index 49705d2..08f3ad0 100644 --- a/src/latexgen.h +++ b/src/latexgen.h @@ -266,7 +266,7 @@ class LatexGenerator : public OutputGenerator void writeGraphicalHierarchy(DotGfxHierarchyTable &) {} void startTextBlock(bool) {} - void endTextBlock() {} + void endTextBlock(bool) {} void startMemberDocPrefixItem() {} void endMemberDocPrefixItem() {} diff --git a/src/mangen.h b/src/mangen.h index b7d43bb..ac5bbe5 100644 --- a/src/mangen.h +++ b/src/mangen.h @@ -232,7 +232,7 @@ class ManGenerator : public OutputGenerator void writeGraphicalHierarchy(DotGfxHierarchyTable &) {} void startTextBlock(bool) {} - void endTextBlock() {} + void endTextBlock(bool) {} void lastIndexPage() {} void startMemberDocPrefixItem() {} diff --git a/src/memberdef.cpp b/src/memberdef.cpp index fd4ff55..ce37bac 100644 --- a/src/memberdef.cpp +++ b/src/memberdef.cpp @@ -1507,17 +1507,13 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, if (!detailed.isEmpty()) { ol.parseDoc(docFile(),docLine(),getOuterScope()?getOuterScope():container,this,detailed+"\n",TRUE,FALSE); - ol.pushGeneratorState(); if (!m_inbodyDocs.isEmpty()) { ol.newParagraph(); ol.parseDoc(inbodyFile(),inbodyLine(),getOuterScope()?getOuterScope():container,this,m_inbodyDocs+"\n",TRUE,FALSE); } - ol.disableAllBut(OutputGenerator::RTF); - ol.newParagraph(); - ol.popGeneratorState(); } - else if(!brief.isEmpty() && (Config_getBool("REPEAT_BRIEF") || + else if (!brief.isEmpty() && (Config_getBool("REPEAT_BRIEF") || !Config_getBool("BRIEF_MEMBER_DESC"))) { if (!m_inbodyDocs.isEmpty()) @@ -1525,10 +1521,6 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, ol.newParagraph(); ol.parseDoc(inbodyFile(),inbodyLine(),getOuterScope()?getOuterScope():container,this,m_inbodyDocs+"\n",TRUE,FALSE); } - ol.pushGeneratorState(); - ol.disableAllBut(OutputGenerator::RTF); - ol.newParagraph(); - ol.popGeneratorState(); } @@ -1678,9 +1670,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, ol.parseText(reimplFromLine.right( reimplFromLine.length()-markerPos-2)); // text right from marker - ol.disableAllBut(OutputGenerator::RTF); ol.newParagraph(); - ol.enableAll(); } else { @@ -1761,9 +1751,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, index=newIndex+matchLen; } ol.parseText(reimplInLine.right(reimplInLine.length()-index)); - ol.disableAllBut(OutputGenerator::RTF); ol.newParagraph(); - ol.enableAll(); } } // write the list of examples that use this member @@ -1781,10 +1769,6 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, writeSourceReffedBy(ol,cname); writeInlineCode(ol,cname); - ol.disableAllBut(OutputGenerator::RTF); - ol.newParagraph(); - ol.enableAll(); - if ((m_hasCallGraph || Config_getBool("CALL_GRAPH")) && isFunction() && Config_getBool("HAVE_DOT") ) diff --git a/src/outputgen.h b/src/outputgen.h index 6a86831..214ffaf 100644 --- a/src/outputgen.h +++ b/src/outputgen.h @@ -342,7 +342,7 @@ class OutputGenerator : public BaseOutputDocInterface //virtual void endQuickIndexItem() = 0; virtual void writeQuickLinks(bool compact,HighlightedItem hli) = 0; virtual void startTextBlock(bool) = 0; - virtual void endTextBlock() = 0; + virtual void endTextBlock(bool) = 0; virtual void lastIndexPage() = 0; virtual void startMemberDocPrefixItem() = 0; virtual void endMemberDocPrefixItem() = 0; diff --git a/src/outputlist.cpp b/src/outputlist.cpp index eaa7811..261355e 100644 --- a/src/outputlist.cpp +++ b/src/outputlist.cpp @@ -132,7 +132,8 @@ void OutputList::popGeneratorState() void OutputList::parseDoc(const char *fileName,int startLine, Definition *ctx,MemberDef * md, const QCString &docStr,bool indexWords, - bool isExample,const char *exampleName) + bool isExample,const char *exampleName, + bool singleLine) { int count=0; if (docStr.isEmpty()) return; @@ -149,12 +150,14 @@ void OutputList::parseDoc(const char *fileName,int startLine, if (docStr.at(docStr.length()-1)=='\n') { root = validatingParseDoc(fileName,startLine, - ctx,md,docStr,indexWords,isExample,exampleName); + ctx,md,docStr,indexWords,isExample,exampleName, + singleLine); } else { root = validatingParseDoc(fileName,startLine, - ctx,md,docStr+"\n",indexWords,isExample,exampleName); + ctx,md,docStr+"\n",indexWords,isExample,exampleName, + singleLine); } og=outputs->first(); diff --git a/src/outputlist.h b/src/outputlist.h index c24950f..68a8c10 100644 --- a/src/outputlist.h +++ b/src/outputlist.h @@ -62,7 +62,8 @@ class OutputList : public OutputDocInterface void parseDoc(const char *fileName,int startLine, Definition *ctx,MemberDef *md,const QCString &docStr, - bool indexWords,bool isExample,const char *exampleName=0); + bool indexWords,bool isExample,const char *exampleName=0, + bool singleLine=FALSE); void parseText(const QCString &textStr); @@ -321,8 +322,8 @@ class OutputList : public OutputDocInterface { forall(&OutputGenerator::writeGraphicalHierarchy,g); } void startTextBlock(bool dense=FALSE) { forall(&OutputGenerator::startTextBlock,dense); } - void endTextBlock() - { forall(&OutputGenerator::endTextBlock); } + void endTextBlock(bool paraBreak=FALSE) + { forall(&OutputGenerator::endTextBlock,paraBreak); } void lastIndexPage() { forall(&OutputGenerator::lastIndexPage); } void startMemberDocPrefixItem() diff --git a/src/rtfdocvisitor.cpp b/src/rtfdocvisitor.cpp index 2f2dd25..a878abc 100644 --- a/src/rtfdocvisitor.cpp +++ b/src/rtfdocvisitor.cpp @@ -28,8 +28,13 @@ #include "message.h" #include + +#define DBG_RTF(x) m_t << x +//#define DBG_RTF(x) do {} while(0) + RTFDocVisitor::RTFDocVisitor(QTextStream &t,BaseCodeDocInterface &ci) - : DocVisitor(DocVisitor_RTF), m_t(t), m_ci(ci), m_insidePre(FALSE), m_hide(FALSE), m_indentLevel(1) + : DocVisitor(DocVisitor_RTF), m_t(t), m_ci(ci), m_insidePre(FALSE), + m_hide(FALSE), m_indentLevel(0), m_lastIsPara(FALSE) { } @@ -49,7 +54,7 @@ void RTFDocVisitor::incIndentLevel() void RTFDocVisitor::decIndentLevel() { - if (m_indentLevel>1) m_indentLevel--; + if (m_indentLevel>0) m_indentLevel--; } //-------------------------------------- @@ -59,20 +64,25 @@ void RTFDocVisitor::decIndentLevel() void RTFDocVisitor::visit(DocWord *w) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocWord)}\n"); filter(w->word()); + m_lastIsPara=FALSE; } void RTFDocVisitor::visit(DocLinkedWord *w) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocLinkedWord)}\n"); startLink(w->ref(),w->file(),w->anchor()); filter(w->word()); endLink(w->ref()); + m_lastIsPara=FALSE; } void RTFDocVisitor::visit(DocWhiteSpace *w) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocWhiteSpace)}\n"); if (m_insidePre) { m_t << w->chars(); @@ -81,11 +91,13 @@ void RTFDocVisitor::visit(DocWhiteSpace *w) { m_t << " "; } + m_lastIsPara=FALSE; } void RTFDocVisitor::visit(DocSymbol *s) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocSymbol)}\n"); switch(s->symbol()) { case DocSymbol::BSlash: m_t << "\\\\"; break; @@ -202,11 +214,13 @@ void RTFDocVisitor::visit(DocSymbol *s) default: err("Error: unknown symbol found\n"); } + m_lastIsPara=FALSE; } void RTFDocVisitor::visit(DocURL *u) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocURL)}\n"); if (Config_getBool("RTF_HYPERLINKS")) { m_t << "{\\field " @@ -230,23 +244,30 @@ void RTFDocVisitor::visit(DocURL *u) filter(u->url()); m_t << "}"; } + m_lastIsPara=FALSE; } void RTFDocVisitor::visit(DocLineBreak *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocLineBreak)}\n"); m_t << "\\par\n"; + m_lastIsPara=TRUE; } void RTFDocVisitor::visit(DocHorRuler *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocHorRuler)}\n"); m_t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw5\\brsp20 \\adjustright \\par}" << endl; + m_lastIsPara=TRUE; } void RTFDocVisitor::visit(DocStyleChange *s) { if (m_hide) return; + m_lastIsPara=FALSE; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocStyleChange)}\n"); switch (s->style()) { case DocStyleChange::Bold: @@ -284,6 +305,7 @@ void RTFDocVisitor::visit(DocStyleChange *s) m_t << "\\par" << endl; m_t << "}" << endl; } + m_lastIsPara=TRUE; break; case DocStyleChange::Div: /* HTML only */ break; case DocStyleChange::Span: /* HTML only */ break; @@ -293,6 +315,7 @@ void RTFDocVisitor::visit(DocStyleChange *s) void RTFDocVisitor::visit(DocVerbatim *s) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocVerbatim)}\n"); switch(s->type()) { case DocVerbatim::Code: // fall though @@ -340,11 +363,13 @@ void RTFDocVisitor::visit(DocVerbatim *s) } break; } + m_lastIsPara=FALSE; } void RTFDocVisitor::visit(DocAnchor *anc) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocAnchor)}\n"); QString anchor; if (!anc->file().isEmpty()) { @@ -360,11 +385,13 @@ void RTFDocVisitor::visit(DocAnchor *anc) } m_t << "{\\bkmkstart " << rtfFormatBmkStr(anchor) << "}" << endl; m_t << "{\\bkmkend " << rtfFormatBmkStr(anchor) << "}" << endl; + m_lastIsPara=FALSE; } void RTFDocVisitor::visit(DocInclude *inc) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocInclude)}\n"); switch(inc->type()) { case DocInclude::IncWithLines: @@ -400,12 +427,14 @@ void RTFDocVisitor::visit(DocInclude *inc) m_t << "}" << endl; break; } + m_lastIsPara=TRUE; } void RTFDocVisitor::visit(DocIncOperator *op) { //printf("DocIncOperator: type=%d first=%d, last=%d text=`%s'\n", // op->type(),op->isFirst(),op->isLast(),op->text().data()); + DBG_RTF("{\\comment RTFDocVisitor::visit(DocIncOperator)}\n"); if (op->isFirst()) { if (!m_hide) @@ -432,10 +461,12 @@ void RTFDocVisitor::visit(DocIncOperator *op) m_t << "\\par" << endl; m_t << "}" << endl; } + m_lastIsPara=TRUE; } else { if (!m_hide) m_t << endl; + m_lastIsPara=FALSE; } } @@ -443,13 +474,17 @@ void RTFDocVisitor::visit(DocFormula *f) { if (m_hide) return; // TODO: do something sensible here, like including a bitmap + DBG_RTF("{\\comment RTFDocVisitor::visit(DocFormula)}\n"); m_t << f->text(); + m_lastIsPara=FALSE; } void RTFDocVisitor::visit(DocIndexEntry *i) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visit(DocIndexEntry)}\n"); m_t << "{\\xe \\v " << i->entry() << "}" << endl; + m_lastIsPara=FALSE; } //-------------------------------------- @@ -459,24 +494,27 @@ void RTFDocVisitor::visit(DocIndexEntry *i) void RTFDocVisitor::visitPre(DocAutoList *l) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocAutoList)}\n"); m_t << "{" << endl; - incIndentLevel(); rtf_listItemInfo[m_indentLevel].isEnum = l->isEnumList(); rtf_listItemInfo[m_indentLevel].number = 1; + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocAutoList *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocAutoList)}\n"); m_t << "\\par" << endl; m_t << "}" << endl; - decIndentLevel(); + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocAutoListItem *) { if (m_hide) return; - m_t << "\\par" << endl; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocAutoListItem)}\n"); + if (!m_lastIsPara) m_t << "\\par" << endl; m_t << rtf_Style_Reset; if (rtf_listItemInfo[m_indentLevel].isEnum) { @@ -488,40 +526,62 @@ void RTFDocVisitor::visitPre(DocAutoListItem *) { m_t << getStyle("ListBullet") << endl; } + incIndentLevel(); + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocAutoListItem *) { + decIndentLevel(); + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocAutoListItem)}\n"); } void RTFDocVisitor::visitPre(DocPara *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocPara)}\n"); } void RTFDocVisitor::visitPost(DocPara *p) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocPara)}\n"); if (!p->isLast() && // omit

for last paragraph !(p->parent() && // and for parameter sections p->parent()->kind()==DocNode::Kind_ParamSect ) - ) m_t << "\\par" << endl; + ) + { + m_t << "\\par" << endl; + m_lastIsPara=TRUE; + } } -void RTFDocVisitor::visitPre(DocRoot *) +void RTFDocVisitor::visitPre(DocRoot *r) { + if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocRoot)}\n"); + if (r->indent()) incIndentLevel(); + m_t << "{" << rtf_Style["BodyText"]->reference << endl; } -void RTFDocVisitor::visitPost(DocRoot *) +void RTFDocVisitor::visitPost(DocRoot *r) { + if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocRoot)}\n"); + if (!m_lastIsPara && !r->singleLine()) m_t << "\\par" << endl; + m_t << "}"; + m_lastIsPara=TRUE; + if (r->indent()) decIndentLevel(); } void RTFDocVisitor::visitPre(DocSimpleSect *s) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocSimpleSect)}\n"); + if (!m_lastIsPara) m_t << "\\par" << endl; m_t << "{"; // start desc - m_t << "{\\b "; // start bold - m_t << "\\par" << endl; + //m_t << "{\\b "; // start bold + m_t << "{" << rtf_Style["Heading5"]->reference << endl; switch(s->type()) { case DocSimpleSect::See: @@ -560,65 +620,80 @@ void RTFDocVisitor::visitPre(DocSimpleSect *s) // special case 1: user defined title if (s->type()!=DocSimpleSect::User && s->type()!=DocSimpleSect::Rcs) { - m_t << ":}"; // end bold + m_t << ":"; m_t << "\\par" << endl; + m_t << "}"; // end bold incIndentLevel(); m_t << rtf_Style_Reset << getStyle("DescContinue"); } + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocSimpleSect *) { if (m_hide) return; - m_t << "\\par" << endl; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocSimpleSect)}\n"); + if (!m_lastIsPara) m_t << "\\par" << endl; decIndentLevel(); m_t << "}"; // end desc + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocTitle *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocTitle)}\n"); } void RTFDocVisitor::visitPost(DocTitle *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocTitle)}\n"); m_t << "}"; // end bold m_t << "\\par" << endl; incIndentLevel(); m_t << rtf_Style_Reset << getStyle("DescContinue"); + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPre(DocSimpleList *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocSimpleSect)}\n"); m_t << "{" << endl; - incIndentLevel(); rtf_listItemInfo[m_indentLevel].isEnum = FALSE; + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocSimpleList *) { if (m_hide) return; - decIndentLevel(); - m_t << "\\par" << endl; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocSimpleSect)}\n"); + if (!m_lastIsPara) m_t << "\\par" << endl; m_t << "}" << endl; + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocSimpleListItem *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocSimpleListItem)}\n"); m_t << "\\par" << rtf_Style_Reset << getStyle("ListBullet") << endl; + m_lastIsPara=FALSE; + incIndentLevel(); } void RTFDocVisitor::visitPost(DocSimpleListItem *) { + decIndentLevel(); + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocSimpleListItem)}\n"); } void RTFDocVisitor::visitPre(DocSection *s) { if (m_hide) return; - m_t << "\\par" << endl << - "{{" // start section + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocSection)}\n"); + if (!m_lastIsPara) m_t << "\\par" << endl; + m_t << "{{" // start section << rtf_Style_Reset; QString heading; int level = QMIN(s->level()+1,4); @@ -631,33 +706,39 @@ void RTFDocVisitor::visitPre(DocSection *s) m_t << "{\\tc\\tcl" << level << " \\v "; filter(s->title()); m_t << "}" << endl; + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPost(DocSection *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocSection)}\n"); m_t << "}" << endl; // end section + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocHtmlList *l) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHtmlList)}\n"); m_t << "{" << endl; - incIndentLevel(); rtf_listItemInfo[m_indentLevel].isEnum = l->type()==DocHtmlList::Ordered; rtf_listItemInfo[m_indentLevel].number = 1; + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocHtmlList *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHtmlList)}\n"); m_t << "\\par" << endl << "}" << endl; - decIndentLevel(); + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocHtmlListItem *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHtmlListItem)}\n"); m_t << "\\par" << endl; m_t << rtf_Style_Reset; if (rtf_listItemInfo[m_indentLevel].isEnum) @@ -670,92 +751,101 @@ void RTFDocVisitor::visitPre(DocHtmlListItem *) { m_t << getStyle("ListBullet") << endl; } + incIndentLevel(); + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocHtmlListItem *) { + decIndentLevel(); + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHtmlListItem)}\n"); } -//void RTFDocVisitor::visitPre(DocHtmlPre *) -//{ -// m_t << "{" << endl; -// m_t << "\\par" << endl; -// m_t << rtf_Style_Reset << getStyle("CodeExample"); -// m_insidePre=TRUE; -//} - -//void RTFDocVisitor::visitPost(DocHtmlPre *) -//{ -// m_insidePre=FALSE; -// m_t << "\\par" << endl; -// m_t << "}" << endl; -//} - void RTFDocVisitor::visitPre(DocHtmlDescList *) { if (m_hide) return; - m_t << "{" << endl; - m_t << rtf_Style_Reset << getStyle("ListContinue"); + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHtmlDescList)}\n"); + //m_t << "{" << endl; + //m_t << rtf_Style_Reset << getStyle("ListContinue"); + //m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocHtmlDescList *) { if (m_hide) return; - m_t << "}" << endl; - m_t << "\\par" << endl; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHtmlDescList)}\n"); + //m_t << "}" << endl; + //m_t << "\\par" << endl; + //m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocHtmlDescTitle *) { if (m_hide) return; - m_t << "\\par" << endl; - m_t << "{\\b "; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHtmlDescTitle)}\n"); + //m_t << "\\par" << endl; + //m_t << "{\\b "; + m_t << "{" << rtf_Style["Heading5"]->reference << endl; + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocHtmlDescTitle *) { if (m_hide) return; - m_t << "}" << endl; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHtmlDescTitle)}\n"); m_t << "\\par" << endl; + m_t << "}" << endl; + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocHtmlDescData *) { + if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHtmlDescData)}\n"); + incIndentLevel(); + m_t << "{" << rtf_Style_Reset << getStyle("DescContinue"); } void RTFDocVisitor::visitPost(DocHtmlDescData *) { + if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHtmlDescData)}\n"); + m_t << "\\par" << endl; + m_t << "}" << endl; + decIndentLevel(); + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocHtmlTable *) { if (m_hide) return; - m_t << "\\par" << endl; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHtmlTable)}\n"); + if (!m_lastIsPara) m_t << "\\par" << endl; + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPost(DocHtmlTable *) { if (m_hide) return; - //if (!t->hasCaption()) - //{ - // m_t << endl; - // m_t << "\\pard \\widctlpar\\intbl\\adjustright" << endl; - // m_t << "{\\row }" << endl; - //} + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHtmlTable)}\n"); m_t << "\\pard" << endl; + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocHtmlCaption *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHtmlCaption)}\n"); } void RTFDocVisitor::visitPost(DocHtmlCaption *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHtmlCaption)}\n"); } void RTFDocVisitor::visitPre(DocHtmlRow *r) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHtmlRow)}\n"); uint i,columnWidth=rtf_pageWidth/r->numCells(); m_t << "\\trowd \\trgaph108\\trleft-108" "\\trbrdrt\\brdrs\\brdrw10 " @@ -774,31 +864,39 @@ void RTFDocVisitor::visitPre(DocHtmlRow *r) "\\cellx" << ((i+1)*columnWidth) << endl; } m_t << "\\pard \\widctlpar\\intbl\\adjustright" << endl; + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocHtmlRow *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHtmlRow)}\n"); m_t << endl; m_t << "\\pard \\widctlpar\\intbl\\adjustright" << endl; m_t << "{\\row }" << endl; + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPre(DocHtmlCell *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHtmlCell)}\n"); m_t << "{"; + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocHtmlCell *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHtmlCell)}\n"); m_t << "\\cell }"; + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPre(DocInternal *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocInternal)}\n"); m_t << "{"; // start desc m_t << "{\\b "; // start bold m_t << theTranslator->trForInternalUseOnly(); @@ -806,19 +904,23 @@ void RTFDocVisitor::visitPre(DocInternal *) m_t << "\\par" << endl; incIndentLevel(); m_t << rtf_Style_Reset << getStyle("DescContinue"); + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocInternal *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocInternal)}\n"); m_t << "\\par" << endl; decIndentLevel(); m_t << "}"; // end desc + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocHRef *href) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHRef)}\n"); if (Config_getBool("RTF_HYPERLINKS")) { m_t << "{\\field " @@ -834,11 +936,13 @@ void RTFDocVisitor::visitPre(DocHRef *href) { m_t << "{\\f2 "; } + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocHRef *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHRef)}\n"); if (Config_getBool("RTF_HYPERLINKS")) { m_t << "}" @@ -849,11 +953,13 @@ void RTFDocVisitor::visitPost(DocHRef *) { m_t << "}"; } + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPre(DocHtmlHeader *header) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocHtmlHeader)}\n"); m_t << "{" // start section << rtf_Style_Reset; QString heading; @@ -863,18 +969,22 @@ void RTFDocVisitor::visitPre(DocHtmlHeader *header) m_t << rtf_Style[heading]->reference; // make table of contents entry m_t << "{\\tc\\tcl \\v " << level << "}"; + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocHtmlHeader *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocHtmlHeader)}\n"); m_t << "\\par" << endl; m_t << "}" << endl; // end section + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocImage *img) { + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocImage)}\n"); if (img->type()==DocImage::Rtf) { m_t << "\\par" << endl; @@ -884,7 +994,7 @@ void RTFDocVisitor::visitPre(DocImage *img) m_t << img->name(); m_t << " \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl; m_t << "}" << endl; - + m_lastIsPara=TRUE; } else // other format -> skip { @@ -896,11 +1006,13 @@ void RTFDocVisitor::visitPre(DocImage *img) void RTFDocVisitor::visitPost(DocImage *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocImage)}\n"); popEnabled(); } void RTFDocVisitor::visitPre(DocDotFile *df) { + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocDotFile)}\n"); writeDotFile(df->file()); // hide caption since it is not supported at the moment @@ -910,24 +1022,28 @@ void RTFDocVisitor::visitPre(DocDotFile *df) void RTFDocVisitor::visitPost(DocDotFile *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocDotFile)}\n"); popEnabled(); } void RTFDocVisitor::visitPre(DocLink *lnk) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocLink)}\n"); startLink(lnk->ref(),lnk->file(),lnk->anchor()); } void RTFDocVisitor::visitPost(DocLink *lnk) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocLink)}\n"); endLink(lnk->ref()); } void RTFDocVisitor::visitPre(DocRef *ref) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocRef)}\n"); if (!ref->file().isEmpty()) startLink(ref->ref(),ref->file(),ref->anchor()); if (!ref->hasLinkText()) filter(ref->targetTitle()); } @@ -935,6 +1051,7 @@ void RTFDocVisitor::visitPre(DocRef *ref) void RTFDocVisitor::visitPost(DocRef *ref) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocRef)}\n"); if (!ref->file().isEmpty()) endLink(ref->ref()); m_t << " "; } @@ -942,31 +1059,38 @@ void RTFDocVisitor::visitPost(DocRef *ref) void RTFDocVisitor::visitPre(DocSecRefItem *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocSecRefItem)}\n"); } void RTFDocVisitor::visitPost(DocSecRefItem *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocSecRefItem)}\n"); } void RTFDocVisitor::visitPre(DocSecRefList *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocSecRefList)}\n"); m_t << "{" << endl; incIndentLevel(); m_t << rtf_Style_Reset << getStyle("LatexTOC") << endl; m_t << "\\par" << endl; + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPost(DocSecRefList *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocSecRefList)}\n"); decIndentLevel(); m_t << "\\par" << endl; m_t << "}"; + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocLanguage *l) { + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocLanguage)}\n"); QString langId = Config_getEnum("OUTPUT_LANGUAGE"); if (l->id().lower()!=langId.lower()) { @@ -977,6 +1101,7 @@ void RTFDocVisitor::visitPre(DocLanguage *l) void RTFDocVisitor::visitPost(DocLanguage *l) { + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocLanguage)}\n"); QString langId = Config_getEnum("OUTPUT_LANGUAGE"); if (l->id().lower()!=langId.lower()) { @@ -987,9 +1112,11 @@ void RTFDocVisitor::visitPost(DocLanguage *l) void RTFDocVisitor::visitPre(DocParamSect *s) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocParamSect)}\n"); m_t << "{"; // start param list - m_t << "\\par" << endl; - m_t << "{\\b "; // start bold + if (!m_lastIsPara) m_t << "\\par" << endl; + //m_t << "{\\b "; // start bold + m_t << "{" << rtf_Style["Heading5"]->reference << endl; switch(s->type()) { case DocParamSect::Param: @@ -1001,15 +1128,18 @@ void RTFDocVisitor::visitPre(DocParamSect *s) default: ASSERT(0); } - m_t << ":}" << endl; + m_t << ":"; m_t << "\\par" << endl; + m_t << "}" << endl; incIndentLevel(); m_t << rtf_Style_Reset << getStyle("DescContinue"); + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPost(DocParamSect *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocParamSect)}\n"); //m_t << "\\par" << endl; decIndentLevel(); m_t << "}" << endl; @@ -1018,6 +1148,7 @@ void RTFDocVisitor::visitPost(DocParamSect *) void RTFDocVisitor::visitPre(DocParamList *pl) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocParamList)}\n"); m_t << "{\\i "; QStrListIterator li(pl->parameters()); const char *s; @@ -1028,20 +1159,24 @@ void RTFDocVisitor::visitPre(DocParamList *pl) filter(s); } m_t << "} "; + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPost(DocParamList *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocParamList)}\n"); m_t << "\\par" << endl; + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocXRefItem *x) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocXRefItem)}\n"); m_t << "{"; // start param list - m_t << "{\\b "; // start bold - m_t << "\\par" << endl; + //m_t << "{\\b "; // start bold + m_t << "{" << rtf_Style["Heading5"]->reference << endl; if (Config_getBool("RTF_HYPERLINKS")) { QString refName; @@ -1074,47 +1209,57 @@ void RTFDocVisitor::visitPre(DocXRefItem *x) { filter(x->title()); } - m_t << ":}"; // end bold + m_t << ":"; m_t << "\\par" << endl; + m_t << "}"; // end bold incIndentLevel(); m_t << rtf_Style_Reset << getStyle("DescContinue"); + m_lastIsPara=FALSE; } void RTFDocVisitor::visitPost(DocXRefItem *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocXRefItem)}\n"); m_t << "\\par" << endl; decIndentLevel(); m_t << "}" << endl; // end xref item + m_lastIsPara=TRUE; } void RTFDocVisitor::visitPre(DocInternalRef *ref) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocInternalRef)}\n"); startLink("",ref->file(),ref->anchor()); } void RTFDocVisitor::visitPost(DocInternalRef *) { if (m_hide) return; + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocInternalRef)}\n"); endLink(""); m_t << " "; } void RTFDocVisitor::visitPre(DocCopy *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocCopy)}\n"); } void RTFDocVisitor::visitPost(DocCopy *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocCopy)}\n"); } void RTFDocVisitor::visitPre(DocText *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPre(DocText)}\n"); } void RTFDocVisitor::visitPost(DocText *) { + DBG_RTF("{\\comment RTFDocVisitor::visitPost(DocText)}\n"); } static char* getMultiByte(int c) @@ -1194,6 +1339,7 @@ void RTFDocVisitor::startLink(const QString &ref,const QString &file,const QStri { m_t << "{\\b "; } + m_lastIsPara=FALSE; } void RTFDocVisitor::endLink(const QString &ref) @@ -1206,6 +1352,7 @@ void RTFDocVisitor::endLink(const QString &ref) { m_t << "}"; } + m_lastIsPara=FALSE; } void RTFDocVisitor::pushEnabled() @@ -1231,13 +1378,14 @@ void RTFDocVisitor::writeDotFile(const QString &fileName) } QString outDir = Config_getString("RTF_OUTPUT"); writeDotGraphFromFile(fileName,outDir,baseName,BITMAP); - m_t << "\\par" << endl; + if (!m_lastIsPara) m_t << "\\par" << endl; m_t << "{" << endl; - m_t << rtf_Style_Reset << endl; - m_t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE "; + m_t << rtf_Style_Reset; + m_t << "\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE "; m_t << baseName << "." << Config_getEnum("DOT_IMAGE_FORMAT"); m_t << " \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl; m_t << "}" << endl; + m_lastIsPara=TRUE; } diff --git a/src/rtfdocvisitor.h b/src/rtfdocvisitor.h index a46c14a..83c5abe 100644 --- a/src/rtfdocvisitor.h +++ b/src/rtfdocvisitor.h @@ -154,6 +154,7 @@ class RTFDocVisitor : public DocVisitor bool m_hide; int m_indentLevel; QStack m_enabled; + bool m_lastIsPara; }; #endif diff --git a/src/rtfgen.cpp b/src/rtfgen.cpp index 4f024d8..17958b9 100644 --- a/src/rtfgen.cpp +++ b/src/rtfgen.cpp @@ -37,8 +37,8 @@ #include "rtfdocvisitor.h" #include "docparser.h" -//#define DBG_RTF(x) x; -#define DBG_RTF(x) +#define DBG_RTF(x) x; +//#define DBG_RTF(x) static QCString dateToRTFDateString() { @@ -1328,7 +1328,7 @@ void RTFGenerator::startTitle() void RTFGenerator::startGroupHeader() { DBG_RTF(t <<"{\\comment startGroupHeader}" << endl) - newParagraph(); + //newParagraph(); t << rtf_Style_Reset; t << rtf_Style["Heading3"]->reference; t << endl; @@ -1426,12 +1426,10 @@ void RTFGenerator::startIndent() DBG_RTF(t << "{\\comment (startIndent) }" << endl) t << "{" << endl; t << rtf_Style_Reset << rtf_CList_DepthStyle() << endl; - //styleStack.push(style); } void RTFGenerator::endIndent() { - //const char *style = /* rtf_CList_DepthStyle(); */ t << "}" << endl; decrementIndentLevel(); } @@ -1762,14 +1760,14 @@ void RTFGenerator::startCodeFragment() { DBG_RTF(t << "{\\comment (startCodeFragment) }" << endl) t << "{" << endl; - newParagraph(); + //newParagraph(); t << rtf_Style_Reset << rtf_Code_DepthStyle(); //styleStack.push(rtf_Style_CodeExample); } void RTFGenerator::endCodeFragment() { - newParagraph(); + //newParagraph(); //styleStack.pop(); //printf("RTFGenerator::endCodeFrament() top=%s\n",styleStack.top()); //t << rtf_Style_Reset << styleStack.top() << endl; @@ -1967,9 +1965,9 @@ void RTFGenerator::startTextBlock(bool dense) } } -void RTFGenerator::endTextBlock() +void RTFGenerator::endTextBlock(bool paraBreak) { - newParagraph(); + if (paraBreak) newParagraph(); DBG_RTF(t << "{\\comment endTextBlock}" << endl) t << "}" << endl; //m_omitParagraph = TRUE; @@ -2448,3 +2446,27 @@ void RTFGenerator::printDoc(DocNode *n) delete visitor; } +void RTFGenerator::rtfwriteRuler_doubleline() +{ + DBG_RTF(t << "{\\comment (rtfwriteRuler_doubleline)}" << endl) + t << "{\\pard\\widctlpar\\brdrb\\brdrdb\\brdrw15\\brsp20 \\adjustright \\par}" << endl; +} + +void RTFGenerator::rtfwriteRuler_emboss() +{ + DBG_RTF(t << "{\\comment (rtfwriteRuler_emboss)}" << endl) + t << "{\\pard\\widctlpar\\brdrb\\brdremboss\\brdrw15\\brsp20 \\adjustright \\par}" << endl; +} + +void RTFGenerator::rtfwriteRuler_thick() +{ + DBG_RTF(t << "{\\comment (rtfwriteRuler_thick)}" << endl) + t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw75\\brsp20 \\adjustright \\par}" << endl; +} + +void RTFGenerator::rtfwriteRuler_thin() +{ + DBG_RTF(t << "{\\comment (rtfwriteRuler_thin)}" << endl) + t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw5\\brsp20 \\adjustright \\par}" << endl; +} + diff --git a/src/rtfgen.h b/src/rtfgen.h index ee4d767..8cfbed5 100644 --- a/src/rtfgen.h +++ b/src/rtfgen.h @@ -235,7 +235,7 @@ class RTFGenerator : public OutputGenerator void endMemberGroup(bool); void startTextBlock(bool dense); - void endTextBlock(); + void endTextBlock(bool); void lastIndexPage(); void startMemberDocPrefixItem() {} @@ -287,10 +287,10 @@ class RTFGenerator : public OutputGenerator void beginRTFDocument(); void beginRTFChapter(); void beginRTFSection(); - void rtfwriteRuler_doubleline() { t << "{\\pard\\widctlpar\\brdrb\\brdrdb\\brdrw15\\brsp20 \\adjustright \\par}" << endl; }; - void rtfwriteRuler_emboss() { t << "{\\pard\\widctlpar\\brdrb\\brdremboss\\brdrw15\\brsp20 \\adjustright \\par}" << endl; }; - void rtfwriteRuler_thick() { t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw75\\brsp20 \\adjustright \\par}" << endl; }; - void rtfwriteRuler_thin() { t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw5\\brsp20 \\adjustright \\par}" << endl; }; + void rtfwriteRuler_doubleline(); + void rtfwriteRuler_emboss(); + void rtfwriteRuler_thick(); + void rtfwriteRuler_thin(); void writeRTFReference(const char *label); char *getMultiByte(int c); }; diff --git a/src/rtfstyle.cpp b/src/rtfstyle.cpp index 997038f..908ac24 100644 --- a/src/rtfstyle.cpp +++ b/src/rtfstyle.cpp @@ -58,6 +58,10 @@ Rtf_Style_Default rtf_Style_Default[] = "\\s4\\sb240\\sa60\\keepn\\widctlpar\\adjustright \\b\\f1\\fs20\\cgrid ", "\\sbasedon0 \\snext0 heading 4;}{\\*\\cs10 \\additive Default Paragraph Font" }, + { "Heading5", + "\\s5\\sb90\\sa30\\keepn\\widctlpar\\adjustright \\b\\f1\\fs20\\cgrid ", + "\\sbasedon0 \\snext0 heading 5;}{\\*\\cs10 \\additive Default Paragraph Font" + }, { "Title", "\\s15\\qc\\sb240\\sa60\\widctlpar\\outlinelevel0\\adjustright \\b\\f1\\fs32\\kerning28\\cgrid ", "\\sbasedon0 \\snext15 Title" diff --git a/src/translator_cz.h b/src/translator_cz.h index 9ccc00e..37a847b 100644 --- a/src/translator_cz.h +++ b/src/translator_cz.h @@ -18,7 +18,8 @@ #ifndef TRANSLATOR_CZ_H #define TRANSLATOR_CZ_H - +// $Id$ +// // The first translation from English to Czech was started by // Vlastimil Havran (1999--2000). The prototype version of Czech strings // with diacritics was implemented by Petr Prikryl (prikrylp@skil.cz), @@ -125,7 +126,9 @@ // 2002/10/15 - The new trEvents() and trEventDocumentation() implemented. // 2003/04/28 - Five new methods "since 1.3" implemented. // 2003/06/10 - Two new methods "since 1.3.1" implemented. -// 2003/08/13 - Four new "since 1.3.3" implemented. +// 2003/08/13 - Four new methods "since 1.3.3" implemented. +// 2004/02/26 - trLegendDocs() updated. +// 2004/02/27 - Text inside the trCallGraph() corrected. // Todo // ---- @@ -1184,8 +1187,6 @@ class TranslatorCzech : public Translator "/*! Tųķda, u které došlo k oųezįnķ grafu. Vztah dģdičnosti " "je skryt. */\n" "class Truncated : public Invisible { };\n\n" - "/* Tųķda, kterį nenķ dokumentovįna komentįųi programu doxygen. */\n" - "class Undocumented { };\n\n" "/*! Bįzovį tųķda dģdģnį veųejnģ (public inheritance). */\n" "class PublicBase : public Truncated { };\n\n" "/*! Bįzovį tųķda, použitį pro chrįnģné dģdģnķ " @@ -1194,6 +1195,10 @@ class TranslatorCzech : public Translator "/*! Bįzovį tųķda, využitį pro privįtnķ dģdģnķ " "(private inheritance). */\n" "class PrivateBase { };\n\n" + "/* Tųķda, kterį nenķ dokumentovįna komentįųi programu doxygen. */\n" + "class Undocumented { };\n\n" + "/*! Šablona tųķdy. */\n" + "template class Templ { };\n\n" "/*! Tųķda, kterį je využķvįna tųķdou Inherited. */\n" "class Used { };\n\n" "/*! Odvozenį tųķda, kterį rłznżm zpłsobem dģdķ z vķce bįzovżch " @@ -1201,7 +1206,8 @@ class TranslatorCzech : public Translator "class Inherited : public PublicBase,\n" " protected ProtectedBase,\n" " private PrivateBase,\n" - " public Undocumented\n" + " public Undocumented,\n" + " public Templ\n" "{\n" " private:\n" " Used *m_usedClass;\n" @@ -1223,7 +1229,7 @@ class TranslatorCzech : public Translator "strukturu nebo tųķdu, pro kterou\n" "nejsou zobrazeny všechny vztahy dģdičnosti nebo obsaženķ. " "Graf je oųezįn v pųķpadģ, kdy jej\n" - "nenķ možné umķstit do vymezenżch hranic.\n" + "nenķ možné umķstit do vymezeného prostoru.\n" "\n" "Šipky (tj. hrany grafu) majķ nįsledujķcķ vżznam:\n" "

    \n" @@ -1238,6 +1244,10 @@ class TranslatorCzech : public Translator "nebo kdy je použķvįna jinou tųķdou. Je označena identifikįtorem " "jedné nebo vķce promģnżch, pųes které\n" "je tųķda nebo struktura zpųķstupnģna.\n" + "
  • Žlutį šipka kreslenį čįrkovanģ vyjadųuje vztah mezi instancķ šablony " + "a šablonou tųķdy, na zįkladģ které byla\n" + "instance šablony vytvoųena. V popisu šipky jsou uvedeny pųķslušné" + " parametry šablony.\n" "
\n"); return decode(result); @@ -1597,7 +1607,7 @@ class TranslatorCzech : public Translator /*! Put in front of the call graph for a function. */ virtual QCString trCallGraph() { - return decode("Graf volįnķ této funkce:"); + return decode("Graf volįnķ pro tuto funkci:"); } ////////////////////////////////////////////////////////////////////////// diff --git a/src/translator_lt.h b/src/translator_lt.h new file mode 100644 index 0000000..a965a4a --- /dev/null +++ b/src/translator_lt.h @@ -0,0 +1,1546 @@ +/****************************************************************************** + * + * + * + * Copyright (C) 1997-2004 by Dimitri van Heesch. + * + * Permission to use, copy, modify, and distribute this software and its + * documentation under the terms of the GNU General Public License is hereby + * granted. No representations are made about the suitability of this software + * for any purpose. It is provided "as is" without express or implied warranty. + * See the GNU General Public License for more details. + * + * Documents produced by Doxygen are derivative works derived from the + * input used in their production; they are not affected by this license. + * + */ + +/* Translation from English to Lithanian by Tomas Simonaitis, Mindaugas Radzius and Aidas Berukstis + * (haden@homelan.lt/mindaugasradzius@takas.lt/aidasber@takas.lt) + * We tried to keep meaning close to original, + * if you have any suggestions drop us an email + * ------------------------------------------- + * Project start :13.May.2k4 + * Last Doxygen version covered : 1.3.6 + * Last revision : + * +*/ + +#ifndef TRANSLATOR_LT_H +#define TRANSLATOR_LT_H + + +class TranslatorLithuanian : public Translator +{ + public: + + // --- Language control methods ------------------- + + /*! Used for identification of the language. The identification + * should not be translated. It should be replaced by the name + * of the language in English using lower-case characters only + * (e.g. "czech", "japanese", "russian", etc.). It should be equal to + * the identification used in language.cpp. + */ + virtual QCString idLanguage() + { return "lithuanian"; } + + /*! Used to get the LaTeX command(s) for the language support. + * This method should return string with commands that switch + * LaTeX to the desired language. For example + * 
"\\usepackage[german]{babel}\n"
+     *
+ * or + * 
"\\usepackage{polski}\n"
+     *  "\\usepackage[latin2]{inputenc}\n"
+     *  "\\usepackage[T1]{fontenc}\n"
+     *
+ * + * The English LaTeX does not use such commands. Because of this + * the empty string is returned in this implementation. + */ + virtual QCString latexLanguageSupportCommand() + { + return ""; + } + + /*! return the language charset. This will be used for the HTML output */ + virtual QCString idLanguageCharset() + { + return "iso-8859-13"; + } + + // --- Language translation methods ------------------- + + /*! used in the compound documentation before a list of related functions. */ + virtual QCString trRelatedFunctions() + { return "Susiję Funkcijos"; } + + /*! subscript for the related functions. */ + virtual QCString trRelatedSubscript() + { return "Atkreipkite dėmesį, čią ne metodai"; } + + /*! header that is put before the detailed description of files, classes and namespaces. */ + virtual QCString trDetailedDescription() + { return "Smulkus aprašymas"; } + + /*! header that is put before the list of typedefs. */ + virtual QCString trMemberTypedefDocumentation() + { return "Tipo Aprašymo Dokumentacija"; } + + /*! header that is put before the list of enumerations. */ + virtual QCString trMemberEnumerationDocumentation() + { return "Išvardinimo Dokumentacija"; } + + /*! header that is put before the list of member functions. */ + virtual QCString trMemberFunctionDocumentation() + { return "Metodų Dokumentacija"; } + + /*! header that is put before the list of member attributes. */ + virtual QCString trMemberDataDocumentation() + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return "Lauko aprašymas"; + } + else + { + return "Atributų Dokumentacija"; + } + } + + /*! this is the text of a link put after brief descriptions. */ + virtual QCString trMore() + { return "Daugiau..."; } + + /*! put in the class documentation */ + virtual QCString trListOfAllMembers() + { return "Visų narių sąrašas."; } + + /*! used as the title of the "list of all members" page of a class */ + virtual QCString trMemberList() + { return "Narių sąrašas"; } + + /*! this is the first part of a sentence that is followed by a class name */ + virtual QCString trThisIsTheListOfAllMembers() + { return "Tai galutinis narių sąrašas "; } + + /*! this is the remainder of the sentence after the class name */ + virtual QCString trIncludingInheritedMembers() + { return ", įtraukiant visus paveldėtus narius."; } + + /*! this is put at the author sections at the bottom of man pages. + * parameter s is name of the project name. + */ + virtual QCString trGeneratedAutomatically(const char *s) + { QCString result="Automatiškai sugeneruota Doxygen įrankiu"; + if (s) result+=(QCString)" "+s; + result+=" iš programos kodo."; + return result; + } + + /*! put after an enum name in the list of all members */ + virtual QCString trEnumName() + { return "išvardinimo vardas"; } + + /*! put after an enum value in the list of all members */ + virtual QCString trEnumValue() + { return "išvardinimo reikšmė"; } + + /*! put after an undocumented member in the list of all members */ + virtual QCString trDefinedIn() + { return "apibrėžta"; } + + // quick reference sections + + /*! This is put above each page as a link to the list of all groups of + * compounds or files (see the \\group command). + */ + virtual QCString trModules() + { return "Moduliai"; } + + /*! This is put above each page as a link to the class hierarchy */ + virtual QCString trClassHierarchy() + { return "Klasių hierarchija"; } + + /*! This is put above each page as a link to the list of annotated classes */ + virtual QCString trCompoundList() + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return "Duomenų Struktūros"; + } + else + { + return "Klasės"; + } + } + + /*! This is put above each page as a link to the list of documented files */ + virtual QCString trFileList() + { return "Failai"; } + + /*! This is put above each page as a link to the list of all verbatim headers */ + virtual QCString trHeaderFiles() + { return "Antraščių Failai"; } + + /*! This is put above each page as a link to all members of compounds. */ + virtual QCString trCompoundMembers() + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return "Duomenų Laukai"; + } + else + { + return "Klasių Nariai"; + } + } + + /*! This is put above each page as a link to all members of files. */ + virtual QCString trFileMembers() + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return "Globalūs Nariai"; + } + else + { + return "Globalūs Nariai"; + } + } + + /*! This is put above each page as a link to all related pages. */ + virtual QCString trRelatedPages() + { return "Susiję Puslapiai"; } + + /*! This is put above each page as a link to all examples. */ + virtual QCString trExamples() + { return "Pavyzdžiai"; } + + /*! This is put above each page as a link to the search engine. */ + virtual QCString trSearch() + { return "Paieška"; } + + /*! This is an introduction to the class hierarchy. */ + virtual QCString trClassHierarchyDescription() + { return "Šis paveldėjimo sąrašas yra beveik surikiuotas " + "abėcėlės tvarka:"; + } + + /*! This is an introduction to the list with all files. */ + virtual QCString trFileListDescription(bool extractAll) + { + QCString result="Visų "; + if (!extractAll) result+="dokumentuotų "; + result+="failų sąrašas su trumpais aprašymais:"; + return result; + } + + /*! This is an introduction to the annotated compound list. */ + virtual QCString trCompoundListDescription() + { + + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return "Duomenų struktūros su trumpais aprašymais:"; + } + else + { + return "Klasės, struktūros, " + "sąjungos ir sąsajos su trumpais aprašymais:"; + } + } + + /*! This is an introduction to the page with all class members. */ + virtual QCString trCompoundMembersDescription(bool extractAll) + { + QCString result="Visų "; + if (!extractAll) + { + result+="dokumentuotų "; + } + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + result+="struktūrų ir sąjungų laukų sąrašas"; + } + else + { + result+="klasių nariai"; + } + result+=" su ryšiais į "; + if (!extractAll) + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + result+="struktūrų/sąjungų kiekvieno lauko dokumentaciją:"; + } + else + { + result+="klasės dokumentacija kiekvienam nariui:"; + } + } + else + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + result+="struktūros/sąjungos, kurios priklauso:"; + } + else + { + result+="klasės, kurios priklauso:"; + } + } + return result; + } + + /*! This is an introduction to the page with all file members. */ + virtual QCString trFileMembersDescription(bool extractAll) + { + QCString result="Sąrašas visų "; + if (!extractAll) result+="dokumentuotų "; + + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + result+="funkcijų, kintamųjų, apibrėžimų, išvardinimų, ir tipų apibrėžimų"; + } + else + { + result+="globalių narių"; + } + result+=" su ryšiais į "; + if (extractAll) + result+="failus, kuriems jie priklauso:"; + else + result+="dokumentacija:"; + return result; + } + + /*! This is an introduction to the page with the list of all header files. */ + virtual QCString trHeaderFilesDescription() + { return "Antraščių failai, kurie sudaro API:"; } + + /*! This is an introduction to the page with the list of all examples */ + virtual QCString trExamplesDescription() + { return "Visų pavyzdžių sąrašas:"; } + + /*! This is an introduction to the page with the list of related pages */ + virtual QCString trRelatedPagesDescription() + { return "Visų susijusių dokumentacijos puslapių sąrašas:"; } + + /*! This is an introduction to the page with the list of class/file groups */ + virtual QCString trModulesDescription() + { return "Visų modulių sąrašas:"; } + + /*! This sentences is used in the annotated class/file lists if no brief + * description is given. + */ + virtual QCString trNoDescriptionAvailable() + { return "Aprašymo nėra"; } + + // index titles (the project name is prepended for these) + + + /*! This is used in HTML as the title of index.html. */ + virtual QCString trDocumentation() + { return "Dokumentacija"; } + + /*! This is used in LaTeX as the title of the chapter with the + * index of all groups. + */ + virtual QCString trModuleIndex() + { return "Modulio Indeksas"; } + + /*! This is used in LaTeX as the title of the chapter with the + * class hierarchy. + */ + virtual QCString trHierarchicalIndex() + { return "Hierarchijos Indeksas"; } + + /*! This is used in LaTeX as the title of the chapter with the + * annotated compound index. + */ + virtual QCString trCompoundIndex() + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return "Duomenų Struktūros Indeksas"; + } + else + { + return "Klasės Indeksas"; + } + } + + /*! This is used in LaTeX as the title of the chapter with the + * list of all files. + */ + virtual QCString trFileIndex() + { return "Failo Indeksas"; } + + /*! This is used in LaTeX as the title of the chapter containing + * the documentation of all groups. + */ + virtual QCString trModuleDocumentation() + { return "Modulio Dokumentacija"; } + + /*! This is used in LaTeX as the title of the chapter containing + * the documentation of all classes, structs and unions. + */ + virtual QCString trClassDocumentation() + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return "Duomenų Struktūros Dokumentacija"; + } + else + { + return "Klasės Dokumentacija"; + } + } + + /*! This is used in LaTeX as the title of the chapter containing + * the documentation of all files. + */ + virtual QCString trFileDocumentation() + { return "Failo Dokumentacija"; } + + /*! This is used in LaTeX as the title of the chapter containing + * the documentation of all examples. + */ + virtual QCString trExampleDocumentation() + { return "Pavyzdžio Dokumentacija"; } + + /*! This is used in LaTeX as the title of the chapter containing + * the documentation of all related pages. + */ + virtual QCString trPageDocumentation() + { return "Puslapio Dokumentacija"; } + + /*! This is used in LaTeX as the title of the document */ + virtual QCString trReferenceManual() + { return "Informacinis Vadovas"; } + + /*! This is used in the documentation of a file as a header before the + * list of defines + */ + virtual QCString trDefines() + { return "Apibrėžimai"; } + + /*! This is used in the documentation of a file as a header before the + * list of function prototypes + */ + virtual QCString trFuncProtos() + { return "Funkcijų Prototipai"; } + + /*! This is used in the documentation of a file as a header before the + * list of typedefs + */ + virtual QCString trTypedefs() + { return "Tipų apibrėžimai"; } + + /*! This is used in the documentation of a file as a header before the + * list of enumerations + */ + virtual QCString trEnumerations() + { return "Išvardinimai"; } + + /*! This is used in the documentation of a file as a header before the + * list of (global) functions + */ + virtual QCString trFunctions() + { return "Funkcijos"; } + + /*! This is used in the documentation of a file as a header before the + * list of (global) variables + */ + virtual QCString trVariables() + { return "Kintamieji"; } + + /*! This is used in the documentation of a file as a header before the + * list of (global) variables + */ + virtual QCString trEnumerationValues() + { return "Išvardinimų reikšmės"; } + + /*! This is used in the documentation of a file before the list of + * documentation blocks for defines + */ + virtual QCString trDefineDocumentation() + { return "Apibrėžimų Dokumentacija"; } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for function prototypes + */ + virtual QCString trFunctionPrototypeDocumentation() + { return "Funkcijų Prototipų Dokumentacija"; } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for typedefs + */ + virtual QCString trTypedefDocumentation() + { return "Tipų apibrėžimų Dokumentacija"; } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for enumeration types + */ + virtual QCString trEnumerationTypeDocumentation() + { return "Išvardinimo Tipo Dokumentacija"; } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for enumeration values + */ + virtual QCString trEnumerationValueDocumentation() + { return "Išvardinimo Reikšmių Dokumentacija"; } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for functions + */ + virtual QCString trFunctionDocumentation() + { return "Funkcijos Dokumentacija"; } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for variables + */ + virtual QCString trVariableDocumentation() + { return "Kintamojo Dokumentacija"; } + + /*! This is used in the documentation of a file/namespace/group before + * the list of links to documented compounds + */ + virtual QCString trCompounds() + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return "Duomenų struktųros"; + } + else + { + return "Klasės"; + } + } + + /*! This is used in the standard footer of each page and indicates when + * the page was generated + */ + virtual QCString trGeneratedAt(const char *date,const char *projName) + { + QCString result=(QCString)"Sugeneruota "+date;/*FIXME*/ + if (projName) result+=(QCString)" "+projName;/*FIXME*/ + result+=(QCString)" ";/*FIXME*/ + return result; + } + /*! This is part of the sentence used in the standard footer of each page. + */ + virtual QCString trWrittenBy() + { + return "parašyta"; + } + + /*! this text is put before a class diagram */ + virtual QCString trClassDiagram(const char *clName) + { + return (QCString)"Paveldimumo diagrama "+clName+":"; /*FIXME*/ + } + + /*! this text is generated when the \\internal command is used. */ + virtual QCString trForInternalUseOnly() + { return "Tiktai vidiniam naudojimui."; } + + /*! this text is generated when the \\reimp command is used. */ + virtual QCString trReimplementedForInternalReasons() + { return "Reimplemented for internal reasons; the API is not affected."; }/*FIXME*/ + + /*! this text is generated when the \\warning command is used. */ + virtual QCString trWarning() + { return "Įspėjimas"; } + + /*! this text is generated when the \\bug command is used. */ + virtual QCString trBugsAndLimitations() + { return "Klaidos ir apribojimai"; } + + /*! this text is generated when the \\version command is used. */ + virtual QCString trVersion() + { return "Versija"; } + + /*! this text is generated when the \\date command is used. */ + virtual QCString trDate() + { return "Data"; } + + /*! this text is generated when the \\return command is used. */ + virtual QCString trReturns() + { return "Gražina"; } + + /*! this text is generated when the \\sa command is used. */ + virtual QCString trSeeAlso() + { return "Taip pat žiūrėti"; } + + /*! this text is generated when the \\param command is used. */ + virtual QCString trParameters() + { return "Parametrai"; } + + /*! this text is generated when the \\exception command is used. */ + virtual QCString trExceptions() + { return "Išimtys"; } + + /*! this text is used in the title page of a LaTeX document. */ + virtual QCString trGeneratedBy() + { return "Sugeneruota"; } + +////////////////////////////////////////////////////////////////////////// +// new since 0.49-990307 +////////////////////////////////////////////////////////////////////////// + + /*! used as the title of page containing all the index of all namespaces. */ + virtual QCString trNamespaceList() + { return "Varų Srities Sąrašas"; } + + /*! used as an introduction to the namespace list */ + virtual QCString trNamespaceListDescription(bool extractAll) + { + QCString result="Sąrašas visų "; + if (!extractAll) result+="dokumentuotų "; + result+="vardų sričių su trumpais aprašymais:"; + return result; + } + + /*! used in the class documentation as a header before the list of all + * friends of a class + */ + virtual QCString trFriends() + { return "Draugai"; } + +////////////////////////////////////////////////////////////////////////// +// new since 0.49-990405 +////////////////////////////////////////////////////////////////////////// + + /*! used in the class documentation as a header before the list of all + * related classes + */ + virtual QCString trRelatedFunctionDocumentation() + { return "Draugiškų Ir Susijusių Funkcijų Dokumentacija"; } + +////////////////////////////////////////////////////////////////////////// +// new since 0.49-990425 +////////////////////////////////////////////////////////////////////////// + + /*! used as the title of the HTML page of a class/struct/union */ + virtual QCString trCompoundReference(const char *clName, + ClassDef::CompoundType compType, + bool isTemplate) + { + QCString result=(QCString)clName; + switch(compType) + { + case ClassDef::Class: result+=" Klasė"; break; + case ClassDef::Struct: result+=" Struktūra"; break; + case ClassDef::Union: result+=" Sąjunga"; break; + case ClassDef::Interface: result+=" Sąsaja"; break; + case ClassDef::Protocol: result+=" Protokolas"; break; + case ClassDef::Category: result+=" Kategorija"; break; + case ClassDef::Exception: result+=" Išimtis"; break; + } + if (isTemplate) result+=" Šablonas"; + return result; + } + + /*! used as the title of the HTML page of a file */ + virtual QCString trFileReference(const char *fileName) + { + QCString result=fileName; + result+=" Failo Nuoroda"; + return result; + } + + /*! used as the title of the HTML page of a namespace */ + virtual QCString trNamespaceReference(const char *namespaceName) + { + QCString result=namespaceName; + result+=" Vardų Srities Nuoroda"; + return result; + } + + virtual QCString trPublicMembers() + { return "Vieši Metodai"; } + virtual QCString trPublicSlots() + { return "Vieši Slotai"; } /*FIXME*/ + virtual QCString trSignals() + { return "Signalai"; } + virtual QCString trStaticPublicMembers() + { return "Statiniai Vieši Metodai"; } + virtual QCString trProtectedMembers() + { return "Apsaugoti Metodai"; } + virtual QCString trProtectedSlots() + { return "Apsaugoti Slotai"; }/*FIXME*/ + virtual QCString trStaticProtectedMembers() + { return "Statiniai Apsaugoti Metodai"; } + virtual QCString trPrivateMembers() + { return "Privatatūs Metodai"; } + virtual QCString trPrivateSlots() + { return "Privatūs Slotai"; }/*FIXME*/ + virtual QCString trStaticPrivateMembers() + { return "Statiniai Privatūs Metodai"; } + + /*! this function is used to produce a comma-separated list of items. + * use generateMarker(i) to indicate where item i should be put. + */ + virtual QCString trWriteList(int numEntries) + { + QCString result; + int i; + // the inherits list contain `numEntries' classes + for (i=0;i