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 Manual: HTML Commands для набора HTML, поддерживаемого doxygen.