Doxygen has support for multiple languages. This means that the text fragments that doxygen generates can changed into languages other than English (the default) at configuration time.
Currently, supported for over 20 languages is available.
Here is a list of the languages and their current maintainers:
|
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 let them (or me) know.
If you want to add support for a language that is not yet listed please see the next section.
This short HOWTO explains how to add support for a new language to Doxygen:
Just follow these steps:
#include<translator_xx.h>
setTranslator()
add else if (L_EQUAL("your_language_name")) { theTranslator = new TranslatorYourLanguage; }
if { ... }
translator_xx.h
to the HEADERS
line in the file doxygen.pro. translator_xx.h
: TRANSLATOR_EN_H
to TRANSLATOR_XX_H
twice. idLanguage()
change "english" into the name of the your language (use lower case characters only). Depending on the language you may also wish to change the member functions latexLanguageSupportCommand() and idLanguageCharset(). OUTPUT_LANGUAGE = your_language_name
in the config file to generate output in your language. translator_xx.h
to me so I can add it to doxygen.
As new versions of doxygen appear, new sentences will be added to the Translator interface class. Of course these need to be translated as well (otherwise doxygen wouldn't even compile!).
Waiting until all language maintainers have translated these new sentences and sent the results would not be very practical for me.
Instead, a new class TranslatorAdapter_x_y_z will be added to translator_adapter.h (here x,y, and z correspond to the current version of doxygen). And all translators that previous derived from Translator will now derive from this adapter class.
The Adapter class contains the new sentences with default translations using the English translator (which is always up to date). Instead of deriving your TranslatorXX class directly from Translator it will derive from the intermediate class TranslatorAdapter_x_y_z.
Thus, if a translator class inherits from a adapter class maintenance is needed. By looking at the adapter class itself (and its base classes) you can easily see which methods need to be updated.
To update a language simply make your translator class derive from TranslatorAdapterBase and provide translations for the methods that were previously provided by the adapter class (and its base classes).