Doxygen windows 配置说明

大部分文档都可以通过doxygen这个跨平台软件生成，doxygen并不能随便读取你的C++的注释,必须按照一定的规则才能生成，所以在编写代码时，一定要按照标准写注释，否则会为以后带来许多麻烦，下面是配置说明。

Doxygen 下载地址：http://www.stack.nl/~dimitri/doxygen/download.html

Step 1:是Doxygen的工作目录，请指定一个已存在的非中文的文件夹
主界面如下图：

Step 2:具体配置

Wizard选项卡

       Project

 

Mode

 

Output

将With search function的钩去掉

 

Diagrams

(Use built-in class diagram generator)将使用内置的生成功能生成每个类的类图，只有一个类是不为生成的。

如果需要更加大的功能比如类继承体系图请选择第三项(Use dot tool from the GraphViz package)需要安GraphViz。

 

Export选项卡

Project 

OUTPUT_LANGUAGE选择chinese

TAB_SIZE是Tab的长度

 

Build

默认是会生成public方法，这里也选择EXTRACT_ALL。它保证输出所有public方法及project方法，EXTRACT_STATIC是生成静态方法。

 

Input

Input为输入目录，支持多个目录，我们可以放入项目目录和include目录，下面的Exclude是忽略目录与文件，可自行添加。

 

Index

选择ALPHABETICAL_INDEX，类中将有一个组合类型索引项。

 

生成的索引

HTML

如果你之前选择了(prepare form compressed HTML(.chm))这里抽GENERATE_HTMLHELP项会是选择状态，它下面的CHM_FILE填写你的CHM文档的名字。HHC_LOCATION则选择你的HTML Help WorkShop安装目录下的HHC程序，一般会在C:/Program Files (x86)/HTML Help Workshop/hhc.exe。选择TOC_EXPAND会生成左边的树目录。

 

Dot

如果你选用内置的生成功能（Use build-in class diagram generator）此时CLASS_DIAGRAMS会是选择状态，而HAV_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_GRAPH                   include

INCLUDED BY GRAPH             被include

CALL_GRAPH                        调用

CALLER_GRAPH                    被调用

DIRECTORY_GRAPH               目录图

GRAPHICAL_HIERARCHY        继承体系图

配置好后中进入Run选项卡单击Run Doxygen即开始生成。