Globale Operatoren/Funktionen mit Doxygen dokumentieren
Verfasst: 24.04.2012, 11:43
Wie strukturiere ich am geschicktesten globale Funktionen und Operatoren in Doxygen?
Ich habe in einem Namespace ca. 20 Klassen und ein davon hat ca. ein Dutzend globale Operator-Templates. Diese sind also nicht Member der Klasse, da sie an alles, was sie aufrufen müssen, eh übers public Interface der Klasse ran kommen. Nun führt das aber zu der Unschönheit, dass ich in Doxygen, wenn ich auf die Referenz des Namespaces gehe, diese Funktionen alle direkt auf einer Seite mit den Klassen habe. Sie nehmen dort mehr Platz ein, als die Klassen. Interessieren tun einen diese Funktionen aber eigentlich nur, wenn man die Doku zu der Klasse, zu deren Interface sie quasi gehören, sehen will. Entsprechend hätte ich sie gerne nicht direkt in der Übersicht des Namespaces, sondern erst zusammen mit den public Membermethoden der Klasse aufgelistet, nachdem man auf diese geklickt hat.
Wie stelle ich das am geschicktesten an?
Ich habe in einem Namespace ca. 20 Klassen und ein davon hat ca. ein Dutzend globale Operator-Templates. Diese sind also nicht Member der Klasse, da sie an alles, was sie aufrufen müssen, eh übers public Interface der Klasse ran kommen. Nun führt das aber zu der Unschönheit, dass ich in Doxygen, wenn ich auf die Referenz des Namespaces gehe, diese Funktionen alle direkt auf einer Seite mit den Klassen habe. Sie nehmen dort mehr Platz ein, als die Klassen. Interessieren tun einen diese Funktionen aber eigentlich nur, wenn man die Doku zu der Klasse, zu deren Interface sie quasi gehören, sehen will. Entsprechend hätte ich sie gerne nicht direkt in der Übersicht des Namespaces, sondern erst zusammen mit den public Membermethoden der Klasse aufgelistet, nachdem man auf diese geklickt hat.
Wie stelle ich das am geschicktesten an?