Użyj doxygen do dokumentowania elementów struktury c poza definicją struktury

Question

Używam doxygen do komentowania mojego kodu C. Korzystam z obcego API (tj. Nie własnego), którego dokumentacja jest skąpa, dlatego zamierzam udokumentować niektóre z tych API w moich własnych plikach źródłowych. I do mają plik nagłówkowy dla obcego API, ale nie jest praktyczne dodawanie własnych komentarzy do tego pliku.

Header obce

struct foreignstruct 
{ 
    int a; 
    int b; 
}; 

My Header

/** My structure comments... 
struct mystruct 
{ 
    /** Describe field here... */ 
    int field; 
}; 

/** @struct foreignstruct 
* @brief This structure blah blah blah... 
* @??? a Member 'a' contains... 
* @??? b Member 'b' contains... 
*/ 

Co tag używać zamiast @??? aby uzyskać poprawny wynik doxygen (gdzie 'poprawny' oznacza wygenerowane wyjście mystruct i foreignstruct są takie same)?

Answer 1

Może kiedyś doxygen będzie miał specjalny tag @field na to, aż do tego czasu, mogą być stosowane następujące:

/** @struct foreignstruct 
* @brief This structure blah blah blah... 
* @var foreignstruct::a 
* Member 'a' contains... 
* @var foreignstruct::b 
* Member 'b' contains... 
*/ 

Która jest notacja short-hand dla

/** @struct foreignstruct 
* @brief This structure blah blah blah... 
*/ 
/** @var foreignstruct::a 
* Member 'a' contains... 
*/ 
/** @var foreignstruct::b 
* Member 'b' contains... 
*/