Doxygen的：記錄一個函數指針類型的參數（ANSI-C）

Question

我的代碼需要一些函數指針類型，如

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

我想記錄的函數的參數語義，但是一個\param[in,out]旁\brief聲明似乎沒有添加額外的文檔。

有沒有辦法讓doxygen將參數文檔添加到函數type-defs中？

TIA任何幫助！

Answer 1

從您的問題中不清楚當您放置\ param時您究竟嘗試了什麼。

對我來說，以下工作（使用的doxygen 1.8.6）：

/** 
* \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); 

在輸出中，它創建的簡要和長的描述中，Parameters部具有參數a和b，和一個Returns部與返回值的描述。

Andy