Doxygen und C++ -- globale Funktionen werden nicht dokumentiert



  • Hallo Leute,

    ich hab mich in der letzten Zeit mal mit Doxygen beschäftigt. Ist eigentlich ne super Sache. Allerding bin ich auf ein kleines Problem gestoßen. Ich hoffe hier kann mir einer weiterhelfen.

    Ich habe eine Klasse geschrieben udn will im headerfile die Doxygen Kommentare haben. Soweit, so gut.
    Jetzt habe ich, wie man es machen soll, die out-/input-operatoren, sowie alle binären (+,-,*,/) also gloable Funktionen deklariert und diese natürlich auch kommentiert.

    Sieht etwa so aus:

    /**
    * \fn ostream& operator<<(ostream& o, const Task& t);
    * \brief Outputoperator for stdout
    * 
    * Prints the Task on stdout.
    * \param ostream& outputstream
    * \param Task& task to write out
    * \return ostream& given outputstream
    */
    ostream& operator<<(ostream& o, const Task& t);
    /**
    * \fn ofstream& operator<<(ofstream& o, const Task& t);
    * \brief Outputoperator for file-ouput
    * 
    * Prints the Task in a file.
    * \param ofstream& file-outputstream
    * \param Task& task to write in file
    * \return ofstream& given file-outputstream
    */
    ofstream& operator<<(ofstream& o, const Task& t);
    

    Leider tauchen diese Kommentare in der Doku nicht auf. Woran kann das liegen???



  • Doch, die werden dokumentiert. Schau mal im fertigen Dokument unter Classes>Class Members>Related Functions.

    Aber warum tust du die Funktionen nicht in einen Namespace? Dann werden sie auch unter Namespaces>Namespace Members>Functions aufgeführt.

    Was auch noch interessant ist, die Funktionen als Module zu dokumentieren:

    /** \defgroup foos Foos
    @{*/
      void foo();
    /*@}*/
    

Anmelden zum Antworten