Doxygen - 声明参数为可选参数

时间:2013-01-10 15:17:22

标签: c++ parameters doxygen optional-parameters

我正在使用Doxygen记录代码库,并且想知道是否存在用于将函数的参数声明为可选的关键字。类似的东西:

/*!
\fn int add(int a, int b=0)
\brief adds two values
\param a the first operand
\param \optional b the second operand.  Default is 0
\return the result
*/

似乎这应该存在,但我无法在任何地方找到它。是否有实际选项,或者我只是需要在说明中做出注释?

2 个答案:

答案 0 :(得分:10)

回答你的问题:不,没有这样的事情。

但我不同意你应该有类似的观点。毕竟,函数声明将与其文档一起显示,因此每个人都可以看到b是可选的,它的默认参数是什么。对于\fn,请参阅doxygen的文档discouraging the use of \fn

答案 1 :(得分:0)

Doxygen不提供您想要的内容 - 您必须在说明中手动记录它。