Doxygen: Dokumentieren Sie die Parameter einer Funktion Zeigertyp (ANSI-C)

Question

Mein Code benötigt einige Funktionszeigertypen wie

/** 
* \brief Callback function type "foo" 
*/ 
typedef int (*foo)(int a, int b); 

Ich mag würde die Semantik der Funktionsargumente dokumentieren, sondern ein \param[in,out] neben Die \brief-Anweisung scheint keine zusätzliche Dokumentation hinzuzufügen.

Gibt es eine Möglichkeit, doxygen hinzufügen Parameter-Dokumentation zu Funktion Typ-Defs?

TIA für jede Hilfe!

Answer 1

Es ist nicht klar aus Ihrer Frage, was genau Sie versucht haben, wenn Sie \ param platziert haben.

Die für mich folgende Werke (doxygen 1.8.6 verwenden):

/** 
* \brief Callback function type "foo" 
* 
* A longer description of foo. 
* \param a Description for a 
* \param b Description for b 
* \return Description for return value 
*/ 
typedef int (*foo)(int a, int b); 

In der Ausgabe, schafft es die kurze und lange Beschreibungen, einen Parameters Abschnitt mit den Parametern a und b, und einen Returns Abschnitt mit die Beschreibung des Rückgabewertes.

Andy