Doxygen使用简介（3）

三．参数简要设置及执行

先采用参数详细设置生成1个通用的配置文件，再根据实际情况，通过简要设置，修改配置文件，生成实际需要的配置文件。

3.1 通用配置文件

根据要求的不同，目前生成了3个通用的配置文件：

1. DoxyConfig_code，通过该配置文件生成的帮助文档除了一些基本信息外，还包括各种关系图，并且包括源代码。

2. DoxyConfig_debug，通过该配置文件生成的帮助文档除了一些基本信息外，还包括各种关系图，除了不包含源代码外，其余内容与通过DoxyConfig_code生成的帮助文档一样。

3. DoxyConfig_release，通过该配置文件生成的帮助文档，用于第三方的开发帮助文档，内容比前两种生成的帮助文档少很多，不包括源代码、私有函数和变量显示、文件包含信息图、函数调用图、源代码目录结构图等。

3.2 简要设置

先导入对应通用配置文件，再进行简要设置。

Fig.3.1 简要”Project”页

如图3.1，设置“Project”页，需要设置工作目录，工程名，版本号，源代码目录，目标文件目录，“Scan recursively”需要打勾，表示包含源代码子目录的内容。

Fig.3.2 简要“Mode”页

如图3.2，设置“Mode”页，如果“Include cross-referenced source code in the output”打勾，则帮助文档包含源文件代码。

 

Fig.3.3 简要“OutPut”页

如图3.3，设置”Output”简单模式。

Fig.3.4 简要“Diagrams”页

如图3.4，设置”Diagrams”页，设置帮助文档包含的各种图形类型。

3.3 执行

Fig.3.5 Run

如图3.5，点击“Run doxygen”，就可以执行，生成帮助文档了。

目前默认的帮助文档名为：Help.chm，根据需要对生成的帮助文档重命名。