Как сгруппировать несколько замечаний в один абзац?

Я относительно новичок в doxygen, предпочитая Javadocs (когда я больше писал на Java) и обычные инструменты обработки текстов (когда я работал в IBM).

Мой стиль комментариев состоит в том, чтобы включать много беглого повествования, разбросанного по всему коду, чтобы цель кода была очень ясной. Я бы предпочел переработать этот текст, чтобы его можно было использовать во внешней документации для API, которые я создаю.

Когда я использую теги \remark, я получаю каждый \remark как отдельный абзац в выводе HTML. Это не выглядит так, как я хочу, чтобы это выглядело. Я также не хочу иметь одно гигантское \remark, которое могло бы охватывать 6 или 8 блоков кода.

Мой вопрос заключается в следующем: как я могу сказать doxygen «объединить» несколько разделов \remark в один абзац, начиная новый абзац только тогда, когда я этого хочу?


html doxygen remarks
person Julie in Austin    schedule 04.09.2014    source источник
comment
Я знаю, что это старо, но я сталкиваюсь с проблемой того же типа, пытаясь использовать \copydoc внутри команды \test, но использование \copydoc автоматически запускает новый абзац (как \remark) даже внутри \parblock   -  person Godric Seer    schedule 13.11.2015

Ответы (1)


arrow_upward
0
arrow_downward

Я не уверен, что полностью понял вопрос, но если вопрос был: "как использовать более 1 абзаца внутри одного тега remark, вы можете использовать parblock и команды endparblock:

/**
 *  \file utils.h
 *  \brief TODO complete the documentation of utils.h
 *
 * \remark  Lorem ipsum dolor sit amet, ex everti iracundia laboramus vel, in tota sensibus posidonium eam. His ei expetenda splendide, has eu iusto delicatissimi. Mei dolor deseruisse et. Viris graeco necessitatibus an est, quod reque vulputate sea cu, an has simul nihil numquam. Modo animal assentior pri ut, te mea duis prima, esse sonet ut vim. Duo in duis legere molestie.
 *
 * Ea mel prima atomorum liberavisse, ei odio voluptua dissentiet vix. Vix an ornatus suscipit perfecto. Ut propriae omnesque cum, usu ferri commune tacimates te, erant definitionem vim id. Vix cu copiosae imperdiet. Vis fierent nominati patrioque et, eam menandri vituperatoribus ei, ea has veritus volutpat neglegentur. Ius cu posse novum utroque.
 *
 * Ad per nobis periculis, legere cetero duo ut. In vis nihil admodum suscipit, per alia consequat expetendis ad, ex erant vocibus adversarium mel. Vix ut modus gloriatur, falli vitae eu eam, te per dicat persius. Vis nostrud maiorum et, sea ut etiam perfecto. Cum ut quod legimus convenire, iriure fabellas gloriatur qui ex.
 *
 * \remark
 *
 * \remark \parblock
 *
 * Lorem ipsum dolor sit amet, ex everti iracundia laboramus vel, in tota sensibus posidonium eam. His ei expetenda splendide, has eu iusto delicatissimi. Mei dolor deseruisse et. Viris graeco necessitatibus an est, quod reque vulputate sea cu, an has simul nihil numquam. Modo animal assentior pri ut, te mea duis prima, esse sonet ut vim. Duo in duis legere molestie.
 *
 * Ea mel prima atomorum liberavisse, ei odio voluptua dissentiet vix. Vix an ornatus suscipit perfecto. Ut propriae omnesque cum, usu ferri commune tacimates te, erant definitionem vim id. Vix cu copiosae imperdiet. Vis fierent nominati patrioque et, eam menandri vituperatoribus ei, ea has veritus volutpat neglegentur. Ius cu posse novum utroque.
 *
 * Ad per nobis periculis, legere cetero duo ut. In vis nihil admodum suscipit, per alia consequat expetendis ad, ex erant vocibus adversarium mel. Vix ut modus gloriatur, falli vitae eu eam, te per dicat persius. Vis nostrud maiorum et, sea ut etiam perfecto. Cum ut quod legimus convenire, iriure fabellas gloriatur qui ex.
 *
 * \endparblock
 *
 * \remark
 *  third remark
 */

Вот вывод в формате HTML: вывод с парблоком и без него. Вы всегда можете проверить документацию parblock, перейдя по ссылке документация parblock doxygen. Если вы все еще не удовлетворены выводом HTML, я бы порекомендовал вам добавить пользовательский файл CSS, определяющий правила примечаний. Вы можете добавить дополнительные файлы CSS через HTML_EXTRA_STYLESHEET: есть класс CSS с именем «примечание к разделу», который позволит вам настроить внешний вид; больше информации об этом здесь. Надеюсь, я помог вам.

person Koldar    schedule 05.09.2014
comment
Я ищу противоположное - объединение нескольких несмежных тегов \remark в один абзац. Я посмотрю на \parblock и посмотрю, будет ли он делать то, что я хочу. - person Julie in Austin; 06.09.2014
comment
Неа. Короткий ответ, кажется, заключается в том, что нет способа создать текстовую диверсию, которая будет собирать текст из нескольких блоков комментариев, а затем выделять его как один абзац. - person Julie in Austin; 06.09.2014