Seite 1 von 1
Dokumentation eigener Klassen im Qt Stil
Verfasst: 15. Februar 2009 11:08
von Al_
Qt dokumentiert die Klassen in der *.cpp Datei in Kommentaren mit Ausrufezeichen, also /*! dies ist die Beschreibung .... */ mit weiteren Tags wie /brief und so.
Ist das Tool, welches aus diesen Kommentaren eine schön strukturierte Hilfedatei extrahiert, öffentlich erhältlich?
Danke für Tipps
Al_
Verfasst: 15. Februar 2009 11:46
von -=Freaky=-
ich bin mir nicht sicher, aber koennten das doxygen-tags sein?
der standard doxygen-output (html) sieht zwar anders aus (siehe z.b.
http://qwt.sourceforge.net/), aber evtl. kann man doxygen entspr. konfigurieren, da bin ich leider nicht so bewandert ...
fuer die kde-api-docs wurde das aber afaik gemacht (also die aufmachung der doxygen-generierten docs angepasst) ...
mfg,
julian
Verfasst: 15. Februar 2009 12:24
von solarix
ja das ist doxygen....das Tool entstand aus dem Bedürfnis, mit den gleichen Tags wie im Qt-Code eine trolltechähnliche Doku erzeugen zu können (das Tool der Trolls ist ja leider nicht OSS).
Siehe auch FAQ von doxygen:
I once wrote a GUI widget based on the Qt library (it is still available at
http://qdbttabular.sourceforge.net/ and maintained by Sven Meyer). Qt had nicely generated documentation (using an internal tool which they didn't want to release) and I wrote similar docs by hand. This was a nightmare to maintain, so I wanted a similar tool. I looked at Doc++ but that just wasn't good enough (it didn't support signals and slots and did not have the Qt look and feel I had grown to like), so I started to write my own tool...
[gelöst] Dokumentation eigener Klassen im Qt Stil
Verfasst: 15. Februar 2009 12:41
von Al_
Wow, schnelle Antworten. Ihr habt absolut Recht: Doxygen kennt Qt-Stil (siehe Punkt 2 auf
http://www.stack.nl/~dimitri/doxygen/docblocks.html).
Herzlichen Dank an Euch beide
Al_
Verfasst: 15. Februar 2009 16:53
von -=Freaky=-
kein problem ...
@solarix: danke fuer die aufklaerung, das wusste ich noch nicht ...
mfg,
julian