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
Expand all 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
This diff is collapsed.
doc/config.doc
View file @ e90eb41e
This diff is collapsed.
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
This diff is collapsed.
src/translator_hr.h
View file @ e90eb41e
This diff is collapsed.
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
This diff is collapsed.
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