Ограничения отступа абзаца команды Doxygen?

Существуют ли ограничения на количество отступов, которые можно использовать в многострочных (абзацевых) командах?

Рассмотрим типичный вариант использования @details в контексте функции:

/**
* @brief Do foo.
* @details Lorem ipsum dolor sit amet, mentitum rationibus nec an.
*          Usu magna eirmod et, aperiri discere volumus pri ex.
*
*          Te pro alii vidit, cu nonumes mediocritatem duo.
*          Paulo detracto tincidunt id vim, ad has oblique percipit.
*
* @tparam T The argument type.
* @param param1 The first parameter.
* @param param2 The second parameter.
* @return The return value.
*/
template< typename T >
inline
T foo( T const& param1, T const& param2 );

Долго @details параграфы должны быть обернуты, что приводит к вопросу о том, есть ли какие-либо ограничения на этот отступ?

Я знаю, что Doxygen использует Markdown, который имеет определенные ограничения / применения отступов, такие как «4 пробела» для кодовых блоков. Может ли вышеуказанный отступ запутать или конфликтовать в тех случаях, когда я хотел вставить код?

В более общем смысле, существуют ли другие варианты использования отступов и возможные конфликты, о которых я не знаю?

@ Томас-Мэттьюс, это вопрос о технические ограничения, не эстетический стиль.

0

Решение

Задача ещё не решена.

Другие решения


По вопросам рекламы [email protected]