Ограничения отступа абзаца (висящего) команды 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 пробела» для кодовых блоков. Будет ли приведенный выше отступ сбивать с толку или конфликтовать в тех случаях, когда я хотел вставить код?

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

@ thomas-matthews, это вопрос о технических ограничениях, а не о эстетическом стиле.


c++ indentation doxygen restrictions
person Charles L Wilcox    schedule 10.09.2014    source источник
comment
@ thomas-matthews, это вопрос о технических ограничениях, а не о эстетическом стиле.   -  person Charles L Wilcox    schedule 10.09.2014
comment
@ thomas-matthews, Кроме того, ... спрашивал раньше и уже получил ответ. это неверно; никто еще не ответил на другой вопрос.   -  person Charles L Wilcox    schedule 10.09.2014
comment
Тем, кто просил открыть это заново: Спасибо.   -  person Charles L Wilcox    schedule 10.09.2014
comment
У меня нет однозначного ответа, но я бы посоветовал не использовать этот отступ, поскольку, по моему опыту, не нужно много времени, чтобы запутать интерпретатор, особенно с включенной поддержкой Markdown. Для эстетики рассмотрите возможность включения JAVADOC_AUTOBRIEF. это устранило бы необходимость в любом отступе в исходном комментарии.   -  person Cheeseminer    schedule 11.09.2014

Ответы (1)


arrow_upward
1
arrow_downward

Очень грубое предложение, но это то, что у меня сработало -

/**
 * @brief Do foo.
 * @details Lorem ipsum dolor sit amet, mentitum rationibus nec an.
 *
 * &nbsp; &nbsp; &nbsp; &nbsp; Usu magna eirmod et, aperiri discere volumus pri ex.
 * &nbsp; &nbsp; &nbsp; &nbsp; 
 * &nbsp; &nbsp; &nbsp; &nbsp; Te pro alii vidit, cu nonumes mediocritatem duo.
 * &nbsp; &nbsp; &nbsp; &nbsp; 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.
 */
person eeerahul    schedule 20.12.2019