doxygen使用简介（2）

二．参数详细设置
2.1 Project页



Fig.2.1 Project页
该页主要包括项目的基本配置。
DOXYFILE_ENCODING是Doxyfile的文本编码，如果文件中有中文字符，需要改为GBK。
填写项目名（PROJECT_NAME）、项目版本（PROJECT_NUMBER）、输出目录（OUTPUT_DIRECTORY）和输出语言（OUTPUT_LANGUAGE）。输出目录可以按Doxyfile的相对目录填写。输出语言相当于程序资源，选择Chinese，则chm帮助文档采用中文说明。
取消FULL_PATH_NAMES。
TAB_SIZE 主要是帮助文件中代码的缩进尺寸，譬如@code和@endcode段中代码的排版，建议符合习惯，设置成4。
OPTIMIZE_OUTPUT_FOR_C 这个选项选择后，生成文档的一些描述性名称会发生变化，主要是符合C习惯。如果是纯C代码，建议选择。
SUBGROUPING这个选项选择后，输出将会按类型分组。

2.2 Build页

Fig.2.2 Build页
这个页面是生成帮助信息中比较关键的配置页面 EXTRACT_ALL 表示输出所有的函数，但是private和static函数不属于其管制。
EXTRACT_PRIVATE 表示输出private函数。
EXTRACT_STATIC 表示输出static函数。同时还有几个EXTRACT，相应查看文档即可。
HIDE_UNDOC_MEMBERS 表示那些没有使用doxygen格式描述的文档（函数或类等）就不显示了。当然，如果EXTRACT_ALL被启用，那么这个标志其实是被忽略的。
NTERNAL_DOCS 主要指是否输出注解中的@internal部分。如果没有被启动，那么注解中所有的@internal部分都将在目标帮助中不可见。
CASE_SENSE_NAMES 是否关注大小写名称，注意，如果开启了，那么所有的名称都将被小写。对于C/C++这种字母相关的语言来说，建议永远不要开启。
HIDE_SCOPE_NAMES 域隐藏，建议永远不要开启。
SHOW_INCLUDE_FILES 是否显示包含文件，如果开启，帮助中会专门生成一个页面，里面包含所有包含文件的列表。
INLINE_INFO 如果开启，那么在帮助文档中，inline函数前面会有一个inline修饰词来标明。
SORT_MEMBER_DOCS 如果开启，那么在帮助文档列表显示的时候，函数名称会排序，否则按照解释的顺序显示。
GENERATE_TODOLIST 是否生成TODOLIST页面，如果开启，那么包含在@todo注解中的内容将会单独生成并显示在一个页面中，其他的GENERATE选项同。
SHOW_USED_FILES 是否在函数或类等的帮助中，最下面显示函数或类的来源文件。
SHOW_FILES 是否显示文件列表页面，如果开启，那么帮助中会存在一个一个文件列表索引页面

2.3 Messages页

Fig.2.3 Message页
主要用来设置编译时的输出信息选项。编译时的输出信息，主要可以用来提醒一些输入的错误语法。
QUIET 如果开启，那么表示关闭编译时的输出信息。
WARN_FORMAT 表示日志输出的格式，没必要修改。
WARN_LOGFILE 表示信息是否输出到LOG文件，因为有DoxyWizard的存在，所以这个选项没有必要使用。

2.4 Input页

Fig.2.4 Input页
指定输入源文件目录（INPUT），如果代码有中文注释，将输入文件编码（INPUT_ENCODING）从UTF-8改为GBK，否则中文代码注释显示为乱码。
FILE_PATTERNS参数是Doxygen要处理的文件类型，缺省值包括Doxygen支持的所有文件类型。不能用Doxygen文档化任意文件类型。例如Doxygen不支持汇编程序。
RECURSIVE打勾，包含输入源文件目录的子目录。

2.5 Source Browser页

Fig.2.5 Source Browse页
如果选择SOURCE_BROWSER，在文档中包含源文件代码。
如果选择INLINE_SOURCES，函数说明处将插入对应的函数代码（源文件执行代码）。
其余采用默认值就可以了。

2.6 HTML页

Fig.2.6 HTML页
CHM_FILE 表示输出的chm文件路径，可以采用相对路径。
GENERATE_CHI 表示索引文件是否单独输出，建议关闭。否则每次生成两个文件，比较麻烦。
TOC_EXPAND 表示是否在索引中列举成员名称以及分组（譬如函数，枚举）名称。
这个页面关系到生成chm的问题，不过很多选项很简单，一看便知。
为了生产.chm文件，系统必须安装微软或其相兼容的chm编译系统。通常为HTML Help Workshop，HHC_LOCATION指向微软的hhc工具。通常为C:/Program Files/HTML Help Workshop/hhc.exe。

2.7 LaTex页

Fig.2.7 LaTex页
取消GENERATE_LATEX，不产生LaTex输出。
GENERATE_LATEX NO
2.8 Dot页



Fig.2.8 dot页
在Dot页，设置帮助文档中显示哪些图，有很多选项很简单，一看便知。