http://blog.csdn.net/lostaway/article/details/6446786
doxygen 是一个支持 c/c++,以及其它多种语言的跨平台文档生成工具。如同 javadoc, doxygen 直接从源文件中提取符合 doxygen 注释规范的注释,生成文档[1]。
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 格式的文档。
2、配置运行 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 快速入门
附录补充几张效果图:
