Doxyfile

# 项目名称, 将显示为标题
PROJECT_NAME            =  CARLA
# 文档生成目录
OUTPUT_DIRECTORY        =  Doxygen
# 输出语言
OUTPUT_LANGUAGE         =  Chinese
# 生成文档时，为每个类创建单独的子目录
CREATE_SUBDIRS          =  YES
# 不显示完整路径名
FULL_PATH_NAMES         =  NO
# 自动将JavaDoc样式的注释的第一行作为函数的简短描述
JAVADOC_AUTOBRIEF       =  YES
# 设置文档查找缓存大小为3
LOOKUP_CACHE_SIZE       =  3
# 强制提取所有类和文件
EXTRACT_ALL             =  YES
# 生成文档时可包含私有成员
EXTRACT_PRIVATE         =  YES
# 生成文档时可包含静态成员
EXTRACT_STATIC          =  YES
# 大小写敏感的类名和文件名
CASE_SENSE_NAMES        =  YES
# 可按字母顺序对简短描述进行排序
SORT_BRIEF_DOCS         =  YES
# 如果有未记录的类或文件，不产生警告
WARN_IF_UNDOCUMENTED    =  NO
 # 警告信息输出到指定的日志文件中
WARN_LOGFILE            =  Doxygen/warnings.log
# 扫描哪些文件
INPUT                   =  Unreal/CarlaUE4/Source Unreal/CarlaUE4/Plugins/Carla/Source LibCarla/source
# 指定要扫描的文件类型
FILE_PATTERNS           =  *.cpp *.h *.hpp *.cc
# 指定不需要扫描的文件或路径
EXCLUDE                 =  LibCarla/source/carla/Version.h
# 递归扫描
RECURSIVE               =  YES
# 生成文档时包含源代码浏览视图
SOURCE_BROWSER          =  YES
# 保留源代码中的注释内容
STRIP_CODE_COMMENTS     =  NO
# 在文档中显示函数的被引用关系
REFERENCED_BY_RELATION  =  YES
# 在文档中显示函数的引用关系
REFERENCES_RELATION     =  YES
# 不生成按字母排序的索引
ALPHABETICAL_INDEX      =  NO
# 生成HTML文档时，支持动态显示和隐藏部分内容
HTML_DYNAMIC_SECTIONS   =  YES
# 不生成索引页
DISABLE_INDEX           =  YES
# 不生成类和文件的树状视图
GENERATE_TREEVIEW       =  NO
# 设置数学公式的字体大小为12
FORMULA_FONTSIZE        =  12
# 不生成LaTeX格式的文档
GENERATE_LATEX          =  NO
# 允许预处理宏在生成文档时展开
MACRO_EXPANSION         =  YES
# 仅展开在配置中预定义的宏
EXPAND_ONLY_PREDEF      =  YES
INCLUDE_PATH            =  Unreal/CarlaUE4/Source Unreal/CarlaUE4/Plugins/Carla/Source Unreal/CarlaUE4/Plugins/CarlaExporter/Source/CarlaExporter Unreal/CarlaUE4/Plugins/CarlaTools/Source/CarlaTools/Private Unreal/CarlaUE4/Plugins/CarlaTools/Source/CarlaTools/Public LibCarla/source
# 仅包含指定类型的文件
INCLUDE_FILE_PATTERNS   =  *.h *.hpp
# 不隐藏未记录的类和文件之间的关系
HIDE_UNDOC_RELATIONS    =  NO
# 启用dot工具生成依赖图、调用图等
HAVE_DOT                =  YES
# 生成类模板之间的关系图
TEMPLATE_RELATIONS      =  YES
# 生成函数的调用图
CALL_GRAPH              =  YES
# 生成函数的调用者图
CALLER_GRAPH            =  YES
# dot工具生成的图像格式为SVG
DOT_IMAGE_FORMAT        =  svg
# 生成支持交互的SVG图像
INTERACTIVE_SVG         =  YES
# 允许dot工具生成多个图像目标
DOT_MULTI_TARGETS       =  YES