cocos2D(二)---- cocos2D文档的使用
2016-02-04 16:26
211 查看
在使用cocos2d进行游戏开发的过程中,难免要查阅cocos2d的API文档。搞清楚怎么使用某个类或者某个方法。幸运的是,cocos2d的作者已经在源码里面加入了文档凝视,我们仅仅须要使用文档生成工具解析源码生成文档就可以。
最经常使用的文档生成工具是Doxygen。
用Doxygen处理cocos2d文档有2种方式:
第1种方式:安装Doxygen软件,解析cocos2d源码。生成html格式的静态文档
第2种方式:利用cocos2d自带的Doxygen功能,将文档集成到Xcode中
以下我分别具体说明上述2种方式的实现步骤:
生成HTML文档
1.下载dmg格式的Doxygen软件http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
2.安装好Doxygen后,打开软件进行參数设置
3.点击Run doxygen開始生成文档
4.生成完成后。打开文档的生成位置(刚才设置的是cocos2d目录)。多了一个html目录,
5.打开html目录中的index.html文件,这个是文档的入口
6.这里能够查看全部的类
7.我们来看看CCSprite类
8.有继承结构图
9.有方法列表
10.点击某个方法,还能够看到方法的具体说明
到这里为止。html格式的文档就搞定了
将cocos2d的文档集成到Xcode中
说明:cocos2d版本号是1.0.1,Xcode版本号是4.5
前提:先安装上面的Doxygen软件到Applications(应用程序)文件夹下
1.打开cocos2d中的doxygen.config文件,设置成输出中文文档(事实上仅仅是部分keyword为中文,这个步骤能够省略)
2.双击打开cocos2d-ios.xcodeproj
3.设置cocos2d-documentation为target
4.编译这个target
提示:点击编译后,会自己主动运行一些脚本去生成文档。请耐心等待。编译过程中会产生非常多错误和警告,这个不影响文档的生成,能够忽略
5.看到Build succeed就代表文档生成完成,这时候请全然退出Xcode后再又一次打开Xcode。接着查看文档
6.能够看到cocos2d的文档已经集成到Xcode中了
7.事实上本质是将文档打包成一个.docset文件。然后生成到:/Users/apple/Library/Developer/Shaerd/Documentation/DocSets目录中(我的username叫apple),Xcode会去这里载入全部的文档,只是仅仅会在打开Xcode时载入一次,这也是要全然重新启动Xcode才干查看新生成的cocos2d文档的原因
两种处理cocos2d文档的方式都介绍完了,个人更推荐採取第2种方式:集成到Xcode中,这也是开发中最常见的方式
原文地址:http://blog.csdn.net/q199109106q/article/details/8590609
感谢作者~!
最经常使用的文档生成工具是Doxygen。
用Doxygen处理cocos2d文档有2种方式:
第1种方式:安装Doxygen软件,解析cocos2d源码。生成html格式的静态文档
第2种方式:利用cocos2d自带的Doxygen功能,将文档集成到Xcode中
以下我分别具体说明上述2种方式的实现步骤:
生成HTML文档
1.下载dmg格式的Doxygen软件http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc2.安装好Doxygen后,打开软件进行參数设置
3.点击Run doxygen開始生成文档
4.生成完成后。打开文档的生成位置(刚才设置的是cocos2d目录)。多了一个html目录,
5.打开html目录中的index.html文件,这个是文档的入口
6.这里能够查看全部的类
7.我们来看看CCSprite类
8.有继承结构图
9.有方法列表
10.点击某个方法,还能够看到方法的具体说明
到这里为止。html格式的文档就搞定了
将cocos2d的文档集成到Xcode中
说明:cocos2d版本号是1.0.1,Xcode版本号是4.5前提:先安装上面的Doxygen软件到Applications(应用程序)文件夹下
1.打开cocos2d中的doxygen.config文件,设置成输出中文文档(事实上仅仅是部分keyword为中文,这个步骤能够省略)
2.双击打开cocos2d-ios.xcodeproj
3.设置cocos2d-documentation为target
4.编译这个target
提示:点击编译后,会自己主动运行一些脚本去生成文档。请耐心等待。编译过程中会产生非常多错误和警告,这个不影响文档的生成,能够忽略
5.看到Build succeed就代表文档生成完成,这时候请全然退出Xcode后再又一次打开Xcode。接着查看文档
6.能够看到cocos2d的文档已经集成到Xcode中了
7.事实上本质是将文档打包成一个.docset文件。然后生成到:/Users/apple/Library/Developer/Shaerd/Documentation/DocSets目录中(我的username叫apple),Xcode会去这里载入全部的文档,只是仅仅会在打开Xcode时载入一次,这也是要全然重新启动Xcode才干查看新生成的cocos2d文档的原因
两种处理cocos2d文档的方式都介绍完了,个人更推荐採取第2种方式:集成到Xcode中,这也是开发中最常见的方式
原文地址:http://blog.csdn.net/q199109106q/article/details/8590609
感谢作者~!
相关文章推荐
- Cocos引擎开发者指南(1-5)
- cocos2dx 3.3 无法打开包括文件: “extensions/ExtensionExport.h” 问题
- cocos2dx-ios接入admob广告
- cocos2d-java错误报错
- Cocos2d-x TextField的使用
- Cocos2d-x TextBMFont的使用
- Cocos2d-x Text的使用
- Cocos2d-x TextAtlas的使用
- Cocos移植到Android-通过命令行交叉编译打包
- cocos2d-x基础——cocos安装和使用基础
- cocos2dx 3.3 pluginx protocols文件夹分析
- Cocos2d-x解析XML文件,解决中文乱码
- (7)基本工作流(使用AndroidStudio编辑Cocos项目)
- cocos2d-x-Tiled 地图坐标 转换 .
- cocos2dx iOS crash _context presentRenderbuffer:GL_RENDERBUFFER
- 03.CocosCreator资源工作流程
- 新编辑器Cocos Creator发布:对不起我来晚了!
- cocos2d-x 3.6版连连看
- (1)了解cocostudio基础
- (28)Cocos2d-x xml解析