我有 doxygen 的文檔如下：/** @fn * Function detailed description * * @param [in] param1_name description of parameter1 * @param [in] param2_name description of parameter2 * @return return_name return description */uint32_t function_name(uint32_t param1_name, uint32_t param2_name);但詳細(xì)的描述沒(méi)有在 doxygen html 中呈現(xiàn)，我遵循了頁(yè)面上的指導(dǎo)方針，但沒(méi)有任何運(yùn)氣。
1 回答
拉風(fēng)的咖菲貓
TA貢獻(xiàn)1995條經(jīng)驗(yàn) 獲得超2個(gè)贊
如果函數(shù)文檔位于已記錄函數(shù)之前，則無(wú)需使用 @fn 關(guān)鍵字。嘗試這個(gè)：
/** @brief function short description
*
* function longer description if need
* @param[in] param1_name description of parameter1
* @param[in] param2_name description of parameter2
* @return return_name return description
*/
uint32_t function_name(uint32_t param1_name, uint32_t param2_name);
- 1 回答
- 0 關(guān)注
- 148 瀏覽
添加回答
舉報(bào)
0/150
提交
取消