第12章 构建文档

本章的主要内容有:

  • 使用Doxygen构建文档
  • 使用Sphinx构建文档
  • 结合Doxygen和Sphinx

文档在所有的软件项目都是有必要的:对于用户来说,了解如何获得并构建代码,并且如何有效地使用源代码或库;对于开发人员来说,文档可用来描述你源码细节,并帮助其他程序员参与其中为该项目作出贡献。本章将展示如何使用CMake构建代码文档,这里使用了两个流行的文档框架:Doxygen和Sphinx。