Doxygen 中的参数格式化
Formatting For Parameters in Doxygen
我正在使用这个方法来记录我的方法：
/**
* 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
这看起来很散漫。参数没有分离。我该如何解决这个问题？
记录参数的 doxygen 是 \param 而不是 \params(so withouts`)。
参见：http://doxygen.nl/manual/commands.html#cmdparam，摘录：
Starts a parameter description for a function parameter with name , followed by a description of the parameter. The existence of the parameter is checked and a warning is given if the documentation of this (or any other) parameter is missing or not present in the function declaration or definition.
The \param command has an optional attribute, dir, specifying the direction of the parameter. Possible values are "[in]", "[in,out]", and "[out]", note the [square] brackets in this description. When a parameter is both input and output, [in,out] is used as attribute.
The parameter description is a paragraph with no special internal structure. All visual enhancement commands may be used inside the paragraph.
Multiple adjacent \param commands will be joined into a single paragraph. Each parameter description will start on a new line. The \param description ends when a blank line or some other sectioning command is encountered.
我正在使用这个方法来记录我的方法：
/**
* 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
这看起来很散漫。参数没有分离。我该如何解决这个问题？
记录参数的 doxygen 是 \param 而不是 \params(so withouts`)。
参见：http://doxygen.nl/manual/commands.html#cmdparam，摘录：
Starts a parameter description for a function parameter with name , followed by a description of the parameter. The existence of the parameter is checked and a warning is given if the documentation of this (or any other) parameter is missing or not present in the function declaration or definition.
The \param command has an optional attribute, dir, specifying the direction of the parameter. Possible values are "[in]", "[in,out]", and "[out]", note the [square] brackets in this description. When a parameter is both input and output, [in,out] is used as attribute.
The parameter description is a paragraph with no special internal structure. All visual enhancement commands may be used inside the paragraph.
Multiple adjacent \param commands will be joined into a single paragraph. Each parameter description will start on a new line. The \param description ends when a blank line or some other sectioning command is encountered.