生成 Cocos2d API 文档并集成到 Xcode 中

安装 doxygen

首先需要安装 doxygen,使用 doxygen 来生成 Cocos2d 的 API 文档。

可以直接从 doxygen 网站上直接下载 dmg 文件进行安装,这样是作为一个应用安装到了 Application 目录下。我们希望自己编译并安装到默认的 /usr/local/bin 目录下,这样我们在命令行下面使用起来会比较方便。

运行下面的命令:

wget http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.2.src.tar.gz
tar zxvf doxygen-1.8.2.src.tar.gz
cd doxygen-1.8.2
./configure
make
sudo make install

注意 make install 的时候使用的是管理员权限。

安装 Graphviz

像许多许多应用一样,doxygen 也使用 Graphviz 进行图像处理。Graphviz 如果自己编译就太麻烦了,因为它有若干依赖项。不想自己编译的可以直接下载官方提供的 Mac 平台的 pkg 安装包(http://www.graphviz.org/Download_macos.php)。Graphviz 会把自己安装到 /usr/local/bin 下面,这也是我们想要的。
想自己编译一下的可以看一下它的源代码页面:http://www.graphviz.org/Download_source.php,里面列出了自己编译时需要的所有依赖项和需要安装的工具。

生成 doxygen 文档

进入 Cocos2d 项目目录,比如我的是:

cd ~/Downloads/devel/cocos2d-iphone-2.1-beta4

运行 doxygen 命令:

doxygen doxygen.config

doxygen.config 是 Cocos2d 项目自带的一个配置文件.

集成到 Xcode

在上一步 doxygen 会在 cocos2d-iphone-2.1-beta4 目录中创建一个名为 html 的存放 API 文档的目录,下一步我们把它集成到 Xcode 中,运行命令:

make -C html install

再打开 Xcode -> Help -> Documentation and API Document, 就可以看到我们刚才生成的 Cocos2d API 文档了。
Screen Shot 2012-12-27 at 上午10.39.59

参考:http://www.cocos2d-iphone.org/archives/358

原文地址:http://www.tfan.org/integrating-cocos2d-api-documents-into-xcode/

回复