生成 cocos2d 的离线文档

cocos2d 官方网站提供了一个第三方的离线文档下载（基于 Adobe AIR 和 Dash），用着不大理想。折腾了一番，干脆弄了一个带搜索功能的本 地 HTML 版。配合 MacOS 自带的 apache 和第三方 Fluid 应用，最终实现了一个很不错的 cocos2d API 离线文档。

准备工作

生成文档需要 doxygen 和 GraphViz 两个应用程序，分别从下面的网站获得：

• doxygen:http://www.doxygen.org/

• GraphViz:http://www.ryandesign.com/graphviz/

制作可以脱离浏览器的离线版查看器，需要 Fluid，可从下面的网站获得：

• Fluid:http://fluidapp.com/

修改生成文档的设定

cocos2d 自带了一个 doxygen.config，但其中的设定并不是很理想，我们需要修改一下。

启动 doxygen 应用，选择菜单“File -> Open”打开 doxygen.config 文件。点击“Expert”选项卡，然后修改下列几项：

• Project 标签

• OUTPUT_LANGUAGE: Chinese

• TAB_SIZE: 4

• Input标签

• FILE_PATTERNS: 增加 *.m

• Source Browser标签

• SOURCE_BROWSER: YES

• STRIP_CODE_COMMENTS: NO

• Dot标签

• CLASS_DIAGRAMS: YES

• DOT_PATH: /usr/local/graphviz-2.14/bin （根据实际目录修改）

• 
  

最后，点击“Wizard”选项卡，设定文档的输出目录和输出格式：

生成文档

设定完成后，点击“Run”选项卡，再点击“Run doxygen”按钮开始生成文档。完成后点击“Show HTML Output”可以打开浏览器查看生成的文档。

＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝

cocos2d引擎在线帮助文档

http://www.cocos2d-x.org/embedded/cocos2d-x/classes.html

http://www.cocos2d-iphone.org/api-ref/0.99.5/annotated.html