C-Code mit Doxygen dokumentieren

[tomcom]

Hallo,

ich möchte ein Projekt mit Doxygen documentieren und habe 6 Fragen dazu ins Wer-Weiss-Was Forum geschrieben und bis jezt keine Antwort erhalten.
Könnt ihr mir vieleicht weiterhelfen?

Frage im WerWeissWas Forum: hier klicken (http://www.wer-weiss-was.de/cgi-bin/forum/showarticle.fpl?ArtikelID=3857442)
Gruß und danke
Thomas

[Boron]

Stelle deine Frage doch hier im Forum. Ich werfe jetzt nur einen kurzen Blick da rüber.

Zu. 2.)
Doxygen Kommentare innerhalb von Funktionen/Methoden sind Blödsinn.
Dokumentiert wird außerhalb!
Du willst ja mit der generierten Dokumentation dem Leser sagen was die Software macht und nicht unbedingt wie sie das macht.
Das "Wie" kannst du dennoch in den Kommentar außerhalb der Funktionen schreiben.
Was genau ein bestimmtes "if" im Code soll geht ja den Doxygen-Doku Leser nix an. Wenn doch, dann soll er halt in den Quellcode schauen, wo das dann als normaler Kommentar steht (/* */ oder //)

3.)
Siehe meine Antwort zu 2.)

4.)
Kene Ahnung.
Was spricht gegen ein überaus praktisches HTML? Alles schön verlinkt :).

5.)
Vielleicht: USE_WINDOWS_ENCODING = Yes oder No
Hängt von deinem System ab. Steht in (englischer) Doxygen-Doku ;).
Und dann zusätzlich im Browser eine vernünftige Zeichenkodierung einstellen (z.B. ISO-8859-1 oder ISO-8859-15 oder UTF-8)

[BlauerBlitz]

Hallo Cybertom!

Zu 1)
Sieh Dir mal @page an. Damit kannst Du irgendwo im Quelltext eine eigene Seite definieren, auf der Du einen beliebigen Text publizieren kannst. Ich habe dieses Statement z. B. schon verwendet, um eine Seite mit einer Aufstellung (mit Hyperlinks) aller verwandten Funktionsaufrufe zu erzeugen, auf die ich dann (mittels @ref) von den verschiedensten Stellen verweisen kann .

MfG
Werner