安装cocos2d文档集

转自

一、安装cocos2d文档集

为了便于今后检索Coco2d的各种类、方法、属性，我们最好将cocos2d的文档安装到Xcode中。作者Blog中曾有一篇译文《使用Doxgen创建Xcode文档集》描述了创建文档集的方法，但时至今日，Xcode已经发展到3.2.5，而Doxgen也升级到1.7.3了，原文中描述的方法也多少有些不适应了。且不知到什么原因，直接在Xcode中编译cocos2d文档集总是不成功，所以这里只能用Doxgen GUI生成cocos2d文档集。

1、安装Doxgen

当前版本为1.7.3，下载地址：

http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc

dmg格式，下载后把doxgen.app拖到“应用程序”目录（／Applications）即可。

2、运行Doxgen.app

Doxgen GUI使用起来很简单，如下图所示：

Step1: Specify the working directory…

需要指定一个Doxgen工作目录，随便指定一个即可，实在不行就新建个，Doxgen有时候会放一些临时文件在这里。

为简单起见，我们使用的是Wizard模式，这种方式比较简单。

Project name：填写项目的名称

Project version or id：版本号

Project logo：选择一个图标，会显示在文档集中。

Source code directory：指定源文件目录，cocos2d的源文件都放在安装目录的cocos2d目录中。当然也可以只指定cocos2d目录，然后勾上Scan recursively，Doxgen会自己去搜索所有子目录。

Destination directory：文档集生成后存放的路径，这里，我们直接指定为cocos2d目录。

好了，点击Run按钮，进入如下界面，然后点击Run doxygen就大功告成了：

打开Xcode，点击Help——>Developer Documentation，打开Document Browser，点击Home按钮，可以看到新多出来的Doc Set：

当然，你也可以打开文档集存放目录（/cocos2d-iphone-0.99.5/html/ ）目录进行浏览（因为我们生成的Doc Set是Html格式的）：