Doxygen 使用笔记整理版本

因为最近要对一个C++工程进行分析，所以使用Doxygen 帮助了解代码架构。

步骤1 ：下载doxygen的binary 包

doxygen下载地址

http://www.10.xdowns.com/uploadFile/2007-7/doxygen.rar

为了使doxygen能够将类图、协作图等 加入到文档中，还要下载安装graphviz for win。

graphviz 2.18下载：

http://www.graphviz.org/pub/graphviz/ARCHIVE/graphviz-2.18.exe

全部安装后就可以开始使用了。

步骤2：运行doxygen wizard.exe

如果你像我一样希望只通过图形界面运行doxygen的话，请在doxygen的bin目录中运行doxywizard.exe，这时按照doxygen根目录下的文档（doxygen_manual-1.5.2.chm）中 Doxywizard usage一节的说明设置即可。主要包括，源码路径、工作路径、输出路径等。

步骤3：点开始，即可生成文档

最后对文档生成过程中遇到的一些问题进行说明：

1.中文问题：中文注释在文档中是乱码。

解决：在expert中的INPUT选项页的INPUT_ENCODEING中填入“GB2312”，这样基于GB的文本编辑器生成的代码就可以正常使用了。

但是，还有一个无法彻底解决的问题就是，当输出语言为中文时左边的导航栏的所有中文仍然是乱码。哪位有解决方案，请务必告知！

2.图形问题：无法绘制类图协作图等图形。

解决：首先确保安装了graphviz for win，注意不是wingraphviz，后者是一个graphviz的com封装，但是doxygen并不是基于它开发的，所以装了也没用。然后在 expert的DOT_PATH中填入graphviz的安装路径。接着在wizard的diagram中选择需要生成的图形类别就可以了。

如果出现无法包含.map文件的错误，可以将工作目录设置成html，并将html中所有文件都清除再试。这个问题的原因还不太确定。

3.输出chm的问题：如何输出.chm文件

在expert中的HTML页：选中“GENERATE_HTMLHELP”，然后在CHM_FILE中填上想要的chm文件名。

HHC_LOCATION中输入hhc.exe文件的路径。hhc.exe可以通过安装HTML Help Workshop获得。

HTML Help Workshop 地址：

http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en

这样，基本上就能够用doxygen生成漂亮的文档了。代码方面，doxygen支持多种格式的注释风格，根据manual选择自己喜欢的就好。 

补充说明：

          doxygen的安装很简单，到官方网站下载doxygen的windows安装程序即可。除了安装doxygen外，还需要安装graphviz，因为doxygen需要使用graphviz的dot.exe生成调用图。graphviz在它的官方网站上也可以下载到安装程序。不过我下载的安装程序在安装时老是报cab文件错误。最后我下载了graphviz的release文件，即安装程序下面的zip压缩文件，下载完成后解压缩即可。

         安装完doxygen后即可进行适当的配置，然后运行doxyfile生成文档。基本的配置前人早有说明，不再赘述。需要注意的是：

        1.要勾选Dot选项卡下面的HAVE_DOT、CALL_GRAPH 、CALLER_GRAPH 选项。并在DOT_PATH下面填入dot.exe的路径，也就是graphviz安装目录下的bin文件夹。

        2.勾选Wizard->Project选项卡下面的Scan recursively！

        3.勾选Build选项卡下面的EXTRACT_ALL、EXTRACT_PRIVATE、EXTRACT_STATIC、EXTRACT_LOCAL_CLASSES、EXTRACT_LOCAL_METHODS选项

        4.如果程序里面有中文，将Project选项卡下的DOXYFILE_ENCODING和Input选项卡下面的INPUT_ENCODING改为GBK

       5.可以勾掉LATEX输出，这样节省编译时间