Doxygen und Inline-Methoden kommentiert



  • Hi,

    habe ein Problem bei der Doku-Generierung mit Doxygen: Wenn ich in meinem Header am Ende einen Inline-Header einbinde (*.inl), und darin eine detaillierte Beschreibung für z.B. einen Inline-Konstruktor habe, wird diese nicht mit in die Doku aufgenommen, während Besdhreibungen von Inline-Funktionen (also keine Klassenmethoden) in derselben Datei mit aufgenommen werden.
    Dachte zuerst, dass liegt an #ifdef __cplusplus am Anfang der *.inl-Datei, habe das aber vordefiniert (in den Doxygen-Präprozessor-Optionen) und es ging trotzdem nicht (wobei aber beispielsweise die Brief-Doku von Funktionen in einem #ifdef __cplusplus-Block mit aufgenommen wurde, im Gegensatz zu vorher).

    Im Header:

    #ifndef HEADER_H
    #define HEADER_H
    
    #ifdef __cplusplus
    
    class A // die Klasse A wird dokumentiert!
    {
      /// Diese Brief-Description wird auch mit aufgenommen
      A(const A &Copy);
    };
    
    #endif
    ...
    
    #include "Header.inl"
    
    #endif
    

    Im Inline-Header:

    #ifdef __cplusplus
    
    /// Diese detaillierte Beschreibung wird nicht mit in die
    /// Dokumentation aufgenommen, warum?
    A::A(const A &Copy)
    {
    }
    
    #endif
    

    Hoffe, irgendjemand hat vielleicht eine Lösung.


Log in to reply