aMule代码分析(1)——用doxyfile生成文档

前几天都是用Vim在看代码,可是对于wxWidget的机制不太熟,抓不住程序的运行轨迹,后来学习了GDB,自己猜着设断点,就知道有些类的运行过程了。但是aMule里面类太多,太庞大,Maxiee感觉自己就像在一片大森林里面,面对着成千上万大大小小的植物,要想把每一个品种搞懂,谈何容易啊。

要是有一幅地图,把这片森林里有多少种树,每一种长什么模样,把这些客观特征都帮我们总结好,到时候我们拿着这张图,按图索骥,我们所需要做的就是思考就好,这样多方便啊!

Maxiee曾在网上看到过一次aMule生成的doxygen文档,感觉正是需要的东西。可是现在网上没那个手册了,不过Maxiee发现aMule代码的docs目录下有一个Doxyfile文件。网上查了一下,有了这个就能生成doxygen文档了。

首先安装doxygen,Maxiee使用的是Arch Linux,需要运行命令:

pacman -S doxygen

pacman -S graphviz    这个貌似Doxygen在绘图时会调用

安装好后,我们需要把docs目录中的Doxyfile文件拷贝到aMule项目根目录中(也就是docs的上级目录啦)。拷贝完成,我们在终端里也进入到这一目录,输入命令:

doxygen Doxyfile

屏幕上会显示很多输出,等一会,就完成了档案生成:

aMule代码分析(1)——用doxyfile生成文档_第1张图片

之后再回到docs目录,我们会发现多了一个html和一个latex,进入html,打开index.html:

aMule代码分析(1)——用doxyfile生成文档_第2张图片

这正是我们想要的啦~O(∩_∩)O~~

接着看代码去!

你可能感兴趣的:(aMule)