Doxygen 结合 graphviz 自动生成项目类图

1.  Doxygen  graphviz  下载地址

     doxgen ：http://www.stack.nl/~dimitri/doxygen/download.html

     graphviz ：http://www.graphviz.org/Download_macos.php

2.  下载完成后 ，进行傻瓜式安装

3.  doxygen  使用文档

    window： Doxygen 使用简介  是针对于window 版 的 

使用DoxyWizard生成CHM文档

安装好后，开始菜单会多出doxygen菜单，打开里面的DoxyWizard。界面如下图。

 Step1是Doxygen的工作目录，请指定一个已存在的非中文的文件夹。

Step2做具体配置工作。

首先是Wizard选项卡：

• Project

Project name: 项目名称

Project version or id: 项目版本号

Source code directory: 项目源码目录

Destination directory: 文档输出目录

• Mode

保持默认选项（Document Entity Only与Optimize for C++ output）即可。

• Output

要生成CHM文档请选择HTML项中的prepare for compressed HTML (.chm)。

同时将With search function (requires PHP enabled web server)的钩去掉。

LaTeX，如果不需要在文档中生成LaTeX公式的话可以不选。

• Diagrams

选择第二项Use Build-In class diagram generator，将使用Doxygen内置的生成功能生成每个类的类图（如果它只有一个类的时候是不会生成的 = =）。

如果需要使用更强大的功能比如类继承体系图，请选择第三项Use dot tool from the GraphViz package，此功能需要安装GraphViz软件。

其次是Export选项卡，配置项比Wizard内容多出许多，这里只做简单介绍。

• Project

OUTPUT_LANGUAGE，选择Chinese。

TAB_SIZE 是Tab的长度，默认为8，大家根据自己喜好……

• Build

默认是会生成public方法，但是貌似有时会莫名奇妙地少掉一些方法的详细信息。

这里也选上EXTRACT_ALL，它保证输出所有public方法及protected方法，static方法不在此范围内。

若要包含static方法的注释，请选中EXTRACT_STATIC。

同理EXTRACT_PRIVATE。

我们生成文档的目的是为了方便各位调用类与函数，因此生成ALL、STATIC、LOCAL_CLASSES就好了吧 = =。

• Messages

生成时的提示信息，默认即可。

• Input

Input为输入目录，支持多个目录，我们可以放入项目目录和Include目录。

下面的Exclude是忽略目录与文件。

• Source Browser

源码浏览器，默认即可。

• Index

钩选ALPHABETICAL_INDEX，类中将有一个组合类型索引项。如下图所示：

 

 

• HTML

如果你之前选择了prepare for compressed HTML (.chm)，

这里的GENERATE_HTMLHELP项会是钩选状态。

它下面的CHM_FILE填写你的CHM文档名字。

HHC_LOCATION则选择你的HTML Help WorkShop安装目录下的hhc程序，

一般会在C:/Program Files/HTML Help Workshop/hhc.exe。

Doxygen生成的默认是UTF-8，因此若不指定CHM_INDEX_ENCODING为GBK的话，CHM会有部分乱码。

钩选TOC_EXPAND，doxygen会为你生成左边树目录。

• Dot

如果你选用内置的生成功能（即选择Use Build-In class diagram generator），此时CLASS_DIAGRAMS会是钩选状态，而HAVE_DOT则是未选状态，默认即可;

如果你选用GraphViz的dot工具生成（即选择Use dot tool from the GraphViz package）情况则相反，请你钩选上CLASS_DIAGRAMS。此时你需要设置下面的DOT_PATH为GraphViz的安装目录，否则将无法生成。

另外以下选项钩选则生成对应的图，不选则不生成：

• CLASS_GRAPHS类图
• COLLABORATION_GRAPH 协作图
• GROUP_GRAPHS 组图
• UML_LOOK是否UML外观
• INCLUDE_GRAPHinclude
• INCLUDED_BY_GRAPH被include
• CALL_GRAPH 调用
• CALLER_GRAPH 被调用
• DIRECTORY_GRAPH 目录图
• GRAPHICAL_HIERARCHY继承体系图

建议钩选以上下划线的几项。效果应如下所示：

 

DOT_IMAGE_FORMAT是生成的图片类型，有PNG/JPG/GIF三种格式可选。

其他项没有用过，请大家自己研究 = =。

配置好后即可运行，进入Run选项卡，单击Run doxygen即开始生成。

对话框会显示调试信息，生成好后点击下面的Show HTML Output可以打开生成的HTML首页。

chm文件则在你指定的生成目录中自己找。

关闭前不要忘了保存配置文件，下次可以继续使用。

它会自动提示你是否需要保存，你也可以选择File菜单的Save项自己保存。

完毕！^^

Mac 版本的：基本和上面是一致的，但是graphviz 执行文件的路径 dot_path 应该改为：/user/local/bin/neato