Erfahrungen mit Doxygen

prolog

Hi

Ja ich schreibe unheimlich langsam weist du.

Nee im ernst, für ne Doku is das viel.

Gibt es auch eine deusche Anleitung für Doxygen?

Winn

http://ftp.tuwien.ac.at/softeng/doxygen/

Such nach "doxygen_manual-1.3.2.pdf.zip" Der Link von der Original doxygen HP ist down bzw. bei mir war das Archive korrupt...

Gruß Winn

Doxygen ist gut und hat sich in mittelgroßen Projekten (15-20 Entwickler)
sehr bewährt. Einziger Kritikpunkt in meinen Augen ist die
absolut unflexible LaTeX-Umsetzung.

hallo!

ich muss ein referat über doxygen halten, anleitung hab ich schon gefunden. kann vielleicht einer von euch mal einen code reinstelle, damit ich mich mit doxygen beschäftigen kann?

danke, gruß chris

aMan

lad dir ogre runter (www.ogre3d.org). das wird mittels doxygen dokumentiert..

helena

Hallo zusammen,

ich schliesse mich auch zu diesem Thema an. Ich habe gerade vor kurzem angefangen, mit Doxygen zu arbeiten. Es geht darum dass ich mit Component Object Model (COM) arbeite und alle Funktionen die als STDMETHOD geschrieben sind nicht dokumentieren kann, d.h. meine Dokumentation wird nicht reingeschrieben.Und ich habe viele solche

Es kann sein dass ich nicht so genau weiss wie ich es einstellen soll.
Ich habe mir gedacht das hat was mit PREPROCESSOR zu tun , aber komme nicht wirklich weit..

Z.B in .h Datei ist es definiert als
public:
STDMETHOD(Summe)(int param1, int param2);

und dann in der Datei .cpp habe ich Implementierung davon mit z.B Dokumentation

/**
* \brief Method to ..
* \param param1 is the first input param.
* \param param2
*
* This Method..........
**/
STDMETHODIMP Operation::Summe(int param1,int param2)
{ ....
}

Wenn ich mit Maus darauf zeige kommt :virtual HRESULT Operation::Summe(param1, param2)

Wenn ich es einfach umschreiben dürfte in virtual HRESULT Operation::Summe(param1, param2) wird das Kommentar dann akzeptiert und geschrieben , aber ich darf das klar nicht..

Hoffentlich kann jemand helfen.

Liebe Grüße..

wenn du mit visual c++ arbeitest kannst du es bedenkenlos direkt hinschreiben, die makros sind nur um es unabhängig zu machen aber COM entspricht gerade der art und weise wie der c++ compiler von microsoft arbeitet, d.h. wenn du den nimmst kannst es ganz normal schreiben, das passt dann alles.

cos0815

Hallo,

kennt jemand ein gutes Addon für die Kommentierung von C++-Code in Visual Studio 2008? Für 2003 und 2005 habe ich welche gefunden ("Steve King's set of addins" und "DoxyComment"). Kennt jemand eins für 2008?

Gruß
cos

Hallo!

ich bin gerade dabei eine Dokumentation mit doxygen zu entwerfen. Nun habe ich die eigentliche Dokumentation fertig geschrieben und auch viele Formeln eingebungen. Es sind viele Funktionen dabei, die Objekte, Abstände zwischen Objekten, Winkel etc. berechnen. Zur Veranschaulichung würde ich gerne Bitmaps oder PNGs in das HTML-Dokument mit einbinden. Geht sowas überhaupt? Ich hab in keiner Hilfe etwas zu dem Thema gefunden und auch noch keine Dokumentation mit Bildern drin gesehen.
ich dachte erst man könnt mit Hilfe von Graphviz eigene Diagramme erstellen, aber das geht leider auch nicht.
Hat jemand ne Idee, wie ich diese Funktionen veranschaulichen könnte?

Vielen Dank im voraus, Thayet

hustbaer

prolog schrieb:

Hi

Ja ich schreibe unheimlich langsam weist du.

Nee im ernst, für ne Doku is das viel.

Nee im Ernst, für ne Doku ist das verdammt wenig.

Nee im Ernst, für ne Doku ist das verdammt wenig.

Nee im Ernst, für ein Kommentar sind über 5 Jahre verspätung verdammt viel.

hustbaer

Thayet schrieb:

Hallo!

ich bin gerade dabei eine Dokumentation mit doxygen zu entwerfen. Nun habe ich die eigentliche Dokumentation fertig geschrieben und auch viele Formeln eingebungen. Es sind viele Funktionen dabei, die Objekte, Abstände zwischen Objekten, Winkel etc. berechnen. Zur Veranschaulichung würde ich gerne Bitmaps oder PNGs in das HTML-Dokument mit einbinden. Geht sowas überhaupt?

Probier das mal.
http://www.stack.nl/~dimitri/doxygen/commands.html#cmdimage

Ich hab in keiner Hilfe etwas zu dem Thema gefunden und auch noch keine Dokumentation mit Bildern drin gesehen.

Doku-Lesen scheint nicht deine Stärke zu sein, was?

hustbaer

Pseudomodg schrieb:

Nee im Ernst, für ne Doku ist das verdammt wenig.

Nee im Ernst, für ein Kommentar sind über 5 Jahre verspätung verdammt viel.

Hihi, OK, übersehen. Aber ich hab den Fred nicht aufgewärmt, das war Thayet.

Hmm, anscheinend nicht.
War ja auch blöd von mir nur das Manuel durchzusehen und davon auszugehen, dass da etwas dazu zu finden ist
Aber nach weiterem längeren recherchieren habe dann auch noch ne Doku gefunden in dem Bilder eingebaut waren, allerdings nur im HTML-Format mit <img src="bild.jpg" alt="">.
Da ich mich mit HTML kaum auskenne bin ich auch nicht auf die Idee gekommen, dass das so funktioniert.
Vielen dank, so sieht es einfacher aus, da muss ich mich jetzt nicht auch noch zusätzlich mit HTML und dessen Parametern beschäftigen

Ist das letzte Comment hier iwie nen Test von neuer Malware??? oO

Oder warum hat der Typ da so hässliche Links mit auffallend vielen lockenden Xbox-Betitelungen off-topic reingestellt?

Und warum wird in nem C++ Forum nicht ordentlich moderiert? ^^

Also entweder hätte dieser Post seit fast einem Jahr gelöscht werden müssen, ich hab was übersehen, oder die/der Mod(s) hat/haben auf die Links geklickt und sind seit Januar 2009 dabei den Krams wieder vom Rechner zu bekommen

greetings