Skip to content

D
doxverilog
Commit e90eb41e authored by Dimitri van Heesch's avatar Dimitri van Heesch
Browse files
Options

Release-1.2.8

parent cd76bda7
Hide whitespace changes
Inline Side-by-side
Showing with 2573 additions and 513 deletions
INSTALL
View file @ e90eb41e
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)
README
View file @ e90eb41e
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)
VERSION
View file @ e90eb41e
1.2.7-20010524
1.2.8
doc/Makefile.in
View file @ e90eb41e
......@@ -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:
doc/Makefile.win_make.in
View file @ e90eb41e
......@@ -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:
doc/Makefile.win_nmake.in
View file @ e90eb41e
......@@ -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)
......
doc/commands.doc
View file @ e90eb41e
......@@ -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.
<h2>\htmlonly <center> --- \endhtmlonly
Structural indicators
......@@ -204,7 +204,7 @@ Doxygen. Unrecognized commands are treated as normal text.
\verbinclude class.h
\htmlonly
Click <a href="$(DOXYGEN_DOCDIR)/examples/class/html/index.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
<hr>
......@@ -218,7 +218,7 @@ Doxygen. Unrecognized commands are treated as normal text.
\verbinclude define.h
\htmlonly
Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define_8h.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
<hr>
......@@ -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 \<name\> argument should be a single word identifier.
The \<name\> 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 <a href="$(DOXYGEN_DOCDIR)/examples/enum/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
<hr>
......@@ -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 \<file-name\> 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 <a href="$(DOXYGEN_DOCDIR)/examples/example/html/examples.html">here</a>
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 <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file_8h.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
<hr>
......@@ -331,7 +331,7 @@ Doxygen. Unrecognized commands are treated as normal text.
\verbinclude func.h
\htmlonly
Click <a href="$(DOXYGEN_DOCDIR)/examples/func/html/class_test.html">here</a>
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 <a href="$(DOXYGEN_DOCDIR)/examples/overload/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
<hr>
......@@ -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 <a href="$(DOXYGEN_DOCDIR)/examples/page/html/pages.html">here</a>
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 <a href="$(DOXYGEN_DOCDIR)/examples/relates/html/class_string.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
<hr>
......@@ -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 <a href="$(DOXYGEN_DOCDIR)/examples/author/html/class_windows_n_t.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
<hr>
......@@ -771,7 +771,7 @@ Public/Protected/Private/... section.
\verbinclude par.cpp
\htmlonly
Click <a href="$(DOXYGEN_DOCDIR)/examples/par/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
<hr>
......@@ -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 <return value> { description }
\addindex \retval
Starts a return value for a function with name
Starts a return value description for a function with name
\<return value\>. 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 <code>::</code> or <code>\#</code>
Two names joined by either <code>::</code> or <code>\#</code>
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 <link-object>
\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 <a href="$(DOXYGEN_DOCDIR)/examples/include/html/example.html">here</a>
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 \<file-name\> 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.
<hr>
\subsection cmdhtmlinclude \htmlinclude <file-name>
......@@ -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.
<hr>
<h2>\htmlonly <center> --- \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).
<br><br>
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!
<hr>
......@@ -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.
<hr>
\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.
<hr>
\subsection cmdamp \&
......
doc/config.doc
View file @ e90eb41e
......@@ -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.
<dt>\c OUTPUT_DIRECTORY <dd>
\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
<dt>\c HIDE_UNDOC_MEMBERS <dd>
\addindex HIDE_UNDOC_MEMBERS
If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, Doxygen will hide all
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
<dt>\c HIDE_UNDOC_CLASSES <dd>
\addindex HIDE_UNDOC_CLASSES
If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, Doxygen will hide all
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
<dt>\c BRIEF_MEMBER_DESC <dd>
\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
<dt>\c REPEAT_BRIEF <dd>
\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.
<dt>\c ALWAYS_DETAILED_SEC <dd>
\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
<dt>\c FULL_PATH_NAMES <dd>
\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
<dt>\c CLASS_DIAGRAMS <dd>
\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
<dt>\c CASE_SENSE_NAMES <dd>
\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
<dt>\c HIDE_SCOPE_NAMES <dd>
\addindex HIDE_SCOPE_NAMES
If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then Doxygen
If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then doxygen
will show members with their full class and namespace scopes in the
documentation. If set to \c YES the scope will be hidden.
\anchor cfg_verbatim_headers
<dt>\c VERBATIM_HEADERS <dd>
\addindex VERBATIM_HEADERS
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
<dt>\c SHOW_INCLUDE_FILES <dd>
\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
<dt>\c JAVADOC_AUTOBRIEF <dd>
\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.
<dt>\c GENERATE_HTML <dd>
\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
<a href="http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download_main.htm">
Microsoft HTML help workshop</a>
Microsoft HTML Help Workshop</a>
\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
<dt>\c TOC_EXPAND <dd>
\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.
<dt>\c GENERATE_LATEX <dd>
\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
<dt>\c LATEX_OUTPUT <dd>
......@@ -848,7 +848,7 @@ followed by the descriptions of the tags grouped by category.
\anchor cfg_compact_latex
<dt>\c COMPACT_LATEX <dd>
\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
<dt>\c LATEX_HEADER <dd>
\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
<dt>\c PDF_HYPERLINKS <dd>
\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
<dt>\c LATEX_BATCHMODE <dd>
......@@ -926,7 +927,7 @@ EXTRA_PACKAGES = times
<dt>\c GENERATE_RTF <dd>
\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
<dt>\c COMPACT_RTF <dd>
\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
<dt>\c RTF_STYLESHEET_FILE <dd>
......@@ -968,7 +969,7 @@ EXTRA_PACKAGES = times
\anchor cfg_rtf_extensions_file
<dt>\c RTF_EXTENSIONS_FILE <dd>
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
<code>doxygen -e rtf extensionFile</code>.
......@@ -981,7 +982,7 @@ EXTRA_PACKAGES = times
<dt>\c GENERATE_MAN <dd>
\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
<dt>\c MAN_LINKS <dd>
\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
<dt>\c ENABLE_PREPROCESSING <dd>
\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
<dt>\c MACRO_EXPANSION <dd>
\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
<dt>\c SEARCH_INCLUDES <dd>
\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
<dt>\c INCLUDE_PATH <dd>
......@@ -1195,7 +1196,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
\anchor cfg_generate_legend <dd>
<dt>\c GENERATE_LEGEND <dd>
\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" ... </pre>
<dt>\c CGI_URL <dd>
\addindex CGI_URL
The \c CGI_URL tag should be the absolute URL to the directory where the
cgi binaries are located. See the documentation of your http daemon for
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.
......
doc/diagrams.doc
View file @ e90eb41e
......@@ -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.
<li> 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.
<li> A \b solid arrow indicates public inheritance.
<li> A \b dashed arrow indicates protected inheritance.
<li> A \b dotted arrow indicated private inheritance.
<li> A \b dotted arrow indicates private inheritance.
</ul>
The elements in the graphs generated by the dot tool have the following
......@@ -91,7 +91,7 @@
<li> 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.
......
doc/docblocks.doc
View file @ e90eb41e
......@@ -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
......
doc/doxygen_usage.doc
View file @ e90eb41e
......@@ -44,7 +44,7 @@ doxygen <config_file>
</ol>
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 <config_file>
......@@ -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!
<li> To make doxygen read/write to standard input/output instead of from/to
a file, use \c - for the file name.
......
doc/doxysearch_usage.doc
View file @ e90eb41e
......@@ -27,7 +27,7 @@ Doxysearch must be run as a CGI binary. This implies the following:
<li> You must have permission to install and execute a CGI binary on the
target.
</ul>
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.
<li>Edit the shell script <code>search.cgi</code> with a text editor.
......@@ -174,7 +174,7 @@ http://blizzard/cgi-bin/search.cgi
\endverbatim
in the additional information section of the <code>index.html</code> file.
<li>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.
</ol>
......
doc/external.doc
View file @ e90eb41e
......@@ -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:
<dt>At configuration time:<dd> just assign the location of the output to the
tag files specified after the \ref cfg_tagfiles "TAGFILES" configuration
option. If you use a relative path it should be relative with respect to
the directory where the html output of your project is generated.
the directory where the HTML output of your project is generated.
<dt>After compile time:<dd> if you do not assign a location to a tag file,
doxygen will generate dummy links for all external HTML references. It will
also generate a perl script called \ref installdox_usage "installdox" in
......
doc/faq.doc
View file @ e90eb41e
......@@ -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 <code>PREPROCESSING = YES</code>.
<li><b>How can I change what's after the <code>\#include</code> in the class documentation?</b>
<li><b>How can I change what is after the <code>\#include</code> in the class documentation?</b>
You can document your class like
......@@ -119,7 +119,7 @@ brackets you should type:
*/
\endverbatim
<li><b>How can I use tag files in combination with compressed HTML</b>
<li><b>How can I use tag files in combination with compressed HTML?</b>
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
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
\endverbatim
In the HEAD section of the HTML page.
in the HEAD section of the HTML page.
<li><b>Why does doxygen use Qt?</b>
......@@ -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.
</ol>
......
doc/features.doc
View file @ e90eb41e
......@@ -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 @@
<li>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.
<li>Supports C++, (Corba, Microsoft, and KDE-DCOP) Java, IDL and C sources.
<li>Supports C++, Java, (Corba, Microsoft, and KDE-DCOP) Java, IDL and C sources.
<li>Supports documentation of files, namespaces, classes, structs, unions,
templates, variables, functions, typedefs, enums and defines.
<li>JavaDoc (1.1), Qt-Doc, and KDOC compatible.
<li>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).
<li>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 @@
<li>Can generate a list of all members of a class (including any inherited
members) along with their protection level.
<li>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. <br>
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.
<li>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 @@
<li>Includes a fast, rank based search engine to search for strings or words
in the class and member documentation.
<li>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.
<li>Allows references to documentation generated for other projects
(or another part of the same project) in a location independent way.
......
doc/formulas.doc
View file @ e90eb41e
......@@ -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
<ul>
<li>\c latex: the \f$\mbox{\LaTeX}\f$ compiler, needed to parse the formulas.
To test I have used the teTeX 0.9 distribution.
<li>\c dvips: a tool to convert dvi files to postscript files
<li>\c dvips: a tool to convert DVI files to PostScript files
I have used version 5.86 from Radical Eye software for testing.
<li>\c gs: the ghostscript interpreter for converting postscript files
to bitmaps. I have used Aladdin Ghostscript 5.10 for testing.
<li>\c gs: the GhostScript interpreter for converting PostScript files
to bitmaps. I have used Aladdin GhostScript 5.10 for testing.
</ul>
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$.
<br>
<li>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[
......
doc/history.doc
View file @ e90eb41e
......@@ -24,7 +24,7 @@
<li>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.
<li>Function arguments can now be documentation with separate comment blocks.
<li>Function arguments can now be documented with separate comment blocks.
<li>Initializers and macro definitions are now included in the documentation.
<li>Variables and typedefs are now put in their own section.
<li>Old configuration files can be upgraded using the -u option without
......@@ -52,7 +52,7 @@
<ul>
<li>Support for templates and namespaces.
<li>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.
<li>Automatic generation of inheritance diagrams for sub & super classes.
<li>Support for man page, compressed HTML help, and hyperlinked PDF output.
......
doc/htmlcmds.doc
View file @ e90eb41e
......@@ -38,8 +38,8 @@ documentation. Note that all attributes of a HTML tag are ignored
<li>\c </DFN> Ends a \c <DFN> section.
<li>\c <DL> Starts a description list.
<li>\c </DL> Ends a description list.
<li>\c <DT> Starts a item title.
<li>\c </DT> Does not generate any output.
<li>\c <DT> Starts an item title.
<li>\c </DT> Ends an item title.
<li>\c <EM> Starts a piece of text displayed in an italic font.
<li>\c </EM> Ends a \c <EM> section.
<li>\c <FORM> Does not generate any output.
......@@ -52,35 +52,34 @@ documentation. Note that all attributes of a HTML tag are ignored
<li>\c <H?> Where ? is one of {3,4,5,6}, starts an unnumbered subsubsection using \c <H3> in HTML.
<li>\c </H?> Where ? is one of {3,4,5,6}, ends an unnumbered subsubsection using \c <H3> in HTML.
<li>\c <I> Starts a piece of text displayed in an italic font.
<li>\c <INPUT> Does not generated any output.
<li>\c <INPUT> Does not generate any output.
<li>\c </I> Ends a \c <I> section.
<li>\c <IMG> This command is written with attributes to the HTML output only.
<li>\c <LI> Starts a new list item.
<li>\c </LI> Does not generate any output.
<li>\c </LI> Ends a list item.
<li>\c <META> Does not generate any output.
<li>\c <MULTICOL> ignored by Doxygen.
<li>\c </MUTLICOL> ignored by Doxygen.
<li>\c <MULTICOL> ignored by doxygen.
<li>\c </MUTLICOL> ignored by doxygen.
<li>\c <OL> Starts a numbered item list.
<li>\c </OL> Ends a numbered item list.
<li>\c <P> Starts a new paragraph.
<li>\c </P> Does not generate any output.
<li>\c <PRE> starts a preformatted fragment.
<li>\c </PRE> ends a preformatted fragment.
<li>\c <SMALL> starts a section of text displayed in a smaller font.
<li>\c </SMALL> ends a \c <SMALL> section.
<li>\c <STRONG> starts a section of bold text.
<li>\c </STRONG> ends a section of bold text.
<li>\c </P> Ends a paragraph.
<li>\c <PRE> Starts a preformatted fragment.
<li>\c </PRE> Ends a preformatted fragment.
<li>\c <SMALL> Starts a section of text displayed in a smaller font.
<li>\c </SMALL> Ends a \c <SMALL> section.
<li>\c <STRONG> Starts a section of bold text.
<li>\c </STRONG> Ends a section of bold text.
<li>\c <SUB> Starts a piece of text displayed in subscript.
<li>\c </SUB> Ends a \c <SUB> section.
<li>\c <SUP> Starts a piece of text displayed in superscript.
<li>\c </SUP> Ends a \c </SUP> section.
<li>\c <TABLE> starts a table, the available space of a page is always
divided equally amount the columns.
<li>\c </TABLE> ends a table
<li>\c <TD> Starts a new table element.
<li>\c </TD> Does not generate any output.
<li>\c <TABLE> starts a table.
<li>\c </TABLE> ends a table.
<li>\c <TD> Starts a new table data element.
<li>\c </TD> Ends a table data element.
<li>\c <TR> Starts a new table row.
<li>\c </TR> Does not generate any output.
<li>\c </TR> Ends a table row.
<li>\c <TT> Starts a piece of text displayed in a typewriter font.
<li>\c </TT> Ends a \c <TT> section.
<li>\c <KBD> Starts a piece of text displayed in a typewriter font.
......
doc/index.doc
View file @ e90eb41e
......@@ -14,7 +14,7 @@
* input used in their production; they are not affected by this license.
*
*/
/*! \page index
/*! \page index Index
\if logo_on
<center>
\htmlonly
......@@ -41,7 +41,7 @@ See the
GNU General Public License</a>
for more details.
<p>
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.
<h2>Introduction</h2>
......@@ -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 <a href="http://www.linux.org">Linux</a>,
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:
<ul>
<li>Section \ref features presents an overview of what Doxygen can do.
<li>Section \ref features presents an overview of what doxygen can do.
<li>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.
<li>Section \ref doxygen_usage shows how to use the \c doxygen program.
<li>Section \ref doxytag_usage shows how to use the \c doxytag program.
<li>Section \ref doxysearch_usage shows how to use the \c doxysearch program.
<li>Section \ref doxywizard_usage shows how to use the \c doxywizard program.
<li>Section \ref installdox_usage shows how to use the \c installdox
script that is generated by Doxygen if you use tag files.
script that is generated by doxygen if you use tag files.
<li>Section \ref output shows how to generate the various output formats
supported by Doxygen.
supported by doxygen.
<li>Section \ref autolink shows how to put links to files, classes,
and members in the documentation.
<li>Section \ref config shows how to fine-tune doxygen, so it
......@@ -151,9 +151,9 @@ Thanks go to:
<ul>
\addindex Doc++
<li>Malte Z&ouml;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.
<li>All people at Troll Tech, for creating a beautiful GUI Toolkit
(which is very useful as a Windows/Unix platform abstraction layer :-)
<li>My brother <a href="http://www.stack.nl/~fidget/index.html">Frank</a>
......
doc/install.doc
View file @ e90eb41e
......@@ -161,9 +161,10 @@ Compilation is now done by performing the following steps:
make install
\endverbatim
Binaries are installed in the directory <code>\<prefix\>/bin</code>
Documentation and examples in the directory
<code>\<prefix\>/doc/doxygen</code>
Binaries are installed in the directory <code>\<prefix\>/bin</code>,
documentation and examples in the directory
<code>\<prefix\>/share/doc/packages/doxygen</code> (use
<code>DOCDIR\\<path\></code> after <code>make</code> to change this).
<code>\<prefix\></code> defaults to /usr but can be changed with
the <code>--prefix</code> option of the configure script.
......@@ -182,12 +183,12 @@ Compilation is now done by performing the following steps:
<b>Qt problems</b>
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.
<b>Latex problems</b>
the file <code>a4wide.sty</code> is not available for all distributions. If
The file <code>a4wide.sty</code> 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.
<li>Perl 5.0 or higher for Windows. This can be download from:
<li>Perl 5.0 or higher for Windows. This can be downloaded from:
http://www.ActiveState.com/Products/ActivePerl/
<li>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 <A HREF="http://www.trolltech.com/products/qt.html">Qt for
Windows</A> \latexonly\par (see
......@@ -400,7 +401,7 @@ Here is what is required:
<li>To generate LaTeX documentation or formulas in HTML you need the tools:
<code>latex</code>, <code>dvips</code> and <code>gswin32</code>.
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
<code>DVI</code> (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.
<li>goto the doxygen root dir and type:
<li>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 <code>..\html</code>
The generated HTML docs are located in the <code>..\html</code>
subdirectory.
The sources for LaTeX documentation are located in <code>..\latex</code>
The sources for LaTeX documentation are located in the <code>..\latex</code>
subdirectory. From those sources, the DVI, PostScript, and PDF
documentation can be generated.
</ol>
......
doc/maintainers.txt
View file @ e90eb41e
......@@ -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
......
doc/output.doc
View file @ e90eb41e
......@@ -39,14 +39,14 @@ The following output formats are \e indirectly supported by doxygen:
<dt><b>Compressed HTML</b> (a.k.a. Windows 98 help)
<dd>Generated by Microsoft's HTML Help workshop from the HTML output if
\c GENERATE_HTMLHELP is set to \c YES.
<dt><b>Postscript</b>
<dt><b>PostScript</b>
<dd>Generated from the \f$\mbox{\LaTeX}\f$ output by
running <code>make ps</code> in the output directory.
For the best results \c PDF_HYPERLINKS should be set to \c NO.
<dt><b>PDF</b>\htmlonly &nbsp;&nbsp;&nbsp;\endhtmlonly
<dd>Generated from the \f$\mbox{\LaTeX}\f$ output by
running <code>make pdf</code> 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.
</dl>
......
doc/starting.doc
View file @ e90eb41e
......@@ -105,7 +105,7 @@ doxygen <config-file>
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
<code>make</code> 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 <code>make ps</code> (this requires <code>dvips</code>).
To put 2 pages on one physical page use <code>make ps_2on1</code> 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 <code>make pdf</code> (or <code>make pdf_2on1</code>).
To get the best results for PDF output you should set
......
examples/jdstyle.cpp
View file @ e90eb41e
......@@ -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()
......
examples/qtstyle.cpp
View file @ e90eb41e
......@@ -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()
*/
......
packages/rpm/doxygen.spec
View file @ e90eb41e
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
......
qtools/qcstring.cpp
View file @ e90eb41e
......@@ -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;
......
src/config.h
View file @ e90eb41e
......@@ -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
......
src/config.l
View file @ e90eb41e
......@@ -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 || val<m_minVal || val>m_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
......
src/defargs.l
View file @ e90eb41e
......@@ -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);
}
......
src/doc.l
View file @ e90eb41e
......@@ -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);
}
<DocRefName>({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);
......
src/dot.cpp
View file @ e90eb41e
......@@ -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
......
src/doxygen.cpp
View file @ e90eb41e
......@@ -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():"<none>",
// 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():"<none>",
// 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():"<none>",
// 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();
}
......
src/ftvhelp.cpp
View file @ e90eb41e
......@@ -274,6 +274,9 @@ static void generateFolderTreeViewData()
else
{
QTextStream t(&f);
#if QT_VERSION >= 200
t.setEncoding(QTextStream::Latin1);
#endif
t << "<html><head>";
t << "<meta http-equiv=\"Content-Type\" content=\"text/html;charset="
<< theTranslator->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(\"<b>";
if (Config_getString("PROJECT_NAME").isEmpty())
{
......
src/groupdef.cpp
View file @ e90eb41e
......@@ -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)
......
src/htmlgen.cpp
View file @ e90eb41e
......@@ -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 << "<hr><address><small>\n";
t << "Generated at $datetime for $projectname ";
t << " by <a href=\"http://www.doxygen.org/index.html\">\n"
t << theTranslator->trGeneratedAt( "$datetime", "$projectname" );
t << " <a href=\"http://www.doxygen.org/index.html\">\n"
<< "<img src=\"doxygen.gif\" alt=\"doxygen\" "
<< "align=\"middle\" border=0 width=110 height=53>\n"
<< "</a> $doxygenversion written by"
<< "</a> $doxygenversion " << theTranslator->trWrittenBy()
<< " <a href=\"mailto:dimitri@stack.nl\">Dimitri van Heesch</a>,\n"
<< " &copy;&nbsp;1997-2001</small></address>\n"
<< "</body>\n"
......@@ -172,7 +175,8 @@ void HtmlGenerator::startFile(const char *name,const char *,
{
t << substituteKeywords(g_header,lastTitle);
}
t << "<!-- Generated by Doxygen " << versionString << " -->" << endl;
t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
<< versionString << " -->" << 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 << "<a name=\"" << anchor << "\" doxytag=\"" << name << "\"></a>";
......
src/htmlgen.h
View file @ e90eb41e
......@@ -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 << "<a name=\"" << label << "\"></a>"; }
void endCodeAnchor() { }
......
src/htmlhelp.cpp
View file @ e90eb41e
......@@ -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 << "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n"
"<HTML><HEAD></HEAD><BODY>\n"
"<OBJECT type=\"text/site properties\">\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 << "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n"
"<HTML><HEAD></HEAD><BODY>\n"
"<OBJECT type=\"text/site properties\">\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"
......
src/language.cpp
View file @ e90eb41e
......@@ -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)
{
......
src/latexgen.cpp
View file @ e90eb41e
......@@ -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"))
{
......
src/latexgen.h
View file @ e90eb41e
......@@ -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() {}
......
src/mangen.cpp
View file @ e90eb41e
......@@ -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();
......
src/mangen.h
View file @ e90eb41e
......@@ -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() {}
......
src/memberdef.cpp
View file @ e90eb41e
......@@ -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());
......
src/outputgen.h
View file @ e90eb41e
......@@ -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,
......
src/outputlist.h
View file @ e90eb41e
......@@ -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)
......
src/rtfgen.cpp
View file @ e90eb41e
......@@ -565,6 +565,10 @@ static void loadStylesheet(const char *name, QDict<StyleData>& 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))
{
......
src/rtfgen.h
View file @ e90eb41e
......@@ -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() {};
......
src/scanner.l
View file @ e90eb41e
......@@ -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 );
}
<FileDocArg1>"*/" {
current->name = yyFileName;
......
src/translator_cz.h
View file @ e90eb41e
......@@ -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"
"<ul>\n"
"<li>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"
"<li>Tmavì zelená šipka oznaèuje vztah chránìné dìdiènosti "
"(protected).\n"
"<li>Tmavì èervená šipka oznaèuje vztah privátní dìdiènosti.\n"
"<li>Tmavì èervená šipka oznaèuje vztah privátní dìdiènosti "
"(private).\n"
"<li>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 "
......
src/translator_de.h
View file @ e90eb41e
......@@ -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
......
src/translator_en.h
View file @ e90eb41e
......@@ -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";
......
src/translator_es.h
View file @ e90eb41e
......@@ -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
* <pre>"\\usepackage[german]{babel}\n"
* </pre>
* or
* <pre>"\\usepackage{polski}\n"
* "\\usepackage[latin2]{inputenc}\n"
* "\\usepackage[T1]{fontenc}\n"
* </pre>
*
* 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<numEntries-2) // not the fore last entry
result+=", ";
else // the fore last entry
result+=", and ";
result+=", y ";
}
}
return result;
......@@ -611,14 +638,14 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5
/*! This is put above each page as a link to all members of namespaces. */
virtual QCString trNamespaceMembers()
{ return "Namespace miembros"; }
{ return "Miembros del Namespace "; }
/*! This is an introduction to the page with all namespace members */
virtual QCString trNamespaceMemberDescription(bool extractAll)
{
QCString result="Lista de ";
if (!extractAll) result+="toda la documentación de ";
result+="los namespace miembros con enlace a ";
result+="los miembros del namespace con enlace a ";
if (extractAll)
result+="los namespace de cada miembro:";
else
......@@ -714,20 +741,19 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5
{
return "Definición en el archivo @0.";
}
//////////////////////////////////////////////////////////////////////////
// new since 1.0.0
// new since 0.49-991205
//////////////////////////////////////////////////////////////////////////
virtual QCString trDeprecated()
{
return "Desaprobado";
return "Desaprobado";
}
//////////////////////////////////////////////////////////////////////////
// new since 1.1.0
// new since 1.0.0
//////////////////////////////////////////////////////////////////////////
/*! this text is put before a collaboration diagram */
virtual QCString trCollaborationDiagram(const char *clName)
{
......@@ -753,17 +779,17 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5
{
return "Ir a la documentación de este archivo.";
}
/*! Text for the \\pre command */
/*! Text for the \pre command */
virtual QCString trPrecondition()
{
return "Precondición";
}
/*! Text for the \\post command */
/*! Text for the \post command */
virtual QCString trPostcondition()
{
return "Postcondicón";
return "Postcondición";
}
/*! Text for the \\invariant command */
/*! Text for the \invariant command */
virtual QCString trInvariant()
{
return "Invariante";
......@@ -794,6 +820,11 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5
{
return "Página indice";
}
//////////////////////////////////////////////////////////////////////////
// new since 1.1.0
//////////////////////////////////////////////////////////////////////////
virtual QCString trNote()
{
return "Nota";
......@@ -843,12 +874,12 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5
/*! Used as a marker that is put before a todo item */
virtual QCString trTodo()
{
return "Todo";
return "Tareas Pendientes";
}
/*! Used as the header of the todo list */
virtual QCString trTodoList()
{
return "Listado de todo";
return "Listado de Tareas Pendientes";
}
//////////////////////////////////////////////////////////////////////////
......@@ -870,13 +901,331 @@ class TranslatorSpanish : public TranslatorAdapter_1_1_5
virtual QCString trInclByDepGraph()
{
return "Este gráfico muestra que archivos directa o "
"indirectamente incluyen a este archivo.";
"indirectamente incluyen a este archivo:";
}
virtual QCString trSince()
{
return "Desde";
}
//////////////////////////////////////////////////////////////////////////
// new since 1.1.5
//////////////////////////////////////////////////////////////////////////
/*! title of the graph legend page */
QCString trLegendTitle()
{
return "Leyenda del Gráfico";
}
/*! page explaining how the dot graph's should be interpreted */
QCString trLegendDocs()
{
return
"Esta página explica como interpretar los gráficos que son generados "
"por doxygen.<p>\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:"
"<p><center><img src=\"graph_legend.gif\"></center>\n"
"<p>\n"
"Las cajas en el gráfico arriba tienen el significado que sigue:\n"
"<ul>\n"
"<li>Una caja llena negra representa la estructura o clase para la cuál"
"se generó el gráfico.\n"
"<li>Una caja con borde negro señala una estructura o clase documentada.\n"
"<li>Una caja con borde griz señala una estructura o clase no documentada.\n"
"<li>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."
"</ul>\n"
"Las flechas tienen el siguiente significado:\n"
"<ul>\n"
"<li>Una flecha azul oscuro es usada para visualizar una relación "
"herencia publica entre dos clases.\n"
"<li>Una flecha verde oscura es usada para herencia protegida.\n"
"<li>Una flecha rojo oscura es usada para herencia privada.\n"
"<li>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"
"</ul>\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
src/translator_hr.h
View file @ e90eb41e
......@@ -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("Trai"); }
QCString trClassHierarchyDescription()
{ return decode("Stablo naslijeivanja je posloeno "
{ return decode("Stablo naslijeivanja je sloeno "
"priblino 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+="imeniku 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+="suelja (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 greaka");
}
//////////////////////////////////////////////////////////////////////////
// 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("Sadraj");
}
/*! 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
src/translator_ru.h
View file @ e90eb41e
......@@ -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
src/translator_sk.h 0 → 100644
View file @ e90eb41e
/******************************************************************************
*
*
*
* 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("Svisiace funkcie"); }
/*! subscript for the related functions. */
virtual QCString trRelatedSubscript()
{ return Decode("(Uveden funkcie nies lenskmi 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("Dokumentcia k lenskm typom"); }
/*! header that is put before the list of enumerations. */
virtual QCString trMemberEnumerationDocumentation()
{ return Decode("Dokumentcia k lenskm enumercim"); }
/*! header that is put before the list of member functions. */
virtual QCString trMemberFunctionDocumentation()
{ return Decode("Dokumentcia k metdam"); }
/*! header that is put before the list of member attributes. */
virtual QCString trMemberDataDocumentation()
{
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
return Decode("Dokumentcia k polokm");
}
else
{
return Decode("Dokumentcia k dtovm 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 vetkch 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 njdete pln zoznam lenov triedy "); }
/*! this is the remainder of the sentence after the class name */
virtual QCString trIncludingInheritedMembers()
{ return Decode(", vrtane vetkch zdedench 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 zdrojovch 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 enumercie"); }
/*! put after an enum value in the list of all members */
virtual QCString trEnumValue()
{ return Decode("hodnota enumercie"); }
/*! 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("Dtov truktry");
}
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 sborov"); }
/*! This is put above each page as a link to the list of all verbatim headers */
virtual QCString trHeaderFiles()
{ return Decode("Zoznam hlavikovch sborov"); }
/*! 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("Dtov poloky");
}
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("Globlne symboly");
}
else
{
return Decode("Symboly v sboroch");
}
}
/*! This is put above each page as a link to all related pages. */
virtual QCString trRelatedPages()
{ return Decode("Ostatn strnky"); }
/*! This is put above each page as a link to all examples. */
virtual QCString trExamples()
{ return Decode("Prklady"); }
/*! This is put above each page as a link to the search engine. */
virtual QCString trSearch()
{ return Decode("Hada"); }
/*! This is an introduction to the class hierarchy. */
virtual QCString trClassHierarchyDescription()
{ return Decode("Tu njdete zoznam, vyjadrujci vzah dedinosti tried. "
"Je zoraden pribline (ale nie plne) poda abecedy:");
}
/*! This is an introduction to the list with all files. */
virtual QCString trFileListDescription(bool extractAll)
{
QCString result="Tu njdete zoznam vetkch ";
if (!extractAll) result+="dokumentovanch ";
result+="sborov so strunmi 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("Nasledujci zoznam obsahuje identifikciu dtovch "
"truktr a ich strun popisy:");
}
else
{
return Decode("Nasledujci zoznam obsahuje predovetkm identifikciu "
"tried, ale nachdzaj sa tu i alie netrivilne prvky, "
"ako s truktry (struct), uniony (union) a rozhrania "
"(interface). V zozname s uveden ich strun "
"popisy:");
}
}
/*! This is an introduction to the page with all class members. */
virtual QCString trCompoundMembersDescription(bool extractAll)
{
QCString result= "Tu njdete zoznam vetkch ";
if (!extractAll)
{
result += "dokumentovanch ";
}
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
result += "poloiek truktr (struct) a unionov (union) ";
}
else
{
result += "lenov tried ";
}
result += "s odkazmi na ";
if (extractAll)
{
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
result += "dokumentciu truktr/unionov, ku ktorm prislchaj:";
}
else
{
result += "dokumentciu tried, ku ktorm prislchaj:";
}
}
else
{
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
result+="truktry/uniony, ku ktorm prislchaj:";
}
else
{
result+="triedy, ku ktorm prislchaj:";
}
}
return Decode(result);
}
/*! This is an introduction to the page with all file members. */
virtual QCString trFileMembersDescription(bool extractAll)
{
QCString result="Tu njdete zoznam vetkch ";
if (!extractAll) result+="dokumentovanch ";
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
result+="funkci, premennch, makier, enumerci a definci typov (typedef) "
"s odkazmi na ";
}
else
{
result+="symbolov, ktor s definovan na rovni svojich sborov. "
"Pre kad symbol je uveden odkaz na ";
}
if (extractAll)
result+="sbory, ku ktorm prislchaj:";
else
result+="dokumentciu:";
return Decode(result);
}
/*! This is an introduction to the page with the list of all header files. */
virtual QCString trHeaderFilesDescription()
{ return Decode("Tu njdete hlavikov sbory, ktor tvoria "
"aplikan programov rozhranie (API):"); }
/*! This is an introduction to the page with the list of all examples */
virtual QCString trExamplesDescription()
{ return Decode("Tu njdete zoznam vetkch prkladov:"); }
/*! This is an introduction to the page with the list of related pages */
virtual QCString trRelatedPagesDescription()
{ return Decode("Nasledujci zoznam odkazuje na alie strnky projektu, "
"ktor maj charakter usporiadanch zoznamov informci, "
"pozbieranch z rznych miest v zdrojovch sboroch:"); }
/*! This is an introduction to the page with the list of class/file groups */
virtual QCString trModulesDescription()
{ return Decode("Tu njdete zoznam vetkch 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 dispozcii"); }
// 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("Dokumentcia"); }
/*! 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 dtovch truktr");
}
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 sborov"); }
/*! This is used in LaTeX as the title of the chapter containing
* the documentation of all groups.
*/
virtual QCString trModuleDocumentation()
{ return Decode("Dokumentcia 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("Dokumentcia tried"); }
/*! This is used in LaTeX as the title of the chapter containing
* the documentation of all files.
*/
virtual QCString trFileDocumentation()
{ return Decode("Dokumentcia sborov"); }
/*! This is used in LaTeX as the title of the chapter containing
* the documentation of all examples.
*/
virtual QCString trExampleDocumentation()
{ return Decode("Dokumentcia prkladov"); }
/*! This is used in LaTeX as the title of the chapter containing
* the documentation of all related pages.
*/
virtual QCString trPageDocumentation()
{ return Decode("Dokumentcia svisiacich strnok"); }
/*! This is used in LaTeX as the title of the document */
virtual QCString trReferenceManual()
{ return Decode("Referenn prruka"); }
/*! This is used in the documentation of a file as a header before the
* list of defines
*/
virtual QCString trDefines()
{ return Decode("Defincia 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("Defincia typov"); }
/*! This is used in the documentation of a file as a header before the
* list of enumerations
*/
virtual QCString trEnumerations()
{ return Decode("Enumercie"); }
/*! 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 enumerci"); }
/*! 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("Dokumentcia k defincim 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("Dokumentcia prototypov"); }
/*! This is used in the documentation of a file/namespace before the list
* of documentation blocks for typedefs
*/
virtual QCString trTypedefDocumentation()
{ return Decode("Dokumentcia definci 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("Dokumentcia enumeranch 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("Dokumentcia enumeranch hodnt"); }
/*! This is used in the documentation of a file/namespace before the list
* of documentation blocks for functions
*/
virtual QCString trFunctionDocumentation()
{ return Decode("Dokumentcia funkci"); }
/*! This is used in the documentation of a file/namespace before the list
* of documentation blocks for variables
*/
virtual QCString trVariableDocumentation()
{ return Decode("Dokumentcia premennch"); }
/*! 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("Dtov truktry");
}
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("Sbory"); }
/*! 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 dedinosti pre triedu "+clName);
}
/*! this text is generated when the \\internal command is used. */
virtual QCString trForInternalUseOnly()
{ return Decode("Iba pre intern pouitie."); }
/*! this text is generated when the \\reimp command is used. */
virtual QCString trReimplementedForInternalReasons()
{ return Decode("Reimplementovan z internch dvodov; "
"aplikan 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("Dtum"); }
/*! 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("Nvratov 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("Vnimky"); }
/*! 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 njdete zoznam vetkch ";
if (!extractAll) result+="dokumentovanch ";
result+="priestorov mien so strunm 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("Dokumentcia k priateom (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("Dokumentcia ");
if (isTemplate) result+="ablny ";
switch(compType)
{
case ClassDef::Class: result+="triedy "; break;
case ClassDef::Struct: result+="truktry "; break;
case ClassDef::Union: result+="unionu "; break;
case ClassDef::Interface: result+="rozhrania "; break;
case ClassDef::Exception: result+="vnimky "; 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("Dokumentcia sboru ");
result+=fileName;
return Decode(result);
}
/*! used as the title of the HTML page of a namespace */
virtual QCString trNamespaceReference(const char *namespaceName)
{
QCString result("Dokumentcia 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 metdy"); }
virtual QCString trPublicSlots()
{ return Decode("Verejn sloty"); }
virtual QCString trSignals()
{ return Decode("Signly"); }
virtual QCString trStaticPublicMembers()
{ return Decode("Statick verejn metdy"); }
virtual QCString trProtectedMembers()
{ return Decode("Chrnen metdy"); }
virtual QCString trProtectedSlots()
{ return Decode("Chrnen sloty"); }
virtual QCString trStaticProtectedMembers()
{ return Decode("Statick chrnen metdy"); }
virtual QCString trPrivateMembers()
{ return Decode("Privtne metdy"); }
virtual QCString trPrivateSlots()
{ return Decode("Privtne sloty"); }
virtual QCString trStaticPrivateMembers()
{ return Decode("Statick privtne metdy"); }
/*! \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<numEntries;i++)
{
// use generateMarker to generate placeholders for the class links!
result+=generateMarker(i); // generate marker for entry i in the list
// (order is left to right)
if (i!=numEntries-1) // not the last entry, so we need a separator
{
if (i<numEntries-2) // not the fore last entry
result+=", ";
else // the fore last entry
result+=" a ";
}
}
return Decode(result);
}
/*! used in class documentation to produce a list of base classes,
* if class diagrams are disabled.
*/
virtual QCString trInheritsList(int numEntries)
{
QCString result("Ded od ");
result += (numEntries == 1) ? "bzovej triedy " : "bzovch tried ";
result += trWriteList(numEntries)+".";
return Decode(result);
}
/*! used in class documentation to produce a list of super classes,
* if class diagrams are disabled.
*/
virtual QCString trInheritedByList(int numEntries)
{
QCString result("Zdeden ");
result += (numEntries == 1) ? "triedou " : "triedami ";
result += trWriteList(numEntries)+".";
return Decode(result);
}
/*! used in member documentation blocks to produce a list of
* members that are hidden by this one.
*/
virtual QCString trReimplementedFromList(int numEntries)
{
QCString result("Reimplementuje ");
result += (numEntries == 1) ? "metdu triedy " : "metdy tried ";
result += trWriteList(numEntries)+".";
return Decode(result);
}
/*! used in member documentation blocks to produce a list of
* all member that overwrite the implementation of this member.
*/
virtual QCString trReimplementedInList(int numEntries)
{
QCString result("Reimplementovan ");
result += (numEntries == 1) ? "triedou " : "triedami ";
result += trWriteList(numEntries)+".";
return Decode(result);
}
/*! This is put above each page as a link to all members of namespaces. */
virtual QCString trNamespaceMembers()
{ return Decode("Symboly v priestoroch mien"); }
/*! This is an introduction to the page with all namespace members */
virtual QCString trNamespaceMemberDescription(bool extractAll)
{
QCString result="Tu njdete zoznam vetkch ";
if (!extractAll) result+="dokumentovanch ";
result+="symbolov, ktor s definovan vo svojich priestoroch mien. "
"U kadho je uveden odkaz na ";
if (extractAll)
result+="dokumentciu prslunho priestoru mien:";
else
result+="prslun priestor mien:";
return Decode(result);
}
/*! This is used in LaTeX as the title of the chapter with the
* index of all namespaces.
*/
virtual QCString trNamespaceIndex()
{ return Decode("Register priestorov mien"); }
/*! This is used in LaTeX as the title of the chapter containing
* the documentation of all namespaces.
*/
virtual QCString trNamespaceDocumentation()
{ return Decode("Dokumentcia priestorov mien"); }
//////////////////////////////////////////////////////////////////////////
// new since 0.49-990522
//////////////////////////////////////////////////////////////////////////
/*! This is used in the documentation before the list of all
* namespaces in a file.
*/
virtual QCString trNamespaces()
{ return Decode("Priestory mien"); }
//////////////////////////////////////////////////////////////////////////
// new since 0.49-990728
//////////////////////////////////////////////////////////////////////////
/*! This is put at the bottom of a class documentation page and is
* followed by a list of files that were used to generate the page.
*/
virtual QCString trGeneratedFromFiles(ClassDef::CompoundType compType,
bool single)
{ // here s is one of " Class", " Struct" or " Union"
// single is true implies a single file
QCString result=(QCString)"Dokumentcia pre ";
switch(compType)
{
case ClassDef::Class: result+="tto triedu"; break;
case ClassDef::Struct: result+="tto truktru (struct)"; break;
case ClassDef::Union: result+="tento union"; break;
case ClassDef::Interface: result+="toto rozhranie"; break;
case ClassDef::Exception: result+="tto vnimku"; break;
}
result+=" bola generovan z ";
if (single) result+="nasledujceho sboru:";
else result+="nasledujcich sborov:";
return Decode(result);
}
/*! This is in the (quick) index as a link to the alphabetical compound
* list.
*/
virtual QCString trAlphabeticalList()
{ return Decode("Register tried"); }
//////////////////////////////////////////////////////////////////////////
// new since 0.49-990901
//////////////////////////////////////////////////////////////////////////
/*! This is used as the heading text for the retval command. */
virtual QCString trReturnValues()
{ return Decode("Nvratov hodnoty"); }
/*! This is in the (quick) index as a link to the main page (index.html)
*/
virtual QCString trMainPage()
{ return Decode("Hlavn strnka"); }
/*! This is used in references to page that are put in the LaTeX
* documentation. It should be an abbreviation of the word page.
*/
virtual QCString trPageAbbreviation()
{ return Decode("s."); }
//////////////////////////////////////////////////////////////////////////
// new since 0.49-991003
//////////////////////////////////////////////////////////////////////////
virtual QCString trSources()
{
return Decode("Zdroje");
}
virtual QCString trDefinedAtLineInSourceFile()
{
return Decode("Defincia je uveden na riadku @0 v sbore @1.");
}
virtual QCString trDefinedInSourceFile()
{
return Decode("Defincia v sbore @0.");
}
//////////////////////////////////////////////////////////////////////////
// new since 0.49-991205
//////////////////////////////////////////////////////////////////////////
virtual QCString trDeprecated()
{
return Decode("Zastaral");
}
//////////////////////////////////////////////////////////////////////////
// new since 1.0.0
//////////////////////////////////////////////////////////////////////////
/*! this text is put before a collaboration diagram */
virtual QCString trCollaborationDiagram(const char *clName)
{
return Decode((QCString)"Diagram tried pre "+clName+":");
}
/*! this text is put before an include dependency graph */
virtual QCString trInclDepGraph(const char *fName)
{
return Decode((QCString)"Graf zvislost na vkladanch sboroch "
"pre "+fName+":");
}
/*! header that is put before the list of constructor/destructors. */
virtual QCString trConstructorDocumentation()
{
return Decode("Dokumentcia kontruktoru a detruktoru");
}
/*! Used in the file documentation to point to the corresponding sources. */
virtual QCString trGotoSourceCode()
{
return Decode("Zobrazi zdrojov text tohoto sboru.");
}
/*! Used in the file sources to point to the corresponding documentation. */
virtual QCString trGotoDocumentation()
{
return Decode("Zobrazi dokumentciu tohoto sboru.");
}
/*! Text for the \pre command */
virtual QCString trPrecondition()
{
return Decode("Prepodmienka");
}
/*! Text for the \post command */
virtual QCString trPostcondition()
{
return Decode("Postpodmienka");
}
/*! Text for the \invariant command */
virtual QCString trInvariant()
{
return Decode("Invariant");
}
/*! Text shown before a multi-line variable/enum initialization */
virtual QCString trInitialValue()
{
return Decode("Inicializtor:");
}
/*! Text used the source code in the file index */
virtual QCString trCode()
{
return Decode("zdrojov text");
}
virtual QCString trGraphicalHierarchy()
{
return Decode("Grafick zobrazenie hierarchie tried");
}
virtual QCString trGotoGraphicalHierarchy()
{
return Decode("Zobrazi grafick podobu hierarchie tried");
}
virtual QCString trGotoTextualHierarchy()
{
return Decode("Zobrazi textov podobu hierarchie tried");
}
virtual QCString trPageIndex()
{
return Decode("Register strnok");
}
//////////////////////////////////////////////////////////////////////////
// new since 1.1.0
//////////////////////////////////////////////////////////////////////////
virtual QCString trNote()
{
return Decode("Poznmka");
}
virtual QCString trPublicTypes()
{
return Decode("Verejn typy");
}
virtual QCString trPublicAttribs()
{
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
return Decode("Dtov poloky");
}
else
{
return Decode("Verejn atribty");
}
}
virtual QCString trStaticPublicAttribs()
{
return Decode("Statick verejn atribty");
}
virtual QCString trProtectedTypes()
{
return Decode("Chrnen typy");
}
virtual QCString trProtectedAttribs()
{
return Decode("Chrnen atribty");
}
virtual QCString trStaticProtectedAttribs()
{
return Decode("Statick chrnen atribty");
}
virtual QCString trPrivateTypes()
{
return Decode("Privtne typy");
}
virtual QCString trPrivateAttribs()
{
return Decode("Privtne atribty");
}
virtual QCString trStaticPrivateAttribs()
{
return Decode("Statick privtne atribty");
}
//////////////////////////////////////////////////////////////////////////
// new since 1.1.3
//////////////////////////////////////////////////////////////////////////
/*! Used as a marker that is put before a todo item */
virtual QCString trTodo()
{
return Decode("Plnovan pravy");
}
/*! Used as the header of the todo list */
virtual QCString trTodoList()
{
return Decode("Zoznam plnovanch prav");
}
//////////////////////////////////////////////////////////////////////////
// new since 1.1.4
//////////////////////////////////////////////////////////////////////////
virtual QCString trReferencedBy()
{
return Decode("Pouva sa v");
}
virtual QCString trRemarks()
{
return Decode("Poznmky"); // ??? not checked in a context
}
virtual QCString trAttention()
{
return Decode("Upozornenie"); // ??? not checked in a context
}
virtual QCString trInclByDepGraph()
{
return Decode("Nasledujci graf ukazuje, ktor sbory priamo alebo "
"nepriamo vkladaj tento sbor:");
}
virtual QCString trSince()
{
return Decode("Od"); // ??? not checked in a context
}
////////////////////////////////////////////////////////////////////////////
// new since 1.1.5
//////////////////////////////////////////////////////////////////////////
/*! title of the graph legend page */
virtual QCString trLegendTitle()
{
return Decode("Vysvetlivky ku grafu");
}
/*! page explaining how the dot graph's should be interpreted */
virtual QCString trLegendDocs()
{
QCString result(
"Tu njdete vysvetlenie, ako maj by interpretovan grafy, "
"ktor boli generovan programom doxygen.<p>\n"
"Uvaujte nasledujci prklad:\n"
"\\code\n"
"/*! Neviditeln trieda, ktor sa v grafe nezobrazuje, pretoe "
"dolo k orezaniu grafu. */\n"
"class Invisible { };\n\n"
"/*! Trieda, u ktorej dolo k orezaniu grafu. Vzah dedinosti "
"je skryt. */\n"
"class Truncated : public Invisible { };\n\n"
"/* Trieda, ktor nieje dokumentovan komentrmi programu doxygen. */\n"
"class Undocumented { };\n\n"
"/*! Odvoden trieda s verejnm (public) dedenm bzovej triedy. */\n"
"class PublicBase : public Truncated { };\n\n"
"/*! Odvoden trieda s chrnenm (protected) dedenm bzovej triedy. */\n"
"class ProtectedBase { };\n\n"
"/*! Odvoden trieda s privtnym dedenm bzovej triedy. */\n"
"class PrivateBase { };\n\n"
"/*! Trieda, ktor je vyuvan triedou Inherited. */\n"
"class Used { };\n\n"
"/*! Odvoden trieda, ktor rznym spsobom ded od viacerch bzovch "
"tried. */\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"
"Pokia je poloka \\c MAX_DOT_GRAPH_HEIGHT konfiguranho sboru "
"nastaven na hodnotu 200, bude vygenerovan nasledujci graf:"
"<p><center><img src=\"graph_legend.gif\"></center>\n"
"<p>\n"
"Bloky (tj. uzly) v uvedenom grafe maj nasledujci vznam:\n"
"<ul>\n"
"<li>ierne vyplnen obdnik reprezentuje truktru alebo triedu, "
"pre ktor bol graf generovan.\n"
"<li>Obdnik s iernym obrysom oznauje dokumentovan "
"truktru alebo triedu.\n"
"<li>Obdnik so edm obrysom oznauje nedokumentovan "
"truktru alebo triedu.\n"
"<li>Obdnik s ervenm obrysom oznauje dokumentovan "
"truktru alebo triedu, pre ktor\n"
"nies zobrazen vetky vzahy dedinosti alebo obsiahnutia. "
"Graf je orezan v prpade, kedy ho\n"
"nieje mon umiestni do vymedzench hranc.\n"
"</ul>\n"
"pky (tj. hrany grafu) maj nasledujc vznam:\n"
"<ul>\n"
"<li>Tmavo modr pka sa pouva pre oznaenie vzahu verejnej "
"dedinosti medzi dvoma triedami.\n"
"<li>Tmavo zelen pka oznauje vzah chrnenej dedinosti "
"(protected).\n"
"<li>Tmavo erven pka oznauje vzah privtnej dedinosti.\n"
"<li>Purpurov pka kreslen iarkovane sa pouva v prpade, "
"ak je trieda obsiahnut v inej triede,\n"
"alebo ak je pouvan inou triedou. Je oznaen identifiktorom "
"jednej alebo viacerch premennch (objektov), cez ktor\n"
"je trieda alebo truktra zprstupnena.\n"
"</ul>\n");
return Decode(result);
}
/*! text for the link to the legend page */
virtual QCString trLegend()
{
return Decode("vysvetlivky");
}
//////////////////////////////////////////////////////////////////////////
// new since 1.2.0
//////////////////////////////////////////////////////////////////////////
/*! Used as a marker that is put before a test item */
virtual QCString trTest()
{
return Decode("Test");
}
/*! Used as the header of the test list */
virtual QCString trTestList()
{
return Decode("Zoznam testov");
}
//////////////////////////////////////////////////////////////////////////
// new since 1.2.1
//////////////////////////////////////////////////////////////////////////
/*! Used as a section header for KDE-2 IDL methods */
virtual QCString trDCOPMethods()
{
return Decode("Metdy DCOP");
}
//////////////////////////////////////////////////////////////////////////
// new since 1.2.2
//////////////////////////////////////////////////////////////////////////
/*! Used as a section header for IDL properties */
virtual QCString trProperties()
{
return Decode("Vlastnosti");
}
/*! Used as a section header for IDL property documentation */
virtual QCString trPropertyDocumentation()
{
return Decode("Dokumentcia k vlastnosti");
}
//////////////////////////////////////////////////////////////////////////
// new since 1.2.4
//////////////////////////////////////////////////////////////////////////
/*! Used for Java interfaces in the summary section of Java packages */
virtual QCString trInterfaces()
{
return Decode("Rozhranie");
}
/*! Used for Java classes in the summary section of Java packages */
virtual QCString trClasses()
{
return Decode("Triedy");
}
/*! Used as the title of a Java package */
virtual QCString trPackage(const char *name)
{
return Decode((QCString)"Balk "+name);
}
/*! Title of the package index page */
virtual QCString trPackageList()
{
return Decode("Zoznam balkov");
}
/*! The description of the package index page */
virtual QCString trPackageListDescription()
{
return Decode("Tu njdete zoznam balkov so strunm popisom "
"(pokia bol uveden):");
}
/*! The link name in the Quick links header for each page */
virtual QCString trPackages()
{
return Decode("Balky");
}
/*! Used as a chapter title for Latex & RTF output */
virtual QCString trPackageDocumentation()
{
return Decode("Dokumentcia balku");
}
/*! Text shown before a multi-line define */
virtual QCString trDefineValue()
{
return Decode("Hodnota:");
}
//////////////////////////////////////////////////////////////////////////
// new since 1.2.5
//////////////////////////////////////////////////////////////////////////
/*! Used as a marker that is put before a \\bug item */
virtual QCString trBug()
{
return Decode("Chyba");
}
/*! Used as the header of the bug list */
virtual QCString trBugList()
{
return Decode("Zoznam chb");
}
//////////////////////////////////////////////////////////////////////////
// new since 1.2.6-20010422
//////////////////////////////////////////////////////////////////////////
/*! Used as ansicpg for RTF file */
virtual QCString trRTFansicp()
{
return "1250";
}
/*! Used as ansicpg for RTF fcharset */
virtual QCString trRTFCharSet()
{
return "0"; //???
}
/*! Used as header RTF general index */
virtual QCString trRTFGeneralIndex()
{
return "Index"; //???
}
/*! 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 ? "Tried" : "tried"));
result+=(singular ? "a" : "y");
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 trFile(bool first_capital, bool singular)
{
QCString result((first_capital ? "Sbor" : "sbor"));
if (!singular) result+="y";
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 trNamespace(bool first_capital, bool singular)
{
QCString result((first_capital ? "Priestor" : "priestor"));
if (!singular) result+="y";
result+=" mien";
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 trGroup(bool first_capital, bool singular)
{
QCString result((first_capital ? "Skupin" : "skupin"));
result+=(singular ? "a" : "y");
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 trPage(bool first_capital, bool singular)
{
QCString result((first_capital ? "Strnk" : "strnk"));
result+=(singular ? "a" : "y");
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 trMember(bool first_capital, bool singular)
{
QCString result((first_capital ? "len" : "len"));
if (!singular) result+="y";
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 ? "Polok" : "polok"));
result+=(singular ? "a" : "y");
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 trGlobal(bool first_capital, bool singular)
{
QCString result((first_capital ? "Globln" : "globln"));
result+=(singular ? "y" : "e");
return result;
}
};
#endif // TRANSLATOR_SK_H
src/util.cpp
View file @ e90eb41e
......@@ -366,40 +366,49 @@ NamespaceDef *getResolvedNamespace(const char *name)
}
}
ClassDef *getResolvedClass(const char *name,bool *pIsTypeDef,QCString *pTemplSpec)
ClassDef *getResolvedClass(const char *n,bool *pIsTypeDef,QCString *pTemplSpec)
{
if (name==0 || name[0]=='\0') return 0;
QCString *subst = Doxygen::typedefDict[name];
QCString name = n;
if (name.isEmpty()) return 0;
int i = name.findRev("::");
QCString *subst = 0;
if (i!=-1) subst = Doxygen::typedefDict[name.right(name.length()-i-2)];
if (subst==0) subst = Doxygen::typedefDict[name],i=-1;
if (subst) // there is a typedef with this name
{
if (pIsTypeDef) *pIsTypeDef=TRUE;
//printf("getResolvedClass `%s'->`%s'\n",name,subst->data());
//printf("getResolvedClass `%s'->`%s'\n",name.data(),subst->data());
if (*subst==name) // avoid resolving typedef struct foo foo;
{
return Doxygen::classSDict.find(name);
}
int count=0; // recursion detection guard
QCString *newSubst;
while ((newSubst=Doxygen::typedefDict[*subst]) && count<10)
QCString typeName = *subst;
if (i!=-1) typeName.prepend(name.left(i)+"::");
while ((newSubst=Doxygen::typedefDict[typeName]) && count<10)
{
if (*subst==*newSubst) return Doxygen::classSDict.find(subst->data()); // for breaking typedef struct A A;
if (typeName==*newSubst)
return Doxygen::classSDict.find(subst->data()); // for breaking typedef struct A A;
subst=newSubst;
typeName=*newSubst;
if (i!=-1) typeName.prepend(name.left(i)+"::");
count++;
}
if (count==10)
{
warn_cont("Warning: possible recursive typedef dependency detected for %s!\n",name);
warn_cont("Warning: possible recursive typedef dependency detected for %s!\n",n);
return Doxygen::classSDict.find(name);
}
else
{
//printf("getClass: subst %s->%s\n",name,subst->data());
//printf("getClass: subst %s->%s\n",name.data(),typeName.data());
int i;
ClassDef *cd = Doxygen::classSDict.find(subst->data());
if (cd==0 && (i=subst->find('<'))>0) // try unspecialized version as well
ClassDef *cd = Doxygen::classSDict.find(typeName);
if (cd==0 && (i=typeName.find('<'))>0) // try unspecialized version as well
{
if (pTemplSpec) *pTemplSpec = subst->right(subst->length()-i);
return Doxygen::classSDict.find(subst->left(i));
if (pTemplSpec) *pTemplSpec = typeName.right(typeName.length()-i);
return Doxygen::classSDict.find(typeName.left(i));
}
else
{
......@@ -1085,7 +1094,8 @@ void stripIrrelevantConstVolatile(QCString &s)
static bool matchArgument(const Argument *srcA,const Argument *dstA,
const QCString &className,
const QCString &namespaceName,
NamespaceList *usingList)
NamespaceList *usingNamespaces,
ClassList *usingClasses)
{
QCString srcAType=trimTemplateSpecifiers(className,srcA->type);
QCString dstAType=trimTemplateSpecifiers(className,dstA->type);
......@@ -1149,9 +1159,9 @@ static bool matchArgument(const Argument *srcA,const Argument *dstA,
srcAType=trimScope(namespaceName,srcAType);
dstAType=trimScope(namespaceName,dstAType);
}
if (usingList && usingList->count()>0)
if (usingNamespaces && usingNamespaces->count()>0)
{
NamespaceListIterator nli(*usingList);
NamespaceListIterator nli(*usingNamespaces);
NamespaceDef *nd;
for (;(nd=nli.current());++nli)
{
......@@ -1159,6 +1169,16 @@ static bool matchArgument(const Argument *srcA,const Argument *dstA,
dstAType=trimScope(nd->name(),dstAType);
}
}
if (usingClasses && usingClasses->count()>0)
{
ClassListIterator cli(*usingClasses);
ClassDef *cd;
for (;(cd=cli.current());++cli)
{
srcAType=trimScope(cd->name(),srcAType);
dstAType=trimScope(cd->name(),dstAType);
}
}
if (!srcA->name.isEmpty() && !dstA->type.isEmpty() &&
(srcAType+" "+srcA->name)==dstAType)
......@@ -1276,7 +1296,8 @@ static bool matchArgument(const Argument *srcA,const Argument *dstA,
static void mergeArgument(Argument *srcA,Argument *dstA,
const QCString &className,
const QCString &namespaceName,
NamespaceList *usingList)
NamespaceList *usingNamespaces,
ClassList *usingClasses)
{
QCString srcAType=trimTemplateSpecifiers(className,srcA->type);
QCString dstAType=trimTemplateSpecifiers(className,dstA->type);
......@@ -1319,9 +1340,9 @@ static void mergeArgument(Argument *srcA,Argument *dstA,
srcAType=trimScope(namespaceName,srcAType);
dstAType=trimScope(namespaceName,dstAType);
}
if (usingList && usingList->count()>0)
if (usingNamespaces && usingNamespaces->count()>0)
{
NamespaceListIterator nli(*usingList);
NamespaceListIterator nli(*usingNamespaces);
NamespaceDef *nd;
for (;(nd=nli.current());++nli)
{
......@@ -1329,6 +1350,16 @@ static void mergeArgument(Argument *srcA,Argument *dstA,
dstAType=trimScope(nd->name(),dstAType);
}
}
if (usingClasses && usingClasses->count()>0)
{
ClassListIterator cli(*usingClasses);
ClassDef *cd;
for (;(cd=cli.current());++cli)
{
srcAType=trimScope(cd->name(),srcAType);
dstAType=trimScope(cd->name(),dstAType);
}
}
if (!srcA->name.isEmpty() && !dstA->type.isEmpty() &&
(srcAType+" "+srcA->name)==dstAType)
......@@ -1463,7 +1494,8 @@ static void mergeArgument(Argument *srcA,Argument *dstA,
*/
bool matchArguments(ArgumentList *srcAl,ArgumentList *dstAl,
const char *cl,const char *ns,bool checkCV,
NamespaceList *usingList)
NamespaceList *usingNamespaces,
ClassList *usingClasses)
{
QCString className=cl;
QCString namespaceName=ns;
......@@ -1475,10 +1507,13 @@ bool matchArguments(ArgumentList *srcAl,ArgumentList *dstAl,
className=className.left(til)+className.right(className.length()-tir-1);
}
//printf("matchArguments(%s,%s) className=%s namespaceName=%s checkCV=%d\n",
//printf("matchArguments(%s,%s) className=%s namespaceName=%s checkCV=%d usingNamespaces=%d usingClasses=%d\n",
// srcAl ? argListToString(srcAl).data() : "",
// dstAl ? argListToString(dstAl).data() : "",
// cl,ns,checkCV);
// cl,ns,checkCV,
// usingNamespaces?usingNamespaces->count():0,
// usingClasses?usingClasses->count():0
// );
if (srcAl==0 || dstAl==0)
{
......@@ -1541,7 +1576,8 @@ bool matchArguments(ArgumentList *srcAl,ArgumentList *dstAl,
Argument *srcA,*dstA;
for (;(srcA=srcAli.current(),dstA=dstAli.current());++srcAli,++dstAli)
{
if (!matchArgument(srcA,dstA,className,namespaceName,usingList))
if (!matchArgument(srcA,dstA,className,namespaceName,
usingNamespaces,usingClasses))
{
NOMATCH
return FALSE;
......@@ -1553,7 +1589,8 @@ bool matchArguments(ArgumentList *srcAl,ArgumentList *dstAl,
++srcAli,++dstAli
)
{
mergeArgument(srcA,dstA,className,namespaceName,usingList);
mergeArgument(srcA,dstA,className,namespaceName,
usingNamespaces,usingClasses);
}
MATCH
return TRUE; // all arguments match
......@@ -1737,7 +1774,8 @@ bool getDefs(const QCString &scName,const QCString &memberName,
{
if (mmd->isLinkable())
{
bool match=args==0 || matchArguments(mmd->argumentList(),argList,className,0,FALSE);
bool match=args==0 ||
matchArguments(mmd->argumentList(),argList,className,0,FALSE);
//printf("match=%d\n",match);
if (match)
{
......@@ -1847,7 +1885,8 @@ bool getDefs(const QCString &scName,const QCString &memberName,
{
argList=new ArgumentList;
stringToArgumentList(args,argList);
match=matchArguments(mmd->argumentList(),argList,0,namespaceName,FALSE);
match=matchArguments(mmd->argumentList(),argList,0,
namespaceName,FALSE);
}
if (match)
{
......
src/util.h
View file @ e90eb41e
......@@ -38,6 +38,7 @@ class ClassSDict;
class BaseClassList;
class GroupDef;
class NamespaceList;
class ClassList;
class MemberGroupList;
class MemberGroupDict;
......@@ -96,10 +97,10 @@ void writePageRef(OutputDocInterface &od,const char *cn,const char *mn);
extern bool matchArguments(ArgumentList *,ArgumentList *,
const char *cl=0,const char *ns=0,bool checkCV=TRUE,
NamespaceList *usingList=0);
NamespaceList *usingNamespaces=0,
ClassList *usingClasses=0);
extern void mergeArguments(ArgumentList *,ArgumentList *);
extern QCString substituteClassNames(const QCString &s);
//extern QCString convertFileName(const QCString &s);
extern QCString substitute(const char *s,const char *src,const char *dst);
extern QCString resolveDefines(const char *n);
extern ClassDef *getClass(const char *key);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment