Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。

Doxygen基础篇（二）——配置Doxygen

前言：
  在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。

1 配置Wizard

1.1 配置Project

  打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。

• Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录；
• Project name: 该项目的名称；
• Project synopsis: 该项目的项目简介；
• Project version or id: 项目版本或id；
• Project logo: 选择项目的logo图标，文件为图片格式；
• Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下；
• Scan recursively: 是否递归子目录，勾选后递归Source code directory所有子目录；
• Destination directory: Doxygen生成目录，一般在工程根目录下创建一个目录（比如目录命名为 doxygen），将Doxygen生成在此目录中。

1.2 配置Mode

  模式配置可设置Doxygen如何查看您的资源，默认情况下只查找已记录的内容。可以根据语言选择更加优化的生成相应的文档。

• Documented entities only: 资源查看方式为只查看已记录的内容；
• All Entities: 资源查看方式为查找所有相关的内容，一般建议选此；
• Include cross-referenced source code in the ouput: 是否在输出文档中包含源代码，勾上就相当于开放源码了，要保密源码只提供接口信息则不要勾选此项；
• Select Programming language to optimize the results for: 选择要解析的语言，以便更好的生成文档；

1.3 配置Output

&emps; 配置Doxygen的输出类型。

• plain HTML: 生成纯HTML格式文档；
• prepare for compressed HTML (.chm): 生成chm格式文档；
• With search function: 带有搜索功能；
• Change color: 设置HTML文档的颜色风格；
• LaTex: 配置PDF格式文档。Doxygen本身不能直接输出pdf文件，而是先生成Latex目录，通过pdflatex来生成pdf文件；

  生成.chm格式文件需要依赖于hhc.exe，这个工具微软已经不再维护了，所以建议生成HTML格式的文档即可。

1.4 配置Diagrams

  Doxygen生成关系图配置，可以配置生成哪些关系图。

• No diagrams: 不生成关系图；
• Use built-in class diagram generator: 构建类关系图；
• Use dot tool from the GraphViz package: 通过dot构建类关系图；
• Class graphs: 通过dot生成类关系图；
• Collaboration diagram: 通过dot生成协作图；
• Overall Class hierarchy: 通过dot生成总体类层次架构图；
• Include dependency graphs: 通过dot生成包含依赖关系图；
• Included by dependency graphs: 通过dot生成被包含依赖关系图；
• Call graphs: 调用图；
• Called by graphs: 被调用图；

2 配置Expert

2.1 配置Project

   Expert 标签页内是更详细的配置项，而之前的 Wizard 向导配置只包含了最基础的设置。

• DOXYFILE_ENCODING: 文档编码格式；
• PROJECT_NAME: 项目名；
• PROJECT_NUMBER: 项目编号；
• PROJECT_BRIEF: 项目简介；
• PROJECT_LOGO: 项目logo:
• OUTPUT_DIRECTORY: Doxygen生成目录；
• OUTPUT_SUBDIRS: 输出语言；
• FULL_PATH_NAMES: 全路径名，名称会带上路径；

2.2 配置Build

   Build 项是对文档生成关键的配置。

• EXTRACT_ALL: 输出所有函数，对private和static函数无效；
• EXTRACT_PRIVATE: 输出private函数；
• EXTRACT_PRIV_VIRTUAL: 输出private virtual函数；
• EXTRACT_STATIC: 输出static函数；
• CASE_SENSE_NAMES: 不区分大小写，如果勾选则名称都将显示为小写；
• SHOW_INCLUDE_FILES: 显示文件包含列表；
• INLINE_INFO: 标明inline函数；
• SORT_MEMBER_DOCS: 开启排序，勾选后函数和变量会自动排序，否则按照解析顺序；
• GENERATE_TODOLIST: 生成TODOLIST，开启后@todo内容将单独生成一个页面显示；
• SHOW_FILES: 显示文件索引列表；

2.3 配置Input

  对输入相关的配置。

• INPUT_ENCODING: 输入源码的编码格式；

2.4 配置HTML

  关于生成HTML的配置。

• CHM_FILE: 指定生成CHM文件名。前提是开启了生成CHM文件；
• HHC_LOCATION: 指定hhc.exe文件路径，生成CHM文件依赖于hhc.exe。前提是开启了生成CHM文件；

   GENERATE_HTMLHELP 与 SEARCHENGINE 配置互斥，要生成CHM文件时需使用 GENERATE_HTMLHELP 配置，要生成纯HTML格式时勾选 SEARCHENGINE 。

2.5 配置Dot

  Dot用于Doxygen生成图表。

• DOT_PATH: dot.exe路径。

3 Run生成文档

  在配置完Doxygen后可以将配置保存在配置文件中（File -> Save），下次直接打开配置文件即可。
  在Run标签页中点击 Run doxygen 开始生成文档，在下方的 Output produced by doxygen 中查看生成log，要注意看有没有 error 信息。生成的chm文件名可由自己指定，生成的HTML主页文件名默认为index.html。

4 安装Graphviz

  doxygen要生成图表需要借助dot.exe工具，该工具需要安装 Graphviz ，在官网找到Windows 64位版本安装。

  安装很简单，按默认直接点下一步就行。
  安装完成后Doxygen中需要设置 DOT_PATH 路径，该路径为Graphviz的bin目录，dot.exe在该目录下。以下是通过Dot生成的图表效果展示。