我正在从事一个C++项目，并且真的爱上了Sphinx文档构建系统。我设法设置了Doxygen和Breathe来产生并向Sphinx提供C++描述。
我不知道Google Ceres Solver文档是如何完成的。例如，他们的API reference包含类名，后跟大量文本，有时甚至带有如上一个链接所示的代码块示例。 是否可以在源文件中编写Doxygen文档并实现此目的？
另一个示例是this class documentation，它大约有两页文本。我以某种方式怀疑所有这些文本是否都以Doxygen注释的形式位于源文件中。我觉得所有多余的文本都已经写在文档的重组文本源中，而在c++源文件中什么也没有。但是使用氧气和呼吸有什么意义呢？
或以不同的方式询问，我应在何处放置有关代码的高级信息？我的意思是我可以在它们的源文件中记录class1和class2，但是我需要在某处解释它们是如何交互以及如何一起使用的。我认为，这是Ceres Solver的文档非常出色的表现。
或者，您可以通过Sphinx + Doxygen + Breathe管道和开源文档将我指向一个C++项目。然后，我可以亲自了解如何做这些事情。不幸的是，我对任何项目一无所知。
最佳答案
我错过了Ceres Solver的github链接。在此可以找到文档的来源。我有点失望，因为完整的文档写在重组文本源文件中，而不是在c++代码中。基本上，他们使用.. class:: className引用类名，然后为信息文本，示例代码块等添加ReST markdown。"Modeling Non-linear Least Squares"中给出了一个示例
关于c++ - 狮身人面像+氧气+呼吸: How do I get a documentation like the one of Google's Ceres Solver?，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/36116413/