Doxygen 常规使用

Doxygen官网地址：http://www.doxygen.org/

使用指南：http://www.stack.nl/~dimitri/doxygen/doxywizard_usage.html

下载地址：http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc

Linux i386 --
doxygen-1.5.9.linux.bin.tar.gz

Windows 95/98/ME/NT/2000/XP/Vista --
doxygen-1.5.9-setup.exe

步骤1 ：下载doxygen的binary 包
doxygen下载地址：Doxygen官网

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

graphviz 下载：

Liunx Redhat 版本下载：http://www.graphviz.org/Download_linux_rhel.php

windows
版本
下载：
http://www.graphviz.org/Download_windows.php
全部安装后就可以开始使用了。

步骤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选择自己喜欢的就好。