【问题标题】:How do I group multiple remarks into a single paragraph?如何将多个备注分组到一个段落中?
【发布时间】:2014-10-28 17:29:37
【问题描述】:

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

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

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

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

【问题讨论】:

  • 我知道这是旧的,但我在尝试在 \test 命令中使用 \copydoc 时遇到了相同类型的问题,但使用 \copydoc 会自动开始一个新段落(很像 \remark)甚至从 \parblock

标签: html doxygen remarks


【解决方案1】:

我不确定我是否完全理解了这个问题,但如果问题是:“如何在单个 remark 标签中使用超过 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 文件:有一个名为“section remark”的 CSS 类应该允许您自定义外观;关于这个here的更多信息。希望对你有所帮助。

【讨论】:

  • 我正在寻找相反的 - 将多个不连续的 \remark 标签组合成一个段落。我要去看看 \parblock 看看它是否会做我想要的。
  • 不。简短的回答似乎是没有办法创建一个文本转移来从多个评论块中收集文本,然后将其作为单个段落发出。
猜你喜欢
  • 2012-09-13
  • 2018-08-11
  • 2019-11-17
  • 1970-01-01
  • 2022-09-23
  • 2020-06-21
  • 2015-07-10
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多