Doxygen配置选项

Dot

Doxygen支持使用Graphviz（一个开源的图形可视化软件，参见http://www.graphviz.org/）的Dot工具进行绘图，下面是一些Dot中常用的配置项及设置效果

HAVE_DOT——启用Dot工具，设为”NO”时该章节所有其它配置项均无效，默认”NO”

COLLABORATION_GRAPH——为每个文档化类生成一个图形来展示该类和其它文档化类的直接和间接实现关系（继承，包含，以及类引用变量），默认”YES”，”NO”关闭

UML_LOOK——以类似UML（Unified Modeling Language）的样式生成继承和协作图表，默认”NO”，”YES”启用

INCLUDE_GRAPH——INCLUDE_GRAPH、ENABLE_PREPROCESSING和SEARCH_INCLUDES都设为”YES”时，Doxygen将为每个文档化文件生成一个展示文件间直接和间接包含依赖的图表，默认”YES”，”NO”关闭
INCLUDED_BY_GRAPH——INCLUDED_BY_GRAPH、ENABLE_PREPROCESSING和SEARCH_INCLUDES都设为”YES”时，Doxygen将为每个文档化文件生成一个展示文件间直接和间接被包含依赖的图表，默认”YES”，”NO”关闭

GRAPHICAL_HIERARCHY——图形化所有类的层次结构，默认”YES”，”NO”关闭

DOT_PATH——指定Dot工具路径，留空假定在Doxygen路径，默认留空

其它的配置项有（同Doxygen配置顺序）：

DIA_PATH
HIDE_UNDOC_RELATIONS
DOT_NUM_THREADS
DOT_FONTNAME
DOT_FONTSIZE
DOT_FONTPATH
CLASS_GRAPH
GROUP_GRAPHS
UML_LIMIT_NUM_FIELDS
DOT_UML_DETAILS
DOT_WRAP_THRESHOLD
TEMPLATE_RELATIONS
CALL_GRAPH
CALLER_GRAPH
DIRECTORY_GRAPH
DIR_GRAPH_MAX_DEPTH
DOT_IMAGE_FORMAT
INTERACTIVE_SVG
DOTFILE_DIRS
MSCFILE_DIRS
DIAFILE_DIRS
PLANTUML_JAR_PATH
PLANTUML_CFG_FILE
PLANTUML_INCLUDE_PATH
DOT_GRAPH_MAX_NODES
MAX_DOT_GRAPH_DEPTH
DOT_TRANSPARENT
DOT_MULTI_TARGETS
GENERATE_LEGEND
DOT_CLEANUP

Preprocessor

Preprocessor的配置项有（同Doxygen配置顺序）：

ENABLE_PREPROCESSING——计算源文件和头文件中的C预处理器指令，设为”NO”时该章节所有其它配置项均无效，默认”YES”，”NO”关闭
MACRO_EXPANSION——在源码中展开所有宏名称，默认”NO”，”YES”启用
EXPAND_ONLY_PREDEF——EXPAND_ONLY_PREDEF和MACRO_EXPANSION都设为”YES”时，仅对PREDEFINED和EXPAND_AS_DEFINED指定的宏进行扩展，默认”YES”
SEARCH_INCLUDES——设为”YES”时，查找#include将搜索INCLUDE_PATH包含的头文件，默认”YES”
INCLUDE_PATH——指定包含头文件的目录，这些文件不是输入文件但应该被预处理器处理，默认留空，该项需要SEARCH_INCLUDES设置为”YES”
INCLUDE_FILE_PATTERNS——指定一个或多个通配符模式（如*.h和*.hpp）来从目录中过滤头文件，留空时将使用FILE_PATTERNS的模式，默认留空
PREDEFINED——指定一个或多个在预处理器启动前定义的宏名称（类似于gcc的-D选项）。该配置项的参数是一个宏列表，格式为name或name=definition（无空格），如果省略定义和”=”，将默认使用”=1″。可以使用:=运算符代替=来避免宏定义被#undef取消定义或递归扩展，默认留空
EXPAND_AS_DEFINED——MACRO_EXPANSION和EXPAND_ONLY_PREDEF都设为”YES”时，该配置项指定需要展开的宏名称列表（使用在源文件中找到的宏定义），可以使用PREDEFINED指定不同的宏定义来改写源码的宏定义，默认留空
SKIP_FUNCTION_MACROS——设为”YES”时，Doxygen的预处理器将移除所有单行、具有全大写字母名称、并且不以分号结尾的类函数宏的引用，这些函数宏通常用于样板代码，不移除会使解析混乱，默认”YES”，”NO”关

External

External的配置项有（同Doxygen配置顺序）：

TAGFILES——指定一个或多个标签文件。对于每个标签文件，应添加外部文档的位置。不带有位置的标签文件格式为TAGFILES = file1 file2 ...，为标签文件添加位置的格式为TAGFILES = file1=loc1 "file2 = loc2" ...，其中loc1和loc2可以是相对或绝对路径或URL。需注意每个标签文件必须具有唯一的名称（不包含路径的名称），如果标签文件不在Doxygen运行目录中，则必须指定标签文件的路径，默认留空
GENERATE_TAGFILE——该标签指定了文件名称时，Doxygen将基于它读取的输入文件来创建标签文件，默认留空
ALLEXTERNALS——在类索引中列出所有外部类，设为”NO”时只列出继承的外部类，默认”NO”
EXTERNAL_GROUPS——在模块索引中列出所有外部组，设为”NO”时只列出当前工程的组，默认”YES”
EXTERNAL_PAGES——在相关页面索引中列出所有外部页面，设为”NO”时只列出当前工程的页面，默认”YES”