2016-04-09 16 views
1

Wenn ich eine Funktion dokumentieren mit Doxygen dokumentieren kann ich dies tun: AberWie struct Datenelemente außerhalb von struct

/*! 
* @brief does something 
* @param a first parameter 
* 
* Longer description 
*/ 
void foo(int a) { /* */ } 

ist es so, wie ich struct Mitglieder auf diese Weise dokumentieren:

/*! 
* @brief a struct 
* @??? a first struct member 
* @??? b second struct member 
* 
* Longer description 
*/ 
struct a 
{ 
    int a, 
    int b, 
}; 

Der Grund ist, ich möchte vermeiden, meine Strukturmitglieder mit Inline-Kommentaren zu dokumentieren, wenn möglich.

Antwort

1
/*! 
* @struct str_a 
* @brief my a struct 
* @details Longer description 
* 
* @var str_a::a 
* @brief first struct member 
* @details detailed first struct member 
* @var str_a::b 
* @brief brf second struct member 
* @details detailed second struct member 
* 
*/ 
struct str_a 
{ 
    int a; 
    int b; 
};