狮身人面像 + Doxygen + Breathe:如何获得像 Google 的 Ceres Solver 这样的文档?
Sphinx + Doxygen + Breathe: How do I get a documentation like the one of Google's Ceres Solver?
我正在做一个C++项目,真的爱上了狮身人面像文档构建系统。我设法设置了Doxygen和Breathe来制作并向Sphinx提供C++描述。
我无法弄清楚Google的Ceres Solver文档是如何完成的。例如,它们的 API 参考包含类名,后跟大量文本,有时甚至包含上一个链接中显示的代码块示例。有没有办法在源文件中编写 Doxygen 文档并实现这一点?
另一个示例是此类文档,它有大约两页文本。我不知何故怀疑所有这些文本都作为 Doxygen 注释位于源文件中。我有一种感觉,所有额外的文本都写在文档的重组文本源中,而 c++ 源文件中没有任何内容。但是,使用氧气和呼吸有什么意义呢?
或者换个问题,我应该把关于代码的高级信息放在哪里?我的意思是我可以在他们的来源中记录class1
和class2
,但我需要在某处解释它们如何相互作用并一起使用。在我看来,这就是谷神星求解器的文档做得很好的地方。
或者,你可以向我指出一个C++项目,其中包含Sphinx + Doxygen + Breathe管道和开源文档。然后我可以亲眼看看如何做这些事情。不幸的是,我不知道任何项目。
我错过了谷神星求解器的 github 链接。在那里可以找到文档的来源。我有点失望,因为完整的文档是写在重组文本源文件中的,而不是在 c++ 代码中。基本上,他们用.. class:: className
引用类名,然后添加ReST标记以获取信息文本,示例代码块等。"非线性最小二乘建模"中给出了一个例子