Doxygen中的参数格式

Question

我正在使用此方法记录我的方法：

/**
* Order beers from another player and add them into own inventory.
* @params from The Player who has to deliver the order
*/

void Player::order(const int numberOfBeers, Player &from)
{
    from.decreaseInventory(numberOfBeers);
    increaseInventory(numberOfBeers);
}

当我检查输出文件时，我只是以这种格式获取它：

Order beers from another player and add them into own inventory. from The Player who has to deliver the order 

这看起来非常不规则。参数之间没有分隔。我该如何解决？

Answer 1

要生成文件的氧气是\param而不是\ params(so withouts`）。

参见：http://doxygen.nl/manual/commands.html#cmdparam，摘录：

以name为函数参数启动参数说明，后跟参数说明。如果该参数（或任何其他）的文档缺少或在函数声明或定义中不存在，则检查该参数是否存在并给出警告。

\ param命令具有一个可选属性dir，用于指定参数的方向。可能的值为“ [输入]”，“ [输入，输出]”和“ [输出]”，请注意本说明中的[方括号]。当参数同时输入和输出时，[in，out]用作属性。

参数说明是没有特殊内部结构的段落。所有视觉增强命令都可以在段落内使用。

多个相邻的\ param命令将合并为一个段落。每个参数描述都将从新的一行开始。当遇到空白行或某些其他分段命令时，\ param说明结束。