Doxygen常用配置

CALLER_GRAPH
若CALLER_GRAPH，HAVE_DOT都为YES，doxygen将被每一个全局函数或类方法生成一个被调用的依赖图。
HIDE_UNDOC_RELATIONS
若为YES，如果目标未被文档化或者不是一个类，那么继承和协作图中将隐藏继承和调用的关系。
COLLABORATION_GRAPH
HIDE_SCOPE_NAMES
域隐藏，建议永远不要开启。
SHOW_INCLUDE_FILES
是否显示包含文件，如果开启，帮助中会专门生成一个页面，里面包含所有包含文件的列表。
INLINE_INFO
如果开启，那么在帮助文档中，inline函数前面会有一个inline修饰词来标明。
SORT_MEMBER_DOCS
用于指定文档中包含一个或多个保存有dot文件的目录。
LATEX_OUTPUT
LaTeX文件的输出目录，与HTML_OUTPUT用法相同，一样是指在OUTPUT_DIRECTORY之下的路径。预设为latex。
LATEX_CMD_NAME
LaTeX程序的命令名称及档案所在。预设为latex。
RTF：
RTF_OUTPUT
与HTML_OUTPUT用法相同，用来指定RTF输出档案路径。预设为rtf。
GRAPHICAL_HIERARCHY
设置为YES时，将会绘制一个图形表示的类图结构。
UML_LOOK
若为YES，doxygen将生成继承和协作的图表，在样式类似于OMG的统一建模语言。
CALL_GRAPH
若CALL_GRAPH，HAVE_DOT都为YES，doxygen将被每一个全局函数或类方法生成一个调用依赖图。
GENERATE_CHI
表示索引文件是否单独输出，建议关闭。否则每次生成两个文件，比较麻烦。
TOC_EXPAND
表示是否在索引中列举成员名称以及分组（譬如函数，枚举）名称。像MSDN那样在左边的树中显示函数列表。若为YES，可在HTML帮助文档的目录和树型查看器中增加额外组成员的条目。
GENERATE_TREEVIEW
SEPARATE_MEMBER_PAGES
若设为YES，doxygen将为每一个成员建立一个新页，若设为NO，成员文档将成为文件/类/名字空间文档中的一部分。像MSDN那样右边每页显示一个函数，把这个选项选中，这样每个函数就是一个页。
TAB_SIZE
主要是帮助文件中代码的缩进尺寸，譬如@code和@endcode段中代码的排版。
HAVE_DOT
如果这个标记设置为Yes，doxygen就使用dot工具生成更强大的图形，比如帮助理解类成员及其数据结构的协作图。注意，如果这个标记设置为Yes，<CLASS_DIAGRAMS>标记就无效了。
CLASS_GRAPH
如果<HAVE_DOT>标记和这个标记同时设置为Yes，就使用dot生成继承层次结构图。
如果开启，那么在帮助文档列表显示的时候，函数名称会排序，否则按照解释的顺序显示。
GENERATE_TODOLIST
是否生成TODOLIST页面，如果开启，那么包含在@todo注解中的内容将会单独生成并显示在一个页面中，其他的GENERATE选项同。
SHOW_USED_FILES
是否在函数或类等的帮助中，最下面显示函数或类成员。
EXTRACT_STATIC
是否解析静态项。
EXTRACT_LOCAL_CLASSES
是否解析源文件（cpp文件）中定义的类。
HIDE_UNDOC_MEMBERS
表示那些没有使用doxygen格式描述的文档（函数或类等）就不显示了。当然，如果EXTRACT_ALL被启用，那么这个标志其实是被忽略的。
SHOW_FILES
是否显示文件列表页面，如果开启，那么帮助中会存在一个一个文件列表索引页面。
Messages：
QUIET
如果开启，那么表示关闭编译时的输出信息。
WARN_FORMAT
表示日志输出的格式，没必要修改。
WARN_LOGFILE
表示信息是否输出到LOG文件，因为有DoxyWizard的存在，所以这个选项没有必要使用。
EXCLUDE
如果您有某几个特定档案或是目录，不希望经过Doxygen处理。您可在这个Tag中指定。
EXCLUDE_PATTERNS
类似于FILE_PATTERNS的用法，只是这个Tag是供EXCLUDE所使用。
Source Brower：
SOURCE_BROWSER
如果设定为YES，则Doxygen会产生出源文件的列表，以供查阅。
若设定为YES，Doxygen会帮您产生一个树状结构，在画面左侧。这个树状结构是以JavaScript所写成。所以需要新版的Browser才能正确显示。
TREEVIEW_WIDTH
用来设定树状结构在画面上的宽度。
LaTex：
GENERATE_LATEX
设定为YES时，会产生LaTeX的文件。不过您的系统必需要有安装LaTeX的相关工具。
Doxygen常用配置
Project：
DOXYFILE_ENCODING
Doxygen文件的编码方式，默认为UTF-8，若希望支持中文，最好设置为GB2312。
PROJECT_NAME
Project的名字，以一个单词为主，多个单词请使用双引号括住。
PROJECT_NUMBER
Project的版本号码。
Input：
INPUT
指定加载或找寻要处理的程序代码文件路径。这边是一个表列式的型态。并且可指定档案及路径。举例来说若您有a.c, b.c, c.c三个档案。您可使用INPUT = a.c, b.c, c.c的方式。若您给定一个目录，该目录下面所有档案都会被处理。
FILE_PATTERNS
如果您的INPUT Tag中指定了目录。您可以透过这个Tag来要求Doxygen在处理时，只针对特定的档案进行动作。例如：您希望对目录下的扩展名为.c, .cpp及.h的档案作处理。您可设定FILE_PATTERNS = *.c, *.cpp, *.h。
您可给定一个CSS的设定，让HTML的输出结果更完美。
GENERATE_HTMLHELP
如设定为YES，Doxygen会产生一个索引文件。这个索引文件在您需要制作windows上的HTML格式的HELP档案时会用的上。是否生成压缩HTML格式文档（.chm）。
CHM_FILE
表示输出的chm文件路径。
INLINE_SOURCES
如果设定为YES，则函数和类的实现代码被包含在文档中。
STRIP_CODE_COMMENTS
忽略普通的文档注释。
REFERENCED_BY_RELATION
Index：
ALPHABETICAL_INDEX
如果设定为YES，则一个依照字母排序的列表会加入在产生的文件中。（有很多类、结构等项时建议设为YES）。
HTML：
GENERATE_HTML
若设定为YES，就会产生HTML版本的说明文件。HTML文件是Doxygen预设产生的格式之一。
HTML_OUTPUT
HTML文件的输出目录。这是一个相对路径，所以实际的路径为OUTPUT_DIRECTORY加上HTML_OUTPUT。这个设定预设为html。
HTML_FILE_EXTENSION
若COLLABORATION_GRAPH，HAVE_DOT都为YES，doxygen将为每个文档化的类生成一个协作图，显示直接和间接的类与其他文档化类的执行依赖关系（继承，包容，类引用变量）。
DOT_PATH
指定dot工具放置的位置，若选项后留空，则假定dot工具处于能被查找到的路径之下。
DOTFILE_DIRS
INTERNAL_DOCS
主要指是否输出注解中的@internal部分。如果没有被启动，那么注解中所有的@internal部分都将在目标帮助中不可见。
CASE_SENSE_NAMES
是否关注大小写名称，注意，如果开启了，那么所有的名称都将被小写。对于C/C++这种字母相关的语言来说，建议永远不要开启。
Man：
GENERATE_MAN
若设定为YES，则会产生Unix Man Page格式的说明文件。
MAN_OUTPUT
与HTML_OUTPUT用法相同，用来指定Man Page的输出目录。预设为man。
XML：
GENERATE_XML
若设定为YES，则会产生XML格式的说明文件。
Preprocessor：
HTML文件的扩展名。预设为.html。
HTML_HEADER
要使用在每一页HTML文件中的Header。如果没有指定，Doxygen会使用自己预设的Header。
HTML_FOOTER
要使用在每一页HTML文件中的Footer。如果没有指定，Doxygen会使用自己预设的Footer。
HTML_STYLESHEET
INPUT_ENCODING
用于指定doxygen解析源文件所使用字符编码，doxygen内部使用UTF-8编码，同样也是默认的输入编码，若希望支持中文，最好设置为GB2312。
RECURSIVE
这是一个布尔值的Tag，只接受YES或NO。当设定为YES时，INPUT所指定目录的所有子目录都会被处理。需要递归处理子目录。
OUTPUT_DIRECTORY
输出路径。产生的文件会放在这个路径之下。如果没有填这个路径，将会以目前所在路径作为输出路径。
OUTPUT_LANGUAGE
输出语言,默认为English。
JAVADOC_AUTOBRIEF
若设为YES，doxygen将会使用一个JavaDoc风格的注释，作为简明描述来表述第一行（直到第一行结束）。