Doxygen + graphviz + Windows Help Workshop生成函数调用图和chm文件

1. 说明

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。

Graph Visualization Software(Graphviz) 是一个由AT&T实验室启动的开源工具包，用于绘制DOT语言脚本描述的图形，它也提供了供其他软件使用的函数库.

Windows Help Workshop：使用这个工具可以生成 CHM 格式的文档

2. 下载安装地址

Doxygen下载链接：www.doxygen.org
Graphviz 下载链接：http://www.graphviz.org
HTMLhelp下载链接：http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en

3.生成效果

1 下图是用Doxygen+Graphviz从netcat的源代码生成的函数调用关系图。这种图有助于阅读C/C++源代码。

2 下面是自己亲测结果
类图：
Public Member Functions：

一个小例子的（为了显示分析的结果）

调用图：

4. 简单使用生成函数调用图

首先安装doxygen，然后解压下载好的graphviz+HTMLhelp+Windows Help Workshop。
1.下安装Doxygen+Graphviz+Windows Help Workshop。
2. 记住Graphviz和Windows Help Workshop的安装目录，以后要用到。
3. 运行doxywizard。
接着打开doxygen:
第一步：


第二步：

第三步：

第四步：


第五步：

第六步：
Build页面，这个页面是生成帮助信息中比较关键的配置页面：

• EXTRACT_ALL 表示：输出所有的函数，但是private和static函数不属于其管制。
• EXTRACT_PRIVATE 表示：输出private函数。
• EXTRACT_STATIC 表示：输出static函数。同时还有几个EXTRACT，相应查看文档即可。
• SHOW_INCLUDE_FILES 表示：是否显示包含文件，如果开启，帮助中会专门生成一个页面，里面包含所有包含文件的列表。
• INLINE_INFO ：如果开启，那么在帮助文档中，inline函数前面会有一个inline修饰词来标明。
• SORT_MEMBER_DOCS ：如果开启，那么在帮助文档列表显示的时候，函数名称会排序，否则按照解释的顺序显示。

第七步：
说明：INPUT_ENCODING (输入的源文件的编码)，要与源文件的编码格式相同。如果源文件不是UTF-8编码最好转一下。

第八步：在[Expert]的HTML页面中，将HHC_LOCATION指向微软的hhc工具。通常是默认解压缩的文件夹C:/Program Files/HTML Help Workshop/hhc.exe（如果是自己选择的解压缩目录，则选择自己的目录）。
HHC_LOCATION中输入hhc.exe文件的路径。
hhc.exe可以通过安装HTML Help Workshop获得。

CHM_FILE：最终生成的.chm的文件名，如“ProjectHelp.chm”。默认为“index.chm”。可以使用路径，也可以使用相对路径，相对于上面设置的输出目录的html目录（建设使用上一级目录，如“..\MyDoc.chm”）
**HHC_LOCATION：**chm 编译器（hhc.exe）的全路径。请指到 HTML Help Workshop 的安装目录的 hhc.exe 程序
**CHM_INDEX_ENCODING：**chm索引文件编码，下面会讲到，这里填“GBK”

如过要像MSDN那样在左边的树中显示函数列表，则在[Expert]的HTML页面，然后选中TOC_EXPAND即可。

第九步：



最后一步：

最后点击Show HTML output 可以查看文档的有关信息的~
也可以在你当时在第一步时选择的Destination directory:D:\DoxygenWorkspace\dest(看看自己选择的文件夹)那个文件夹里面找到~
如果在CHM_FILE没有选择或者自己填的名称，默认存在Destination directory路径下的html文件夹中可以找到index.chm或者自己命名.chm~

整理学习参考于:链接1 链接2 链接3