瘸腿蛤蟆笔记09-cocos2d-x-3.2工具使用-doxygen

转载标明出处：http://blog.csdn.net/notbaron/article/details/38341639

上篇回顾

         上篇中，蛤蟆学习了如何简单的使用TexturePacker工具来打包一群图片，然后再使用该图片形成动画。经过几个晚上的学习，我想我们已经走到了cocos2d-x的门口，接下来很多的路需要小伙伴自己取走。但是蛤蟆会一直陪伴在大家身边。

         刚下班回来，今天在公司开了几个会议。开会太伤神的实在。

         今天，我看到了doxygen工具，这个很不错。应该在很早就介绍给大家，现在我们开始。

 

工具介绍

         首先看百度百科：

Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞泰坦尼克号同样的辛苦。大部分有用的批注都是属于针对函数、类型等等的说明。所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担。不过，反过来说，整理文件的工作对于您来说，就是沉重的负担。

         看到了么，这个工具是用来根据程序中注释生成说明文件的。是不是很给力的。

具体步骤

         首先，到官网下载 http://www.stack.nl/~dimitri/doxygen/download.html.

如下图 1

         蛤蟆用的是windows，所以选择了wndows的二进制文件。下载，然后默认安装即可。

         然后，我们进入到 \cocos2d-x-3.2\docs目录下，发现有如下图2

         我们打开刚安装的doxygen程序中的doxywizard，如下图3

         打开File->Open->，选择 \cocos2d-x-3.2\docs路径下的doxygen.config文件。

然后如下图4中，点击 Run页签，再点击 run doxygen 按钮。

结束后如下图5所示。

         现在我们就得到了离线的API指南。我进入到目录 \cocos2d-x-3.2\docs\html中，双击打开index.html文件，得到如下图6 所示。

 

 

 

 

总结

         通过本笔记，我们学会了工具doxygen使用。这样我们就可以产生离线的API手册。再也不用担心上不了网了。接下去，蛤蟆将会学习并记录精灵的动作。