将Cocos2D API参考整合入XCode的方法

这篇文章翻译自cocos2d官方的一篇blog:Integrating cocos2d API reference into XCode

翻译这篇文章,是cocos2d这样优秀和常用的lib库,没有api参考提示会很痛苦.这种痛苦cocos2d伟大的开发者们肯定也曾经体验过,所以, 在cocos2d里提供了方便的文档安装脚本(是一个编译的target).

按以下步骤安装cocos2d API参考到xcode里:

[安装doxygen]
下载和安装最新版本的doxygen.
下载地址:http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
下载DMG格式的安装包.将App拖入Applications文件夹.

[编译cocos2d-documentation]
在xcode里打开cocos2d项目,编译目标选择cocos2d-documentation
花B编译.

就是如此简单…

[其他问题]
1.有很多童鞋编译完之后,在doucment里还是找不到cocos2d的文档,这可能是因为build目录没有正确清理的原因,建议手动删除 cocos2-iphone工程下build目录里的文件重新build,一般就可以解决.
2.比较遗憾的,cocos2d的文档不支持quick help(按住alt将鼠标指针变为十字,双击关键字).只能选中文字之后,右键->find text in document.不过因为是开源库,这个遗憾可以通过花键+双击直接查看头文件注视和方法实现来弥补.
3.cocos2d的生成目录是：/Users/用户名/Library/Developer/Shared/Documentation/DocSets

 

将附加解压放到/Users/用户名/Library/Developer/Shared/Documentation/DocSets 中可以直接使用