（转）Doxygen文档生成工具

　　http://blog.csdn.net/lostaway/article/details/6446786

 

Doxygen 是一个支持 C/C++，以及其它多种语言的跨平台文档生成工具。如同 JavaDoc, doxygen 直接从源文件中提取符合 doxygen 注释规范的注释，生成文档^[1]。 

一、安装

1.1 安装 Doxygen 1.7.4(Windows)

地址：ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.4.windows.bin.zip

 

1.2 安装 graphviz 2.28.0(Windows)

地址：http://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.28.0.msi

 

graphviz 是一个由AT&T实验室启动的开源工具包，用于绘制DOT语言脚本描述的图形^[2]。Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图，如不须要此功能可不安装该工具包。

 

1.3 安装 Windows Help Workshop 1.32

地址：http://download.microsoft.com/download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe

 

这个工具就很少说了，生成 CHM 帮助文档的。 Doxygen 使用它生成 CHM 格式的文档。

 

二、配置

运行 Doxywizard 开始配置

Doxygen 1.7.4 主界面以下图 1 所示。

 

说明：

Doxygen 工做目录(1:) 就是用来存放配置文件的目录，别无它用。

 

选择 wizard 标签下的 Output Topics

相关配置说明以下图 2 所示。

 

 

选择 wizard 标签下的 Diagrams Topics

相关配置说明以下图 3 所示。

 

若是以前安装了 Graphviz 工具包，就可启用该选项。

 

选择 expert 标签下的 Project Topics

相关配置说明以下图 4 所示。

 

说明：编码格式，UTF-8 是首选。

 

选择 expert 标签下的 Input Topics

相关配置说明以下图 5 所示。

 

 

说明：

输入的源文件的编码，要与源文件的编码格式相同。若是源文件不是UTF-8编码最好转一下。

 

 

选择 expert 标签下的 HTML Topics

相关配置说明以下图 6 所示。

 

说明：

若是在 Wizard 的 Output Topics 中选择了 prepare for compressed HTML (.chm)选项，此处就会要求选择 hhc.exe 程序的位置。在 windows help workshop 安装目录下能够找到 hhc.exe。

 

 

在 Expert 标签中还有超多的选项，须要按本身的要求去定制。我的喜爱问题就再也不赘述了，你们能够查 doxygen 文档啥的，里面有每一个选项的详细介绍。

 

选择 Run 标签

相关配置说明以下图 7 所示。

 

 点击 Run doxygen 按钮， Doxygen 就会从源代码中抓取符合规范的注释生成你定制的格式的文档。接下来的工做就是学习 doxygen 的注释规范了，参考 《doxygen 快速入门》第 2 节 “经常使用注释语法”。慢慢的就能够体会到 doxygen 的方便性。

 

Doxygen 生成 CHM 文档乱码的问题

因为 Windows 的默认编码不是 UTF-8， Doxygen 生成的 CHM文件目录和文件标题栏是乱码。通常解决步骤能够参考《doxygen 快速入门》关于解决目录乱码的问题。这里要补充的一点就是，最好将 index.hhc、index.hhk 、index.hhp都转为 UTF-8格式。这样标题栏啥的也不会是乱码了。

参考

[1] http://zh.wikipedia.org/wiki/Doxygen Wikipedia-doxygen

[2] http://zh.wikipedia.org/wiki/Graphviz Wikipedia-graphviz

[3] http://hi.baidu.com/soulmachine/blog/item/6055ad017a9a1606738da58c.html doxygen 快速入门

 

附录

补充几张效果图：