2
我正在使用doxygen生成C++代碼的HTML文檔。不幸的是,doxygen在方法描述中沒有顯示未公開的方法參數。例如,下面的顯示無證函數參數
/**
* Some method
* @param p1 Some param
*/
void method(const std::string& p1, const std::string& p2);
方法說明會顯示註釋和參數p1
但不p2
。
如何配置doxygen以列出方法描述中的所有參數,即使未明確記錄?
AFAIK這是不可能的(我可能是錯的)。參數「p2」出現在doxygen文檔的方法簽名中,這是不夠的嗎?如果你希望它也出現在參數列表中,我想你將不得不記錄它(你可以把文檔留空,例如只使用'\ param p2')。 – Chris
當列出所有參數並且未記錄的參數有空白註釋時(比如在JavaDoc中),它在我看來更加一致。記錄所有參數當然會解決這個問題,但我可以直接寫評論。 ;) –