Verwenden Sie doxygen Dateikopf als Modulbeschreibung

Question

Ich frage mich, ob es eine Möglichkeit gibt, die doxygen Dateikopfbeschreibung auch für die Modulbeschreibung wiederzuverwenden.

/** 
    \file    
    \brief   Some brief info 
    \details  more Details 
*/ 
/** 
    \defgroup Views 
    \brief (Same as header doxy) 
    \details (Same as header doxy) 
*/ 

Um Redundanz zu vermeiden, werde ich den Text nicht kopieren. Wenn ich die defgroup an den Anfang der Datei verschiebe, erhalte ich nur den im Modul erwähnten Dateinamen und nicht die Beschreibung. Ich habe schon einige Kombinationen ausprobiert, aber ich habe mein Ziel nie erreicht. Der Detail- und Kurztext befindet sich entweder in der Moduldokumentation oder in der Dateidokumentation. Hat jemand eine andere Idee, wie man den Text wiederverwenden kann?

Vielen Dank,

Jonny

Answer 1

fand ich eine Lösung selbst. Sie können den doxy-Befehl @copydoc verwenden, um die Dokumentation zu kopieren.

Mein Code für test.h sieht wie folgt vor:

/** 
    \file   test.h 
    \brief   Some brief info 
    \details  more Details 
*/ 
/** 
    \defgroup Views 
    @copydoc view.h 
*/