Doxygen文档生成工具的使用

http://blog.csdn.net/xu_fu/article/details/8425652

Doxygen是一个开源的项目文档生成工具，只要在代码中按规定的格式添加注释，就可以使用该工具自动生成相应的文档，同时结合Graphviz这个图形可视化软件，还可以得到相应的类图关系等可视化图片。这个文档工具支持C/C++、Java等多种语言，输出几种不同的文档格式，只试验输出了HTML，下面就介绍捣鼓了一下午的成果吧：

1、需要安装的软件

Doxygen
Graphviz
HTML Help Workshop

这些软件可以在这里下载http://dl.vmall.com/c0pcrafyg8，也可以在后面的参考资料1中找到下载地址。

三个软件的安装过程都非常简单，直接下一步就可以了，可以更改安装路径。

2、生成HTML文件

首先打开Doxywizad，进行一些参数设置。如图：



其中Step1.是设置该配置文件的保存路径，点击Step2中的Expert进行具体的文档生成设定，相应的步骤可以在参考资料1中找到，设置完成后保存，在点击Run下的Run doxygen系统就会自动运行进行文档生成了，就像这样



这里重点说一下遇到的问题：

我生成的是Live555这个开源项目的文档，我将源码文件放在了D:\live\src这个目录下面，按照参考资料1中的步骤进行了设置然后运行，成功生成HTML文档，但打开index.html后只有个标题，其他什么也没有，后来找到参考资料2解决了这个问题，就是在Exper进行配置的时候将Input下的RECURSIVE勾选，这样才能将src目录下的所有子目录也包含进去，否则它一看src目录下一个源文件也没有，当然在html中就什么都不会产生咯。设置如下图：



由于源码比较多，用Graphviz生成的图片就有4000多张，所以时间也比较长，最后成功生成HTML文件。

3、chm文件制作

这个比较简单，第二步正确设置后会生成index.hhp文件，有这个文件就可以编译chm文件了。

在命令行cd到HTML Help Workshop安装目录下，输入hhc index.hhp即可，等上一会就可以看到提示生成.chm文件，位置在index.hhp的目录下。

参考资料1->http://www.fmddlmyy.cn/text21.html；

参考资料2->http://www.ibm.com/developerworks/cn/aix/library/au-learningdoxygen/index.html#resources.