Описание тега в стиле Doxygen в виде нескольких строк - PullRequest
5 голосов
/ 09 августа 2010

В проекте C ++ для документации я использую doxygen и стиль javadoc. Я довольно новичок в javadoc и не уверен, допустим ли этот тип вещей.

/**
 * ...stuff...
 * @return foo foo foo foo foo. Foo foo
 * foo foo foo foo foo.
 */

т.е. информация о том, что возвращается (и мой вопрос относится ко всем тегам), должна занимать несколько строк. Это автоматически определяется или мне нужно сделать что-то особенное?

Кроме того, насколько я понимаю, вы можете получить краткое описание класса и более подробное описание класса. Как и в приведенной выше проблеме, может ли краткое описание класса быть более чем одной строкой? Если да, какой синтаксис для этого?

1 Ответ

4 голосов
/ 09 августа 2010

Документы doxygen утверждают, что

Если используются фигурные скобки, аргумент продолжается до следующего абзаца.Абзацы разделены пустой строкой или индикатором раздела.

Команда return указана как команда стиля абзаца.Таким образом, вы можете использовать столько строк, сколько захотите, добавить одну лишнюю пустую строку или просто запустить новую команду, чтобы завершить return.

...