使用doxygen生成头文件函数说明文档/帮助文档

来源：互联网发布：备案域名购买编辑：程序博客网时间：2024/04/30 05:59

参考文档：

http://blog.sina.com.cn/s/blog_a459dcf50102v7fr.html

http://blog.sina.com.cn/s/blog_a459dcf50102v7ft.html

http://blog.csdn.net/vbvcde/article/details/4225630

安装参考

参考：http://blog.sina.com.cn/s/blog_a459dcf50102v7fr.html

1、下载doxygen-1.8.8-setup.exe，下载地址为：
华军软件：http://www.onlinedown.net/soft/117010.htm

2、下载graphviz，下载地址为（可选：生成关系图的话需要）
华军软件：http://www.onlinedown.net/softdown/522293_2.htm

3、下载HTMLHelp，下载地址为（可选：生成chm的话需要）
microsoft：https://msdn.microsoft.com/en-us/library/ms669985.aspx

使用参考

参考：http://blog.sina.com.cn/s/blog_a459dcf50102v7ft.html 参考博客中介绍的比较清楚

重点注意：

1. Mode配置：

Select the desired extraction mode
选择：All Enities (缺省是：Documented entities only）

2. 使用graphviz生成流程图的话，需要配置dot路径：

Expert页面：

Dot配置中的: DOT_PATH，配置为安装dot的路径，形如：D:\Program Files (x86)\Graphviz2.39\bin

3. 使用htmlhelp生成chm的话，需要配置hhc.exe路径：
Expert页面：
html配置中的: HHC_LOCATION，配置为安装hhc.exe的路径，形如：D:/Program Files (x86)/HTML Help Workshop/hhc.exe
CHM_FILE，配置生成chm的文件名，例如test.chm

CHM_INDEX_ENCODING: GB2312

输出乱码时的处理

参考：http://blog.csdn.net/vbvcde/article/details/4225630

在Expert页面tab配置：

1. Project项中设置输出为中文Chinese（原来缺省的是English)
OUTPUT_LANGUAGE = Chinese
2.Input项中设置输入为中文GBK（原来缺省的是utf8)
INPUT_ENCODING=GBK

0 0