《Cocos2D-x权威指南》——2.4 使用Doxygen工具生成Cocos2D-x文档

简介: 本节书摘来自华章计算机《Cocos2D-x权威指南》一书中的第2章,第2.4节,作者:满硕泉著, 更多章节内容可以访问云栖社区“华章计算机”公众号查看。

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

Doxygen是一种开源跨平台的工具,其功能是从程序源代码中抽取类、方法、成员的注释,形成一个和源代码配套的API(Application Programming Interface,应用程序编程接口)帮助文档。Doxygen工具完全支持C、C++、Java、Objective-C等语言,部分支持PHP、C#。
Doxygen可以根据代码中的注释,按照规则生成相应的文档。Cocos2D-x的代码就依照了它的规则,并且提供了doxygen.cocos2d-x文件。这是Cocos2D-x代码的 Doxygen 配置文档,可以通过这个文件来生成Cocos2D-x文档。
首先下载Doxygen,下载地址为http://www.doxygen.nl/download.html#latestsrc。根据系统选择要下载的版本,建议下载安装版。下载完成后运行程序,出现如图2-42所示的界面。
image

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

image

打开配置文件后出现了Cocos2D-x版本配置信息,单击“Run”选项卡,单击“Run doxygen”按钮,运行生成文档,完成后如图2-44所示。

image

打开Cocos2D-x目录下的doxygenhtml目录下的index.html文件,如图2-45所示,可以使用Cocos2D-x文档了。

image

相关文章
|
1月前
|
XML 存储 JSON
CocosCreator 面试题(十五)Cocos Creator如何内置protobuf JS版本?
CocosCreator 面试题(十五)Cocos Creator如何内置protobuf JS版本?
【Cocos2d实例教程一】xcode5下Cocos2d环境的搭建
(转载请注明出处:http://blog.csdn.net/buptgshengod)     第一步,现在要安装集成环境xcode5,安装xcode5需要系统至少是os x 10.8.5。     第二步,下载cocos2d-iphone到电脑文档或任何一个文件夹(这里以文档为例),    下载地址:http://code.google.com/p/cocos2d-iphone/d
909 0
|
JavaScript 前端开发 API
【Cocos2d-x】开发基础-Cocos简介与环境搭建
【Cocos2d-x】开发基础-Cocos简介与环境搭建
348 0
|
iOS开发 开发框架
|
API Go 开发工具
《Cocos2D权威指南》——1.2 下载与安装
本节书摘来自华章计算机《Cocos2D权威指南》一书中的第1章,第1.2节,作者:王寒,屈光辉,周雪彬著, 更多章节内容可以访问云栖社区“华章计算机”公众号查看。
1278 0
|
JavaScript 前端开发 iOS开发
《Cocos2D权威指南》——1.4 深入学习HelloCocos2D项目
本节书摘来自华章计算机《Cocos2D权威指南》一书中的第1章,第1.4节,作者:王寒,屈光辉,周雪彬著, 更多章节内容可以访问云栖社区“华章计算机”公众号查看。
1075 0
|
Android开发 iOS开发 开发者
《Cocos2D-x权威指南》——1.1 什么是Cocos2D
本节书摘来自华章计算机《Cocos2D-x权威指南》一书中的第1章,第1.1节,作者:满硕泉著, 更多章节内容可以访问云栖社区“华章计算机”公众号查看。
1725 0

热门文章

最新文章