[Doxygen-users] Info on the status of the language translators (January 2002)

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

(January 8, 2002; zipped translator_report.txt attached)

Hallo to the language maintainers,

Firstly, I wish to all of you all the best in the New
Year.  You know, what are the things that would made
you happy.  Let's your good dreams come true.

My explicit thanks to all language maintainer who gave
their time for free to many many users.  My thanks to
the users who helped to improve doxygen.

Secondly,

   ----------------------------------------------------
   We are searching for Finnish and Swedish maintainers
   because their translators became extremely obsolete.
   Read the text below.
   ----------------------------------------------------

(This is the main reason why this message is posted
also to the "doxygen users" mailing list.)

Now, I am sending this as a reminder of status of the
translator classes for the supported languages (files
translator_xx.h).  No new translator methods were added
to the Translator class since doxygen 1.2.11.  Still,
there are things to improve.

Yesterday, I have updated the doxygen/doc/translator.pl
script that can help you with updating your TranslatorXxx class. 
The script and one of its results, the translator report, can be
found inside the zip fila attached to this message.

The translator report is generated automatically from
sources.  Because of this, it cannot capture human-like
recognition power.  On the other hand, the information
generated by the script should be quite accurate (or
accurately false -- tell me if you find some problem).

The last version of the translator report contains also
the following part:

----------------------------------------------------------------------
The following translator adapter classes are implemented -- the older (with
lower number) are always derived from the newer. They implement the
listed required methods. Notice that some versions of doxygen did not
introduce any changes related to the language translators.  From here you
may
guess how much work should be done to update your translator:

  TranslatorAdapter_1_2_11	implements  1 required method...
    QCString trReferences()

  TranslatorAdapter_1_2_7	implements  1 required method...
    QCString trAuthor(bool first_capital, bool singular)

  TranslatorAdapter_1_2_6	implements 13 required methods...
    QCString trRTFansicp()
    QCString trRTFCharSet()
    QCString trRTFGeneralIndex()
    QCString trFile(bool first_capital, bool singular)
    QCString latexLanguageSupportCommand()
    QCString idLanguageCharset()
    QCString trClass(bool first_capital, bool singular)
    QCString trNamespace(bool first_capital, bool singular)
    QCString trGroup(bool first_capital, bool singular)
    QCString trPage(bool first_capital, bool singular)
    QCString trMember(bool first_capital, bool singular)
    QCString trField(bool first_capital, bool singular)
    QCString trGlobal(bool first_capital, bool singular)

  TranslatorAdapter_1_2_5	implements  2 required methods...
    QCString trBug()
    QCString trBugList()

  TranslatorAdapter_1_2_4	implements  8 required methods...
    QCString trInterfaces()
    QCString trClasses()
    QCString trPackage(const char *name)
    QCString trPackageList()
    QCString trPackageListDescription()
    QCString trPackages()
    QCString trPackageDocumentation()
    QCString trDefineValue()

  TranslatorAdapter_1_2_2	implements  2 required methods...
    QCString trProperties()
    QCString trPropertyDocumentation()

  TranslatorAdapter_1_2_1	implements  1 required method...
    QCString trDCOPMethods()

----------------------------------------------------------------------

It clearly shows that it should not be very time
consuming to update the languages at least to the 1.2.4
status (4 of 25 languages).  

It also clearly shows that translators with status
1.2.7 and 1.2.11 can easily be updated to the
up-to-date status (5 languages).

The "Internalization" or "langhowto" part of the
documentation will be updated to match the
translator.pl improvements.

The main problem are the Finnish and Swedish
translators.  It seems that the maintainers are
unreachable.  Their translator classes are very
obsolete.  This will probably cause complication with
near future development.  In the worst case, the
languages may be removed from doxygen.

You can find the zipped translator_report.txt
attached to this message.  The content basically says 
what methods are to be implemented and what methods
should be removed (never used).

 <<tr200201.zip>> 
Here is the snippet from inside that lists the up-to-date
translators.

----------------------------------------------------------------------
The following translator classes are up-to-date (sorted alphabetically).
This means that they derive from the Translator class.  Anyway, there still
may be some details listed even for the up-to-date translators.
Please, check the text below if the translator is marked so.

  TranslatorBrazilian
  TranslatorCroatian
  TranslatorCzech
  TranslatorDutch
  TranslatorEnglish
  TranslatorFrench
  TranslatorGerman
  TranslatorItalian
  TranslatorJapanese    -- see details below in the report
  TranslatorKorean
  TranslatorPortuguese
  TranslatorRussian     -- see details below in the report
  TranslatorSlovak
  TranslatorSlovene

----------------------------------------------------------------------

It show that we have more up-to-date translators again.
Thanks to those, who updated.

The "see details below in the report" generally means
that there are probably some obsolete methods that
should be removed -- they are never used.  

Here the Russian is the exception, because it
implements some new, experimental methods, that were
recognized by the non-thinking script as obsolete (they
are not found in the abstract Translator class in
translator.h).  Read doxygen/html/langhowto.html (the
part of doxygen documentation) for details.

The "should be removed" methods are shown also for
obsolete translators.  In other words, removing
obsolete methods is the easiest way to make things
moving forward ;-)

Thanks for your attention,
  Petr
-- 
Petr Prikryl, Skil, spol. s r.o., (pri...@sk...)