[doxygen] Doku für C structs

supertux

Hallo

ich hab einige C Structs, die ich dokumentieren will. Also hab ich meine Header Files so angepasst, dass doxygen die Doku erzeugt. Das Problem ist, dass ich neben den Members der Structs keine Doxygen Kommentare haben will, weil sie recht lang sind

struct abc
{
   int a; ///< bla bla bla bla ...... bla bla
   int b; ///< bla bla ...
}

Das will ich nicht, weil es recht lang werden kann und dann wird der Code unlesbar. Man kann aber mit doxygen die Doku anderswo anlegen:

/**
 * \breif bla bla bla
 *
 * \var a bla bla bla
 * \var b bla bla bla
 */
struct abc
{
   int a;
   int b;
}

Ich dachte, ich könnte so etwas schaffen, aber ich bekomme folgendes:

src/include/gtkreminder/gr_message.h:-1: Warning: documented function `uid The UID of the user ...
...
src/include/gtkreminder/gr_message.h:75: Warning: Member uid (variable) of class gr_message_c is not documented.

Hab mir die ganze Sektion "Special Commands" durchgelesen aber ich finde kein passendes Command für C structs. Kann ich das überhaupt oder muss ich den Dokublock im Struct haben? (was ich letztendlich nicht will)

Gruss
Pablo

CStoll

Das hier ist einer der ersten Links, die Google ausgespuckt hat - hilft der?

supertux

nein, weil in der Doku der Doxygen Seite dasselbe (und noch mehr) steht. Ich finde überall, dass \var für eine Variable steht aber doxygen meint immer, die Funktion wäre nicht vorhanden.

C++ Forumbot

Dieser Thread wurde von Moderator/in rüdiger aus dem Forum Linux/Unix in das Forum Rund um die Programmierung verschoben.

Im Zweifelsfall bitte auch folgende Hinweise beachten:
C/C++ Forum :: FAQ - Sonstiges :: Wohin mit meiner Frage?

Dieses Posting wurde automatisch erzeugt.