Internationalization

Support for multiple languages

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 languages are English, French, Czech, Dutch, Spannish, Swedish, Russian, Czech, Croatian, Italian, Hungarian, Finnish, German and Japanese, and Korean. Here is a list of the languages and their current maintainers:

Language Maintainer Contact address (remove the NOSPAM.) German Jens Breitenstein Jens.Breitenstein@NOSPAM.tlc.de French Christophe Bordeux bordeux@NOSPAM.lig.di.epfl.ch Swedish Samuel Hägglund XeT Erixon sahag96@NOSPAM.nts.mh.se xet@NOSPAM.hem.passagen.se Czech Petr Prikryl Vlastimil Havran prikrylp@NOSPAM.skil.cz havran@NOSPAM.fel.cvut.cz Italian Ahmed Aldo Faisal Alessandro Falappa aaf23@NOSPAM.cam.ac.uk a.falappa@NOSPAM.flashnet.it Japanese Kenji Nagamatsu naga@NOSPAM.joyful.club.ne.jp Spanish Francisco Oltra Thennet foltra@NOSPAM.puc.cl Finnish Olli Korhonen Olli.Korhonen@NOSPAM.ccc.fi Russian Andrey V. Stolyarov crocodil@NOSPAM.croco.net Korean Richard Kim ryk@NOSPAM.dspwiz.com Hungarian Földvári György foldvari@NOSPAM.diatronltd.com Croatian Boris Bralo boris.bralo@NOSPAM.zg.tel.hr Polish Grzegorz Kowal g_kowal@NOSPAM.poczta.onet.pl Dutch Dimitri van Heesch dimitri@NOSPAM.stack.nl

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.

Language HOWTO

This short HOWTO explains how to add support for a new language to Doxygen:

Just follow these steps:

1. 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.
2. Create a copy of translator_nl.h and name it translator_<your_2_letter_counter_code>.h I'll use xx in the rest of this document.
3. Edit language.cpp: Add a

   #include<translator_xx.h>
   

   in setTranslator() add

       else if (L_EQUAL("your_language_name"))
       {
         theTranslator = new TranslatorYourLanguage;
       }
   

   after the if { ... }
4. Edit doxygen.pro and add translator_xx.h to the HEADERS line in the file doxygen.pro.
5. Edit translator_xx.h:
   • Rename TRANSLATOR_NL_H to TRANSLATOR_XX_H twice.
   • Rename TranslatorDutch to TranslatorYourLanguage
   • In the member latexBabelPackage() change "dutch" into the name of the latex package that adds support for your language.
   • Edit all the strings that are returned by the members that start with tr. Look at the corresponding member in translator.h for the english text that is returned and translate that into your language. Try to match punctuation and capitals! To enter special characters (with accents) you can:
     • Enter them directly if your keyboard supports that and you are using a Latin-1 font. Doxygen will translate the characters to proper Latex and leave the Html and man output for what it is.
     • Use html codes like &auml; for an a with an umlaut (i.e. ä). See the HTML specification for the codes.
6. Recompile everything (do this from the root of the distribution, because the Makefile.dox* have to be regenerated!)
7. Now you can use OUTPUT_LANGUAGE = your_language_name in the config file to generate output in your language.
8. Send translator_xx.h or a diff -u of the changes to me so I can add it to doxygen.

---