doxygen-develop

[Doxygen-develop] Info on the status of the language translators (December 16, 2003)

[Petr P. <Pr...@sk...>]

Info on the status of the language translators (December 16, 2003)=20

Related to the doxygen 1.3.5-20031215 in CVS. Posted to
doxygen-develop, copied to doxygen-users. The previous
report was dated September 24, 2003.

ATTENTION: Full translator_report.txt is stored (together
with this text) at
http://doxygen.sourceforge.net/dl/doxygen-1.3-cvs/=20
as tr2003MMDD.zip where MMDD is replaced by the month and day.

Summary:=20
 - Doxygen 1.3.5 was released recently.
 - Total 30 (KoreanEn added), 13 up-to-date (+4), 5 almost=20
   up-to-date (-1), 7 slightly obsolete (-3), 2 obsolete,=20
   1 not maintained, 2 different.=20
 - Searching for the Finnish maintainer and possibly also=20
   for Hungarian and Norwegian ones.

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

Hi,

Firstly, thanks to all active language maintainers. The
Christmas time is almost here. Stop to type and enjoy the
other sides of the life (I know that some of you will not
follow that hint ;)  There is a great new-year self-promise
for some of you: "I will bring my language support for
Doxygen to up-to-date status in January!"

If you speak Finnish, Hungarian, or Norwegian, please
consider to help with the language support to the existing
maintainers or take the maintainership and carve your name
into the related part of the source files ;)

=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Current status
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D

The total is 30 languages now. The new one is not really
new. It is the KoreanEn (mixed Korean and English). Because
it is derived from TranslatorEnglish, it is reported as
really obsolete, which is not true (similar case as the
JapaneseEn). The newer translator.py script will be modified
not to report such translators this way (later).

Thirteen of the languages are up-to-date: Brazilian, Chinese
Traditional, Croatian, Czech, Danish, Dutch, English,
French, German, Italian, Korean, Russian, and Serbian.

Five of the languages are very close to the up-to-date
status. They reflect at least some changes since Doxygen 1.3
release: Polish, Japanese, Portuguese, Spanish, and Swedish.
Good job!

Seven of the languages are slightly obsolete, but they still
require impementing not more than 18 methods: Catalan,
Chinese, Greek, Romanian, Slovak, Slovene, and Ukrainian.

Two of the languages -- Hungarian and Norwegian -- must
implement about 45 methods to become up-to-date. Please, try
harder. Or should we search for not-so-tired, new
maintainers? Keep in mind that the translator adapters, used
for your translator classes, make Doxygen slightly bigger
and more complex. After updating your languages, the
adapters can be removed.

  -----------------------------------------------
  We still have not found new Finnish maintainer. =20
  The translator became extremely obsolete, and=20
  it seems that the original maintainer is not
  in touch with doxygen anymore.
  -----------------------------------------------

Reminder: look at the translator report inside
http://doxygen.sourceforge.net/dl/doxygen-1.3-cvs/=20
tr2003MMDD.zip
If you think that your language should be listed as
up-to-date, but it is not, you probably forgot to change the
base class of your translator class to "Translator". Then,
you can run the doc/translator.pl script to generate the
translator report and check the status of your translator
report and see what has to be done to make it up-to-date.

Note: The translator.pl is the original script that will be
replaced by translator.py one day. You can also give it a
try. In fact, it is almost one-to-one rewrite of the perl
version, so do not be disappointed if you like Python. It is
planned to be rewritten using the OO approach.
 =20
With regards,
  Petr
=20
--=20
Petr Prikryl, (prikrylp at skil dot cz)

Re: [Doxygen-develop] Info on the status of the language translators (December 16, 2003)

[Akos K. <ak...@us...>]

Hi all,

I'm sad to hear that the hungarian translator is so obsolate. Last night
I've extended the translator so that it is now up-to-date in the sense that
it now inherits from Translator and all messages are hungarian. I've also
fixed some typos and made the messages a bit more consistent.

I still have to check all the messages once more, but I'll send the updated
translator as soon as I'm ready (hopefully tonight or tomorrow).

Additionally, if the current hungarian maintainer doesn't want to maintain
the translator I'll apply for maintainership.

Regards,
Akos

Btw, are there any test cases I could use to test all the messages?

----- Original Message -----
From: "Petr Prikryl" <Pr...@sk...>
To: "Doxygen developers" <dox...@li...>
Cc: "Doxygen users" <dox...@li...>
Sent: Tuesday, December 16, 2003 9:53 AM
Subject: [Doxygen-develop] Info on the status of the language translators
(December 16, 2003)


If you speak Finnish, Hungarian, or Norwegian, please
consider to help with the language support to the existing
maintainers or take the maintainership and carve your name
into the related part of the source files ;)

Two of the languages -- Hungarian and Norwegian -- must
implement about 45 methods to become up-to-date. Please, try
harder. Or should we search for not-so-tired, new
maintainers? Keep in mind that the translator adapters, used
for your translator classes, make Doxygen slightly bigger
and more complex. After updating your languages, the
adapters can be removed.

[Doxygen-develop] LaTeX and Math Formula in doxygen

[Rick E. <ri...@ev...>]

I have started a simple user guide for math formulas under doxygen.
My input to doxygen and my configuration file are in the attached
tarball.
This is still be worked on... but I thought I'd release the current
version for comments.

This creates an series of html pages, LaTeX docs and man pages...
I have only been looking at html pages during development.

This is not an exhaustive help (arrays are not explained).

I was forced into a lot of research in order to document a program that
I have that relies on a large set of math equations. Previously, these
equations were separately documented from the code. Doxygen allows me to
embed the equations into the source.

Let me know what you think of the helps ....

-- 
Rick Eversole <ri...@ev...>

[Doxygen-develop] Enhancement Request (Line number references)

[Rick E. <ri...@ev...>]

OK ... Ref/anchors are useful ...
But, 
I would really like to refer to source line numbers with \todo
\bug and \test ... seems the cleanest way is to introduce a new
command maybe \location which expands to file:lineno 
(eg.   foo.c:104 )

This is useful when reading code and annotating for review. I've been
using doxygen as part of a translation project and using the
\todo, \bug and \test tags as ways to know what I still need in
the way of tests and code...

It is hard with 8,000 lines of code to get back to specific 
areas that code reading has indicated I should check further.
The tags help but \location tag would be very very useful.

I looked at doxygen sources and all the lexers seem to swallow
"\n" so this is probably not that easy to implement ...

in the past I let the parser handle \n and the lexer only
counts the lines... tricky issues with lexicals that cover
more than one line ... they have to could \n 's themselves

Just a thought and request for enhancement ... 

I have too many other projects going to rip into 
doxygen and patch... it does not look to be a quick fix ...

On Tue, 2003-12-16 at 00:53, Petr Prikryl wrote:
> Info on the status of the language translators (December 16, 2003) 
> 
> Related to the doxygen 1.3.5-20031215 in CVS. Posted to
> doxygen-develop, copied to doxygen-users. The previous
> report was dated September 24, 2003.
> 
> ATTENTION: Full translator_report.txt is stored (together
> with this text) at
> http://doxygen.sourceforge.net/dl/doxygen-1.3-cvs/
> as tr2003MMDD.zip where MMDD is replaced by the month and day.
> 
> Summary: 
>  - Doxygen 1.3.5 was released recently.
>  - Total 30 (KoreanEn added), 13 up-to-date (+4), 5 almost 
>    up-to-date (-1), 7 slightly obsolete (-3), 2 obsolete, 
>    1 not maintained, 2 different. 
>  - Searching for the Finnish maintainer and possibly also 
>    for Hungarian and Norwegian ones.
> 
> ------------------------------------------------------------
> 
> Hi,
> 
> Firstly, thanks to all active language maintainers. The
> Christmas time is almost here. Stop to type and enjoy the
> other sides of the life (I know that some of you will not
> follow that hint ;)  There is a great new-year self-promise
> for some of you: "I will bring my language support for
> Doxygen to up-to-date status in January!"
> 
> If you speak Finnish, Hungarian, or Norwegian, please
> consider to help with the language support to the existing
> maintainers or take the maintainership and carve your name
> into the related part of the source files ;)
> 
> ==============
> Current status
> ==============
> 
> The total is 30 languages now. The new one is not really
> new. It is the KoreanEn (mixed Korean and English). Because
> it is derived from TranslatorEnglish, it is reported as
> really obsolete, which is not true (similar case as the
> JapaneseEn). The newer translator.py script will be modified
> not to report such translators this way (later).
> 
> Thirteen of the languages are up-to-date: Brazilian, Chinese
> Traditional, Croatian, Czech, Danish, Dutch, English,
> French, German, Italian, Korean, Russian, and Serbian.
> 
> Five of the languages are very close to the up-to-date
> status. They reflect at least some changes since Doxygen 1.3
> release: Polish, Japanese, Portuguese, Spanish, and Swedish.
> Good job!
> 
> Seven of the languages are slightly obsolete, but they still
> require impementing not more than 18 methods: Catalan,
> Chinese, Greek, Romanian, Slovak, Slovene, and Ukrainian.
> 
> Two of the languages -- Hungarian and Norwegian -- must
> implement about 45 methods to become up-to-date. Please, try
> harder. Or should we search for not-so-tired, new
> maintainers? Keep in mind that the translator adapters, used
> for your translator classes, make Doxygen slightly bigger
> and more complex. After updating your languages, the
> adapters can be removed.
> 
>   -----------------------------------------------
>   We still have not found new Finnish maintainer.  
>   The translator became extremely obsolete, and 
>   it seems that the original maintainer is not
>   in touch with doxygen anymore.
>   -----------------------------------------------
> 
> Reminder: look at the translator report inside
> http://doxygen.sourceforge.net/dl/doxygen-1.3-cvs/
> tr2003MMDD.zip
> If you think that your language should be listed as
> up-to-date, but it is not, you probably forgot to change the
> base class of your translator class to "Translator". Then,
> you can run the doc/translator.pl script to generate the
> translator report and check the status of your translator
> report and see what has to be done to make it up-to-date.
> 
> Note: The translator.pl is the original script that will be
> replaced by translator.py one day. You can also give it a
> try. In fact, it is almost one-to-one rewrite of the perl
> version, so do not be disappointed if you like Python. It is
> planned to be rewritten using the OO approach.
>   
> With regards,
>   Petr
>  
-- 
Rick Eversole <ri...@ev...>