Doxygen的文檔可能的參數值

Question

目前我的C代碼函數聲明如下

/** Some fubar function 
*@param[in] val1 the first input variable 
*@param[in] val2 the second input variable 
*/ 
void foo (int val1, int val2); 

但文件說，參數只能除了在一定範圍內的數字，例如，0-500

是它除了作爲參數描述的一部分之外，是否可以記錄這些？也許這樣它會在生成的文檔中單獨顯示？

E.g.在乳膠生產的pdf中，會生成一個表格，其中包含參數類型（int），方向（in）和名稱（var1/var2）的單元格。有0-500的另一個表格單元格的某種方式？

Answer 1

你最好的選擇可能是詳細部分的表格。 Doxygen在文檔中支持HTML命令，並且PDF中生成的表看起來不錯。

/** 
* @brief Some fubar function 
* @param[in] val1 the first input variable 
* @param[in] val2 the second input variable 
* 
* <TABLE> 
* <TR><TD>Type</TD><TD>Direction</TD><TD>Name</TD><TD>Value Range</TD></TR> 
* <TR><TD>int</TD><TD>in</TD><TD>val1</TD><TD>0-500</TD></TR> 
* <TR><TD>int</TD><TD>in</TD><TD>val2</TD><TD>1-1000</TD></TR> 
* </TABLE> 
*/ 
void foo(int val1, int val2) {} 

問題在於它對我來說看起來很冗餘。也許將表限制爲參數名稱和期望值看起來會更好。對於doxygen支持的HTML集合，請參閱Doxygen Manual: HTML Commands。