Doxygen的 - 声明参数为可选(Doxygen - declare parameter as

2019-08-06 07:23发布

我记录使用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
*/

好像这是应该存在的东西,但我一直没能在任何地方找到它。 是否有一个实际的选择,还是我只需要记的描述?

Answer 1:

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

但我不同意你的意见,应该有类似的东西。 毕竟,在函数声明将连同它的文档显示,所以大家可以看到, b是可选的,它的默认参数为。 而对于\fn看到doxygen的文档鼓励使用\新生力量 。



Answer 2:

你想不被Doxygen的提供什么样的 - 你必须手动记下它的描述。



文章来源: Doxygen - declare parameter as optional