cocos2d-x帮助文档(通过doxygen制作)

来源:互联网 发布:淘宝双11总额 编辑:程序博客网 时间:2024/06/04 01:29

本文介绍用Doxygen生成cocos2d-x的帮助文档,方便我我们平时的开发。

1. Doxygen

Doxygen是一个能将项目代码中的注释转化为文档,自动提取代码结构,生成继承图。他支持很多种语言(C/C++, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl等),也可以生成不同格式的帮助文档(word、pdf、html和unix的man帮助文档格式)。

下载地址:http://www.stack.nl/~dimitri/doxygen/download.html

2.文档生成

安装好Doxygen后,运行该程序。对于cocos2d-x的文档生成,由于在cocos2d-x的代码中有doxygen的配置文件,所以这里基本不用自己配置。点击File->Open,打开cocos2d-x根目录下的document中的doxygen.config,将看到Doxygen中显示已经配置好的信息。包括工作目录、源代码目录、文档生成位置,还有编码的配置等。


如果有需要,根据自己的需求修改相应配置。【Expert】为主要配置界面。

配置后相关参数后,点击【Run】选项卡中的按钮【Run doxygen】即可。