doxygen - Problem beim Extrahieren von Aufzählungstypen

Vom einfachen Programm zum fertigen Debian-Paket, Fragen rund um Programmiersprachen, Scripting und Lizenzierung.
Antworten
Benutzeravatar
eagle
Beiträge: 2282
Registriert: 05.11.2002 11:20:53
Wohnort: Berlin

doxygen - Problem beim Extrahieren von Aufzählungstypen

Beitrag von eagle » 15.11.2005 21:23:04

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
"I love deadlines. I love the whooshing sound they make as they fly by." -- Douglas Adams

Benutzeravatar
Joghurt
Beiträge: 5244
Registriert: 30.01.2003 15:27:31
Wohnort: Hamburg
Kontaktdaten:

Beitrag von Joghurt » 15.11.2005 21:31:58

Geht bei mir ohne Probleme:

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 
    };
}
Wichtig ist, dass die Klasse dokumentiert ist.

Benutzeravatar
eagle
Beiträge: 2282
Registriert: 05.11.2002 11:20:53
Wohnort: Berlin

Beitrag von eagle » 15.11.2005 21:37:37

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

Benutzeravatar
Joghurt
Beiträge: 5244
Registriert: 30.01.2003 15:27:31
Wohnort: Hamburg
Kontaktdaten:

Beitrag von Joghurt » 15.11.2005 21:40:42

In dem Falle muss die Datei selbst "kommentiert" sein:

Code: Alles auswählen

///@file dateiname.cpp
an den Anfang schreiben.

Benutzeravatar
eagle
Beiträge: 2282
Registriert: 05.11.2002 11:20:53
Wohnort: Berlin

Beitrag von eagle » 15.11.2005 21:48:25

Ja danke das war es. Ich hatte mir schon echt einen "Wolf" gesucht 8) .

eagle
"I love deadlines. I love the whooshing sound they make as they fly by." -- Douglas Adams

Benutzeravatar
Joghurt
Beiträge: 5244
Registriert: 30.01.2003 15:27:31
Wohnort: Hamburg
Kontaktdaten:

Beitrag von Joghurt » 15.11.2005 21:50:32

Ist übrigens schlechter Programmierstil. Das enum gehört mindestens in einen Namespace.

Benutzeravatar
eagle
Beiträge: 2282
Registriert: 05.11.2002 11:20:53
Wohnort: Berlin

Beitrag von eagle » 16.11.2005 08:43:01

Erwischt :oops: und zwar ein sehr Fauler ... Ich werde versuchen den Tipp in Zukunft zu beherzigen.

eagle
"I love deadlines. I love the whooshing sound they make as they fly by." -- Douglas Adams

Antworten