C++ .NET und Doxygen



  • Hallo,
    Ich muss gerade eine .NET Klasse mit Doxygen dokumentieren und ich schaffe es nicht ein property zu dokumentieren. Hat jemand eine Idee wie das gehen könnte?

    Wenn ich folgendes mache:

    /** \property String^ username
     *  \brief Username fuer die Website.
     */
    property String^ username {
    	String^ get() {return m_sUid;}
    	void set(String^ uid) {m_sUid = uid;};
    };
    

    bekomme ich nur den Fehler von Doxygen:

    Warning: documented function `String CRecvStream::username' was not declared or defined.
    

    Wenn ich stattdessen

    property String^ username() {...}
    

    schreiben würde, käme doxygen halbwegs damit zurecht, aber der Compiler hat natürlich etwas dagegen.

    mfG
    Sebastian



  • Also ich mache das einfach so:

    /// kurze Beschreibung
    /*! ausführliche Beschreibung
    */
    property String^ username 
    {
        String^ get() {return m_sUid;}
        void set(String^ uid) {m_sUid = uid;};
    };
    

    Ich vermute mal das mit den Backslashs ist ne spezielle Funktion von Doxygen?
    Wichtig ist auch mindestens Version 1.5.2 zu haben für C++/CLI. Siehe http://www.stack.nl/~dimitri/doxygen/changelog.html
    Viel Erfolg noch,
    Matthias



  • @UB909: Normalerweise muß man diese Zuordnung nur explizit angeben, wenn der Doxygen-Kommentar nicht direkt neben dem dokumentierten Element steht. Ich hab' Das eigentlich auch nur für \file benötigt (aber ich dokumentiere bislang auch nur C++ Programme mit Doxygen).

    @Herr Latz: \irgendwas oder @irgendwas kennzeichnen special commands für Doxygen (dahinter verbergen sich teilweise Formatierung, aber auch inhaltliche Kennungen wie @todo oder @param).



  • Hallo,

    ich nutze Doxygen 1.5.4 zur Dokumentation.
    Programmierumgebung ist Visual Studio C++ Express 2005.

    Ich hab folgendes Problem:

    Properties werden von Doxygen nicht erkannt, ich habe beide Methoden (und noch viele andere 😞 ) getestet, aber die Properties wollen einfach nicht in der Doku erscheinen.
    Nutze ich zweitere Methode, so erscheint die Kurzbeschreibung und der Beschreibungstext bei der nächsten Funktion.
    Ist das Property das letzte Element in der Datei, so taucht der Text nirgends auf.
    Nutze ich den Befehl \property, so lautet die Ausgabe auf "not declared or defined".
    Das Problem besteht für alle Dateien.

    Langsam bin ich echt verzweifelt, gibts da vielleicht nen Trick???
    Außerdem wüßte ich gerne, ob zweitere Methode von HerrLatz bei jemandem funktioniert.

    Vielen Dank schonmal.
    MfG, Petra


Anmelden zum Antworten