Orb/Doxygen/LANGUAGE.HOWTO
changeset 4 468f4c8d3d5b
parent 0 42188c7ea2d9
equal deleted inserted replaced
3:d8fccb2cd802 4:468f4c8d3d5b
     1 This short howto explains how to add support for a new language to Doxygen:
     1 This short howto explains how to add support for a new language to Doxygen:
     2 
     2 
     3 Just follow these steps:
     3 Just follow these steps:
     4 
     4 
     5 1) Tell me for which language you want to add support. If no one else
     5 1) Tell me which language you want to add support for. If no one else
     6    is already working on support for that language, you will be 
     6    is already working on support for that language, you will be 
     7    assigned as the maintainer for the language. I'll create a 
     7    assigned as the maintainer for the language. I'll create a 
     8    list on Doxygen's homepage, so everyone knows who is doing what.
     8    list on Doxygen's homepage, so everyone knows who is doing what.
     9 2) Create a copy of translator_en.h and name it 
     9 2) Create a copy of translator_en.h and name it 
    10    translator_<your_2_letter_counter_code>.h
    10    translator_<your_2_letter_country_code>.h
    11    I'll use xx in the rest of this document.
    11    I'll use xx in the rest of this document.
    12 3) Edit language.cpp:
    12 3) Edit language.cpp:
    13    - Add a #include<translator_xx.h> 
    13    - Add a #include<translator_xx.h> 
    14    - In setTranslator() add
    14    - In setTranslator() add
    15      
    15      
    19      }
    19      }
    20    
    20    
    21      after the if { ... }
    21      after the if { ... }
    22 4) Edit libdoxygen.pro.in and add translator_xx.h to the HEADERS line.
    22 4) Edit libdoxygen.pro.in and add translator_xx.h to the HEADERS line.
    23 5) Edit translator_xx.h:
    23 5) Edit translator_xx.h:
    24    - Rename TRANSLATOR_EN_H to TRANSLATOR_XX_H twice.
    24    - Change TRANSLATOR_EN_H to TRANSLATOR_XX_H (in both the #include line and
    25    - Rename TranslatorEnglish to TranslatorYourLanguage 
    25      the #define line).
       
    26    - Change TranslatorEnglish to TranslatorYourLanguage 
    26    - In the member idLanguage() change "english" into the name of your
    27    - In the member idLanguage() change "english" into the name of your
    27      language (use lower case characters only). Depending on the language you
    28      language (use lower case characters only). Depending on the language you
    28      may also wish to change the member functions latexLanguageSupportCommand()
    29      may also wish to change the member functions latexLanguageSupportCommand()
    29      and idLanguageCharset().
    30      and idLanguageCharset().
    30    - Edit all the strings that are returned by the members that start
    31    - Edit all the strings that are returned by the members that start