From e90eb41e09adeb8970ef9a64fb8f163f068d7b17 Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Mon, 4 Jun 2001 14:15:23 +0000 Subject: Release-1.2.8 --- INSTALL | 4 +- README | 4 +- VERSION | 2 +- doc/Makefile.in | 8 +- doc/Makefile.win_make.in | 10 +- doc/Makefile.win_nmake.in | 2 +- doc/commands.doc | 70 +-- doc/config.doc | 83 +-- doc/diagrams.doc | 6 +- doc/docblocks.doc | 2 +- doc/doxygen_usage.doc | 4 +- doc/doxysearch_usage.doc | 8 +- doc/external.doc | 4 +- doc/faq.doc | 8 +- doc/features.doc | 12 +- doc/formulas.doc | 16 +- doc/history.doc | 4 +- doc/htmlcmds.doc | 37 +- doc/index.doc | 20 +- doc/install.doc | 31 +- doc/maintainers.txt | 4 + doc/output.doc | 4 +- doc/starting.doc | 10 +- examples/jdstyle.cpp | 2 +- examples/qtstyle.cpp | 2 +- packages/rpm/doxygen.spec | 2 +- qtools/qcstring.cpp | 42 +- src/config.h | 115 ++-- src/config.l | 120 +++- src/defargs.l | 1 + src/doc.l | 40 +- src/dot.cpp | 12 +- src/doxygen.cpp | 80 ++- src/ftvhelp.cpp | 7 + src/groupdef.cpp | 2 +- src/htmlgen.cpp | 14 +- src/htmlgen.h | 3 +- src/htmlhelp.cpp | 10 + src/language.cpp | 5 + src/latexgen.cpp | 27 +- src/latexgen.h | 2 +- src/mangen.cpp | 21 +- src/mangen.h | 2 +- src/memberdef.cpp | 10 +- src/outputgen.h | 4 +- src/outputlist.h | 5 +- src/rtfgen.cpp | 14 +- src/rtfgen.h | 2 +- src/scanner.l | 1 + src/translator_cz.h | 38 +- src/translator_de.h | 30 +- src/translator_en.h | 8 +- src/translator_es.h | 421 ++++++++++++-- src/translator_hr.h | 200 +++++-- src/translator_ru.h | 63 ++- src/translator_sk.h | 1334 +++++++++++++++++++++++++++++++++++++++++++++ src/util.cpp | 89 ++- src/util.h | 5 +- 58 files changed, 2573 insertions(+), 513 deletions(-) create mode 100644 src/translator_sk.h diff --git a/INSTALL b/INSTALL index ee6e255..7cde105 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,6 @@ -DOXYGEN Version 1.2.7-20010524 +DOXYGEN Version 1.2.8 Please read the installation section of the manual for instructions. -------- -Dimitri van Heesch (24 May 2001) +Dimitri van Heesch (04 June 2001) diff --git a/README b/README index bec5b17..feb2212 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -DOXYGEN Version 1.2.7_20010524 +DOXYGEN Version 1.2.8 Please read INSTALL for compilation instructions. @@ -7,4 +7,4 @@ The latest version of doxygen can be obtained at Enjoy, -Dimitri van Heesch (24 May 2001) +Dimitri van Heesch (04 June 2001) diff --git a/VERSION b/VERSION index 58be32e..db6fb4a 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.2.7-20010524 +1.2.8 diff --git a/doc/Makefile.in b/doc/Makefile.in index 90c7d94..38675ed 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -12,7 +12,7 @@ # Documents produced by Doxygen are derivative works derived from the # input used in their production; they are not affected by this license. -all: FORCE +all: language FORCE DOXYGEN_DOCDIR=$(DOXYDOCS); \ export DOXYGEN_DOCDIR; \ VERSION=$(VERSION) ; \ @@ -28,9 +28,11 @@ all: FORCE clean: rm -rf ../html ../latex language.doc -language: language.doc language.tpl translator.pl +language: language.doc -language.doc: language.tpl FORCE +translators: $(wildcard ../src/translator_*.h) + +language.doc: translators maintainers.txt language.tpl translator.pl $(PERL) translator.pl FORCE: diff --git a/doc/Makefile.win_make.in b/doc/Makefile.win_make.in index b1a2009..3b7c3c7 100644 --- a/doc/Makefile.win_make.in +++ b/doc/Makefile.win_make.in @@ -12,7 +12,7 @@ # Documents produced by Doxygen are derivative works derived from the # input used in their production; they are not affected by this license. -all: +all: language FORCE @xcopy /s /q /i ..\examples ..\html\examples set DOXYGEN_DOCDIR=. & \ set VERSION=$(VERSION) & \ @@ -26,5 +26,13 @@ all: clean: del /s /q ..\html ..\latex + del translator_report.txt *.bak + +language: language.doc + +translators: ..\src\translator_*.h + +language.doc: translators maintainers.txt language.tpl translator.pl + $(PERL) translator.pl FORCE: diff --git a/doc/Makefile.win_nmake.in b/doc/Makefile.win_nmake.in index 92829a1..dd53b22 100644 --- a/doc/Makefile.win_nmake.in +++ b/doc/Makefile.win_nmake.in @@ -12,7 +12,7 @@ # Documents produced by Doxygen are derivative works derived from the # input used in their production; they are not affected by this license. -all: FORCE +all: language FORCE @xcopy /s /q /i ..\examples ..\html\examples set DOXYGEN_DOCDIR=. set VERSION=$(VERSION) diff --git a/doc/commands.doc b/doc/commands.doc index b0b9bc2..087fad0 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -145,7 +145,7 @@ documentation: \endlatexonly The following subsections provide a list of all commands that are recognized by -Doxygen. Unrecognized commands are treated as normal text. +doxygen. Unrecognized commands are treated as normal text.

\htmlonly
--- \endhtmlonly Structural indicators @@ -204,7 +204,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude class.h \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly
@@ -218,7 +218,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude define.h \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly
@@ -231,7 +231,7 @@ Doxygen. Unrecognized commands are treated as normal text. categories. You can also use groups as members of other groups, thus building a hierarchy of groups. - The \ argument should be a single word identifier. + The \ argument should be a single-word identifier. \sa page \ref grouping "Grouping", sections \ref cmdingroup "\\ingroup", \ref cmdaddtogroup "\\addtogroup", \ref cmdweakgroup "\\weakgroup". @@ -256,7 +256,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude enum.h \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly
@@ -271,7 +271,7 @@ Doxygen. Unrecognized commands are treated as normal text. If any are found, the names are cross-referenced with the documentation. Source files or directories can be specified using the \ref cfg_example_path "EXAMPLE_PATH" - tag of Doxygen's configuration file. + tag of doxygen's configuration file. If \ itself is not unique for the set of example files specified by the @@ -287,7 +287,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude example_test.cpp \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \sa section \ref cmdinclude "\\include". @@ -310,7 +310,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude file.h \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly
@@ -331,7 +331,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude func.h \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef". @@ -343,7 +343,7 @@ Doxygen. Unrecognized commands are treated as normal text. By default the value of a define and the initializer of a variable are displayed unless they are longer than 30 lines. By putting this command in a comment block of a define or variable, the - initializer always hidden. + initializer is always hidden. \sa section \ref cmdshowinitializer "\\showinitializer". @@ -461,7 +461,7 @@ Public/Protected/Private/... section. \verbinclude examples/overload.cpp \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly
@@ -471,14 +471,14 @@ Public/Protected/Private/... section. Indicates that a comment block contains a piece of documentation that is not directly related to one specific class, file or member. The HTML generator creates a page containing the documentation. The - \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly generator + \f$\mbox{\LaTeX}\f$ generator starts a new section in the chapter `Page documentation'. \par Example: \verbinclude page.doc \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \par Note: @@ -509,7 +509,7 @@ Public/Protected/Private/... section. \verbinclude relates.cpp \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly
@@ -537,7 +537,7 @@ Public/Protected/Private/... section. \subsection cmdtypedef \typedef (typedef declaration) \addindex \typedef - Indicates that a comment block contains documentation for a typedef, + Indicates that a comment block contains documentation for a typedef (either global or as a member of a class). This command is equivalent to \\var and \\fn. @@ -557,7 +557,7 @@ Public/Protected/Private/... section. \subsection cmdvar \var (variable declaration) \addindex \var - Indicates that a comment block contains documentation for a variable, + Indicates that a comment block contains documentation for a variable or enum value (either global or as a member of a class). This command is equivalent to \\typedef and \\fn. @@ -606,7 +606,7 @@ Public/Protected/Private/... section. \verbinclude author.cpp \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly
@@ -771,7 +771,7 @@ Public/Protected/Private/... section. \verbinclude par.cpp \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly
@@ -821,7 +821,7 @@ Public/Protected/Private/... section. \subsection cmdremarks \remarks { remark text } \addindex \remarks - Starts a paragraph where one or more marks may be entered. + Starts a paragraph where one or more remarks may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. @@ -847,7 +847,7 @@ Public/Protected/Private/... section. \subsection cmdretval \retval { description } \addindex \retval - Starts a return value for a function with name + Starts a return value description for a function with name \. Followed by a description of the return value. The text of the paragraph that forms the description has no special internal structure. All visual enhancement commands may be used inside the @@ -863,7 +863,7 @@ Public/Protected/Private/... section. \addindex \sa Starts a paragraph where one or more cross-references to classes, functions, methods, variables, files or URL may be specified. - Two names joines by either :: or \# + Two names joined by either :: or \# are understood as referring to a class and one of its members. One of several overloaded methods or constructors may be selected by including a parenthesized list of argument types after @@ -975,7 +975,7 @@ Public/Protected/Private/... section. \subsection cmdlink \link \addindex \link - The links that are automatically generated by Doxygen always have the + The links that are automatically generated by doxygen always have the name of the object they point to as link-text. The \\link command can be used to create a link to an object (a file, @@ -1048,7 +1048,7 @@ Public/Protected/Private/... section. add documentation between the pieces. Source files or directories can be specified using the \ref cfg_example_path "EXAMPLE_PATH" - tag of Doxygen's configuration file. + tag of doxygen's configuration file. The class and member declarations and definitions inside the code fragment are `remembered' during the parsing of the comment block that contained @@ -1065,7 +1065,7 @@ Public/Protected/Private/... section. \verbinclude example_test.cpp \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \sa sections \ref cmdline "\\line", \ref cmdskip "\\skip", @@ -1079,7 +1079,7 @@ Public/Protected/Private/... section. The command takes the name of an include file as an argument. Source files or directories can be specified using the \ref cfg_example_path "EXAMPLE_PATH" - tag of Doxygen's configuration file. + tag of doxygen's configuration file. If \ itself is not unique for the set of example files specified by the @@ -1178,7 +1178,7 @@ Public/Protected/Private/... section. placing \\verbatim and \\endverbatim commands around it. Files or directories that doxygen should look for can be specified using the - \ref cfg_example_path "EXAMPLE_PATH" tag of Doxygen's configuration file. + \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file.
\subsection cmdhtmlinclude \htmlinclude @@ -1189,7 +1189,7 @@ Public/Protected/Private/... section. placing \\htmlonly and \\endhtmlonly commands around it. Files or directories that doxygen should look for can be specified using the - \ref cfg_example_path "EXAMPLE_PATH" tag of Doxygen's configuration file. + \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file.

\htmlonly
--- \endhtmlonly @@ -1378,7 +1378,7 @@ Public/Protected/Private/... section. endhtmlonly command. This command can be used to include HTML code that is too complex - for Doxygen (i.e. applets, java-scripts, and HTML tags that + for doxygen (i.e. applets, java-scripts, and HTML tags that require attributes). You can use the \\latexonly and \\endlatexonly pair to provide a proper \f$\mbox{\LaTeX}\f$ alternative. @@ -1401,12 +1401,12 @@ Public/Protected/Private/... section. following values are supported: \c html and \c latex. The second argument specifies the file name of the image. - Doxygen will look for files in the paths (or files) that you specified + doxygen will look for files in the paths (or files) that you specified after the \ref cfg_image_path "IMAGE_PATH" tag. If the image is found it will be copied to the correct output directory. If the image name contains spaces you'll have to put quotes (") around it. You can also specify an absolute URL instead of a file name, but then - doxygen does not copy the image or check its existance. + doxygen does not copy the image nor check its existance. The third argument is optional and can be used to specify the caption that is displayed below the image. This argument has to be specified @@ -1439,9 +1439,9 @@ Public/Protected/Private/... section. \warning The image format for HTML is limited to what your browser supports. For \f$\mbox{\LaTeX}\f$ the image format - must be an encapsulated postscipt (eps). + must be Encapsulated PostScipt (eps).

- Doxygen does not check if the image is in the correct format. + doxygen does not check if the image is in the correct format. So \e you have to make sure this is the case!
@@ -1453,7 +1453,7 @@ Public/Protected/Private/... section. endlatexonly command. This command can be used to include \f$\mbox{\LaTeX}\f$ code that is too - complex for Doxygen (i.e. images, formulas, special characters). You can + complex for doxygen (i.e. images, formulas, special characters). You can use the \\htmlonly and \\endhtmlonly pair to provide a proper HTML alternative. @@ -1531,7 +1531,7 @@ Public/Protected/Private/... section. \addindex \\ This command writes a backslash character (\\) to the HTML and \f$\mbox{\LaTeX}\f$ output. The backslash has to be escaped in some - cases because Doxygen uses it to detect commands. + cases because doxygen uses it to detect commands.
\subsection cmdat \@ @@ -1539,7 +1539,7 @@ Public/Protected/Private/... section. \addindex \@ This command writes an at-sign (@) to the HTML and \f$\mbox{\LaTeX}\f$ output. The at-sign has to be escaped in some cases - because Doxygen uses it to detect JavaDoc commands. + because doxygen uses it to detect JavaDoc commands.
\subsection cmdamp \& diff --git a/doc/config.doc b/doc/config.doc index f5d1f1e..13d3991 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -14,7 +14,7 @@ * input used in their production; they are not affected by this license. * */ -/*! \page config +/*! \page config Configuration \section config Configuration @@ -213,7 +213,7 @@ followed by the descriptions of the tags grouped by category.
\c OUTPUT_DIRECTORY
\addindex OUTPUT_DIRECTORY The \c OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) - path into which the generated HTML and Latex documentation will be written. + path into which the generated documentation will be written. 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. @@ -254,7 +254,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_hide_undoc_members
\c HIDE_UNDOC_MEMBERS
\addindex HIDE_UNDOC_MEMBERS - If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, Doxygen will hide all + If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, doxygen will hide all undocumented members inside documented classes or files. If set to \c NO (the default) these members will be included in the various overviews, but no documentation section is generated. @@ -263,7 +263,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_hide_undoc_classes
\c HIDE_UNDOC_CLASSES
\addindex HIDE_UNDOC_CLASSES - If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, Doxygen will hide all + If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, doxygen will hide all undocumented classes. If set to \c NO (the default) these classes will be included in the various overviews. @@ -272,7 +272,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_brief_member_desc
\c BRIEF_MEMBER_DESC
\addindex BRIEF_MEMBER_DESC - If the \c BRIEF_MEMBER_DESC tag is set to \c YES (the default) Doxygen will + If the \c BRIEF_MEMBER_DESC tag is set to \c YES (the default) doxygen will include brief member descriptions after the members that are listed in the file and class documentation (similar to JavaDoc). Set to NO to disable this. @@ -280,7 +280,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_repeat_brief
\c REPEAT_BRIEF
\addindex REPEAT_BRIEF - If the \c REPEAT_BRIEF tag is set to \c YES (the default) Doxygen will + If the \c REPEAT_BRIEF tag is set to \c YES (the default) doxygen will prepend the brief description of a member or function before the detailed description @@ -292,13 +292,13 @@ followed by the descriptions of the tags grouped by category.
\c ALWAYS_DETAILED_SEC
\addindex ALWAYS_DETAILED_SEC If the \c ALWAYS_DETAILED_SEC and \c REPEAT_BRIEF tags are both set to \c YES then - Doxygen will generate a detailed section even if there is only a brief + doxygen will generate a detailed section even if there is only a brief description. \anchor cfg_full_path_names
\c FULL_PATH_NAMES
\addindex FULL_PATH_NAMES - If the \c FULL_PATH_NAMES tag is set to \c YES Doxygen will prepend the full + If the \c FULL_PATH_NAMES tag is set to \c YES doxygen will prepend the full path before files name in the file list and in the header files. If set to NO the shortest path that makes the file name unique will be used @@ -321,8 +321,8 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_class_diagrams
\c CLASS_DIAGRAMS
\addindex CLASS_DIAGRAMS - If the \c CLASS_DIAGRAMS tag is set to \c YES (the default) Doxygen will - generate a class diagram (in Html and \f$\mbox{\LaTeX}\f$) for classes with base or + If the \c CLASS_DIAGRAMS tag is set to \c YES (the default) doxygen will + generate a class diagram (in HTML and \f$\mbox{\LaTeX}\f$) for classes with base or super classes. Setting the tag to \c NO turns the diagrams off. \anchor cfg_source_browser @@ -347,7 +347,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_case_sense_names
\c CASE_SENSE_NAMES
\addindex CASE_SENSE_NAMES - If the \c CASE_SENSE_NAMES tag is set to \c NO (the default) then Doxygen + If the \c CASE_SENSE_NAMES tag is set to \c NO (the default) then doxygen will only generate file names in lower case letters. If set to \c YES upper case letters are also allowed. This is useful if you have classes or files whose names only differ in case and if your file system @@ -363,14 +363,14 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_hide_scope_names
\c HIDE_SCOPE_NAMES
\addindex HIDE_SCOPE_NAMES - If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then Doxygen + If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then doxygen will show members with their full class and namespace scopes in the documentation. If set to \c YES the scope will be hidden. \anchor cfg_verbatim_headers
\c VERBATIM_HEADERS
\addindex VERBATIM_HEADERS - If the \c VERBATIM_HEADERS tag is set the \c YES (the default) then Doxygen + If the \c VERBATIM_HEADERS tag is set the \c YES (the default) then doxygen will generate a verbatim copy of the header file for each class for which an include is specified. Set to NO to disable this. \sa Section \ref cmdclass "\\class". @@ -378,14 +378,14 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_show_include_files
\c SHOW_INCLUDE_FILES
\addindex SHOW_INCLUDE_FILES - If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen + If the SHOW_INCLUDE_FILES tag is set to YES (the default) then doxygen will put list of the files that are included by a file in the documentation of that file. \anchor cfg_javadoc_autobrief
\c JAVADOC_AUTOBRIEF
\addindex JAVADOC_AUTOBRIEF - If the \c JAVADOC_AUTOBRIEF is set to \c YES then Doxygen + If the \c JAVADOC_AUTOBRIEF is set to \c YES then doxygen will interpret the first line (until the first dot) of a JavaDoc-style comment as the brief description. If set to NO (the default), the Javadoc-style will behave just like the Qt-style comments. @@ -665,7 +665,7 @@ followed by the descriptions of the tags grouped by category.
\c GENERATE_HTML
\addindex GENERATE_HTML - If the \c GENERATE_HTML tag is set to \c YES (the default) Doxygen will + If the \c GENERATE_HTML tag is set to \c YES (the default) doxygen will generate HTML output \anchor cfg_html_output @@ -760,16 +760,16 @@ followed by the descriptions of the tags grouped by category. \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a project file that can be read by - Microsoft HTML help workshop + Microsoft HTML Help Workshop \latexonly (see http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download\_main.htm) \endlatexonly on Windows. - The HTML workshop contains a compiler that can convert all HTML output + The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen into a single compressed HTML file (.chm). Compressed HTML files are now used as the Windows 98 help format, and will replace - the old windows help format (.hlp) on all Windows platforms in the future. + the old Windows help format (.hlp) on all Windows platforms in the future. Compressed HTML files also contain an index, a table of contents, and you can search for words in the documentation (which basically renders \c doxysearch obsolete on Windows). @@ -792,8 +792,8 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_toc_expand
\c TOC_EXPAND
\addindex TOC_EXPAND - The \c TOC_EXPAND flag can be set YES to add extra items for - group members to the table of contents of the Html help documentation + The \c TOC_EXPAND flag can be set to YES to add extra items for + group members to the table of contents of the HTML help documentation and to the tree view. \anchor cfg_disable_index @@ -834,8 +834,8 @@ followed by the descriptions of the tags grouped by category.
\c GENERATE_LATEX
\addindex GENERATE_LATEX - If the \c GENERATE_LATEX tag is set to \c YES (the default) Doxygen will - generate Latex output. + If the \c GENERATE_LATEX tag is set to \c YES (the default) doxygen will + generate \f$\mbox{\LaTeX}\f$ output. \anchor cfg_latex_output
\c LATEX_OUTPUT
@@ -848,7 +848,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_compact_latex
\c COMPACT_LATEX
\addindex COMPACT_LATEX - If the \c COMPACT_LATEX tag is set to \c YES Doxygen generates more compact + If the \c COMPACT_LATEX tag is set to \c YES doxygen generates more compact \f$\mbox{\LaTeX}\f$ documents. This may be useful for small projects and may help to save some trees in general. @@ -881,8 +881,8 @@ EXTRA_PACKAGES = times
\c LATEX_HEADER
\addindex LATEX_HEADER The \c LATEX_HEADER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$ - header for the generated latex document. The header should contain everything - until the first chapter. + header for the generated \f$\mbox{\LaTeX}\f$ document. + The header should contain everything until the first chapter. If it is left blank doxygen will generate a standard header. See section \ref doxygen_usage for information on how to @@ -904,10 +904,11 @@ EXTRA_PACKAGES = times
\c PDF_HYPERLINKS
\addindex PDF_HYPERLINKS - If the \c PDF_HYPERLINKS tag is set to \c YES, the LaTeX that is generated - is prepared for conversion to pdf (using ps2pdf). The pdf file will + If the \c PDF_HYPERLINKS tag is set to \c YES, the \f$\mbox{\LaTeX}\f$ 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. + This makes the output suitable for online browsing using a PDF viewer. \anchor cfg_latex_batchmode
\c LATEX_BATCHMODE
@@ -926,7 +927,7 @@ EXTRA_PACKAGES = times
\c GENERATE_RTF
\addindex GENERATE_RTF - If the \c GENERATE_RTF tag is set to \c YES Doxygen will generate RTF output. + If the \c GENERATE_RTF tag is set to \c YES doxygen will generate RTF output. The RTF output is optimised for Word 97 and may not look too pretty with other readers/editors. @@ -940,7 +941,7 @@ EXTRA_PACKAGES = times \anchor cfg_compact_rtf
\c COMPACT_RTF
\addindex COMPACT_RTF - If the \c COMPACT_RTF tag is set to \c YES Doxygen generates more compact + If the \c COMPACT_RTF tag is set to \c YES doxygen generates more compact RTF documents. This may be useful for small projects and may help to save some trees in general. @@ -954,7 +955,7 @@ EXTRA_PACKAGES = times Word compatible reader that support those fields. \par note: - wordpad (write) and others do not support links. + WordPad (write) and others do not support links. \anchor cfg_rtf_stylesheet_file
\c RTF_STYLESHEET_FILE
@@ -968,7 +969,7 @@ EXTRA_PACKAGES = times \anchor cfg_rtf_extensions_file
\c RTF_EXTENSIONS_FILE
- Set optional variables used in the generation of an rtf document. + Set optional variables used in the generation of an RTF document. Syntax is similar to doxygen's config file. A template extensions file can be generated using doxygen -e rtf extensionFile. @@ -981,7 +982,7 @@ EXTRA_PACKAGES = times
\c GENERATE_MAN
\addindex GENERATE_MAN - If the \c GENERATE_MAN tag is set to \c YES (the default) Doxygen will + If the \c GENERATE_MAN tag is set to \c YES (the default) doxygen will generate man pages for classes and files. \anchor cfg_man_output @@ -1002,7 +1003,7 @@ EXTRA_PACKAGES = times \anchor cfg_man_links
\c MAN_LINKS
\addindex MAN_LINKS - If the \c MAN_LINKS tag is set to \c YES and Doxygen generates man output, + If the \c MAN_LINKS tag is set to \c 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. @@ -1016,14 +1017,14 @@ EXTRA_PACKAGES = times
\c ENABLE_PREPROCESSING
\addindex ENABLE_PREPROCESSING - If the \c ENABLE_PREPROCESSING tag is set to \c YES (the default) Doxygen will + If the \c ENABLE_PREPROCESSING tag is set to \c YES (the default) doxygen will evaluate all C-preprocessor directives found in the sources and include files. \anchor cfg_macro_expansion
\c MACRO_EXPANSION
\addindex MACRO_EXPANSION - If the \c MACRO_EXPANSION tag is set to \c YES Doxygen will expand all macro + If the \c MACRO_EXPANSION tag is set to \c YES doxygen will expand all macro names in the source code. If set to \c NO (the default) only conditional compilation will be performed. Macro expansion can be done in a controlled way by setting \c EXPAND_ONLY_PREDEF to \c YES. @@ -1039,7 +1040,7 @@ EXTRA_PACKAGES = times
\c SEARCH_INCLUDES
\addindex SEARCH_INCLUDES If the \c SEARCH_INCLUDES tag is set to \c YES (the default) the includes files - in the \c INCLUDE_PATH (see below) will be search if a \#include is found. + in the \c INCLUDE_PATH (see below) will be searched if a \#include is found. \anchor cfg_include_path
\c INCLUDE_PATH
@@ -1195,7 +1196,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... \anchor cfg_generate_legend
\c GENERATE_LEGEND
\addindex GENERATE_LEGEND - If the \c GENERATE_LEGEND tag is set to \c YES (the default) Doxygen will + If the \c GENERATE_LEGEND tag is set to \c YES (the default) doxygen will generate a legend page explaining the meaning of the various boxes and arrows in the dot generated graphs. @@ -1222,7 +1223,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ...
\c CGI_URL
\addindex CGI_URL The \c CGI_URL tag should be the absolute URL to the directory where the - cgi binaries are located. See the documentation of your http daemon for + cgi binaries are located. See the documentation of your HTTP daemon for details. \anchor cfg_doc_url @@ -1363,7 +1364,7 @@ EXPAND_AS_DEFINED = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \ Q_VARIANT_AS \endverbatim -Here Doxygen's preprocessor is used to substitute some +Here doxygen's preprocessor is used to substitute some macro names that are normally substituted by the C preprocessor, but without doing full macro expansion. diff --git a/doc/diagrams.doc b/doc/diagrams.doc index 2153f16..3217800 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -61,7 +61,7 @@ little marker in the lower right corner to indicate that the class contains base classes that are hidden. For the class diagrams the maximum tree width is currently 8 elements. - If a tree wider some nodes will be hidden. + If a tree is wider some nodes will be hidden. If the box is filled with a dashed pattern the inheritance relation is virtual.
  • A \b white box indicates that the documentation of the class @@ -81,7 +81,7 @@ If the box has a \b dashed border this indicates virtual inheritance.
  • A \b solid arrow indicates public inheritance.
  • A \b dashed arrow indicates protected inheritance. -
  • A \b dotted arrow indicated private inheritance. +
  • A \b dotted arrow indicates private inheritance. The elements in the graphs generated by the dot tool have the following @@ -91,7 +91,7 @@
  • A box with a \b red border indicates a node that has \e more arrows than are shown! In order words: the graph is \e truncated with respect to this node. - The reason a graph is sometimes truncated is too prevent images + The reason a graph is sometimes truncated is to prevent images from becoming too large. For the graphs generated with dot doxygen tries to limit the width of the resulting image to 1024 pixels. diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 547e617..bb73ccb 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -204,7 +204,7 @@ Here is an example of the use of these comment blocks: for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly -\warning These blocks can only be used to document \e members. +\warning These blocks can only be used to document \e members and \e parameters. They cannot be used to document files, classes, unions, structs, groups, namespaces and enums themselves. Furthermore, the structural commands mentioned in the previous section diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc index 5796896..865f5ca 100644 --- a/doc/doxygen_usage.doc +++ b/doc/doxygen_usage.doc @@ -44,7 +44,7 @@ doxygen If you have a configuration file generated with an older version of -doxygen that you can upgrade it to the current version by running doxygen +doxygen, you can upgrade it to the current version by running doxygen with the -u option. \verbatim doxygen -u @@ -85,7 +85,7 @@ doxygen -w rtf rtfstyle.cfg file then you can use the optional \c -s option. This can use be used in combination with the \c -u option, to add or strip the documentation from an existing configuration file. - Please use the \c -s this option if you send me a configuration file + Please use the \c -s option if you send me a configuration file as part of a bug report!
  • To make doxygen read/write to standard input/output instead of from/to a file, use \c - for the file name. diff --git a/doc/doxysearch_usage.doc b/doc/doxysearch_usage.doc index 72dc397..6d6ad29 100644 --- a/doc/doxysearch_usage.doc +++ b/doc/doxysearch_usage.doc @@ -27,7 +27,7 @@ Doxysearch must be run as a CGI binary. This implies the following:
  • You must have permission to install and execute a CGI binary on the target. -Ask you system administrator or provider if you are unsure if this is possible. +Ask your system administrator or provider if you are unsure if this is possible. In order to be able to search fast and efficient, doxysearch does not search the generated documentation directly. Instead, it uses an @@ -131,8 +131,8 @@ This can be done by carefully following these steps: \par Note: Doxytag requires quite a large amount of memory to - generate the search index (about 30 Mb on my Linux box)! - The resulting index file requires about 3 Mb space on your disk. + generate the search index (about 30 MB on my Linux box)! + The resulting index file requires about 3 MB space on your disk.
  • Edit the shell script search.cgi with a text editor. @@ -174,7 +174,7 @@ http://blizzard/cgi-bin/search.cgi \endverbatim in the additional information section of the index.html file.
  • Start your favourite web browser and click on the link. - If everything is ok, you should get a page where you can enter + If everything is OK, you should get a page where you can enter search terms. diff --git a/doc/external.doc b/doc/external.doc index d8f4285..f3a1e05 100644 --- a/doc/external.doc +++ b/doc/external.doc @@ -45,7 +45,7 @@ To generate a tag file for your project, simply put the name of the tag file after the \ref cfg_generate_tagfile "GENERATE_TAGFILE" option in the configuration file. -To combine the output of one or more external projects with you own project +To combine the output of one or more external projects with your own project you should specify the name of the tag files after the \ref cfg_tagfiles "TAGFILES" option in the configuration file. @@ -57,7 +57,7 @@ There are two ways to do this:
    At configuration time:
    just assign the location of the output to the tag files specified after the \ref cfg_tagfiles "TAGFILES" configuration option. If you use a relative path it should be relative with respect to - the directory where the html output of your project is generated. + the directory where the HTML output of your project is generated.
    After compile time:
    if you do not assign a location to a tag file, doxygen will generate dummy links for all external HTML references. It will also generate a perl script called \ref installdox_usage "installdox" in diff --git a/doc/faq.doc b/doc/faq.doc index 7b4894b..f20dfc0 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -91,7 +91,7 @@ around the blocks that should be hidden and put: in the config file then all blocks should be skipped by Doxygen as long as PREPROCESSING = YES. -
  • How can I change what's after the \#include in the class documentation? +
  • How can I change what is after the \#include in the class documentation? You can document your class like @@ -119,7 +119,7 @@ brackets you should type: */ \endverbatim -
  • How can I use tag files in combination with compressed HTML +
  • How can I use tag files in combination with compressed HTML? If you want to refer from one compressed HTML file \c a.chm to another compressed HTML file @@ -160,7 +160,7 @@ doxygen generates. You can include this by putting \verbatim \endverbatim -In the HEAD section of the HTML page. +in the HEAD section of the HTML page.
  • Why does doxygen use Qt? @@ -194,7 +194,7 @@ This error happens when doxygen lexical scanner has a rules that matches more than 16K input character in one go. I've seen this happening on a very large generated file (>16K lines), where the built-in preprocessor converted it into an empty file (with >16K of newlines). Another case -where this might happen is if you have lines in you code with more than +where this might happen is if you have lines in your code with more than 16K characters. diff --git a/doc/features.doc b/doc/features.doc index 68d54f0..053a9db 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -14,7 +14,7 @@ * input used in their production; they are not affected by this license. * */ -/*! \page features.html +/*! \page features Features \section features Features @@ -23,12 +23,12 @@
  • Requires very little overhead from the writer of the documentation. Plain text will do, but for more fancy or structured output HTML tags and/or some of doxygen's special commands can be used. -
  • Supports C++, (Corba, Microsoft, and KDE-DCOP) Java, IDL and C sources. +
  • Supports C++, Java, (Corba, Microsoft, and KDE-DCOP) Java, IDL and C sources.
  • Supports documentation of files, namespaces, classes, structs, unions, templates, variables, functions, typedefs, enums and defines.
  • JavaDoc (1.1), Qt-Doc, and KDOC compatible.
  • Automatically generates class diagrams in HTML (as clickable - image maps) and \f$\mbox{\LaTeX}\f$ (as encapsulated postscript images). + image maps) and \f$\mbox{\LaTeX}\f$ (as Encapsulated PostScript images).
  • Uses the dot tool of the Graphviz tool kit to generate include dependency graphs, collaboration diagrams, and graphical class hierarchy graphs. @@ -38,11 +38,11 @@
  • Can generate a list of all members of a class (including any inherited members) along with their protection level.
  • Outputs documentation in on-line format (HTML and UNIX man page) and - off-line format (\f$\mbox{\LaTeX}\f$) and RTF simultaniously + off-line format (\f$\mbox{\LaTeX}\f$ and RTF) simultaneously (any of these can be disabled if desired). All formats are optimized for ease of reading.
    Furthermore, compressed HTML can be generated from HTML output using - Microsoft's HTML help workshop (Windows only) and PDF can be generated + Microsoft's HTML Help Workshop (Windows only) and PDF can be generated from the \f$\mbox{\LaTeX}\f$ output.
  • Includes a full C preprocessor to allow proper parsing of conditional code fragments and to allow expansion of all or part of macros definitions. @@ -57,7 +57,7 @@
  • Includes a fast, rank based search engine to search for strings or words in the class and member documentation.
  • You can type normal HTML tags in your documentation. Doxygen will convert - them to their equivalent \f$\mbox{\LaTeX}\f$ and man-page + them to their equivalent \f$\mbox{\LaTeX}\f$, RTF, and man-page counterparts automatically.
  • Allows references to documentation generated for other projects (or another part of the same project) in a location independent way. diff --git a/doc/formulas.doc b/doc/formulas.doc index bd1aa22..e90424f 100644 --- a/doc/formulas.doc +++ b/doc/formulas.doc @@ -17,17 +17,17 @@ /*! \page formulas Including formulas Doxygen allows you to put \f$\mbox{\LaTeX}\f$ formulas in the -output (this works only for the HTML and \f$\mbox{\LaTeX}\f$ formats, -not for the man page output). To be able to include formulas (as images) -in the HTML documentation, you will also need to have the following tools -installed +output (this works only for the HTML and \f$\mbox{\LaTeX}\f$ output, +not for the RTF nor for the man page output). To be able to include +formulas (as images) in the HTML documentation, you will also need to +have the following tools installed
    • \c latex: the \f$\mbox{\LaTeX}\f$ compiler, needed to parse the formulas. To test I have used the teTeX 0.9 distribution. -
    • \c dvips: a tool to convert dvi files to postscript files +
    • \c dvips: a tool to convert DVI files to PostScript files I have used version 5.86 from Radical Eye software for testing. -
    • \c gs: the ghostscript interpreter for converting postscript files - to bitmaps. I have used Aladdin Ghostscript 5.10 for testing. +
    • \c gs: the GhostScript interpreter for converting PostScript files + to bitmaps. I have used Aladdin GhostScript 5.10 for testing.
    There are two ways to include formulas in the documentation. @@ -44,7 +44,7 @@ There are two ways to include formulas in the documentation. \f$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}\f$.
  • Unnumbered displayed formulas that are centered on a separate line. - These formulas should be put between \\f\[ and \\f\] commands. + These formulas should be put between \\f[ and \\f] commands. An example: \verbatim \f[ diff --git a/doc/history.doc b/doc/history.doc index eb5f2f1..5a28e9d 100644 --- a/doc/history.doc +++ b/doc/history.doc @@ -24,7 +24,7 @@
  • Using the dot tool of the AT&T's GraphViz package, doxygen can now generate inheritance diagrams, collaboration diagrams, include dependency graphs, included by graphs and graphical inheritance overviews. -
  • Function arguments can now be documentation with separate comment blocks. +
  • Function arguments can now be documented with separate comment blocks.
  • Initializers and macro definitions are now included in the documentation.
  • Variables and typedefs are now put in their own section.
  • Old configuration files can be upgraded using the -u option without @@ -52,7 +52,7 @@
    • Support for templates and namespaces.
    • Internationalization support. Currently supported languages are: - English, Czech, German, Spanish, Finnish, French, Italian, Japanse, + English, Czech, German, Spanish, Finnish, French, Italian, Japanese, Dutch, and Swedish.
    • Automatic generation of inheritance diagrams for sub & super classes.
    • Support for man page, compressed HTML help, and hyperlinked PDF output. diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 0429139..79faf11 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -38,8 +38,8 @@ documentation. Note that all attributes of a HTML tag are ignored
    • \c Ends a \c section.
    • \c
      Starts a description list.
    • \c
      • Ends a description list. -
    • \c
      Starts a item title. -
    • \c
      • Does not generate any output. +
    • \c
      Starts an item title. +
    • \c
      • Ends an item title.
    • \c Starts a piece of text displayed in an italic font.
    • \c Ends a \c section.
    • \c
      Does not generate any output. @@ -52,35 +52,34 @@ documentation. Note that all attributes of a HTML tag are ignored
    • \c Where ? is one of {3,4,5,6}, starts an unnumbered subsubsection using \c

      in HTML.
    • \c Where ? is one of {3,4,5,6}, ends an unnumbered subsubsection using \c

      in HTML.
    • \c Starts a piece of text displayed in an italic font. -
    • \c Does not generated any output. +
    • \c Does not generate any output.
    • \c Ends a \c section.
    • \c This command is written with attributes to the HTML output only.
    • \c
    • Starts a new list item. -
    • \c
      • Does not generate any output. +
    • \c
      • Ends a list item.
    • \c Does not generate any output. -
    • \c ignored by Doxygen. -
    • \c ignored by Doxygen. +
    • \c ignored by doxygen. +
    • \c ignored by doxygen.
    • \c
        Starts a numbered item list.
      1. \c
      Ends a numbered item list.
    • \c

      Starts a new paragraph. -

    • \c

      Does not generate any output. -
    • \c 
       starts a preformatted fragment.
-
    • \c
      • ends a preformatted fragment. -
    • \c starts a section of text displayed in a smaller font. -
    • \c ends a \c section. -
    • \c starts a section of bold text. -
    • \c ends a section of bold text. +
    • \c

      Ends a paragraph. +
    • \c 
         Starts a preformatted fragment.
+
    • \c
      • Ends a preformatted fragment. +
    • \c Starts a section of text displayed in a smaller font. +
    • \c Ends a \c section. +
    • \c Starts a section of bold text. +
    • \c Ends a section of bold text.
    • \c Starts a piece of text displayed in subscript.
    • \c Ends a \c section.
    • \c Starts a piece of text displayed in superscript.
    • \c Ends a \c section. -
    • \c starts a table, the available space of a page is always - divided equally amount the columns. -
    • \c
      • ends a table -
    • \c Starts a new table element. -
    • \c Does not generate any output. +
    • \c starts a table. +
    • \c
      • ends a table. +
    • \c Starts a new table data element. +
    • \c Ends a table data element.
    • \c Starts a new table row. -
    • \c Does not generate any output. +
    • \c Ends a table row.
    • \c Starts a piece of text displayed in a typewriter font.
    • \c Ends a \c section.
    • \c Starts a piece of text displayed in a typewriter font. diff --git a/doc/index.doc b/doc/index.doc index cb1b9c3..a66df37 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -14,7 +14,7 @@ * input used in their production; they are not affected by this license. * */ -/*! \page index +/*! \page index Index \if logo_on
      \htmlonly @@ -41,7 +41,7 @@ See the GNU General Public License for more details.

      -Documents produced by Doxygen are derivative works derived from the +Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license.

      Introduction

      @@ -54,7 +54,7 @@ It can help you in three ways: off-line reference manual (in \f$\mbox{\LaTeX}\f$) from a set of documented source files. There is also support for generating output in RTF (MS-Word), - Postscript, hyperlinked PDF, compressed HTML, and Unix man pages. + PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. @@ -70,7 +70,7 @@ It can help you in three ways: Doxygen is developed under Linux, but is set-up to be highly portable. As a result, it runs on most -other UNIX flavors as well. Furthermore, an executable for +other Unix flavors as well. Furthermore, an executable for Windows 9x/NT is also available. This manual is divided into two parts, each of which is divided into several @@ -98,17 +98,17 @@ The first part forms a user manual: The second part forms a reference manual:
        -
      • Section \ref features presents an overview of what Doxygen can do. +
      • Section \ref features presents an overview of what doxygen can do.
      • Section \ref history shows what has changed during the development - of Doxygen and what still has to be done. + of doxygen and what still has to be done.
      • Section \ref doxygen_usage shows how to use the \c doxygen program.
      • Section \ref doxytag_usage shows how to use the \c doxytag program.
      • Section \ref doxysearch_usage shows how to use the \c doxysearch program.
      • Section \ref doxywizard_usage shows how to use the \c doxywizard program.
      • Section \ref installdox_usage shows how to use the \c installdox - script that is generated by Doxygen if you use tag files. + script that is generated by doxygen if you use tag files.
      • Section \ref output shows how to generate the various output formats - supported by Doxygen. + supported by doxygen.
      • Section \ref autolink shows how to put links to files, classes, and members in the documentation.
      • Section \ref config shows how to fine-tune doxygen, so it @@ -151,9 +151,9 @@ Thanks go to:
          \addindex Doc++
        • Malte Zöckler and Roland Wunderling, authors of DOC++. - The first version of Doxygen borrowed some code of an old version of DOC++. + The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still - given me a good start in writing Doxygen. + given me a good start in writing doxygen.
        • All people at Troll Tech, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer :-)
        • My brother Frank diff --git a/doc/install.doc b/doc/install.doc index 2a5a6e6..79743b9 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -161,9 +161,10 @@ Compilation is now done by performing the following steps: make install \endverbatim - Binaries are installed in the directory \/bin - Documentation and examples in the directory - \/doc/doxygen + Binaries are installed in the directory \/bin, + documentation and examples in the directory + \/share/doc/packages/doxygen (use + DOCDIR\\ after make to change this). \ defaults to /usr but can be changed with the --prefix option of the configure script. @@ -182,12 +183,12 @@ Compilation is now done by performing the following steps: Qt problems -The Qt include files and libraries are not a sub directory of the -directory pointed to by QTDIR on some systems. +The Qt include files and libraries are not a subdirectory of the +directory pointed to by QTDIR on some systems (for instance on Red Hat 6.0 includes are in /usr/include/qt and -libs are in /usr/lib) +libs are in /usr/lib). -The solution: goto the root of the doxygen distribution and do: +The solution: go to the root of the doxygen distribution and do: \verbatim mkdir qt cd qt @@ -203,7 +204,7 @@ Now install doxygen as described above. Latex problems -the file a4wide.sty is not available for all distributions. If +The file a4wide.sty is not available for all distributions. If your distribution does not have it please select another paper type in the config file (see the \ref cfg_paper_type "PAPER_TYPE" tag in the config file). @@ -352,7 +353,7 @@ Here is what is required: Borland C++ or MINGW (see http://www.mingw.org) are also supported. -
        • Perl 5.0 or higher for Windows. This can be download from: +
        • Perl 5.0 or higher for Windows. This can be downloaded from: http://www.ActiveState.com/Products/ActivePerl/
        • The GNU tools flex, bison, and sed. @@ -390,7 +391,7 @@ Here is what is required: As a result doxygen can be compiled on systems without X11 or the commerical version of Qt. - For doxywizard, a complete Qt library this is + For doxywizard, a complete Qt library is still a requirement however. You may be interested in the professional license of Qt for Windows \latexonly\par (see @@ -400,7 +401,7 @@ Here is what is required:
        • To generate LaTeX documentation or formulas in HTML you need the tools: latex, dvips and gswin32. To get these working under Windows - install the fpTeX distribution You can download it at: + install the fpTeX distribution. You can download it at: ftp://ctan.tug.org/tex-archive/systems/win32/web2c/fptex-0.3/ Make sure the tools are available from a dos box, by adding the @@ -409,7 +410,7 @@ Here is what is required: For your information, the LaTeX is freely available set of so called macros and styles on the top of the famous TeX program (by famous Donald Knuth) and the accompanied utilities (all - available for free). It is used to for high quality + available for free). It is used for high quality typesetting. The result -- in the form of so called DVI (DeVice Independent) file -- can be printed or displayed on various devices preserving exactly the same look up @@ -457,7 +458,7 @@ Compilation is now done by performing the following steps: of the documentation into PostScript or PDF. It is \e not needed for compiling the doxygen's binaries. -
        • goto the doxygen root dir and type: +
        • Go to the doxygen root dir and type: \verbatim make.bat msvc @@ -486,10 +487,10 @@ Compilation is now done by performing the following steps: nmake \endverbatim - The generated docs int HTML are located in the ..\html + The generated HTML docs are located in the ..\html subdirectory. - The sources for LaTeX documentation are located in ..\latex + The sources for LaTeX documentation are located in the ..\latex subdirectory. From those sources, the DVI, PostScript, and PDF documentation can be generated. diff --git a/doc/maintainers.txt b/doc/maintainers.txt index bddd9d4..11a231a 100644 --- a/doc/maintainers.txt +++ b/doc/maintainers.txt @@ -30,6 +30,7 @@ French Christophe Bordeux: bordeux@lig.di.epfl.ch German +Jens Seidel: jensseidel@users.sourceforge.net Jens Breitenstein: Jens.Breitenstein@tlc.de Hungarian @@ -60,6 +61,9 @@ Alexandru Iosup: aiosup@yahoo.com Russian Alexandr Chelpanov: cav@cryptopro.ru +Slovak +Stanislav Kudlac: qwerty1@pobox.sk + Slovene Matjaz Ostroversnik: matjaz.ostroversnik@zrs-tk.si diff --git a/doc/output.doc b/doc/output.doc index 1c6508f..8e427a9 100644 --- a/doc/output.doc +++ b/doc/output.doc @@ -39,14 +39,14 @@ The following output formats are \e indirectly supported by doxygen:
          Compressed HTML (a.k.a. Windows 98 help)
          Generated by Microsoft's HTML Help workshop from the HTML output if \c GENERATE_HTMLHELP is set to \c YES. -
          Postscript +
          PostScript
          Generated from the \f$\mbox{\LaTeX}\f$ output by running make ps in the output directory. For the best results \c PDF_HYPERLINKS should be set to \c NO.
          PDF\htmlonly    \endhtmlonly
          Generated from the \f$\mbox{\LaTeX}\f$ output by running make pdf in the output directory. - In order to get hyperlinks in the pdf file, + In order to get hyperlinks in the PDF file, \c PDF_HYPERLINKS should be set to \c YES in the configuration file. diff --git a/doc/starting.doc b/doc/starting.doc index 927d2a0..b307788 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -105,7 +105,7 @@ doxygen Doxygen will create a \c html, \c rtf, \c latex and/or \c man directory inside the output directory. -As the names suggest the \c html directory contain the +As the names suggest these directories contain the generated documentation in HTML, RTF, \f$\mbox{\LaTeX}\f$ and Unix-Man page format. @@ -132,12 +132,12 @@ documentation, \c doxygen writes a \c Makefile into the \c latex directory. By typing \c make in the \c latex directory the dvi file \c refman.dvi will be generated (provided that you have a make tool called make of course). This file can then be viewed using \c xdvi or -converted into a postscript file \c refman.ps by +converted into a PostScript file \c refman.ps by typing make ps (this requires dvips). To put 2 pages on one physical page use make ps_2on1 instead. -The resulting Postscript file can be send to a postscript -printer. If you do not have a postscript printer, you can try to use -ghostscript to convert postscript into something your printer understands. +The resulting PostScript file can be send to a PostScript +printer. If you do not have a PostScript printer, you can try to use +ghostscript to convert PostScript into something your printer understands. Conversion to PDF is also possible if you have installed the ghostscript interpreter; just type make pdf (or make pdf_2on1). To get the best results for PDF output you should set diff --git a/examples/jdstyle.cpp b/examples/jdstyle.cpp index bbd2149..bd8b9a7 100644 --- a/examples/jdstyle.cpp +++ b/examples/jdstyle.cpp @@ -34,7 +34,7 @@ class Test /** * a normal member taking two arguments and returning an integer value. * @param a an integer argument. - * @param s a constant chararcter pointer. + * @param s a constant character pointer. * @see Test() * @see ~Test() * @see testMeToo() diff --git a/examples/qtstyle.cpp b/examples/qtstyle.cpp index de5ad34..e24d541 100644 --- a/examples/qtstyle.cpp +++ b/examples/qtstyle.cpp @@ -36,7 +36,7 @@ class Test //! A normal member taking two arguments and returning an integer value. /*! \param a an integer argument. - \param s a constant chararcter pointer. + \param s a constant character pointer. \return The test results \sa Test(), ~Test(), testMeToo() and publicVar() */ diff --git a/packages/rpm/doxygen.spec b/packages/rpm/doxygen.spec index b235205..ec266de 100644 --- a/packages/rpm/doxygen.spec +++ b/packages/rpm/doxygen.spec @@ -1,5 +1,5 @@ Name: doxygen -Version: 1.2.7_20010524 +Version: 1.2.8 Summary: documentation system for C, C++ and IDL Release: 3 Source: doxygen-%{version}.src.tar.gz diff --git a/qtools/qcstring.cpp b/qtools/qcstring.cpp index 2d2e0c5..44324c2 100644 --- a/qtools/qcstring.cpp +++ b/qtools/qcstring.cpp @@ -666,8 +666,8 @@ int QCString::find( char c, int index, bool cs ) const d = strchr( data()+index, c ); } else { d = data()+index; - c = tolower( c ); - while ( *d && tolower(*d) != c ) + c = tolower( (uchar) c ); + while ( *d && tolower((uchar) *d) != c ) d++; if ( !*d && c ) // not found d = 0; @@ -740,8 +740,8 @@ int QCString::findRev( char c, int index, bool cs ) const while ( d >= b && *d != c ) d--; } else { // case insensitive - c = tolower( c ); - while ( d >= b && tolower(*d) != c ) + c = tolower( (uchar) c ); + while ( d >= b && tolower((uchar) *d) != c ) d--; } return d >= b ? (int)(d - b) : -1; @@ -801,9 +801,9 @@ int QCString::contains( char c, bool cs ) const if ( *d++ == c ) count++; } else { // case insensitive - c = tolower( c ); + c = tolower( (uchar) c ); while ( *d ) { - if ( tolower(*d) == c ) + if ( tolower((uchar) *d) == c ) count++; d++; } @@ -1031,7 +1031,7 @@ QCString QCString::lower() const register char *p = s.data(); if ( p ) { while ( *p ) { - *p = tolower(*p); + *p = tolower((uchar) *p); p++; } } @@ -1059,7 +1059,7 @@ QCString QCString::upper() const register char *p = s.data(); if ( p ) { while ( *p ) { - *p = toupper(*p); + *p = toupper((uchar)*p); p++; } } @@ -1089,19 +1089,19 @@ QCString QCString::stripWhiteSpace() const register char *s = data(); QCString result = s; int reslen = result.length(); - if ( !isspace(s[0]) && !isspace(s[reslen-1]) ) + if ( !isspace((uchar) s[0]) && !isspace((uchar) s[reslen-1]) ) return result; // returns a copy s = result.data(); int start = 0; int end = reslen - 1; - while ( isspace(s[start]) ) // skip white space from start + while ( isspace((uchar) s[start]) ) // skip white space from start start++; if ( s[start] == '\0' ) { // only white space result.resize( 1 ); return result; } - while ( end && isspace(s[end]) ) // skip white space from end + while ( end && isspace((uchar) s[end]) ) // skip white space from end end--; end -= start - 1; memmove( result.data(), &s[start], end ); @@ -1134,9 +1134,9 @@ QCString QCString::simplifyWhiteSpace() const char *to = result.data(); char *first = to; while ( TRUE ) { - while ( *from && isspace(*from) ) + while ( *from && isspace((uchar) *from) ) from++; - while ( *from && !isspace(*from) ) + while ( *from && !isspace((uchar)*from) ) *to++ = *from++; if ( *from ) *to++ = 0x20; // ' ' @@ -1367,7 +1367,7 @@ long QCString::toLong( bool *ok ) const int neg = 0; if ( !p ) goto bye; - while ( isspace(*p) ) // skip leading space + while ( isspace((uchar)*p) ) // skip leading space p++; if ( *p == '-' ) { p++; @@ -1375,16 +1375,16 @@ long QCString::toLong( bool *ok ) const } else if ( *p == '+' ) { p++; } - if ( !isdigit(*p) ) + if ( !isdigit((uchar)*p) ) goto bye; - while ( isdigit(*p) ) { + while ( isdigit((uchar)*p) ) { if ( val > max_mult || (val == max_mult && (*p-'0') > 7+neg) ) goto bye; val = 10*val + (*p++ - '0'); } if ( neg ) val = -val; - while ( isspace(*p) ) // skip trailing space + while ( isspace((uchar)*p) ) // skip trailing space p++; if ( *p == '\0' ) is_ok = TRUE; @@ -1411,18 +1411,18 @@ ulong QCString::toULong( bool *ok ) const bool is_ok = FALSE; if ( !p ) goto bye; - while ( isspace(*p) ) // skip leading space + while ( isspace((uchar)*p) ) // skip leading space p++; if ( *p == '+' ) p++; - if ( !isdigit(*p) ) + if ( !isdigit((uchar)*p) ) goto bye; - while ( isdigit(*p) ) { + while ( isdigit((uchar)*p) ) { if ( val > max_mult || (val == max_mult && (*p-'0') > 5) ) goto bye; val = 10*val + (*p++ - '0'); } - while ( isspace(*p) ) // skip trailing space + while ( isspace((uchar)*p) ) // skip trailing space p++; if ( *p == '\0' ) is_ok = TRUE; diff --git a/src/config.h b/src/config.h index b690bcb..8874cff 100644 --- a/src/config.h +++ b/src/config.h @@ -48,79 +48,19 @@ class ConfigOption QCString docs() const { return m_doc; } QCString dependsOn() const { return m_dependency; } - void addDependency(const char *dep) - { - m_dependency = dep; - } + void addDependency(const char *dep) { m_dependency = dep; } protected: - virtual void writeTemplate(QTextStream &t,bool sl) = 0; + virtual void writeTemplate(QTextStream &t,bool sl,bool upd) = 0; virtual void convertStrToVal() {} - virtual void substEnvVars() {} + virtual void substEnvVars() = 0; virtual void init() {} - QCString convertToComment(const QCString &s) - { - QCString result; - if (s.isEmpty()) return result; - else - { - result+="# "; - QCString tmp=s.stripWhiteSpace(); - char *p=tmp.data(); - char c; - while ((c=*p++)) - { - if (c=='\n') result+="\n# "; - else result+=c; - } - result+='\n'; - } - return result; - } - - void writeBoolValue(QTextStream &t,bool v) - { - if (v) t << "YES"; else t << "NO"; - } - - void writeIntValue(QTextStream &t,int i) - { - t << i; - } - - void writeStringValue(QTextStream &t,QCString &s) - { - const char *p=s.data(); - char c; - bool hasBlanks=FALSE; - if (p) - { - while ((c=*p++)!=0 && !hasBlanks) hasBlanks = (c==' ' || c=='\n' || c=='\t'); - if (hasBlanks) - t << "\"" << s << "\""; - else - t << s; - } - } - - void writeStringList(QTextStream &t,QStrList &l) - { - const char *p = l.first(); - bool first=TRUE; - while (p) - { - char c; - const char *s=p; - bool hasBlanks=FALSE; - while ((c=*p++)!=0 && !hasBlanks) hasBlanks = (c==' ' || c=='\n' || c=='\t'); - if (!first) t << " "; - first=FALSE; - if (hasBlanks) t << "\"" << s << "\""; else t << s; - p = l.next(); - if (p) t << " \\" << endl; - } - } + QCString convertToComment(const QCString &s); + void writeBoolValue(QTextStream &t,bool v); + void writeIntValue(QTextStream &t,int i); + void writeStringValue(QTextStream &t,QCString &s); + void writeStringList(QTextStream &t,QStrList &l); QCString m_spaces; QCString m_name; @@ -141,7 +81,7 @@ class ConfigInfo : public ConfigOption m_name = name; m_doc = doc; } - void writeTemplate(QTextStream &t, bool sl) + void writeTemplate(QTextStream &t, bool sl,bool) { if (!sl) { @@ -151,6 +91,7 @@ class ConfigInfo : public ConfigOption t << "# " << m_doc << endl; t << "#---------------------------------------------------------------------------\n"; } + void substEnvVars() {} }; /*! \brief Option of the list type. @@ -171,7 +112,7 @@ class ConfigList : public ConfigOption void setWidgetType(WidgetType w) { m_widgetType = w; } WidgetType widgetType() const { return m_widgetType; } QStrList *valueRef() { return &m_value; } - void writeTemplate(QTextStream &t,bool sl) + void writeTemplate(QTextStream &t,bool sl,bool) { if (!sl) { @@ -209,7 +150,8 @@ class ConfigEnum : public ConfigOption return QStrListIterator(m_valueRange); } QCString *valueRef() { return &m_value; } - void writeTemplate(QTextStream &t,bool sl) + void substEnvVars(); + void writeTemplate(QTextStream &t,bool sl,bool) { if (!sl) { @@ -250,7 +192,7 @@ class ConfigString : public ConfigOption WidgetType widgetType() const { return m_widgetType; } void setDefaultValue(const char *v) { m_defValue = v; } QCString *valueRef() { return &m_value; } - void writeTemplate(QTextStream &t,bool sl) + void writeTemplate(QTextStream &t,bool sl,bool) { if (!sl) { @@ -292,7 +234,8 @@ class ConfigInt : public ConfigOption int minVal() const { return m_minVal; } int maxVal() const { return m_maxVal; } void convertStrToVal(); - void writeTemplate(QTextStream &t,bool sl) + void substEnvVars(); + void writeTemplate(QTextStream &t,bool sl,bool upd) { if (!sl) { @@ -301,7 +244,14 @@ class ConfigInt : public ConfigOption t << endl; } t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "= "; - writeIntValue(t,m_value); + if (upd) + { + writeStringValue(t,m_valueString); + } + else + { + writeIntValue(t,m_value); + } t << "\n"; } void init() { m_value = m_defValue; } @@ -327,8 +277,11 @@ class ConfigBool : public ConfigOption m_value = defVal; m_defValue = defVal; } + QCString *valueStringRef() { return &m_valueString; } bool *valueRef() { return &m_value; } - void writeTemplate(QTextStream &t,bool sl) + void convertStrToVal(); + void substEnvVars(); + void writeTemplate(QTextStream &t,bool sl,bool upd) { if (!sl) { @@ -337,13 +290,21 @@ class ConfigBool : public ConfigOption t << endl; } t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "= "; - writeBoolValue(t,m_value); + if (upd) + { + writeStringValue(t,m_valueString); + } + else + { + writeBoolValue(t,m_value); + } t << "\n"; } void init() { m_value = m_defValue; } private: bool m_value; bool m_defValue; + QCString m_valueString; }; #define Config_getString(val) Config::instance()->getString(__FILE__,__LINE__,val) @@ -512,7 +473,7 @@ class Config * is \c TRUE the description of each configuration option will * be omitted. */ - void writeTemplate(QFile *f,bool shortIndex); + void writeTemplate(QFile *f,bool shortIndex,bool updateOnly); ///////////////////////////// // internal API diff --git a/src/config.l b/src/config.l index e3a1813..061aa93 100644 --- a/src/config.l +++ b/src/config.l @@ -63,6 +63,75 @@ void initWarningFormat() #define YY_NEVER_INTERACTIVE 1 #define YY_NO_UNPUT +/* ----------------------------------------------------------------- + */ + +QCString ConfigOption::convertToComment(const QCString &s) +{ + QCString result; + if (s.isEmpty()) return result; + else + { + result+="# "; + QCString tmp=s.stripWhiteSpace(); + char *p=tmp.data(); + char c; + while ((c=*p++)) + { + if (c=='\n') result+="\n# "; + else result+=c; + } + result+='\n'; + } + return result; +} + +void ConfigOption::writeBoolValue(QTextStream &t,bool v) +{ + if (v) t << "YES"; else t << "NO"; +} + +void ConfigOption::writeIntValue(QTextStream &t,int i) +{ + t << i; +} + +void ConfigOption::writeStringValue(QTextStream &t,QCString &s) +{ + const char *p=s.data(); + char c; + bool hasBlanks=FALSE; + if (p) + { + while ((c=*p++)!=0 && !hasBlanks) hasBlanks = (c==' ' || c=='\n' || c=='\t'); + if (hasBlanks) + t << "\"" << s << "\""; + else + t << s; + } +} + +void ConfigOption::writeStringList(QTextStream &t,QStrList &l) +{ + const char *p = l.first(); + bool first=TRUE; + while (p) + { + char c; + const char *s=p; + bool hasBlanks=FALSE; + while ((c=*p++)!=0 && !hasBlanks) hasBlanks = (c==' ' || c=='\n' || c=='\t'); + if (!first) t << " "; + first=FALSE; + if (hasBlanks) t << "\"" << s << "\""; else t << s; + p = l.next(); + if (p) t << " \\" << endl; + } +} + +/* ----------------------------------------------------------------- + */ + Config *Config::m_instance = 0; void ConfigInt::convertStrToVal() @@ -73,13 +142,34 @@ void ConfigInt::convertStrToVal() int val = m_valueString.toInt(&ok); if (!ok || valm_maxVal) { - warn_cont("Warning: argument of %s is not a valid number in the range [%d..%d]!\n" - "Using the default of %d!\n",m_name.data(),m_minVal,m_maxVal,m_value); + warn_cont("Warning: argument `%s' for option %s is not a valid number in the range [%d..%d]!\n" + "Using the default: %d!\n",m_valueString.data(),m_name.data(),m_minVal,m_maxVal,m_value); } m_value=val; } } +void ConfigBool::convertStrToVal() +{ + QCString val = m_valueString.stripWhiteSpace().lower(); + if (!val.isEmpty()) + { + if (val=="yes" || val=="true" || val=="1") + { + m_value=TRUE; + } + else if (val=="no" || val=="false" || val=="0") + { + m_value=FALSE; + } + else + { + warn_cont("Warning: argument `%s' for option %s is not a valid boolean value\n" + "Using the default: %s!\n",m_valueString.data(),m_name.data(),m_value?"YES":"NO"); + } + } +} + QCString &Config::getString(const char *fileName,int num,const char *name) const { ConfigOption *opt = m_dict->find(name); @@ -362,8 +452,8 @@ static void readIncludeFile(const char *incName) BEGIN(GetString); break; case ConfigOption::O_Bool: - b = ((ConfigBool *)option)->valueRef(); - BEGIN(GetBool); + s = ((ConfigBool *)option)->valueStringRef(); + BEGIN(GetString); break; } } @@ -545,7 +635,7 @@ static void writeStringList(QTextStream &t,QStrList &l) } #endif -void Config::writeTemplate(QFile *f,bool sl) +void Config::writeTemplate(QFile *f,bool sl,bool upd) { QTextStream t(f); #ifdef DOXYWIZARD @@ -568,7 +658,7 @@ void Config::writeTemplate(QFile *f,bool sl) ConfigOption *option = m_options->first(); while (option) { - option->writeTemplate(t,sl); + option->writeTemplate(t,sl,upd); option = m_options->next(); } } @@ -691,6 +781,20 @@ void ConfigList::substEnvVars() substEnvVarsInStrList(m_value); } +void ConfigBool::substEnvVars() +{ + substEnvVarsInString(m_valueString); +} + +void ConfigInt::substEnvVars() +{ + substEnvVarsInString(m_valueString); +} + +void ConfigEnum::substEnvVars() +{ + substEnvVarsInString(m_value); +} void Config::substituteEnvironmentVars() { @@ -1602,7 +1706,7 @@ void Config::create() cb->addDependency("GENERATE_HTML"); cb = addBool( "TOC_EXPAND", - "The TOC_EXPAND flag can be set YES to add extra items for group members \n" + "The TOC_EXPAND flag can be set to YES to add extra items for group members \n" "to the contents of the Html help documentation and to the tree view. \n", FALSE ); @@ -1753,7 +1857,7 @@ void Config::create() "If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated \n" "will contain hyperlink fields. The RTF file will \n" "contain links (just like the HTML output) instead of page references. \n" - "This makes the output suitable for online browsing using a WORD or other. \n" + "This makes the output suitable for online browsing using WORD or other. \n" "programs which support those fields. \n" "Note: wordpad (write) and others do not support links. \n", FALSE diff --git a/src/defargs.l b/src/defargs.l index 68eaa91..e04d2ec 100644 --- a/src/defargs.l +++ b/src/defargs.l @@ -272,6 +272,7 @@ ID [a-z_A-Z][a-z_A-Z0-9]* a->array = removeRedundantWhiteSpace(g_curArgArray); a->defval = g_curArgDefValue.copy(); a->docs = g_curArgDocs.stripWhiteSpace(); + a->docs += "\n"; // for commands that need termination in doc.l (like \verbatim) //printf("Argument `%s' `%s' adding docs=`%s'\n",a->type.data(),a->name.data(),a->docs.data()); g_argList->append(a); } diff --git a/src/doc.l b/src/doc.l index 61dd582..7638fdd 100644 --- a/src/doc.l +++ b/src/doc.l @@ -279,15 +279,6 @@ static void forceEndTable() //----------------------------------------------------------------------------- -static void endArgumentList() -{ - if (insideArgumentList) - { - insideArgumentList=FALSE; - outDoc->endItemList(); - } -} - static void includeFile(OutputDocInterface &od,const char *fileName,bool quiet) { bool ambig; @@ -645,6 +636,35 @@ static void forceEndItemList() insideItemList=FALSE; } +static void endArgumentList() +{ +#if 0 + IndentInfo *info; + while ((info=listIndentStack.pop())!=0) + { + delete info; + } + while (!currentListIndent.isEmpty()) + { + char c=*currentListIndent.pop(); + switch(c) + { + case 'O': outDoc->endEnumList(); break; + case 'U': outDoc->endItemList(); break; + case 'D': + if (!inBlock()) outDoc->endDescription(); + break; + } + } + insideItemList=FALSE; +#endif + if (insideArgumentList) + { + insideArgumentList=FALSE; + outDoc->endItemList(); + } +} + //----------------------------------------------------------------- enum ImageTypes @@ -1697,6 +1717,7 @@ OPMASK ({B}*{OPNORM}({OPARG}?))|({OPCAST}{OPARG}) BEGIN(DocScan); } ({SCOPENAME}|{FILE}){B}+/"\"" { + //printf(">>> ref `%s'\n",yytext); sectionRef=yytext; sectionRef=sectionRef.stripWhiteSpace(); BEGIN(DocRefArgStart); @@ -1710,6 +1731,7 @@ OPMASK ({B}*{OPNORM}({OPARG}?))|({OPCAST}{OPARG}) SectionInfo *sec; if ((sec=Doxygen::sectionDict[sectionRef])) { + //printf("Is a section!\n"); if (sec->type==SectionInfo::Anchor) { outDoc->writeObjectLink(sec->ref,sec->fileName,sec->label,text); diff --git a/src/dot.cpp b/src/dot.cpp index 4aae44d..69dc041 100644 --- a/src/dot.cpp +++ b/src/dot.cpp @@ -290,8 +290,18 @@ static void computeTemplateInstance( QCString templSpec; while (extractClassNameFromType(actualArg,pos,name,templSpec)) { + Definition *scopeDef = cd->getOuterScope(); + QCString scopeName; + if (scopeDef) scopeName = scopeDef->qualifiedName(); //printf("name=%s templSpec=%s\n",name.data(),templSpec.data()); - ClassDef *acd=getResolvedClass(name); + ClassDef *acd=0; + + // try with scope. + if (!scopeName.isEmpty()) + acd = getResolvedClass(scopeName+"::"+name); + // try without scope. + // TODO: try intermediate scopes as well! + if (acd==0) acd = getResolvedClass(name); if (acd && !templSpec.isEmpty()) { // store specific template instance in the class diff --git a/src/doxygen.cpp b/src/doxygen.cpp index 372c53a..1ae907e 100644 --- a/src/doxygen.cpp +++ b/src/doxygen.cpp @@ -256,10 +256,17 @@ static void addRelatedPage(const char *name,const QCString &ptitle, { si->fileName=gd->getOutputFileBase(); } + else if (pi->inGroup) + { + si->fileName=pi->inGroup->getOutputFileBase().copy(); + } else { si->fileName=pageName; } + //printf("si->label=`%s' si->definition=%s si->fileName=`%s'\n", + // si->label.data(),si->definition?si->definition->name().data():"", + // si->fileName.data()); //printf(" SectionInfo: sec=%p sec->fileName=%s\n",si,si->fileName.data()); //printf("Adding section info %s\n",pi->name.data()); Doxygen::sectionDict.insert(pageName,si); @@ -2362,8 +2369,13 @@ static bool findBaseClassRelation( baseClassName.prepend(scopeName.left(scopeOffset)+"::"); } bool baseClassIsTypeDef; - ClassDef *baseClass=getResolvedClass(baseClassName,&baseClassIsTypeDef); - //printf("baseClassName=`%s' baseClass=%p\n",baseClassName.data(),baseClass); + QCString templSpec; + ClassDef *baseClass=getResolvedClass(baseClassName,&baseClassIsTypeDef,&templSpec); + //printf(" baseClassName=`%s' baseClass=%s templSpec=%s\n", + // baseClassName.data(), + // baseClass?baseClass->name().data():"", + // templSpec.data() + // ); if (baseClassName!=root->name) // check for base class with the same name, // look in the outer scope for a match { @@ -2376,7 +2388,6 @@ static bool findBaseClassRelation( ); int i; - QCString templSpec; if (baseClass==0 && (i=baseClassName.find('<'))!=-1) // base class has template specifiers { @@ -2510,7 +2521,7 @@ static bool findBaseClassRelation( } if (isTemplBaseClass==-1 && found) { - Debug::print(Debug::Classes,0," Documented base class `%s'\n",bi->name.data()); + Debug::print(Debug::Classes,0," Documented base class `%s' templSpec=%s\n",bi->name.data(),templSpec.data()); // add base class to this class QCString usedName; if (baseClassIsTypeDef) usedName=bi->name; @@ -3681,11 +3692,12 @@ static void findMember(Entry *root, FileDef *fd=findFileDef(Doxygen::inputNameDict,root->fileName,ambig); // list of namespaces using in the file that this member definition is part of NamespaceList *nl = fd ? fd->getUsedNamespaces() : 0; + ClassList *cl = fd ? fd->getUsedClasses() : 0; bool matching= md->isVariable() || md->isTypedef() || // needed for function pointers (md->argumentList()==0 && root->argList->count()==0) || - matchArguments(argList, root->argList,className,namespaceName,TRUE,nl); + matchArguments(argList, root->argList,className,namespaceName,TRUE,nl,cl); Debug::print(Debug::FindMembers,0, @@ -4952,7 +4964,10 @@ static void buildPageList(Entry *root) { QCString title=root->args.stripWhiteSpace(); if (title.isEmpty()) title=theTranslator->trMainPage(); - addRefItem(root->todoId,root->testId,root->bugId,"page","index",title); + addRefItem(root->todoId,root->testId,root->bugId,"page", + Config_getBool("GENERATE_TREEVIEW")?"main":"index", + title + ); } EntryListIterator eli(*root->sublist); Entry *e; @@ -4970,17 +4985,18 @@ static void findMainPage(Entry *root) { //printf("Found main page! \n======\n%s\n=======\n",root->doc.data()); QCString title=root->args.stripWhiteSpace(); + QCString indexName=Config_getBool("GENERATE_TREEVIEW")?"main":"index"; Doxygen::mainPage = new PageInfo(root->fileName,root->startLine, - "index", root->doc,title); + indexName, root->doc,title); //setFileNameForSections(root->anchors,"index",Doxygen::mainPage); - Doxygen::mainPage->fileName = "index"; + Doxygen::mainPage->fileName = indexName; Doxygen::mainPage->addSections(root->anchors); // a page name is a label as well! SectionInfo *si=new SectionInfo( Doxygen::mainPage->name,Doxygen::mainPage->title,SectionInfo::Section); - si->fileName="index"; - Doxygen::sectionDict.insert("index",si); + si->fileName=indexName; + Doxygen::sectionDict.insert(indexName,si); } else { @@ -5057,13 +5073,39 @@ static void resolveUserReferences() SectionInfo *si; for (;(si=sdi.current());++sdi) { + //printf("si->label=`%s' si->definition=%s si->fileName=`%s'\n", + // si->label.data(),si->definition?si->definition->name().data():"", + // si->fileName.data()); + PageInfo *pi=0; + + // if this section is in a page and the page is in a group, then we + // have to adjust the link file name to point to the group. + if (!si->fileName.isEmpty() && + (pi=Doxygen::pageSDict->find(si->fileName)) && + pi->inGroup) + { + si->fileName=pi->inGroup->getOutputFileBase().copy(); + } + + if (si->definition) { - //printf("si=`%s' def=`%s' file=`%s'\n", - // si->label.data(), - // si->definition->name().data(), - // si->definition->getOutputFileBase().data()); - si->fileName=si->definition->getOutputFileBase().copy(); + // TODO: there should be one function in Definition that returns + // the file to link to, so we can avoid the following tests. + GroupDef *gd=0; + if (si->definition->definitionType()==Definition::TypeMember) + { + gd = ((MemberDef *)si->definition)->getGroupDef(); + } + + if (gd) + { + si->fileName=gd->getOutputFileBase().copy(); + } + else + { + si->fileName=si->definition->getOutputFileBase().copy(); + } } // hack: the items of a todo/test list are all fragments from different files, // so the resulting section's all have the wrong file name (not from the @@ -5421,7 +5463,7 @@ static void generateConfigFile(const char *configFile,bool shortList, bool writeToStdout=(configFile[0]=='-' && configFile[1]=='\0'); if (fileOpened) { - Config::instance()->writeTemplate(&f,shortList); + Config::instance()->writeTemplate(&f,shortList,updateOnly); if (!writeToStdout) { if (!updateOnly) @@ -6006,8 +6048,8 @@ void readConfiguration(int argc, char **argv) QCString configFile=fileToString(argv[optind+4]); if (configFile.isEmpty()) exit(1); Config::instance()->parse(fileToString(argv[optind+4]),argv[optind+4]); - Config::instance()->convertStrToVal(); Config::instance()->substituteEnvironmentVars(); + Config::instance()->convertStrToVal(); Config::instance()->check(); } else @@ -6044,8 +6086,8 @@ void readConfiguration(int argc, char **argv) QCString configFile=fileToString(argv[optind+3]); if (configFile.isEmpty()) exit(1); Config::instance()->parse(fileToString(argv[optind+3]),argv[optind+3]); - Config::instance()->convertStrToVal(); Config::instance()->substituteEnvironmentVars(); + Config::instance()->convertStrToVal(); Config::instance()->check(); } else // use default config @@ -6144,7 +6186,6 @@ void readConfiguration(int argc, char **argv) } Config::instance()->parse(config,configName); - Config::instance()->convertStrToVal(); if (updateConfig) { @@ -6153,6 +6194,7 @@ void readConfiguration(int argc, char **argv) } Config::instance()->substituteEnvironmentVars(); + Config::instance()->convertStrToVal(); Config::instance()->check(); } diff --git a/src/ftvhelp.cpp b/src/ftvhelp.cpp index 2dfe90c..38c2e72 100644 --- a/src/ftvhelp.cpp +++ b/src/ftvhelp.cpp @@ -274,6 +274,9 @@ static void generateFolderTreeViewData() else { QTextStream t(&f); +#if QT_VERSION >= 200 + t.setEncoding(QTextStream::Latin1); +#endif t << ""; t << "idLanguageCharset() << "\">\n"; @@ -389,6 +392,10 @@ void FTVHelp::initialize() } /* Write the header of the contents file */ m_cts.setDevice(m_cf); +#if QT_VERSION >= 200 + m_cts.setEncoding(QTextStream::Latin1); +#endif + m_cts << "foldersTree = gFld(\""; if (Config_getString("PROJECT_NAME").isEmpty()) { diff --git a/src/groupdef.cpp b/src/groupdef.cpp index 752dc4c..1c3123c 100644 --- a/src/groupdef.cpp +++ b/src/groupdef.cpp @@ -642,7 +642,7 @@ void addMemberToGroups(Entry *root,MemberDef *md) GroupDef *fgd=0; for (;(g=gli.current());++gli) { - GroupDef *gd; + GroupDef *gd=0; if (!g->groupname.isEmpty() && (gd=Doxygen::groupDict[g->groupname]) && g->pri >= pri) diff --git a/src/htmlgen.cpp b/src/htmlgen.cpp index 2ff36de..0c82986 100644 --- a/src/htmlgen.cpp +++ b/src/htmlgen.cpp @@ -132,6 +132,9 @@ static void writeDefaultHeaderFile(QTextStream &t,const char *title, void HtmlGenerator::writeHeaderFile(QFile &file) { QTextStream t(&file); +#if QT_VERSION >= 200 + t.setEncoding(QTextStream::Latin1); +#endif writeDefaultHeaderFile(t,"$title",FALSE); } @@ -139,11 +142,11 @@ void HtmlGenerator::writeFooterFile(QFile &file) { QTextStream t(&file); t << "
          \n"; - t << "Generated at $datetime for $projectname "; - t << " by \n" + t << theTranslator->trGeneratedAt( "$datetime", "$projectname" ); + t << " \n" << "\"doxygen\"\n" - << " $doxygenversion written by" + << " $doxygenversion " << theTranslator->trWrittenBy() << " Dimitri van Heesch,\n" << " © 1997-2001
          \n" << "\n" @@ -172,7 +175,8 @@ void HtmlGenerator::startFile(const char *name,const char *, { t << substituteKeywords(g_header,lastTitle); } - t << "" << endl; + t << "" << endl; } void HtmlGenerator::startQuickIndexItem(const char *s,const char *l) @@ -289,7 +293,7 @@ void HtmlGenerator::writeStyleInfo(int part) } } -void HtmlGenerator::startDoxyAnchor(const char *, +void HtmlGenerator::startDoxyAnchor(const char *,const char *, const char *anchor, const char *name) { t << ""; diff --git a/src/htmlgen.h b/src/htmlgen.h index e293e98..e334572 100644 --- a/src/htmlgen.h +++ b/src/htmlgen.h @@ -138,7 +138,8 @@ class HtmlGenerator : public OutputGenerator void endMemberDoc(); //void writeDoxyAnchor(const char *fName,const char *clName, // const char *anchor,const char *name); - void startDoxyAnchor(const char *fName,const char *anchor,const char *name); + void startDoxyAnchor(const char *fName,const char *manName, + const char *anchor,const char *name); void endDoxyAnchor(const char *fName,const char *anchor); void startCodeAnchor(const char *label) { t << ""; } void endCodeAnchor() { } diff --git a/src/htmlhelp.cpp b/src/htmlhelp.cpp index f49374f..482b53a 100644 --- a/src/htmlhelp.cpp +++ b/src/htmlhelp.cpp @@ -264,6 +264,9 @@ void HtmlHelp::initialize() } /* Write the header of the contents file */ cts.setDevice(cf); +#if QT_VERSION >= 200 + cts.setEncoding(QTextStream::Latin1); +#endif cts << "\n" "\n" "\n" @@ -281,6 +284,9 @@ void HtmlHelp::initialize() } /* Write the header of the contents file */ kts.setDevice(kf); +#if QT_VERSION >= 200 + kts.setEncoding(QTextStream::Latin1); +#endif kts << "\n" "\n" "\n" @@ -297,6 +303,10 @@ void HtmlHelp::createProjectFile() if (f.open(IO_WriteOnly)) { QTextStream t(&f); +#if QT_VERSION >= 200 + t.setEncoding(QTextStream::Latin1); +#endif + QCString indexName="index.html"; if (Config_getBool("GENERATE_TREEVIEW")) indexName="main.html"; t << "[OPTIONS]\n" diff --git a/src/language.cpp b/src/language.cpp index 32bf52a..87e4c13 100644 --- a/src/language.cpp +++ b/src/language.cpp @@ -42,6 +42,7 @@ #include "translator_no.h" #include "translator_br.h" #include "translator_dk.h" +#include "translator_sk.h" #endif #define L_EQUAL(a) !stricmp(langName,a) @@ -139,6 +140,10 @@ bool setTranslator(const char *langName) { theTranslator=new TranslatorDanish; } + else if (L_EQUAL("slovak")) + { + theTranslator=new TranslatorSlovak; + } #endif else // use the default language (i.e. english) { diff --git a/src/latexgen.cpp b/src/latexgen.cpp index e176192..e21e7d8 100644 --- a/src/latexgen.cpp +++ b/src/latexgen.cpp @@ -390,21 +390,20 @@ void LatexGenerator::writeHeaderFile(QFile &f) void LatexGenerator::writeStyleSheetFile(QFile &f) { QTextStream t(&f); +#if QT_VERSION >= 200 + t.setEncoding(QTextStream::Latin1); +#endif + writeDefaultStyleSheetPart1(t); QCString &projectName = Config_getString("PROJECT_NAME"); - t << "Generated at " << dateToString(TRUE); - if (projectName.isEmpty()) - { - t << " for " << projectName << " "; - } - t << "by doxygen written by Dimitri van Heesch \\copyright~1997-2001"; + + t << theTranslator->trGeneratedAt( dateToString(TRUE), projectName ); + t << " doxygen " << theTranslator->trWrittenBy() << " "; + t << "Dimitri van Heesch \\copyright~1997-2001"; writeDefaultStyleSheetPart2(t); - t << "Generated at " << dateToString(TRUE); - if (projectName.isEmpty()) - { - t << " for " << projectName << " "; - } - t << "by doxygen written by Dimitri van Heesch \\copyright~1997-2001"; + t << theTranslator->trGeneratedAt( dateToString(TRUE), projectName ); + t << " doxygen " << theTranslator->trWrittenBy() << " "; + t << "Dimitri van Heesch \\copyright~1997-2001"; writeDefaultStyleSheetPart3(t); } @@ -1096,8 +1095,8 @@ void LatexGenerator::endMemberDoc() if (Config_getBool("COMPACT_LATEX")) t << "\\hfill"; } -void LatexGenerator::startDoxyAnchor(const char *fName,const char *anchor, - const char *) +void LatexGenerator::startDoxyAnchor(const char *fName,const char *, + const char *anchor, const char *) { if (Config_getBool("PDF_HYPERLINKS")) { diff --git a/src/latexgen.h b/src/latexgen.h index 4d07b51..fec4a2d 100644 --- a/src/latexgen.h +++ b/src/latexgen.h @@ -133,7 +133,7 @@ class LatexGenerator : public OutputGenerator void lineBreak() { t << "\\par\n"; } void startMemberDoc(const char *,const char *,const char *,const char *); void endMemberDoc(); - void startDoxyAnchor(const char *,const char *,const char *); + void startDoxyAnchor(const char *,const char *,const char *,const char *); void endDoxyAnchor(const char *,const char *); void startCodeAnchor(const char *) {} void endCodeAnchor() {} diff --git a/src/mangen.cpp b/src/mangen.cpp index bdf3795..ad3e63a 100644 --- a/src/mangen.cpp +++ b/src/mangen.cpp @@ -372,30 +372,17 @@ void ManGenerator::startMemberDoc(const char *,const char *,const char *,const c paragraph=FALSE; } -void ManGenerator::startDoxyAnchor(const char *fname,const char *, - const char *name) +void ManGenerator::startDoxyAnchor(const char *,const char *manName, + const char *, const char *) { - const char *basename; - // something to be done? if( !Config_getBool("MAN_LINKS") ) { return; // no } - // truncate after an (optional) :: - basename = strrchr( name, ':' ); - if ( !basename ) - { - basename = name; - } - else - { - basename++; - } - // only create file when it doesn't exist - QCString fileName=dir+"/"+buildFileName( basename ); + QCString fileName=dir+"/"+buildFileName( manName ); QFile linkfile( fileName ); if ( !linkfile.open( IO_ReadOnly ) ) { @@ -406,7 +393,7 @@ void ManGenerator::startDoxyAnchor(const char *fname,const char *, #if QT_VERSION >= 200 linkstream.setEncoding(QTextStream::Latin1); #endif - linkstream << ".so man" << getExtension() << "/" << buildFileName( fname ) << endl; + linkstream << ".so man" << getExtension() << "/" << buildFileName( manName ) << endl; } } linkfile.close(); diff --git a/src/mangen.h b/src/mangen.h index 818f325..ba362fd 100644 --- a/src/mangen.h +++ b/src/mangen.h @@ -126,7 +126,7 @@ class ManGenerator : public OutputGenerator void writeChar(char c); void startMemberDoc(const char *,const char *,const char *,const char *); void endMemberDoc(); - void startDoxyAnchor(const char *,const char *,const char *); + void startDoxyAnchor(const char *,const char *,const char *,const char *); void endDoxyAnchor(const char *,const char *) {} void startCodeAnchor(const char *) {} void endCodeAnchor() {} diff --git a/src/memberdef.cpp b/src/memberdef.cpp index 0d4aa98..cff02af 100644 --- a/src/memberdef.cpp +++ b/src/memberdef.cpp @@ -597,7 +597,7 @@ void MemberDef::writeDeclaration(OutputList &ol, { QCString doxyName=name().copy(); if (!cname.isEmpty()) doxyName.prepend(cname+"::"); - ol.startDoxyAnchor(cfname,anchor(),doxyName); + ol.startDoxyAnchor(cfname,cname,anchor(),doxyName); ol.addIndexItem(name(),cname); ol.addIndexItem(cname,name()); @@ -912,7 +912,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, { if (vmd->isEnumerate() && ldef.mid(i,l)==vmd->name()) { - ol.startDoxyAnchor(cfname,anchor(),doxyName); + ol.startDoxyAnchor(cfname,cname,anchor(),doxyName); ol.startMemberDoc(cname,name(),anchor(),name()); if (hasHtmlHelp) { @@ -928,7 +928,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, if (!found) // anonymous compound { //printf("Anonymous compound `%s'\n",cname.data()); - ol.startDoxyAnchor(cfname,anchor(),doxyName); + ol.startDoxyAnchor(cfname,cname,anchor(),doxyName); ol.startMemberDoc(cname,name(),anchor(),name()); if (hasHtmlHelp) { @@ -950,7 +950,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, } else { - ol.startDoxyAnchor(cfname,anchor(),doxyName); + ol.startDoxyAnchor(cfname,cname,anchor(),doxyName); ol.startMemberDoc(cname,name(),anchor(),name()); if (hasHtmlHelp) { @@ -1189,7 +1189,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, } //ol.writeListItem(); ol.startDescTableTitle(); - ol.startDoxyAnchor(cfname,fmd->anchor(),fmd->name()); + ol.startDoxyAnchor(cfname,cname,fmd->anchor(),fmd->name()); first=FALSE; ol.startEmphasis(); ol.docify(fmd->name()); diff --git a/src/outputgen.h b/src/outputgen.h index 438fa4d..d8c7917 100644 --- a/src/outputgen.h +++ b/src/outputgen.h @@ -329,8 +329,8 @@ class OutputGenerator : public BaseOutputDocInterface virtual void startMemberDoc(const char *,const char *, const char *,const char *) = 0; virtual void endMemberDoc() = 0; - virtual void startDoxyAnchor(const char *fName,const char *anchor, - const char *name) = 0; + virtual void startDoxyAnchor(const char *fName,const char *manName, + const char *anchor,const char *name) = 0; virtual void endDoxyAnchor(const char *fileName,const char *anchor) = 0; virtual void writeLatexSpacing() = 0; virtual void writeStartAnnoItem(const char *type,const char *file, diff --git a/src/outputlist.h b/src/outputlist.h index 3660d97..c19d5d5 100644 --- a/src/outputlist.h +++ b/src/outputlist.h @@ -219,8 +219,9 @@ class OutputList : public OutputDocInterface { forall(&OutputGenerator::startMemberDoc,clName,memName,anchor,title); } void endMemberDoc() { forall(&OutputGenerator::endMemberDoc); } - void startDoxyAnchor(const char *fName,const char *anchor, const char *name) - { forall(&OutputGenerator::startDoxyAnchor,fName,anchor,name); } + void startDoxyAnchor(const char *fName,const char *manName, + const char *anchor, const char *name) + { forall(&OutputGenerator::startDoxyAnchor,fName,manName,anchor,name); } void endDoxyAnchor(const char *fn,const char *anchor) { forall(&OutputGenerator::endDoxyAnchor,fn,anchor); } void startCodeAnchor(const char *label) diff --git a/src/rtfgen.cpp b/src/rtfgen.cpp index 8a8c31f..9e2213e 100644 --- a/src/rtfgen.cpp +++ b/src/rtfgen.cpp @@ -565,6 +565,10 @@ static void loadStylesheet(const char *name, QDict& dict) static const QRegExp separator("[ \t]*=[ \t]*"); uint lineNr=1; QTextStream t(&file); +#if QT_VERSION >= 200 + t.setEncoding(QTextStream::Latin1); +#endif + while (!t.eof()) { QCString s(4096); // string buffer of max line length @@ -663,6 +667,10 @@ static void loadExtensions(const char *name) static const QRegExp separator("[ \t]*=[ \t]*"); uint lineNr=1; QTextStream t(&file); +#if QT_VERSION >= 200 + t.setEncoding(QTextStream::Latin1); +#endif + while (!t.eof()) { QCString s(4096); // string buffer of max line length @@ -1806,7 +1814,8 @@ void RTFGenerator::endMemberDoc() newParagraph(); } -void RTFGenerator::startDoxyAnchor(const char *,const char *,const char *) +void RTFGenerator::startDoxyAnchor(const char *,const char *, + const char *,const char *) { } @@ -2593,6 +2602,9 @@ bool RTFGenerator::preProcessFileInplace(const char *path,const char *name) return FALSE; } QTextStream outt(&outf); +#if QT_VERSION >= 200 + outt.setEncoding(QTextStream::Latin1); +#endif if (!PreProcessFile(thisDir,mainRTFName,outt)) { diff --git a/src/rtfgen.h b/src/rtfgen.h index 15d0ffc..9dcfb70 100644 --- a/src/rtfgen.h +++ b/src/rtfgen.h @@ -125,7 +125,7 @@ class RTFGenerator : public OutputGenerator void lineBreak(); void startMemberDoc(const char *,const char *,const char *,const char *); void endMemberDoc(); - void startDoxyAnchor(const char *,const char *,const char *); + void startDoxyAnchor(const char *,const char *,const char *,const char *); void endDoxyAnchor(const char *,const char *); void startCodeAnchor(const char *) {}; void endCodeAnchor() {}; diff --git a/src/scanner.l b/src/scanner.l index 4d1dda8..cb158bb 100644 --- a/src/scanner.l +++ b/src/scanner.l @@ -3635,6 +3635,7 @@ TITLE [tT][iI][tT][lL][eE] // insert \n and decrement the line number to compensate for the artifical newline unput('\n'); yyLineNr--; + BEGIN( Doc ); } "*/" { current->name = yyFileName; diff --git a/src/translator_cz.h b/src/translator_cz.h index 64cd8d2..551b6e8 100644 --- a/src/translator_cz.h +++ b/src/translator_cz.h @@ -119,7 +119,19 @@ // the context better. // - Implemented new method trAuthor(params). // - Removed obsolete methods trAuthor() and trAuthors(). +// +// 2001/05/25 +// - Updated misleading information in trLegendDocs(). +// - The trReimplementedInList() updated to fit the context better. +// - The trReimplementedFromList() updated to fit the context better. // +// Todo +// ---- +// - The trReimplementedFromList() should pass the kind of the +// reimplemented element. It can be method, typedef or possibly +// something else. It is difficult to find the general translation +// for all kinds in the Czech language. +// // Notices: // -------- // The conditional compilation ensures or the neutral functionality @@ -148,7 +160,7 @@ class TranslatorCzech : public Translator } public: - // --- Language contol methods ------------------- + // --- Language control methods ------------------- virtual QCString idLanguage() { return "czech"; } @@ -560,7 +572,7 @@ class TranslatorCzech : public Translator * list of (global) variables */ virtual QCString trEnumerationValues() - { return decode("Hodnoty výčtů"); } + { return decode("Hodnoty výčtu"); } /*! This is used in the documentation of a file before the list of * documentation blocks for defines @@ -757,7 +769,7 @@ class TranslatorCzech : public Translator return decode(result); } - /*! \mgroup Class sections + /*! * these are for the member sections of a class, struct or union */ virtual QCString trPublicMembers() @@ -780,7 +792,6 @@ class TranslatorCzech : public Translator { return decode("Privátní sloty"); } virtual QCString trStaticPrivateMembers() { return decode("Statické privátní metody"); } - /*! \endmgroup */ /*! this function is used to produce a comma-separated list of items. * use generateMarker(i) to indicate where item i should be put. @@ -834,8 +845,7 @@ class TranslatorCzech : public Translator */ virtual QCString trReimplementedFromList(int numEntries) { - QCString result("Reimplementuje "); - result += (numEntries == 1) ? "metodu třídy " : "metody tříd "; + QCString result("Reimplementuje stejnojmenný prvek z "); result += trWriteList(numEntries)+"."; return decode(result); } @@ -845,8 +855,7 @@ class TranslatorCzech : public Translator */ virtual QCString trReimplementedInList(int numEntries) { - QCString result("Reimplementováno "); - result += (numEntries == 1) ? "třídou " : "třídami "; + QCString result("Reimplementováno v "); result += trWriteList(numEntries)+"."; return decode(result); } @@ -1157,11 +1166,13 @@ class TranslatorCzech : public Translator "class Truncated : public Invisible { };\n\n" "/* Třída, která není dokumentována komentáři programu doxygen. */\n" "class Undocumented { };\n\n" - "/*! Odvozená třída s veřejným (public) děděním bázové třídy. */\n" + "/*! Bázová třída děděná veřejně (public inheritance). */\n" "class PublicBase : public Truncated { };\n\n" - "/*! Odvozená třída s chráněným (protected) děděním bázové třídy. */\n" + "/*! Bázová třída, použitá pro chráněné dědění " + "(protected inheritance). */\n" "class ProtectedBase { };\n\n" - "/*! Odvozená třída s privátním děděním bázové třídy. */\n" + "/*! Bázová třída, využitá pro privátní dědění " + "(private inheritance). */\n" "class PrivateBase { };\n\n" "/*! Třída, která je využívána třídou Inherited. */\n" "class Used { };\n\n" @@ -1197,10 +1208,11 @@ class TranslatorCzech : public Translator "Šipky (tj. hrany grafu) mají následující význam:\n" "
            \n" "
          • Tmavě modrá šipka se používá pro označení vztahu veřejné " - "dědičnosti mezi dvěma třídami.\n" + "dědičnosti (public) mezi dvěma třídami.\n" "
          • Tmavě zelená šipka označuje vztah chráněné dědičnosti " "(protected).\n" - "
          • Tmavě červená šipka označuje vztah privátní dědičnosti.\n" + "
          • Tmavě červená šipka označuje vztah privátní dědičnosti " + "(private).\n" "
          • Purpurová šipka kreslená čárkovaně se používá v případě, " "kdy je třída obsažena v jiné třídě,\n" "nebo kdy je používána jinou třídou. Je označena identifikátorem " diff --git a/src/translator_de.h b/src/translator_de.h index f926ac6..b3d26dd 100644 --- a/src/translator_de.h +++ b/src/translator_de.h @@ -45,6 +45,10 @@ // - Removed implementation of latexBabelPackage(), trVerbatimText(), // trFiles(), added latexLanguageSupportCommand(). // +// 2001/05/25 Jens Seidel (jensseidel@users.sourceforge.net) +// - Update for "new since 1.2.7-20010524" version: +// removed trAuthors(), trAuthor(), added trAuthor(bool, bool) +// // Todo: // - translation of all Config_getBool("OPTIMIZE_OUTPUT_FOR_C") // strings (see translator.h) @@ -58,9 +62,7 @@ #ifndef TRANSLATOR_DE_H #define TRANSLATOR_DE_H -#include "translator.h" - -class TranslatorGerman : public TranslatorAdapterCVS +class TranslatorGerman : public Translator { public: @@ -398,10 +400,6 @@ class TranslatorGerman : public TranslatorAdapterCVS virtual QCString trEnumerationValues() { return "Aufzählungswerte"; } - /* This is used in man pages as the author section. */ - virtual QCString trAuthor() - { return "Autor"; } - /* This is used in the documentation of a file before the list of * documentation blocks for defines */ @@ -499,10 +497,6 @@ class TranslatorGerman : public TranslatorAdapterCVS virtual QCString trDate() { return "Datum"; } - /* this text is generated when the \author command is used. */ - virtual QCString trAuthors() - { return "Autor(en)"; } - /* this text is generated when the \return command is used. */ virtual QCString trReturns() { return "Rückgabe"; } @@ -1293,6 +1287,20 @@ class TranslatorGerman : public TranslatorAdapterCVS return result; } + ////////////////////////////////////////////////////////////////////////// + // new since 1.2.7-20010524 + ////////////////////////////////////////////////////////////////////////// + + /* This text is generated when the \author command is used and + * for the author section in man pages. + */ + virtual QCString trAuthor(bool, bool singular) + { + QCString result("Autor"); + if (!singular) result+="en"; + return result; + } + }; #endif diff --git a/src/translator_en.h b/src/translator_en.h index 27d2da3..16b2c65 100644 --- a/src/translator_en.h +++ b/src/translator_en.h @@ -463,7 +463,6 @@ class TranslatorEnglish : public Translator virtual QCString trEnumerationValues() { return "Enumeration values"; } - /*! This is used in man pages as the author section. */ /*! This is used in the documentation of a file before the list of * documentation blocks for defines */ @@ -568,7 +567,6 @@ class TranslatorEnglish : public Translator virtual QCString trDate() { return "Date"; } - /*! this text is generated when the \\author command is used. */ /*! this text is generated when the \\return command is used. */ virtual QCString trReturns() { return "Returns"; } @@ -882,17 +880,17 @@ class TranslatorEnglish : public Translator { return "Go to the documentation of this file."; } - /*! Text for the \pre command */ + /*! Text for the \\pre command */ virtual QCString trPrecondition() { return "Precondition"; } - /*! Text for the \post command */ + /*! Text for the \\post command */ virtual QCString trPostcondition() { return "Postcondition"; } - /*! Text for the \invariant command */ + /*! Text for the \\invariant command */ virtual QCString trInvariant() { return "Invariant"; diff --git a/src/translator_es.h b/src/translator_es.h index a1c3427..7ba37f4 100644 --- a/src/translator_es.h +++ b/src/translator_es.h @@ -25,9 +25,7 @@ #ifndef TRANSLATOR_ES_H #define TRANSLATOR_ES_H -#include "translator_adapter.h" - -class TranslatorSpanish : public TranslatorAdapter_1_1_5 +class TranslatorSpanish : public TranslatorAdapterCVS { public: virtual QCString idLanguage() @@ -36,13 +34,38 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5 virtual QCString latexBabelPackage() { return ""; } + /*! 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-1"; + } + /*! used in the compound documentation before a list of related functions. */ virtual QCString trRelatedFunctions() { return "Funciones relacionadas"; } /*! subscript for the related functions. */ virtual QCString trRelatedSubscript() - { return "(Observa que estas no son funciones miembro.)"; } + { return "(Observar que estas no son funciones miembro.)"; } /*! header that is put before the detailed description of files, classes and namespaces. */ virtual QCString trDetailedDescription() @@ -110,7 +133,7 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5 * parameter f is the name of the include file. */ virtual QCString trVerbatimText(const char *f) - { return (QCString)"Este es el texto al pie de la letra del "+f+" archivo adjunto."; } + { return (QCString)"Este es el texto al pie de la letra del archivo "+f+" adjunto."; } // quick reference sections @@ -166,8 +189,8 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5 virtual QCString trFileListDescription(bool extractAll) { QCString result="Lista de todos los archivos "; - if (!extractAll) result+="documentados y"; - result+=" con descripciones breves:"; + if (!extractAll) result+="documentados y "; + result+="con descripciones breves:"; return result; } @@ -186,7 +209,7 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5 if (extractAll) result+=" la documentación de cada clase:"; else - result+="la clase de la que forman parte:"; + result+=" la clase de la que forman parte:"; return result; } @@ -266,7 +289,7 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5 * the documentation of all classes, structs and unions. */ virtual QCString trClassDocumentation() - { return "Documentación de clasee"; } + { return "Documentación de clases"; } /*! This is used in LaTeX as the title of the chapter containing * the documentation of all files. @@ -501,36 +524,39 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5 ClassDef::CompoundType compType, bool /*isTemplate*/) { - QCString result=(QCString)clName+" "; + + QCString result="Referencia de "; switch(compType) { - case ClassDef::Class: result+=" Clase"; break; - case ClassDef::Struct: result+=" Estructura"; break; - case ClassDef::Union: result+=" Unión"; break; - case ClassDef::Interface: result+=" Interfaz"; break; - case ClassDef::Exception: result+=" Excepción"; break; + case ClassDef::Class: result+="la Clase "; break; + case ClassDef::Struct: result+="la Estructura "; break; + case ClassDef::Union: result+="la Unión "; break; + case ClassDef::Interface: result+="la Interfaz "; break; + case ClassDef::Exception: result+="la Excepción "; break; } - result+=" Referencia"; + result+=(QCString)clName; return result; } /*! used as the title of the HTML page of a file */ virtual QCString trFileReference(const char *fileName) { - QCString result=fileName; - result+=" Archivo referencia"; + QCString result="Referencia del Archivo "; + result+=fileName; return result; } /*! used as the title of the HTML page of a namespace */ virtual QCString trNamespaceReference(const char *namespaceName) { - QCString result=namespaceName; - result+=" Namespace referencia"; + QCString result="Referencia del Namespace "; + result+=namespaceName; return result; } - /* these are for the member sections of a class, struct or union */ + /*! \mgroup Class sections + * these are for the member sections of a class, struct or union + */ virtual QCString trPublicMembers() { return "Métodos públicos"; } virtual QCString trPublicSlots() @@ -551,6 +577,7 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5 { return "Slots privados"; } virtual QCString trStaticPrivateMembers() { return "Métodos privados estáticos"; } + /*! \endmgroup */ /*! this function is used to produce a comma-separated list of items. * use generateMarker(i) to indicate where item i should be put. @@ -571,7 +598,7 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5 if (i\n" + "Considere el siguiente ejemplo:\n" + "/*! Clase invisible por truncamiento */\n" + "class Invisible { };\n\n" + "/*! Clase truncada, relación de herencia escondida */\n" + "class Truncated : public Invisible { };\n\n" + "/* Clase no documentada con comentarios de doxygen */\n" + "class Undocumented { };\n\n" + "/*! Clase que es heredera usando herencia publica */\n" + "class PublicBase : public Truncated { };\n\n" + "/*! Clase que es heredera usando herencia protegida */\n" + "class ProtectedBase { };\n\n" + "/*! Clase que es heredera usando herencia privada */\n" + "class PrivateBase { };\n\n" + "/*! Clase que es usada por la clase hija */\n" + "class Used { };\n\n" + "/*! Super-Clase que hereda de varias otras clases */\n" + "class Inherited : public PublicBase,\n" + " protected ProtectedBase,\n" + " private PrivateBase,\n" + " public Undocumented\n" + "{\n" + " private:\n" + " Used *m_usedClass;\n" + "};\n" + "\\endcode\n" + "Si la etiqueta \\c MAX_DOT_GRAPH_HEIGHT en el archivo de configuración " + "tiene valor 200 resultará en el siguiente gráfico:" + "

            \n" + "

            \n" + "Las cajas en el gráfico arriba tienen el significado que sigue:\n" + "

              \n" + "
            • Una caja llena negra representa la estructura o clase para la cuál" + "se generó el gráfico.\n" + "
            • Una caja con borde negro seńala una estructura o clase documentada.\n" + "
            • Una caja con borde griz seńala una estructura o clase no documentada.\n" + "
            • una caja con borde rojo seńala una estructura o clase documentada \n" + " de la cuál no toda las relaciones de jerarquía/contenido son " + "mostradas. El gráfico sera truncado si este no calza dentro de los " + "límites especificados." + "afgekapt als hij niet past binnen de gespecificeerde grenzen." + "
            \n" + "Las flechas tienen el siguiente significado:\n" + "
              \n" + "
            • Una flecha azul oscuro es usada para visualizar una relación " + "herencia publica entre dos clases.\n" + "
            • Una flecha verde oscura es usada para herencia protegida.\n" + "
            • Una flecha rojo oscura es usada para herencia privada.\n" + "
            • Una flecha segmentada púrpura se usa si la clase es contenida o " + "usada por otra clase. La flecha está etiquetada por la variable " + "con que se accede a la clase o estructura apuntada. \n" + "
            \n"; + } + /*! text for the link to the legend page */ + QCString trLegend() + { + return "leyenda"; + } + +////////////////////////////////////////////////////////////////////////// +// new since 1.2.0 +////////////////////////////////////////////////////////////////////////// + + /*! Used as a marker that is put before a test item */ + QCString trTest() + { + return "Prueba"; + } + /*! Used as the header of the test list */ + QCString trTestList() + { + return "Lista de Pruebas"; + } + + +////////////////////////////////////////////////////////////////////////// +// new since 1.2.1 +////////////////////////////////////////////////////////////////////////// + + /*! Used as a section header for KDE-2 IDL methods */ + virtual QCString trDCOPMethods() + { + return "Métodos DCOP"; + } +////////////////////////////////////////////////////////////////////////// +// new since 1.2.2 +////////////////////////////////////////////////////////////////////////// + + /*! Used as a section header for IDL properties */ + virtual QCString trProperties() + { + return "Propiedades"; + } + /*! Used as a section header for IDL property documentation */ + virtual QCString trPropertyDocumentation() + { + return "Documentación de Propiedades"; + } + +////////////////////////////////////////////////////////////////////////// +// new since 1.2.4 +////////////////////////////////////////////////////////////////////////// + + /*! Used for Java interfaces in the summary section of Java packages */ + virtual QCString trInterfaces() + { + return "Interfaces"; + } + /*! Used for Java classes in the summary section of Java packages */ + virtual QCString trClasses() + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return "Estructuras de Datos"; + } + else + { + return "Clases"; + } + } + /*! Used as the title of a Java package */ + virtual QCString trPackage(const char *name) + { + return (QCString)"Paquetes "+name; + } + /*! Title of the package index page */ + virtual QCString trPackageList() + { + return "Lista de Paquetes "; + } + /*! The description of the package index page */ + virtual QCString trPackageListDescription() + { + return "Aquí van los paquetes con una breve descripción (si etá disponible):"; + } + /*! The link name in the Quick links header for each page */ + virtual QCString trPackages() + { + return "Paquetes"; + } + /*! Used as a chapter title for Latex & RTF output */ + virtual QCString trPackageDocumentation() + { + return "Documentación del Paquete"; + } + /*! Text shown before a multi-line define */ + virtual QCString trDefineValue() + { + return "Valor:"; + } + +////////////////////////////////////////////////////////////////////////// +// new since 1.2.5 +////////////////////////////////////////////////////////////////////////// + + /*! Used as a marker that is put before a \\bug item */ + virtual QCString trBug() + { + return "Bug"; + } + /*! Used as the header of the bug list */ + virtual QCString trBugList() + { + return "Lista de Bugs"; + } + +////////////////////////////////////////////////////////////////////////// +// new since 1.2.6 +////////////////////////////////////////////////////////////////////////// + + /*! Used as ansicpg for RTF file + * + * The following table shows the correlation of Charset name, Charset Value and + * Codepage number: + * Charset Name Charset Value(hex) Codepage number + * ------------------------------------------------------ + * DEFAULT_CHARSET 1 (x01) + * SYMBOL_CHARSET 2 (x02) + * OEM_CHARSET 255 (xFF) + * ANSI_CHARSET 0 (x00) 1252 + * RUSSIAN_CHARSET 204 (xCC) 1251 + * EE_CHARSET 238 (xEE) 1250 + * GREEK_CHARSET 161 (xA1) 1253 + * TURKISH_CHARSET 162 (xA2) 1254 + * BALTIC_CHARSET 186 (xBA) 1257 + * HEBREW_CHARSET 177 (xB1) 1255 + * ARABIC _CHARSET 178 (xB2) 1256 + * SHIFTJIS_CHARSET 128 (x80) 932 + * HANGEUL_CHARSET 129 (x81) 949 + * GB2313_CHARSET 134 (x86) 936 + * CHINESEBIG5_CHARSET 136 (x88) 950 + * + */ + virtual QCString trRTFansicp() + { + return "1252"; + } + + /*! Used as ansicpg for RTF fcharset + * \see trRTFansicp() for a table of possible values. + */ + virtual QCString trRTFCharSet() + { + return "0"; + } + + /*! Used as header RTF general index */ + virtual QCString trRTFGeneralIndex() + { + return "Índice"; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trClass(bool first_capital, bool singular) + { + QCString result((first_capital ? "Clase" : "clase")); + if (first_capital) toupper(result.at(0)); + if (!singular) result+="s"; + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trFile(bool first_capital, bool singular) + { + QCString result((first_capital ? "Archivo" : "archivo")); + if (!singular) result+="s"; + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trNamespace(bool first_capital, bool singular) + { + QCString result((first_capital ? "Namespace" : "namespace")); + if (!singular) result+="s"; + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trGroup(bool first_capital, bool singular) + { + QCString result((first_capital ? "Grupo" : "grupo")); + if (!singular) result+="s"; + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trPage(bool first_capital, bool singular) + { + QCString result((first_capital ? "Página" : "pagina")); + if (!singular) result+="s"; + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trMember(bool first_capital, bool singular) + { + QCString result((first_capital ? "Miembro" : "miembro")); + if (!singular) result+="s"; + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trField(bool first_capital, bool singular) + { + QCString result((first_capital ? "Campo" : "campo")); + if (!singular) result+="s"; + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trGlobal(bool first_capital, bool singular) + { + QCString result((first_capital ? "Global" : "global")); + if (!singular) result+="es"; + return result; + } + }; #endif + + diff --git a/src/translator_hr.h b/src/translator_hr.h index f3395aa..8463acb 100644 --- a/src/translator_hr.h +++ b/src/translator_hr.h @@ -31,12 +31,18 @@ // 2001/01/22 // - Added strings from 1.2.4 // +// 2001/05/25 +// - Added strings and up to and including 1.2.7_20010524 +// - Removed obsolete method trFiles() +// - Removed obsolete method trAuthor() +// - Removed obsolete method trAuthor() +// - Removed obsolete method trVerbatimHeadert() +// - Method latexBabelPackage() removed, ude latexLanguageSupportCommand +// #ifndef TRANSLATOR_HR_H #define TRANSLATOR_HR_H -#include "translator_adapter.h" - -class TranslatorCroatian : public TranslatorAdapter_1_2_6 +class TranslatorCroatian : public Translator { private: /*! to avoid macro redefinition from translator_cz.h */ @@ -58,8 +64,8 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 #else { return "iso-8859-2"; } #endif - QCString latexBabelPackage() - { return "croatian"; } + QCString latexLanguageSupportCommand() + { return "\\usepackage[croatian]{babel}\n"; } QCString trRelatedFunctions() { return "Povezane funkcije"; } QCString trRelatedSubscript() @@ -98,30 +104,42 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 { return decode("enum vrijednost"); } QCString trDefinedIn() { return decode("definirano u"); } - QCString trVerbatimText(const char *f) - { return (QCString)"Ovo je citirani tekst iz include datoteke "+f+"."; } QCString trModules() { return "Moduli"; } QCString trClassHierarchy() { return "Stablo klasa"; } QCString trCompoundList() - { return "Sve klase"; } + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return "Sve strukture"; + } + else + { + return "Sve klase"; + } + } QCString trFileList() { return "Popis datoteka"; } QCString trHeaderFiles() { return "Header datoteke"; } QCString trCompoundMembers() - { return decode("Svi članovi"); } + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + return decode("Svi članovi struktura"); + else + return decode("Svi članovi klasa"); + } QCString trFileMembers() - { return decode("Članovi(memberi) u datoteci"); } + { return decode("Članovi klasa u datoteci"); } QCString trRelatedPages() - { return decode("Povezane stranice"); } + { return decode("Stranice povezane s ovom"); } QCString trExamples() { return "Primjeri"; } QCString trSearch() { return decode("Traľi"); } QCString trClassHierarchyDescription() - { return decode("Stablo naslijeđivanja je posloľeno " + { return decode("Stablo naslijeđivanja je sloľeno " "pribliľno po abecedi:"); } QCString trFileListDescription(bool extractAll) @@ -201,8 +219,6 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 { return "Varijable"; } QCString trEnumerationValues() { return "Vrijednosti enumeracija"; } - QCString trAuthor() - { return "autor"; } QCString trDefineDocumentation() { return "Dokumentacija definicija"; } QCString trFunctionPrototypeDocumentation() @@ -217,8 +233,6 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 { return "Dokumentacija varijable"; } QCString trCompounds() { return "Strukture"; } - QCString trFiles() - { return "Datoteke"; } QCString trGeneratedAt(const char *date,const char *projName) { QCString result=(QCString)"Generirano "+date; @@ -248,8 +262,6 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 { return "Verzija"; } QCString trDate() { return "Datum"; } - QCString trAuthors() - { return "Autor(i)"; } QCString trReturns() { return "Povratne vrijednosti"; } QCString trSeeAlso() @@ -266,12 +278,12 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 ////////////////////////////////////////////////////////////////////////// QCString trNamespaceList() - { return "Popis namespace-ova"; } + { return "Popis imenika"; } QCString trNamespaceListDescription(bool extractAll) { QCString result="Popis svih "; if (!extractAll) result+="dokumentiranih "; - result+="namespace-ova s kratkim opisom:"; + result+="imenika s kratkim opisom:"; return decode(result); } QCString trFriends() @@ -316,7 +328,7 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 QCString trNamespaceReference(const char *namespaceName) // used as the title of the HTML page of a namespace { - QCString result ="Opis namespace-a "; + QCString result ="Opis imenika "; result+=namespaceName; return decode(result); @@ -396,23 +408,23 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 QCString trNamespaceMembers() // This is put above each page as a link to all members of namespaces. - { return decode("Namespace članovi"); } + { return decode("Članovi imenika"); } QCString trNamespaceMemberDescription(bool extractAll) // This is an introduction to the page with all namespace members { QCString result="Lista svih "; if (!extractAll) result+="dokumentiranih "; - result+="namespace članova s linkovima na "; + result+="članova imenika s linkovima na "; if (extractAll) - result+="namespace dokumentaciju svakog člana:"; + result+="imeničku dokumentaciju svakog člana:"; else - result+="namespace kojima pripadaju:"; + result+="imenike kojima pripadaju:"; return decode(result); } QCString trNamespaceIndex() // This is used in LaTeX as the title of the chapter with the // index of all namespaces. - { return "Kazalo namespace-a"; } + { return "Kazalo imenika"; } QCString trNamespaceDocumentation() // This is used in LaTeX as the title of the chapter containing // the documentation of all namespaces. @@ -427,7 +439,7 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 */ QCString trNamespaces() { - return "Namespaces"; + return "Imenici"; } ////////////////////////////////////////////////////////////////////////// @@ -450,9 +462,8 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 case ClassDef::Interface: result+="sučelja (interface)"; break; case ClassDef::Exception: result+="iznimke (exception)"; break; } - result+=" je generirana iz datotek"; - if (single) result+="e :"; else result+="a :"; - return decode(result); + result+=" je generirana iz " + trFile(false, single) + ": "; + return decode(result); } /*! This is in the (quick) index as a link to the alphabetical compound @@ -814,10 +825,10 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 return "Vrijednost:"; } - ////////////////////////////////////////////////////////////////////////// - // new since 1.2.5 - ////////////////////////////////////////////////////////////////////////// - +////////////////////////////////////////////////////////////////////////// +// new since 1.2.5 +////////////////////////////////////////////////////////////////////////// + /*! Used as a marker that is put before a \\bug item */ virtual QCString trBug() { @@ -829,10 +840,9 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 return decode("Popis greąaka"); } - ////////////////////////////////////////////////////////////////////////// - // new since 1.2.6 - ////////////////////////////////////////////////////////////////////////// - +////////////////////////////////////////////////////////////////////////// +// new since 1.2.6 +////////////////////////////////////////////////////////////////////////// /*! Used as ansicpg for RTF file */ virtual QCString trRTFansicp() { @@ -843,6 +853,120 @@ class TranslatorCroatian : public TranslatorAdapter_1_2_6 { return "238"; } + /*! Used as header RTF general index */ + virtual QCString trRTFGeneralIndex() + { + return decode("Sadrľaj"); + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trClass(bool first_capital, bool singular) + { + QCString result((first_capital ? "Klas" : "klas")); + result+= (singular ? "a" : "e"); + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trFile(bool first_capital, bool singular) + { + QCString result((first_capital ? "Datotek" : "datotek")); + result+= (singular ? "a" : "e"); + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trNamespace(bool first_capital, bool singular) + { + QCString result; + if (singular) + result = ((first_capital ? "Imenik" : "imenik")); + else + result = ((first_capital ? "Imenici" : "imenici")); + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trGroup(bool first_capital, bool singular) + { + QCString result((first_capital ? "Grup" : "grup")); + result+= (singular ? "a" : "e"); + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trPage(bool first_capital, bool singular) + { + QCString result((first_capital ? "Stranic" : "stranic")); + result+= (singular ? "a" : "e"); + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trMember(bool first_capital, bool singular) + { + QCString result((first_capital ? "Član" : "član")); + if (!singular) result+="ovi"; + return decode(result); + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trField(bool first_capital, bool singular) + { + QCString result((first_capital ? "Polj" : "polj")); + result+= (singular ? "e" : "a"); + return result; + } + + /*! This is used for translation of the word that will possibly + * be followed by a single name or by a list of names + * of the category. + */ + virtual QCString trGlobal(bool first_capital, bool singular) + { + QCString result((first_capital ? "G" : "g")); + if( singular ) + result += "lobalna varijabla"; + else + result += "lobalne varijable"; + + return result; + } + +////////////////////////////////////////////////////////////////////////// +// new since 1.2.7 +////////////////////////////////////////////////////////////////////////// + + /*! This text is generated when the \\author command is used and + * for the author section in man pages. */ + virtual QCString trAuthor(bool first_capital, bool singular) + { + QCString result((first_capital ? "Autor" : "autor")); + if (!singular) result+="i"; + return result; + } + }; #endif diff --git a/src/translator_ru.h b/src/translator_ru.h index 37d9deb..64c5b6d 100644 --- a/src/translator_ru.h +++ b/src/translator_ru.h @@ -48,7 +48,7 @@ #ifndef TRANSLATOR_RU_H #define TRANSLATOR_RU_H -class TranslatorRussian : public TranslatorAdapterCVS +class TranslatorRussian : public Translator { private: /*! The Decode() inline assumes the source written in the @@ -70,7 +70,11 @@ class TranslatorRussian : public TranslatorAdapterCVS /* Used to get the command(s) for the language support. */ virtual QCString latexLanguageSupportCommand() - { return "\\usepackage[russianb]{babel}\n"; } +#ifdef _WIN32 + { return "\\usepackage[cp1251]{inputenc}\n\\usepackage[russian]{babel}\n"; } +#else + { return "\\usepackage[koi8-r]{inputenc}\n\\usepackage[russian]{babel}\n"; } +#endif /*! return the language charset. This will be used for the HTML output */ virtual QCString idLanguageCharset() @@ -169,13 +173,6 @@ class TranslatorRussian : public TranslatorAdapterCVS virtual QCString trDefinedIn() { return decode("ĎĐŇĹÄĹĚĹÎĎ ×"); } - // TODO: trVerbatimText is no longer used => remove! - /*! put as in introduction in the verbatim header file of a class. - * parameter f is the name of the include file. - */ - virtual QCString trVerbatimText(const char *f) - { return decode( (QCString)"üÔĎ ĐŇŃÍÁŃ ×ÓÔÁ×ËÁ ÔĹËÓÔÁ ÉÚ ×ËĚŔŢÁĹÍĎÇĎ ĆÁĘĚÁ")+f; } - // quick reference sections /*! This is put above each page as a link to the list of all groups of @@ -466,10 +463,6 @@ class TranslatorRussian : public TranslatorAdapterCVS virtual QCString trEnumerationValues() { return decode("üĚĹÍĹÎÔŮ ĐĹŇĹŢÉÓĚĹÎÉĘ"); } - /*! This is used in man pages as the author section. */ - virtual QCString trAuthor() - { return decode("á×ÔĎŇ"); } - /*! This is used in the documentation of a file before the list of * documentation blocks for defines */ @@ -531,9 +524,6 @@ class TranslatorRussian : public TranslatorAdapterCVS /*! This is used in the documentation of a group before the list of * links to documented files */ - virtual QCString trFiles() - { return decode("ćÁĘĚŮ"); } - /*! This is used in the standard footer of each page and indicates when * the page was generated */ @@ -542,7 +532,7 @@ class TranslatorRussian : public TranslatorAdapterCVS QCString result=decode("äĎËŐÍĹÎÔÁĂÉŃ "); if (projName) result+=decode("ĐĎ ")+projName; result+=decode(". đĎÓĚĹÄÎÉĹ ÉÚÍĹÎĹÎÉŃ: ")+date; - result+=decode(". óĎÚÄÁÎĎ ÓÉÓÔĹÍĎĘ "); + result+=decode(". óĎÚÄÁÎĎ ÓÉÓÔĹÍĎĘ"); return result; } /*! This is part of the sentence used in the standard footer of each page. @@ -584,10 +574,6 @@ class TranslatorRussian : public TranslatorAdapterCVS virtual QCString trDate() { return decode("äÁÔÁ"); } - /*! this text is generated when the \\author command is used. */ - virtual QCString trAuthors() - { return decode("á×ÔĎŇ(Ů)"); } - /*! this text is generated when the \\return command is used. */ virtual QCString trReturns() { return decode("÷ĎÚ×ŇÁÝÁĹÔ"); } @@ -1181,7 +1167,14 @@ class TranslatorRussian : public TranslatorAdapterCVS /*! Used for Java classes in the summary section of Java packages */ virtual QCString trClasses() { - return decode("ëĚÁÓÓŮ"); + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return decode( "óÔŇŐËÔŐŇŮ ÄÁÎÎŮČ" ); + } + else + { + return decode( "ëĚÁÓÓŮ" ); + } } /*! Used as the title of a Java package */ virtual QCString trPackage(const char *name) @@ -1254,9 +1247,17 @@ class TranslatorRussian : public TranslatorAdapterCVS */ virtual QCString trClass(bool first_capital, bool singular) { - QCString result((first_capital ? "ëĚÁÓÓ" : "ËĚÁÓÓ")); - if(!singular) result+="Ů"; - return decode(result); + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + QCString result((first_capital ? "óÔŇŐËÔŐŇŮ ÄÁÎÎŮČ" : "ÓÔŇŐËÔŐŇŮ ÄÁÎÎŮČ")); + return decode(result); + } + else + { + QCString result((first_capital ? "ëĚÁÓÓ" : "ËĚÁÓÓ")); + if(!singular) result+="Ů"; + return decode(result); + } } /*! This is used for translation of the word that will possibly @@ -1336,6 +1337,18 @@ class TranslatorRussian : public TranslatorAdapterCVS return decode(result); } +////////////////////////////////////////////////////////////////////////// +// new since 1.2.7 +////////////////////////////////////////////////////////////////////////// + + /*! This text is generated when the \\author command is used and + * for the author section in man pages. */ + virtual QCString trAuthor(bool first_capital, bool singular) + { + QCString result((first_capital ? "á×ÔĎŇ" : "Á×ÔĎŇ")); + if (!singular) result+="Ů"; + return decode(result); + } }; #endif diff --git a/src/translator_sk.h b/src/translator_sk.h new file mode 100644 index 0000000..2f1b2b1 --- /dev/null +++ b/src/translator_sk.h @@ -0,0 +1,1334 @@ +/****************************************************************************** + * + * + * + * Copyright (C) 1997-2001 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. + * + */ + +#ifndef TRANSLATOR_SK_H +#define TRANSLATOR_SK_H + +class TranslatorSlovak : public TranslatorAdapterCVS +{ + private: + /*! The Decode() inline assumes the source written in the + Windows encoding (maintainer only dependent). + */ + inline QCString Decode(const QCString & sInput) + { +#ifdef _WIN32 + return sInput; +#else + return Win1250ToISO88592(sInput); +#endif + } + + public: + // --- Language contol methods ------------------- + + virtual QCString idLanguage() + { return "slovak"; } + + virtual QCString latexLanguageSupportCommand() + { return "\\usepackage{slovak}\n"; } + + /*! return the language charset. This will be used for the HTML output */ + virtual QCString idLanguageCharset() + { +#ifdef _WIN32 + return "windows-1250"; +#else + return "iso-8859-2"; +#endif + } + + // --- Language translation methods ------------------- + + /*! used in the compound documentation before a list of related functions. */ + virtual QCString trRelatedFunctions() + { return Decode("Súvisiace funkcie"); } + + /*! subscript for the related functions. */ + virtual QCString trRelatedSubscript() + { return Decode("(Uvedené funkcie niesú členskými funkciami.)"); } + + /*! header that is put before the detailed description of files, classes and namespaces. */ + virtual QCString trDetailedDescription() + { return Decode("Detailný popis"); } + + /*! header that is put before the list of typedefs. */ + virtual QCString trMemberTypedefDocumentation() + { return Decode("Dokumentácia k členským typom"); } + + /*! header that is put before the list of enumerations. */ + virtual QCString trMemberEnumerationDocumentation() + { return Decode("Dokumentácia k členským enumeráciám"); } + + /*! header that is put before the list of member functions. */ + virtual QCString trMemberFunctionDocumentation() + { return Decode("Dokumentácia k metódam"); } + + /*! header that is put before the list of member attributes. */ + virtual QCString trMemberDataDocumentation() + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return Decode("Dokumentácia k položkám"); + } + else + { + return Decode("Dokumentácia k dátovým členom"); + } + } + + /*! this is the text of a link put after brief descriptions. */ + virtual QCString trMore() + { return Decode("..."); } + + /*! put in the class documentation */ + virtual QCString trListOfAllMembers() + { return Decode("Zoznam všetkých členov."); } + + /*! used as the title of the "list of all members" page of a class */ + virtual QCString trMemberList() + { return Decode("Zoznam členov triedy"); } + + /*! this is the first part of a sentence that is followed by a class name */ + virtual QCString trThisIsTheListOfAllMembers() + { return Decode("Tu nájdete úplný zoznam členov triedy "); } + + /*! this is the remainder of the sentence after the class name */ + virtual QCString trIncludingInheritedMembers() + { return Decode(", vrátane všetkých zdedených členov."); } + + /*! 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="Generované automaticky programom Doxygen " + "zo zdrojových textov"; + if (s) result+=(QCString)" projektu "+s; + result+="."; + return Decode(result); + } + + /*! put after an enum name in the list of all members */ + virtual QCString trEnumName() + { return Decode("meno enumerácie"); } + + /*! put after an enum value in the list of all members */ + virtual QCString trEnumValue() + { return Decode("hodnota enumerácie"); } + + /*! put after an undocumented member in the list of all members */ + virtual QCString trDefinedIn() + { return Decode("definovaný v"); } + + // 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 Decode("Moduly"); } + + /*! This is put above each page as a link to the class hierarchy */ + virtual QCString trClassHierarchy() + { return Decode("Hierarchia tried"); } + + /*! 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 Decode("Dátové štruktúry"); + } + else + { + return Decode("Zoznam tried"); + } + } + + /*! This is put above each page as a link to the list of documented files */ + virtual QCString trFileList() + { return Decode("Zoznam súborov"); } + + /*! This is put above each page as a link to the list of all verbatim headers */ + virtual QCString trHeaderFiles() + { return Decode("Zoznam hlavičkových súborov"); } + + /*! 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 Decode("Dátové položky"); + } + else + { + return Decode("Zoznam členov tried"); + } + } + + /*! 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 Decode("Globálne symboly"); + } + else + { + return Decode("Symboly v súboroch"); + } + } + + /*! This is put above each page as a link to all related pages. */ + virtual QCString trRelatedPages() + { return Decode("Ostatné stránky"); } + + /*! This is put above each page as a link to all examples. */ + virtual QCString trExamples() + { return Decode("Príklady"); } + + /*! This is put above each page as a link to the search engine. */ + virtual QCString trSearch() + { return Decode("Hľadať"); } + + /*! This is an introduction to the class hierarchy. */ + virtual QCString trClassHierarchyDescription() + { return Decode("Tu nájdete zoznam, vyjadrujúci vzťah dedičnosti tried. " + "Je zoradený približne (ale nie úplne) podľa abecedy:"); + } + + /*! This is an introduction to the list with all files. */ + virtual QCString trFileListDescription(bool extractAll) + { + QCString result="Tu nájdete zoznam všetkých "; + if (!extractAll) result+="dokumentovaných "; + result+="súborov so stručnými popismi:"; + return Decode(result); + } + + /*! This is an introduction to the annotated compound list. */ + virtual QCString trCompoundListDescription() + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + return Decode("Nasledujúci zoznam obsahuje identifikáciu dátových " + "štruktúr a ich stručné popisy:"); + } + else + { + return Decode("Nasledujúci zoznam obsahuje predovšetkým identifikáciu " + "tried, ale nachádzajú sa tu i ďalšie netriviálne prvky, " + "ako sú štruktúry (struct), uniony (union) a rozhrania " + "(interface). V zozname sú uvedené ich stručné " + "popisy:"); + } + } + + /*! This is an introduction to the page with all class members. */ + virtual QCString trCompoundMembersDescription(bool extractAll) + { + QCString result= "Tu nájdete zoznam všetkých "; + if (!extractAll) + { + result += "dokumentovaných "; + } + + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + result += "položiek štruktúr (struct) a unionov (union) "; + } + else + { + result += "členov tried "; + } + + result += "s odkazmi na "; + + if (extractAll) + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + result += "dokumentáciu štruktúr/unionov, ku ktorým prislúchajú:"; + } + else + { + result += "dokumentáciu tried, ku ktorým prislúchajú:"; + } + } + else + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + result+="štruktúry/uniony, ku ktorým prislúchajú:"; + } + else + { + result+="triedy, ku ktorým prislúchajú:"; + } + } + + return Decode(result); + } + + /*! This is an introduction to the page with all file members. */ + virtual QCString trFileMembersDescription(bool extractAll) + { + QCString result="Tu nájdete zoznam všetkých "; + if (!extractAll) result+="dokumentovaných "; + + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + { + result+="funkcií, premenných, makier, enumerácií a definícií typov (typedef) " + "s odkazmi na "; + } + else + { + result+="symbolov, ktoré sú definované na úrovni svojich súborov. " + "Pre každý symbol je uvedený odkaz na "; + } + + if (extractAll) + result+="súbory, ku ktorým prislúchajú:"; + else + result+="dokumentáciu:"; + + return Decode(result); + } + + /*! This is an introduction to the page with the list of all header files. */ + virtual QCString trHeaderFilesDescription() + { return Decode("Tu nájdete hlavičkové súbory, ktoré tvoria " + "aplikačné programové rozhranie (API):"); } + + /*! This is an introduction to the page with the list of all examples */ + virtual QCString trExamplesDescription() + { return Decode("Tu nájdete zoznam všetkých príkladov:"); } + + /*! This is an introduction to the page with the list of related pages */ + virtual QCString trRelatedPagesDescription() + { return Decode("Nasledujúci zoznam odkazuje na ďalšie stránky projektu, " + "ktoré majú charakter usporiadaných zoznamov informácií, " + "pozbieraných z rôznych miest v zdrojových súboroch:"); } + + /*! This is an introduction to the page with the list of class/file groups */ + virtual QCString trModulesDescription() + { return Decode("Tu nájdete zoznam všetkých modulov:"); } + + /*! This sentences is used in the annotated class/file lists if no brief + * description is given. + */ + virtual QCString trNoDescriptionAvailable() + { return Decode("Popis nieje k dispozícii"); } + + // index titles (the project name is prepended for these) + + + /*! This is used in HTML as the title of index.html. */ + virtual QCString trDocumentation() + { return Decode("Dokumentácia"); } + + /*! This is used in LaTeX as the title of the chapter with the + * index of all groups. + */ + virtual QCString trModuleIndex() + { return Decode("Register modulov"); } + + /*! This is used in LaTeX as the title of the chapter with the + * class hierarchy. + */ + virtual QCString trHierarchicalIndex() + { return Decode("Register hierarchie tried"); } + + /*! 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 Decode("Register dátových štruktúr"); + } + else + { + return Decode("Register tried"); + } + } + + /*! This is used in LaTeX as the title of the chapter with the + * list of all files. + */ + virtual QCString trFileIndex() + { return Decode("Register súborov"); } + + /*! This is used in LaTeX as the title of the chapter containing + * the documentation of all groups. + */ + virtual QCString trModuleDocumentation() + { return Decode("Dokumentácia modulov"); } + + /*! This is used in LaTeX as the title of the chapter containing + * the documentation of all classes, structs and unions. + */ + virtual QCString trClassDocumentation() + { return Decode("Dokumentácia tried"); } + + /*! This is used in LaTeX as the title of the chapter containing + * the documentation of all files. + */ + virtual QCString trFileDocumentation() + { return Decode("Dokumentácia súborov"); } + + /*! This is used in LaTeX as the title of the chapter containing + * the documentation of all examples. + */ + virtual QCString trExampleDocumentation() + { return Decode("Dokumentácia príkladov"); } + + /*! This is used in LaTeX as the title of the chapter containing + * the documentation of all related pages. + */ + virtual QCString trPageDocumentation() + { return Decode("Dokumentácia súvisiacich stránok"); } + + /*! This is used in LaTeX as the title of the document */ + virtual QCString trReferenceManual() + { return Decode("Referenčná príručka"); } + + /*! This is used in the documentation of a file as a header before the + * list of defines + */ + virtual QCString trDefines() + { return Decode("Definícia makier"); } + + /*! This is used in the documentation of a file as a header before the + * list of function prototypes + */ + virtual QCString trFuncProtos() + { return Decode("Prototypy"); } + + /*! This is used in the documentation of a file as a header before the + * list of typedefs + */ + virtual QCString trTypedefs() + { return Decode("Definícia typov"); } + + /*! This is used in the documentation of a file as a header before the + * list of enumerations + */ + virtual QCString trEnumerations() + { return Decode("Enumerácie"); } + + /*! This is used in the documentation of a file as a header before the + * list of (global) functions + */ + virtual QCString trFunctions() + { return Decode("Funkcie"); } + + /*! This is used in the documentation of a file as a header before the + * list of (global) variables + */ + virtual QCString trVariables() + { return Decode("Premenné"); } + + /*! This is used in the documentation of a file as a header before the + * list of (global) variables + */ + virtual QCString trEnumerationValues() + { return Decode("Hodnoty enumerácií"); } + + /*! This is used in man pages as the author section. */ + virtual QCString trAuthor() + { return Decode("Autor"); } + + /*! This is used in the documentation of a file before the list of + * documentation blocks for defines + */ + virtual QCString trDefineDocumentation() + { return Decode("Dokumentácia k definíciám makier"); } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for function prototypes + */ + virtual QCString trFunctionPrototypeDocumentation() + { return Decode("Dokumentácia prototypov"); } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for typedefs + */ + virtual QCString trTypedefDocumentation() + { return Decode("Dokumentácia definícií typov"); } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for enumeration types + */ + virtual QCString trEnumerationTypeDocumentation() + { return Decode("Dokumentácia enumeračných typov"); } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for enumeration values + */ + virtual QCString trEnumerationValueDocumentation() + { return Decode("Dokumentácia enumeračných hodnôt"); } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for functions + */ + virtual QCString trFunctionDocumentation() + { return Decode("Dokumentácia funkcií"); } + + /*! This is used in the documentation of a file/namespace before the list + * of documentation blocks for variables + */ + virtual QCString trVariableDocumentation() + { return Decode("Dokumentácia premenných"); } + + /*! 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 Decode("Dátové štruktúry"); + } + else + { + return Decode("Triedy"); + } + } + + /*! This is used in the documentation of a group before the list of + * links to documented files + */ + virtual QCString trFiles() + { return Decode("Súbory"); } + + /*! 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)"Generované "+date; + if (projName) result+=(QCString)" pre projekt "+projName; + result+=(QCString)" programom"; + return Decode(result); + } + /*! This is part of the sentence used in the standard footer of each page. + */ + virtual QCString trWrittenBy() + { + return Decode(" -- autor "); + } + + /*! this text is put before a class diagram */ + virtual QCString trClassDiagram(const char *clName) + { + return Decode((QCString)"Diagram dedičnosti pre triedu "+clName); + } + + /*! this text is generated when the \\internal command is used. */ + virtual QCString trForInternalUseOnly() + { return Decode("Iba pre interné použitie."); } + + /*! this text is generated when the \\reimp command is used. */ + virtual QCString trReimplementedForInternalReasons() + { return Decode("Reimplementované z interných dôvodov; " + "aplikačné rozhranie zachované."); } + + /*! this text is generated when the \\warning command is used. */ + virtual QCString trWarning() + { return Decode("Pozor"); } + + /*! this text is generated when the \\bug command is used. */ + virtual QCString trBugsAndLimitations() + { return Decode("Chyby a obmedzenia"); } + + /*! this text is generated when the \\version command is used. */ + virtual QCString trVersion() + { return Decode("Verzia"); } + + /*! this text is generated when the \\date command is used. */ + virtual QCString trDate() + { return Decode("Dátum"); } + + /*! this text is generated when the \\author command is used. */ + virtual QCString trAuthors() + { return Decode("Autor/autori"); } + + /*! this text is generated when the \\return command is used. */ + virtual QCString trReturns() + { return Decode("Návratová hodnota"); } + + /*! this text is generated when the \\sa command is used. */ + virtual QCString trSeeAlso() + { return Decode("Viz tiež"); } + + /*! this text is generated when the \\param command is used. */ + virtual QCString trParameters() + { return Decode("Parametre"); } + + /*! this text is generated when the \\exception command is used. */ + virtual QCString trExceptions() + { return Decode("Výnimky"); } + + /*! this text is used in the title page of a LaTeX document. */ + virtual QCString trGeneratedBy() + { return Decode("Generované programom"); } + + // new since 0.49-990307 + + /*! used as the title of page containing all the index of all namespaces. */ + virtual QCString trNamespaceList() + { return Decode("Zoznam priestorov mien"); } + + /*! used as an introduction to the namespace list */ + virtual QCString trNamespaceListDescription(bool extractAll) + { + QCString result="Tu nájdete zoznam všetkých "; + if (!extractAll) result+="dokumentovaných "; + result+="priestorov mien so stručným popisom:"; + return Decode(result); + } + + /*! used in the class documentation as a header before the list of all + * friends of a class + */ + virtual QCString trFriends() + { return Decode("Priatelia (friends)"); } + +////////////////////////////////////////////////////////////////////////// +// new since 0.49-990405 +////////////////////////////////////////////////////////////////////////// + + /*! used in the class documentation as a header before the list of all + * related classes + */ + virtual QCString trRelatedFunctionDocumentation() + { return Decode("Dokumentácia k priateľom (friends)"); } + +////////////////////////////////////////////////////////////////////////// +// 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("Dokumentácia "); + if (isTemplate) result+="šablóny "; + switch(compType) + { + case ClassDef::Class: result+="triedy "; break; + case ClassDef::Struct: result+="štruktúry "; break; + case ClassDef::Union: result+="unionu "; break; + case ClassDef::Interface: result+="rozhrania "; break; + case ClassDef::Exception: result+="výnimky "; break; + } + result+=clName; + return Decode(result); + } + + /*! used as the title of the HTML page of a file */ + virtual QCString trFileReference(const char *fileName) + { + QCString result("Dokumentácia súboru "); + result+=fileName; + return Decode(result); + } + + /*! used as the title of the HTML page of a namespace */ + virtual QCString trNamespaceReference(const char *namespaceName) + { + QCString result("Dokumentácia priestoru mien "); + result+=namespaceName; + return Decode(result); + } + + /*! \mgroup Class sections + * these are for the member sections of a class, struct or union + */ + virtual QCString trPublicMembers() + { return Decode("Verejné metódy"); } + virtual QCString trPublicSlots() + { return Decode("Verejné sloty"); } + virtual QCString trSignals() + { return Decode("Signály"); } + virtual QCString trStaticPublicMembers() + { return Decode("Statické verejné metódy"); } + virtual QCString trProtectedMembers() + { return Decode("Chránené metódy"); } + virtual QCString trProtectedSlots() + { return Decode("Chránené sloty"); } + virtual QCString trStaticProtectedMembers() + { return Decode("Statické chránené metódy"); } + virtual QCString trPrivateMembers() + { return Decode("Privátne metódy"); } + virtual QCString trPrivateSlots() + { return Decode("Privátne sloty"); } + virtual QCString trStaticPrivateMembers() + { return Decode("Statické privátne metódy"); } + /*! \endmgroup */ + + /*! 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