doxygen配置文件说明

#Doxygen文件的编码方式,默认为UTF-8,若希望支持中文,最好设置为 GB2312 DOXYFILE_ENCODING = GB2312 #Project的版本号 PROJECT_VERSION = 1.0 # 项目名称,将作为于所生成的程序文档首页标题, Project 的名字,以一个单词为主,多个单词请使用双引号括住 PROJECT_NAME = “M2 List” # 文档版本号,可对应于项目版本号,譬如 svn、cvs 所生成的项目版本号 PROJECT_NUMBER = "1.0.0" # 程序文档输出目录,产生的文件会放在这个路径之下。如果没有填这个路径,将会以目前所在路径作为输出路径 OUTPUT_DIRECTORY = doc/ # 程序文档语言环境,默认为English OUTPUT_LANGUAGE = Chinese # 如果是制作 C 程序文档,该选项必须设为 YES,否则默认生成 C++ 文档格式 OPTIMIZE_OUTPUT_FOR_C = YES # 对于使用 typedef 定义的结构体、枚举、联合等数据类型,只按照 typedef 定义的类型名进行文档化 TYPEDEF_HIDES_STRUCT = YES # 在 C++ 程序文档中,该值可以设置为 NO,而在 C 程序文档中,由于 C 语言没有所谓的域/名字空间这样的概念,所以此处设置为 YES HIDE_SCOPE_NAMES = YES # 让 doxygen 静悄悄地为你生成文档,只有出现警告或错误时,才在终端输出提示信息 QUIET = YES #指定加载或找寻要处理的程序代码文件路径。这边是一个表列式的型态。并且可指定档案及路径 INPUT = src # 如果INPUT Tag 中指定了目录,可以透过这个Tag来要求Doxygen在处理时,只针对特定的档案进行动作。例如:希望对目录下的扩展名为.c, .cpp及.h的档 #案作处理。可设定FILE_PATTERNS = *.c, *.cpp, *.h FILE_PATTERNS = *.c\ *.h #是否允许源程序在程序文档中产生 SOURCE_BROWSER = YES # 递归遍历当前目录的子目录,寻找被文档化的程序源文件 RECURSIVE = YES # 示例程序目录 EXAMPLE_PATH = example/ # 示例程序的头文档 (.h 文件) 与实现文档 (.c 文件) 都作为程序文档化对象 EXAMPLE_PATTERNS = *.c\ *.h # 递归遍历示例程序目录的子目录,寻找被文档化的程序源文件 EXAMPLE_RECURSIVE = YES # 允许程序文档中显示本文档化的函数相互调用关系 REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES REFERENCES_LINK_SOURCE = YES # 不生成 latex 格式的程序文档 GENERATE_LATEX = NO # 在程序文档中允许以图例形式显示函数调用关系,前提是你已经安装了 graphviz 软件包 HAVE_DOT = YES CALL_GRAPH = YES CALLER_GRAPH = YES

doxygen配置文件说明相关文档

最新文档

返回顶部