Programm zur Dokumentation

[farion]

Hallo

Ich benutze zur Zeit KDevelop, nun möchte ich für mein Programm, bzw. alle Klassen etc. eine Dokumentation schreiben, gibt es hier ein Programm, dass mir die Arbeit erleichtert, bzw abnimmt.
Ich möchte vllt nur noch schreiben müssen was tut das oder jenes.

Gruss Far

[Morfio]

Hallo,

da gibt es tatsächlich was: DoxyGen (www.doxygen.org).

Viele Grüße,

Morfio ...

[peschmae]

Ist zumindest bei mir sogar in KDE eingebunden, das Doxygen: Erstellen|API-Dokumentation erstellen

MfG Peschmä

[farion]

Oh ja, hatte den Sinn hinter doxygen nicht verstanden.

Das ist ja ziemlich mächtig, sehr viele Exportmöglichkeiten und man muss nur richtig kommentieren, also nicht mal mehr was ausserhalb des Codes machen.

Noch eine Frage, weiss jemand, wie ich das layout der html-ausgabe verändern kann, gibt es da templates?
Irgendwie sind nur zwei Dateien(neben doc und man) im doxygen-paket dabei (debian sid) und ein data-paket o.ä. existiert auch nicht.
Wird das evtl. von kdevelop geregelt?

Gruss far

[peschmae]

Soviel ich weiss verwendet das erzeugte HTML ein einziges doxygen.css-Stylesheet. In dem solltest du dann so ziemlich alles einstellen können.

MfG Peschmä

[farion]

Habe jetzt Ubuntu und in kdevelop fehlt "Api-Dokumentation" erstellen, auch in "Projekt-Optionen" fehlt die Einstellung.

doxygen ist installiert. was fehlt da noch.

bye far

PS: Mit den Debian Paketen klappts, da habe ich auch noch jede Menge anderer Optionen, die ich zwar nicht brauche, aber vorher auch nicht hatte (zB.: GameboyAdvanced-Unterstützung )
Blöd ist nur, dass er am Ende noch

doxytag -s search .idx

macht, was aber wohl veraltet ist, denn am Schluss kommt das hier

Error: doxytag cannot be used to generate a search index anymore.
This functionality has been integrated into doxygen.

Die Suche funktioniert aber trotzdem, wird wohl vorher dann von doxygen erledigt.

[undefined]

Refrence Downloaden und sich das Verzeichnis common einmal ansehen
http://developer.kde.org/documentation/library/3.4-api/

Die Suchfunktion Funktioniert nur wenn du als Extension php angibst und das ganze über den Webserver laufen läßt.