Doxygen und CPP-Files ...



  • Hallo,

    ich nutze Doxygen zum Dokumentieren meines Codes.
    Nun nimmt Doxygen nur die Kommentare in den Header-Dateien bzw. Klassendefinitionen und nicht die Kommentare, die ich über die jeweiligen Implementierungen der Funktionen schreibe.
    Kann ich die beiden Kommentare verbinden? Vielleicht den Implementierungskommentar als nähere Erläuterung?

    Habt vielen Dank



  • Das steht soweit ich mich erinnere in der Doku, wo erklärt wird, wie man dokumentiert.



  • Also bei mir uebernimmt er die Doku-Kommentare aus den cpp-Dateien. In den Header-Dateien habe ich keine Doku-Kommentare stehen.



  • wenn du für eine entity mehrere docs hast, nimmt doxygen nur eine:

    // .h:
    /// Some nice function
    /// It is really amazing, try it!
    void foo();
    
    // .cpp:
    /// This function sucks. 
    /// I wrote it, but I'd never call it!
    void foo()
    {
     bar();
    }
    

    Allerdings kannst du - mit den richtigen Einstellungen - die Kurzdoku im Header und die langdoku im Body haben (so mach ich's meistens)


Anmelden zum Antworten