Posts Tagged ‘Doxygen’

Documenting in different languages with Doxygen | Mit Doxygen in verschiedenen Sprachen dokumentieren

26. February 2008

(Deutsch weiter unten!)

Today I’ve found out – okay, I was given a hint – that it is easy to create the Doxygen documentation in several languages at once (It’s all in the Doxygen documentation of course ;-) ).

In the configuration file (Doxyfile) edit the following line:
ALIASES
by adding the following entries:
“english=if english” “endenglish=endif” “deutsch=if deutsch” “enddeutsch=endif”

In line
ENABLED_SECTIONS
add
deutsch
or
english
what ever is needed next.

In the code write:
/*! @english
* This is English.
* @endenglish
* @deutsch
* Das ist Deutsch.
* @enddeutsch
*/

And the entire documentation will be in one language – surprise, surprise. (There is a more direct way, but that’ll do for now.)

And the documentation suddenly becomes a lot more readable ;-)

###########################

Ich habe heute herausgefunden, dank eines Winks mit dem Zaunpfahl, dass es ganz einfach ist die Dokumentation in Doxygen in mehreren Sprachen zu erstellen (Steht auch alles in der Doxygen Dokumentation ;-) ).

In der der Konfigurationsdatei (Doxyfile) kommen in die Zeile:
ALIASES
zusätzlich folgende Einträge:
“english=if english” “endenglish=endif” “deutsch=if deutsch” “enddeutsch=endif”

In der Zeile
ENABLED_SECTIONS
wird je nach Bedarf
deutsch
oder
english
hingeschrieben.

Im Code macht man folgendes:
/*! @english
* This is English.
* @endenglish
* @deutsch
* Das ist Deutsch.
* @enddeutsch
*/

Und schon wird die Dokumentation völlig einsprachig. (Es geht noch direkter, aber das reicht fürs Erste.)

Und die Dokumentation wird wirklich lesbarer ;-)

Example JavaDocs, Doxyfile and Copiled HTML Helpfile(.chm) | Beispiel für meine JavaDoc, generierende Doxyfile und Copiled HTML Hilfedatei(.chm)

24. February 2008

(Deutsch weiter unten!)

Today I have made some decisions. I have designed my JavaDocs documentation format, and thereby indirectly (through Doxygen and the generating file Doxyfile_english) take influence on the appearance of the generated Help file (in .html and .chm files). I have designed the layout of the help file largely oriented on SELFHTML’s layout, because I have always felt that this manual allowed easier access (even for beginners) . You’ll find my JavaDocs format here, the generating Dogygen file is here and the .chm output file here.

########################

Heute habe ich einige Entscheidungen getroffen. Ich habe das Format meiner JavaDocs Dokumentation festgelegt und somit indirekt (über Doxygen und die generierende Datei Doxyfile_deutsch) auf das Aussehen der generierten Hilfedatei (im .html und .chm Format) Einfluss genommen. Bei der Hilfe Datei habe ich mich weitestgehend am Layout von SELFHTML orientiert, da ich schon immer fand, dass man dazu (auch als Anfänger) leichter Zugang findet.
Mein JavaDocs Format ist hier, die generierende Datei ist hier und die .chm-Datei hier.