Форматирование параметров в 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 not \ params (so without s`).

См .: http://doxygen.nl/manual/commands.html#cmdparam, выдержки:

Запускает описание параметра для параметра функции с именем, за которым следует описание параметра. Наличие параметра проверяется и выдается предупреждение, если документация этого (или любого другого) параметра отсутствует или отсутствует в объявлении или определении функции.

Команда \ param имеет необязательный атрибут, dir, указывающий направление параметра. Возможные значения: «[in]», «[in, out]» и «[out]», обратите внимание на квадратные скобки в этом описании. Когда параметр является как входным, так и выходным, в качестве атрибута используется [in, out].

Описание параметра - это абзац без специальной внутренней структуры. Все команды визуального улучшения могут использоваться внутри абзаца.

Несколько смежных команд \ param будут объединены в один абзац. Описание каждого параметра начинается с новой строки. Описание \ param заканчивается, когда встречается пустая строка или какая-либо другая команда секционирования.