Skip to content

D
doxverilog
Commit e31402cb authored by Petr Prikryl's avatar Petr Prikryl
Browse files
Options

doc/language.doc generated from the updated sources (bgcolored)

parent b935f319
Hide whitespace changes
Inline Side-by-side
Showing with 139 additions and 135 deletions
doc/language.doc
View file @ e31402cb
/******************************************************************************
* Do not edit this file. It was generated by the translator.py script.
* Do not edit this file. It was generated by the translator.py script.
*
* Copyright (C) 1997-2013 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
* 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.
*
......@@ -22,7 +22,7 @@ text fragments, generated by doxygen, can be produced in languages other
than English (the default). The output language is chosen through the
configuration file (with default name and known as Doxyfile).
Currently (version 1.8.4), 40 languages
Currently (version 1.8.5), 40 languages
are supported (sorted alphabetically):
Afrikaans, Arabic, Armenian, Brazilian Portuguese, Catalan, Chinese,
Chinese Traditional, Croatian, Czech, Danish, Dutch, English,
......@@ -52,256 +52,256 @@ when the translator was updated.
<!-- table content begin -->
<tr bgcolor="#ffffff">
<td>Afrikaans</td>
<td bgcolor="#ffffff">Afrikaans</td>
<td>Johan Prinsloo</td>
<td>johan at zippysnoek dot com</td>
<td>1.6.0</td>
<td bgcolor="#ffcccc">1.6.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>Arabic</td>
<td bgcolor="#ffcccc">Arabic</td>
<td>Moaz Reyad<br/>Muhammad Bashir Al-Noimi</td>
<td><span style="color: brown">[resigned]</span><br/>mbnoimi at gmail dot com</td>
<td>1.4.6</td>
<td bgcolor="#ff5555">1.4.6</td>
</tr>
<tr bgcolor="#ffffff">
<td>Armenian</td>
<td bgcolor="#ffffff">Armenian</td>
<td>Armen Tangamyan</td>
<td>armen dot tangamyan at anu dot edu dot au</td>
<td>1.8.0</td>
<td bgcolor="#ffffcc">1.8.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>Brazilian Portuguese</td>
<td bgcolor="#ffffff">Brazilian Portuguese</td>
<td>Fabio "FJTC" Jun Takada Chino</td>
<td>jun-chino at uol dot com dot br</td>
<td>1.8.0</td>
<td bgcolor="#ffffcc">1.8.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>Catalan</td>
<td bgcolor="#ffffff">Catalan</td>
<td>Maximiliano Pin<br/>Albert Mora</td>
<td>max dot pin at bitroit dot com<br/><span style="color: brown">[unreachable]</span></td>
<td>1.8.0</td>
<td bgcolor="#ffffcc">1.8.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>Chinese</td>
<td bgcolor="#ffffff">Chinese</td>
<td>Lian Yang<br/>Li Daobing<br/>Wei Liu</td>
<td>lian dot yang dot cn at gmail dot com<br/>lidaobing at gmail dot com<br/>liuwei at asiainfo dot com</td>
<td>1.8.2</td>
<td bgcolor="#ffffcc">1.8.2</td>
</tr>
<tr bgcolor="#ffffff">
<td>Chinese Traditional</td>
<td bgcolor="#ffffff">Chinese Traditional</td>
<td>Daniel YC Lin<br/>Gary Lee</td>
<td>dlin dot tw at gmail dot com<br/>garywlee at gmail dot com</td>
<td>up-to-date</td>
<td bgcolor="#ffffff">almost up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>Croatian</td>
<td bgcolor="#ffffff">Croatian</td>
<td>Boris Bralo</td>
<td>boris dot bralo at gmail dot com</td>
<td>1.8.2</td>
<td bgcolor="#ffffcc">1.8.2</td>
</tr>
<tr bgcolor="#ffffff">
<td>Czech</td>
<td bgcolor="#ffffff">Czech</td>
<td>Petr Přikryl</td>
<td>prikryl at atlas dot cz</td>
<td>up-to-date</td>
<td bgcolor="#ccffcc">up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>Danish</td>
<td bgcolor="#ffffff">Danish</td>
<td>Poul-Erik Hansen<br/>Erik Søe Sørensen</td>
<td>pouhan at gnotometrics dot dk<br/>eriksoe+doxygen at daimi dot au dot dk</td>
<td>1.8.0</td>
<td bgcolor="#ffffcc">1.8.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>Dutch</td>
<td bgcolor="#ffffff">Dutch</td>
<td>Dimitri van Heesch</td>
<td>dimitri at stack dot nl</td>
<td>up-to-date</td>
<td bgcolor="#ccffcc">up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>English</td>
<td bgcolor="#ffffff">English</td>
<td>Dimitri van Heesch</td>
<td>dimitri at stack dot nl</td>
<td>up-to-date</td>
<td bgcolor="#ccffcc">up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>Esperanto</td>
<td bgcolor="#ffffff">Esperanto</td>
<td>Ander Martínez</td>
<td>ander dot basaundi at gmail dot com</td>
<td>1.8.4</td>
<td bgcolor="#ffffcc">1.8.4</td>
</tr>
<tr bgcolor="#ffffff">
<td>Finnish</td>
<td bgcolor="#ffffff">Finnish</td>
<td>Antti Laine</td>
<td>antti dot a dot laine at tut dot fi</td>
<td>1.6.0</td>
<td bgcolor="#ffcccc">1.6.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>French</td>
<td bgcolor="#ffffff">French</td>
<td>David Martinet<br/>Xavier Outhier<br/>Benoît BROSSE</td>
<td>contact at e-concept-applications dot fr<br/>xouthier at yahoo dot fr<br/>Benoit dot BROSSE at ingenico dot com</td>
<td>up-to-date</td>
<td bgcolor="#ccffcc">up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>German</td>
<td bgcolor="#ffffff">German</td>
<td>Peter Grotrian<br/>Jens Seidel</td>
<td>Peter dot Grotrian at pdv-FS dot de<br/>jensseidel at users dot sf dot net</td>
<td>1.8.4</td>
<td bgcolor="#ffffcc">1.8.4</td>
</tr>
<tr bgcolor="#ffffff">
<td>Greek</td>
<td bgcolor="#ffffff">Greek</td>
<td>Paul Gessos</td>
<td>gessos dot paul at yahoo dot gr</td>
<td>1.8.4</td>
<td bgcolor="#ffffcc">1.8.4</td>
</tr>
<tr bgcolor="#ffffff">
<td>Hungarian</td>
<td bgcolor="#ffcccc">Hungarian</td>
<td>Ákos Kiss<br/>Földvári György</td>
<td>akiss at users dot sourceforge dot net<br/><span style="color: brown">[unreachable]</span></td>
<td>1.4.6</td>
<td bgcolor="#ff5555">1.4.6</td>
</tr>
<tr bgcolor="#ffffff">
<td>Indonesian</td>
<td bgcolor="#ffffff">Indonesian</td>
<td>Hendy Irawan</td>
<td>ceefour at gauldong dot net</td>
<td>1.8.0</td>
<td bgcolor="#ffffcc">1.8.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>Italian</td>
<td bgcolor="#ffffff">Italian</td>
<td>Alessandro Falappa<br/>Ahmed Aldo Faisal</td>
<td>alessandro at falappa dot net<br/>aaf23 at cam dot ac dot uk</td>
<td>1.8.2</td>
<td bgcolor="#ffffcc">1.8.2</td>
</tr>
<tr bgcolor="#ffffff">
<td>Japanese</td>
<td bgcolor="#ffffff">Japanese</td>
<td>Hiroki Iseri<br/>Ryunosuke Satoh<br/>Kenji Nagamatsu<br/>Iwasa Kazmi</td>
<td>goyoki at gmail dot com<br/>sun594 at hotmail dot com<br/>naga at joyful dot club dot ne dot jp<br/><span style="color: brown">[unreachable]</span></td>
<td>1.6.0</td>
<td bgcolor="#ffcccc">1.6.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>JapaneseEn</td>
<td bgcolor="#ffffff">JapaneseEn</td>
<td>see the Japanese language</td>
<td>&nbsp;</td>
<td>English based</td>
<td bgcolor="#ccffcc">English based</td>
</tr>
<tr bgcolor="#ffffff">
<td>Korean</td>
<td bgcolor="#ffffff">Korean</td>
<td>Kim Taedong<br/>SooYoung Jung<br/>Richard Kim</td>
<td>fly1004 at gmail dot com<br/>jung5000 at gmail dot com<br/><span style="color: brown">[unreachable]</span></td>
<td>up-to-date</td>
<td bgcolor="#ccffcc">up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>KoreanEn</td>
<td bgcolor="#ffffff">KoreanEn</td>
<td>see the Korean language</td>
<td>&nbsp;</td>
<td>English based</td>
<td bgcolor="#ccffcc">English based</td>
</tr>
<tr bgcolor="#ffffff">
<td>Latvian</td>
<td bgcolor="#ffffff">Latvian</td>
<td>Lauris</td>
<td>lauris at nix.lv</td>
<td>up-to-date</td>
<td bgcolor="#ccffcc">up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>Lithuanian</td>
<td bgcolor="#ffcccc">Lithuanian</td>
<td>Tomas Simonaitis<br/>Mindaugas Radzius<br/>Aidas Berukstis<br/><span style="color: red; background-color: yellow">-- searching for the maintainer --</span></td>
<td><span style="color: brown">[unreachable]</span><br/><span style="color: brown">[unreachable]</span><br/><span style="color: brown">[unreachable]</span><br/><span style="color: brown">[Please, try to help to find someone.]</span></td>
<td>1.4.6</td>
<td bgcolor="#ff5555">1.4.6</td>
</tr>
<tr bgcolor="#ffffff">
<td>Macedonian</td>
<td bgcolor="#ffffff">Macedonian</td>
<td>Slave Jovanovski</td>
<td>slavejovanovski at yahoo dot com</td>
<td>1.6.0</td>
<td bgcolor="#ffcccc">1.6.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>Norwegian</td>
<td bgcolor="#ffcccc">Norwegian</td>
<td>Lars Erik Jordet</td>
<td>lejordet at gmail dot com</td>
<td>1.4.6</td>
<td bgcolor="#ff5555">1.4.6</td>
</tr>
<tr bgcolor="#ffffff">
<td>Persian</td>
<td bgcolor="#ffffff">Persian</td>
<td>Ali Nadalizadeh</td>
<td>nadalizadeh at gmail dot com</td>
<td>1.7.5</td>
<td bgcolor="#ffcccc">1.7.5</td>
</tr>
<tr bgcolor="#ffffff">
<td>Polish</td>
<td bgcolor="#ffffff">Polish</td>
<td>Piotr Kaminski<br/>Grzegorz Kowal<br/>Krzysztof Kral</td>
<td><span style="color: brown">[unreachable]</span><br/><span style="color: brown">[unreachable]</span><br/>krzysztof dot kral at gmail dot com</td>
<td>1.8.2</td>
<td bgcolor="#ffffcc">1.8.2</td>
</tr>
<tr bgcolor="#ffffff">
<td>Portuguese</td>
<td bgcolor="#ffffff">Portuguese</td>
<td>Rui Godinho Lopes<br/>Fabio "FJTC" Jun Takada Chino</td>
<td><span style="color: brown">[resigned]</span><br/>jun-chino at uol dot com dot br</td>
<td>1.8.0</td>
<td bgcolor="#ffffcc">1.8.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>Romanian</td>
<td bgcolor="#ffffff">Romanian</td>
<td>Ionut Dumitrascu<br/>Alexandru Iosup</td>
<td>reddumy at yahoo dot com<br/>aiosup at yahoo dot com</td>
<td>up-to-date</td>
<td bgcolor="#ffffff">almost up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>Russian</td>
<td>Alexandr Chelpanov</td>
<td>cav at cryptopro dot ru</td>
<td>1.7.5</td>
<td bgcolor="#ffffff">Russian</td>
<td>Brilliantov Kirill Vladimirovich<br/>Alexandr Chelpanov</td>
<td>brilliantov at byterg dot ru<br/>cav at cryptopro dot ru</td>
<td bgcolor="#ffffff">almost up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>Serbian</td>
<td bgcolor="#ffffff">Serbian</td>
<td>Dejan Milosavljevic</td>
<td><span style="color: brown">[unreachable]</span></td>
<td>1.6.0</td>
<td bgcolor="#ffcccc">1.6.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>SerbianCyrilic</td>
<td bgcolor="#ffffff">SerbianCyrilic</td>
<td>Nedeljko Stefanovic</td>
<td>stenedjo at yahoo dot com</td>
<td>1.6.0</td>
<td bgcolor="#ffcccc">1.6.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>Slovak</td>
<td bgcolor="#ffffff">Slovak</td>
<td>Kali+Laco Švec<br/>Petr Přikryl</td>
<td><span style="color: brown">[the Slovak language advisors]</span><br/>prikryl at atlas dot cz</td>
<td>up-to-date</td>
<td bgcolor="#ccffcc">up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>Slovene</td>
<td bgcolor="#ffcccc">Slovene</td>
<td>Matjaž Ostroveršnik</td>
<td>matjaz dot ostroversnik at ostri dot org</td>
<td>1.4.6</td>
<td bgcolor="#ff5555">1.4.6</td>
</tr>
<tr bgcolor="#ffffff">
<td>Spanish</td>
<td bgcolor="#ffffff">Spanish</td>
<td>Bartomeu<br/>Francisco Oltra Thennet<br/>David Vaquero</td>
<td>bartomeu at loteria3cornella dot com<br/><span style="color: brown">[unreachable]</span><br/>david at grupoikusnet dot com</td>
<td>up-to-date</td>
<td bgcolor="#ccffcc">up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>Swedish</td>
<td bgcolor="#ffffff">Swedish</td>
<td>Mikael Hallin</td>
<td>mikaelhallin at yahoo dot se</td>
<td>1.6.0</td>
<td bgcolor="#ffcccc">1.6.0</td>
</tr>
<tr bgcolor="#ffffff">
<td>Turkish</td>
<td bgcolor="#ffffff">Turkish</td>
<td>Emin Ilker Cetinbas</td>
<td>niw3 at yahoo dot com</td>
<td>1.7.5</td>
<td bgcolor="#ffcccc">1.7.5</td>
</tr>
<tr bgcolor="#ffffff">
<td>Ukrainian</td>
<td bgcolor="#ffffff">Ukrainian</td>
<td>Olexij Tkatchenko<br/>Petro Yermolenko</td>
<td><span style="color: brown">[resigned]</span><br/>python at i dot ua</td>
<td>1.8.4</td>
<td bgcolor="#ffffcc">1.8.4</td>
</tr>
<tr bgcolor="#ffffff">
<td>Vietnamese</td>
<td bgcolor="#ffffff">Vietnamese</td>
<td>Dang Minh Tuan</td>
<td>tuanvietkey at gmail dot com</td>
<td>1.6.0</td>
<td bgcolor="#ffcccc">1.6.0</td>
</tr>
<!-- table content end -->
</table>
......@@ -335,7 +335,7 @@ when the translator was updated.
~ & Li Daobing & {\tt\tiny lidaobing at gmail dot com} & ~ \\
~ & Wei Liu & {\tt\tiny liuwei at asiainfo dot com} & ~ \\
\hline
Chinese Traditional & Daniel YC Lin & {\tt\tiny dlin dot tw at gmail dot com} & up-to-date \\
Chinese Traditional & Daniel YC Lin & {\tt\tiny dlin dot tw at gmail dot com} & almost up-to-date \\
~ & Gary Lee & {\tt\tiny garywlee at gmail dot com} & ~ \\
\hline
Croatian & Boris Bralo & {\tt\tiny boris dot bralo at gmail dot com} & 1.8.2 \\
......@@ -403,10 +403,11 @@ when the translator was updated.
Portuguese & Rui Godinho Lopes & {\tt\tiny [resigned] rgl at ruilopes dot com} & 1.8.0 \\
~ & Fabio "FJTC" Jun Takada Chino & {\tt\tiny jun-chino at uol dot com dot br} & ~ \\
\hline
Romanian & Ionut Dumitrascu & {\tt\tiny reddumy at yahoo dot com} & up-to-date \\
Romanian & Ionut Dumitrascu & {\tt\tiny reddumy at yahoo dot com} & almost up-to-date \\
~ & Alexandru Iosup & {\tt\tiny aiosup at yahoo dot com} & ~ \\
\hline
Russian & Alexandr Chelpanov & {\tt\tiny cav at cryptopro dot ru} & 1.7.5 \\
Russian & Brilliantov Kirill Vladimirovich & {\tt\tiny brilliantov at byterg dot ru} & almost up-to-date \\
~ & Alexandr Chelpanov & {\tt\tiny cav at cryptopro dot ru} & ~ \\
\hline
Serbian & Dejan Milosavljevic & {\tt\tiny [unreachable] dmilos at email dot com} & 1.6.0 \\
\hline
......@@ -436,10 +437,10 @@ when the translator was updated.
Most people on the list have indicated that they were also busy
doing other things, so if you want to help to speed things up please
doing other things, so if you want to help to speed things up please
let them (or me) know.
If you want to add support for a language that is not yet listed
If you want to add support for a language that is not yet listed
please read the next section.
......@@ -450,12 +451,12 @@ This short HOWTO explains how to add support for the new language to Doxygen:
Just follow these steps:
<ol>
<li>Tell me for which language you want to add support. If no one else
is already working on support for that language, you will be
assigned as the maintainer for the language.
<li>Create a copy of translator_en.h and name it
is already working on support for that language, you will be
assigned as the maintainer for the language.
<li>Create a copy of translator_en.h and name it
translator_\<your_2_letter_country_code\>.h
I'll use xx in the rest of this document.
<li>Add definition of the symbol for your language in the configure
<li>Add definition of the symbol for your language in the configure
at two places in the script:
<ol>
<li>After the <code>f_langs=</code> is statement, in lower case.
......@@ -464,7 +465,7 @@ at two places in the script:
The rerun the configure script such that is generates src/lang_cfg.h.
This file should now contain a \#define for your language code.
<li>Edit language.cpp:
Add a
Add a
\verbatim
#ifdef LANG_xx
#include<translator_xx.h>
......@@ -481,46 +482,47 @@ This file should now contain a \#define for your language code.
{
theTranslator = new TranslatorYourLanguage;
}
#endif
#endif
\endverbatim
after the <code>if { ... }</code>. I.e., it must be placed after the code
for creating the English translator at the beginning, and before the
<code>else { ... }</code> part that creates the translator for the
for creating the English translator at the beginning, and before the
<code>else { ... }</code> part that creates the translator for the
default language (English again).
<li>Edit libdoxygen.pro.in and add \c translator_xx.h to
<li>Edit libdoxygen.pro.in and add \c translator_xx.h to
the \c HEADERS line.
<li>Edit <code>translator_xx.h</code>:
<ul>
<li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code>
twice (i.e. in the \c \#ifndef and \c \#define preprocessor commands at
<li>Use the UTF-8 capable editor and open the file using the UTF-8 mode.
<li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code>
twice (i.e. in the \c \#ifndef and \c \#define preprocessor commands at
the beginning of the file).
<li>Rename TranslatorEnglish to TranslatorYourLanguage
<li>In the member <code>idLanguage()</code> change "english" into the
<li>Rename TranslatorEnglish to TranslatorYourLanguage
<li>In the member <code>idLanguage()</code> change "english" into the
name of your language (use lower case characters only). Depending
on the language you may also wish to change the member functions
latexLanguageSupportCommand(), idLanguageCharset() and others
(you will recognize them when you start the work).
<li>Edit all the strings that are returned by the member functions that
start with tr.
on the language you may also wish to change the member functions
latexLanguageSupportCommand() and other (you will recognize them when
you start the work).
<li>Edit all the strings that are returned by the member functions that
start with \c tr.
Try to match punctuation and capitals!
To enter special characters (with accents) you can:
<ul>
<li> Enter them directly if your keyboard supports that and you are
using a Latin-1 font. Doxygen will translate the
characters to proper \f$\mbox{\LaTeX}\f$ and leave the
HTML and man output for what it is (which is fine, if
idLanguageCharset() is set correctly).
<li> Enter them directly if your keyboard supports that. Recall that
the text is expected to be saved using the UTF-8 encoding. Doxygen
will translate the characters to proper \f$\mbox{\LaTeX}\f$ and
leaves the HTML and man output in UTF-8.
<li> Use html codes like \&auml; for an a with an umlaut (i.e. &auml;).
See the HTML specification for the codes.
</ul>
</ul>
<li>Run configure and make again from the root of the distribution,
<li>Run configure and make again from the root of the distribution,
in order to regenerated the Makefiles.
<li>Now you can use <code>OUTPUT_LANGUAGE = your_language_name</code>
<li>Now you can use <code>OUTPUT_LANGUAGE = your_language_name</code>
in the config file to generate output in your language.
<li>Send <code>translator_xx.h</code> to me so I can add it to doxygen.
Send also your name and e-mail address to be included in the
\c maintainers.txt list.
\c maintainers.txt list. You can also clone the Doxygen repository
at GitHub and make a PullRequest later.
</ol>
......@@ -536,7 +538,7 @@ until all language maintainers have translated the new sentences and
sent the results would not be very practical. The following text
describes the usage of translator adapters to solve the problem.
<b>The role of Translator Adapters.</b>
<b>The role of Translator Adapters.</b>
Whenever the \c Translator class interface changes in the new
release, the new class \c TranslatorAdapter_x_y_z is added to the \c
translator_adapter.h file (here x, y, and z are numbers that
......@@ -552,7 +554,7 @@ TranslatorAdapter_x_y_z class may use the obsolete method to get the
result which is as close as possible to the older result in the
target language. If it is not possible, the result (the default
translation) is obtained using the English translator, which is (by
definition) always up-to-date.
definition) always up-to-date.
<b>For example,</b> when the new \c trFile() method with
parameters (to determine the capitalization of the first letter and
......@@ -582,7 +584,7 @@ of the translator adapter classes:
The \c trFiles() is not present in the \c TranslatorEnglish class,
because it was removed as obsolete. However, it was used until now
and its call was replaced by
and its call was replaced by
\verbatim
trFile(true, false)
......@@ -648,16 +650,16 @@ translator adapter classes.
<b>To simplify the maintenance of the language translator classes</b>
for the supported languages, the \c translator.py Python
script was developed (located in \c doxygen/doc directory).
script was developed (located in \c doxygen/doc directory).
It extracts the important information about obsolete and
new methods from the source files for each of the languages.
new methods from the source files for each of the languages.
The information is stored in the translator report ASCII file
(\c translator_report.txt).
(\c translator_report.txt).
\htmlonly If you compiled this documentation
from sources and if you have also doxygen sources available the
link <a href="../doc/translator_report.txt"
><code>doxygen/doc/translator_report.txt</code></a> should be valid.\endhtmlonly
><code>doxygen/doc/translator_report.txt</code></a> should be valid.\endhtmlonly
Looking at the base class of the language translator, the script
guesses also the status of the translator -- see the last column of
......@@ -680,7 +682,7 @@ expected, you can always decide use some suitable translator adapter to
finish the changes later and still make your translator working.
<b>The most radical way of updating the language translator</b> is
to make your translator class derive directly
to make your translator class derive directly
from the abstract class \c Translator and provide translations for the
methods that are required to be implemented -- the compiler will
tell you if you forgot to implement some of them. If you are in
......@@ -693,14 +695,16 @@ because the adapter classes do implement also the obsolete methods
In other words, the up-to-date language translators do not need the
\c TranslatorAdapter_x_y_z classes at all, and you do not need to
implement anything else than the methods required by the Translator
class (i.e. the pure virtual methods of the \c Translator -- they
class (i.e. the pure virtual methods of the \c Translator -- they
end with <code>=0;</code>).
If everything compiles fine, try to run \c translator.py, and have a
look at the translator report (ASCII file) at the \c doxygen/doc
directory. Even if your translator is marked as up-to-date, there
still may be some remarks related to your source code. Namely, the
obsolete methods--that are not used at all--may be listed in the
directory. Your translator is marked as up-to-date only if the script
does not detect anything special. If the translator uses the \c Translator
base class, there still may be some remarks related to your source code.
In the case, the translator is marked as <em>almost up-to-date</em>.
Namely, the obsolete methods--that are not used at all--may be listed in the
section for your language. Simply, remove their code (and run the \c
translator.py again). Also, you will be informed when you forgot to
change the base class of your translator class to some newer adapter
......@@ -728,7 +732,7 @@ report shorter (also produced faster) -- it will contain only the
information related to your translator. Once you reach the state when
the base class should be changed to some newer adapter, you will see
the note in the translator report.
Warning: Don't forget to compile Doxygen to discover, whether it is
compilable. The \c translator.py does not check if everything is
correct with respect to the compiler. Because of that, it may lie
......@@ -743,7 +747,7 @@ When doing so, all the missing methods will be replaced by the
English translation. This means that not-implemented methods will
always return the English result. Such translators are marked using
word \c obsolete. You should read it <b>really obsolete</b>. No
guess about the last update can be done.
guess about the last update can be done.
Often, it is possible to construct better result from the obsolete
methods. Because of that, the translator adapter classes should be
......
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