使用Doxygen工具生成Cocos2D-x 2.1.0文档

Doxygen是一种开源跨平台的工具,其功能是从程序源代码中抽取类、方法、成员的注释,形成一个和源代码配套的API(Application Programming Interface,应用程序编程接口)帮助文档。Doxygen工具,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C等语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器(或.chm格式),或离线的LATEX、RTF参考手册。

Doxygen可以根据代码中的注释,按照规则生成相应的文档。Cocos2D-x的代码就依照了它的规则,并且提供了doxygen.config文件。这是Cocos2D-x代码的Doxygen配置文档,可以通过这个文件来生成Cocos2D-x文档。

首先下载Doxygen,下载地址为http://www.doxygen.nl/download.html#latestsrc。根据系统选择要下载的版本,建议下载安装版。下载完成后运行程序,出现如图2-42所示的界面。

1

使用File→Open打开cocos2d-x-2.1.4cocos2d-x-2.1.4目录下的document目录下的doxygen.config文件,界面如图2-43所示。

2

(在wizard菜单下,对于“project”标签,设置对应的doxygen的工作路径、源代码的路径、生成的doc的路径、软件的版本号等,可以将工程src目录拷贝到单独的文件夹下。)

在wizard菜单下,对于“output”标签,设置生成文件的格式为.chm。

3

在expert菜单下,对于“HTML”标签下,勾选’GENNERATE_HTMLHELP’,并且设置生成的.chm文件的名称,此时就需要使用“html help workshop”软件的hhc.exe,在“HHC_LOCATION”下输入hhc.exe文件的路径,通常情况下为“C:Program FilesHTML Help Workshop”。(我的hhc.exe的文件路径是D:/Program Files/HTML Help Workshop/hhc.exe)

4

打开配置文件后出现了Cocos2D-x版本配置信息,单击“Run”选项卡,单击“Run doxygen”按钮,运行生成文档,完成后如图2-44所示。生成.html文档和.chm文档需要一段时间,耐心等待!

5

打开Cocos2D-x目录下的cocos2d-x-2.1.4cocos2d-x-2.1.4document目录下的index.html和index.chm文件,如图所示,可以使用Cocos2D-x文档了。

6

7

原文地址:https://www.cnblogs.com/yssgyw/p/3208664.html