与 Doxygen 和 Autodoc 的差异

由于 Breathe 试图弥补 Sphinx 和 Doxygen 之间的差距,它被 Doxygen 在其 XML 中输出的内容和 Sphinx 通过 Docutils 文档模型接受的内容限制了。

这导致了 Breathe 输出和 Doxygen HTML 输出以及 Sphinx Autodoc 输出之间的一些差异。

这些都是不完整的清单,但我们很想在问题被提请我们注意时扩大它们。

Doxygen

  • Doxygen 允许在评论中使用 HTML 和 Markdown 两种语法的标题。这些标题在输出中被渲染成标准的 HTML 标题(h1,h2,h3,等等)

    RestructuredText 只允许在文档章节的开头有标题,你不能把任意的章节放到输出中来获得标题的外观,所以在 doxygen 注释中发现的任何标题在 Breathe HTML 输出中被呈现为强调文本。

Sphinx Autodoc

  • 目前还没有突出的差异,尽管它们肯定存在。