OGRE学习之路02：手把手教你如何通过Doxygen从源码生成OGRE 1.10.11 的离线API文档

前言：

Doxygen是一个很好的东西，可以帮助我们轻松地基于源码生成项目的API文档，这样我们可以更加方便地学习别人的开源项目，也别时相关资料非常匮乏的领域.

安装Doxygen

sudo apt-get install doxygen
sudo apt-get install graphviz
sudo apt install doxygen-gui

生成 OGRE 1.10.11 的离线API文档

打开终端，输入如下的命令：

doxywizard

此时就会打开Doxygen的GUI配置界面，有点像CMake的GUI

首先配置Wizard标签页：









接着，配置Export标签页：





最后，点击生成即可



可以看到，我这里由于配置中要求抽取所有的内容，所以文件数量显著增加，由原来默认配置中的19000个文件直接飙升到34000个文件，这就导致了打开生成的文件所在目录的时候需要比较长的时间，为此，建议大家在浏览器上创建一个标签，方便下一次启动文档.



上面就是我通过Doxygen最后生成的离线文档.