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

Question

我对doxygen比较陌生，喜欢Javadocs（当我在写更多的Java时）和普通的文字处理工具（当时我在为IBM工作时）。

我的评论风格是在整个代码库中包含大量贯穿叙述的叙述，以便代码的目的非常明确。我宁愿重新处理该文本，以便可以将其用于我正在生成的API的外部文档。

当我使用\ remark标签时，每次\ remark都会在HTML输出中作为单独的段落结束。这看起来并不像我希望的样子。我不想有一个可能涵盖6或8个代码块的巨人\评论。

我的问题是这样的 - 我如何告诉doxygen将多个\备注部分“合并”为一个段落，仅在需要时才开始新段落？

Answer 1

我不知道如果我完全理解这个问题，但如果问题是：“如何使用单一句话标签内超过100款，你可以使用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文件：有一个名为“section remark”的CSS类应该允许您自定义外观;更多关于这个的信息here。我希望我帮助你。