Ich habe ein Problem mit doxygen und der Dokumentation von Aufzählungstypen unter C++. doxygen extrahiert diese nur wenn die Option EXTRACT_ALL = YES gesetzt ist. Das ist aber nicht gewünscht, da so auch jede Menge anderer Informationen erscheinen.
eagle
doxygen - Problem beim Extrahieren von Aufzählungstypen
doxygen - Problem beim Extrahieren von Aufzählungstypen
"I love deadlines. I love the whooshing sound they make as they fly by." -- Douglas Adams
Geht bei mir ohne Probleme:
Wichtig ist, dass die Klasse dokumentiert ist.
Code: Alles auswählen
/// The Foo class
class Foo {
public:
/// Bar enum
enum Bar {
/// Lorem ipsum dolor sit amet
FOO,
/// consectetur adipisicing elit
BAR,
/// sed do eiusmod tempor incididunt ut labore
BAZ
};
}
Ja das funktioniert bei mir auch allerdings nicht mehr so:
Code: Alles auswählen
/// Bar enum
enum Bar {
/// Lorem ipsum dolor sit amet
FOO,
/// consectetur adipisicing elit
BAR,
/// sed do eiusmod tempor incididunt ut labore
BAZ
};
/// The Foo class
class Foo {
public:
/// Foobar
void fooBar();
}
"I love deadlines. I love the whooshing sound they make as they fly by." -- Douglas Adams
In dem Falle muss die Datei selbst "kommentiert" sein:an den Anfang schreiben.
Code: Alles auswählen
///@file dateiname.cpp