Doxygen - как завершить блок внимания без перевода строки

Question

В основном я хочу продолжить поток обычного текста после раздела внимания.Если я оставлю новую строку, doxygen не будет ассоциировать текст перед новой строкой в ​​качестве документации по пункту.Существует ли общий способ завершения произвольного раздела, такого как @attention, без помещения всего раздела (т. Е. @attention) в другой блок и его завершения.

Редактировать

Например, если

///this is a function
///@attention attention text

///should be outside attention text
void testFunc() {};

, вывод кислорода выглядит следующим образом:

void testFunc ()

должен быть за пределами текста внимания

это функция

Внимание:
текст внимания

т.е. порядок текста изменен.

Обновление

Другая похожая проблема: в начале файла, который у меня есть:

///@author Somebody
///

#define MY_MACRO printf

Автор связывается с макросом, а не со всем файлом.Если я добавляю пустую строку комментария после @author, я получаю тот же результат

Как правило, существует ли универсальный способ завершить блок в doxygen, когда нет явного макроса закрытия, подобного @endcode.

Answer 1

Автор связывается с макросом, а не со всем файлом.

Если вы хотите, чтобы он был связан с файлом, то вам следует связать его с файлом . Это означает использование спецификатора @file в том же блоке, что и @author (и перед ним, очевидно).

Answer 2

Попробуйте:

///this is a function
///@attention attention text
///
///should be outside attention text
void testFunc() {};

Вместо того, чтобы оставлять пустые строки в блоке документации, держите их все вместе.Команда внимания заканчивается пустой строкой, но эта пустая строка, как ожидается, будет частью блока документации (т. Е. Пустая строка означает /// сама по себе).

В качестве альтернативы, вы можете использовать /** */ стиль комментариев, и тогда вы будете писать

/** this is a function
    @attention attention text

    should be outside attention text
*/
void testFunc() {};