Zeilenumbruch in Label von Image bei Doxygen



  • Hallo,

    ich habe folgenden Doxygen-Kommentar einer Funktion.

    /// Disconnect a node from its ancestors in the tree. That is, after performing this operation the target node is active.
    /// Due to disconnecting the target, former ancestors of it may loose active sites and become obsolete and have to be removed.
    /// @param target The node to be disconnected
    /// @image html disconnect_rec.jpg "The blue node gets disconnected from the ARG. The nodes circled in green are the ones to which adapt_above() is applied. The grey lines indicate connections generated by reconnect()."
    void Changer::disconnect_nd(Rev_Base_Nd* target) { ... }
    

    Mein Problem ist nun, dass das Label bei @image arg lang ist und ich es auf mehrer Zeilen umbrechen möchte. Einfach

    /// Disconnect a node from its ancestors in the tree. That is, after performing this operation the target node is active.
    /// Due to disconnecting the target, former ancestors of it may loose active sites and become obsolete and have to be removed.
    /// @param target The node to be disconnected
    /// @image html disconnect_coal.jpg
    /// @image html disconnect_rec.jpg "The blue node gets disconnected from the ARG. The nodes circled in green are the ones
    /// to which adapt_above() is applied. The grey lines indicate connections generated by reconnect()."
    void Changer::disconnect_nd(Rev_Base_Nd* target) { ... }
    

    zu schreiben, geht aber nicht.

    weiß jemand, wie man das macht?



  • Versuchs mal einfach mit <br> mittendrin.



  • KuhTee schrieb:

    Versuchs mal einfach mit <br> mittendrin.

    Meinst du so

    /// Disconnect a node from its ancestors in the tree. That is, after performing this operation the target node is active.
    /// Due to disconnecting the target, former ancestors of it may loose active sites and become obsolete and have to be removed.
    /// @param target The node to be disconnected
    /// @image html disconnect_coal.jpg
    /// @image html disconnect_rec.jpg "The blue node gets disconnected from the ARG. The nodes circled in green are the ones <br>
    /// to which adapt_above() is applied. The grey lines indicate connections generated by reconnect()."
    void Changer::disconnect_nd(Rev_Base_Nd* target) { ... }
    

    ?

    Wenn ja: Das führt leider nicht zum Erfolg. Die zweite Zeile "to which ..." wird dann als nicht zum Image-Label gehörend interpretiert.



  • Und wenn du nach dem <br> den Text weiterführst?



  • KuhTee schrieb:

    Und wenn du nach dem <br> den Text weiterführst?

    Sorry, da war ich ungenau: Das Problem für mich ist nicht die Länge des Labels in der von Doxygen erzeugten Doku (da werden automatisch Zeilenumbrüche eingefügt), sondern die Länge des Labels im Source-Code. So ein Label kann ja mehrere Hundert Zeichen lang sein und ist dann schwer zu editieren. Daher würde ich es gerne im Source-Code auf mehrere Zeilen verteilen.



  • LÖsung: lange Dokumentation im Body, kurze Dokumentation im label.


Log in to reply