如何将多个备注分组到一个段落中？

Question

我是doxygen的新手，更喜欢Javadocs（当我编写更多Java时）和常规文字处理工具（当我在IBM工作时）。

我的评论风格是在整个代码库中包含大量的运行叙述，以便代码的目的非常明确。我更喜欢重新编写该文本，以便它可以用于我正在生成的API的外部文档。

当我使用\ remark标签时，我将每个\ remark作为HTML输出中的单独段落。这看起来不像我想要的样子。我不希望有一个巨大的\注释，可能涵盖6或8个代码块。

我的问题是这样 - 我怎么能告诉doxygen将多个\ remark部分“合并”到一个段落中，只在我想要的时候开始一个新的段落？

Answer 1

我不确定我是否完全理解了这个问题，但如果问题是：＆＃34;如何在一个评论标记内使用超过1个段落，则可以使用 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 doxygen documentation来检查parblock文档。 如果您仍然不满意HTML输出，我建议您添加一个指定备注规则的自定义CSS文件。您可以通过HTML_EXTRA_STYLESHEET添加其他CSS文件：有一个名为＆＃34的CSS类; section remark＆＃34;应该允许你自定义外观;有关此here的更多信息。我希望我能帮助你。