1

我对 doxygen 比较陌生,我更喜欢 Javadocs(当我编写更多 Java 时)和常规文字处理工具(当我为 IBM 工作时)。

我的评论风格是在整个代码库中穿插大量运行叙述,以便代码的目的非常明确。我更愿意重新处理该文本,以便将其用于我正在生成的 API 的外部文档。

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

我的问题是——我如何告诉 doxygen 将多个 \remark 部分“合并”成一个段落,只有在我想要的时候才开始一个新段落?

4

1 回答 1

0

我不确定我是否完全理解了这个问题,但如果问题是:“如何在单个备注标签内使用超过 1 个段落,您可以使用parblockendparblock命令:

/**
 *  \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 文档来检查 parblock 文档。如果您仍然对 HTML 输出不满意,我建议您添加自定义 CSS 文件指定备注规则。您可以通过 HTML_EXTRA_STYLESHEET 添加额外的 CSS 文件:有一个名为“section remark”的 CSS 类应该允许您自定义外观;关于这个的更多信息在这里。我希望我对你有所帮助。

于 2014-09-05T19:26:27.690 回答