5 Stimmen

wie man generierte Konstruktoren in Doxygen dokumentiert

Wir verwenden Doxygen, um unsere Klassen zu dokumentieren. Ich würde gerne explizit dokumentieren, dass eine Klasse generierte Konstruktoren und/oder Destruktoren hat, um zu zeigen, dass ich darüber nachgedacht habe und entschieden habe, dass z.B. das Kopieren mit dem generierten Copy-Konstruktor sicher ist. Der Konstruktor/Destruktor ist jedoch nicht deklariert und daher weiß doxygen nicht, zu welcher Funktion die Dokumentation gehört. Gibt es Möglichkeiten, doxygen dazu zu bringen, Funktionskommentare einzuschließen, auch wenn die Funktion nie deklariert wird?

//! The Foo class documentation
class Foo {
    //! @fn Foo(const Foo&) 
    //! Generated copy constructor OK to use

    //! method documentation
    void method();
}

Außerdem würde ich die Signatur der erzeugten Dateien gar nicht schreiben wollen.

Ich denke, die andere Möglichkeit ist, es einfach in der Klassenüberschrift zu beschreiben. Gibt es andere Ansätze?

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X