doxygen 配置说明

来源:互联网 发布:手机不能用数据上网 编辑:程序博客网 时间:2024/06/05 20:56
# Doxygen文件的编码方式,默认为UTF-8,若希望支持中文,最好设置为 GB2312DOXYFILE_ENCODING      = UTF-8# Project 的名字,以一个单词为主,多个单词请使用双引号括住PROJECT_NAME           = "Test"#  文档版本号,可对应于项目版本号,譬如 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 语言没有所谓的域 / 名字空间这样的概念,所以此处设置为 YESHIDE_SCOPE_NAMES       = YES# 让 doxygen 静悄悄地为你生成文档,只有出现警告或错误时,才在终端输出提示信息QUIET                  = YES# 如果您的INPUT Tag 中指定了目录。您可以透过这个Tag来要求Doxygen在处理时,只针对特定的档案进行动作。例如:您希望对目录下的扩展名为.c, .cpp及.h的档案作处理。您可设定FILE_PATTERNS = *.c, *.cpp, *.h。    FILE_PATTERNS          = *.h *.c# 递归遍历当前目录的子目录,寻找被文档化的程序源文件RECURSIVE              = YES# 示例程序目录EXAMPLE_PATH           =# 类似于FILE_PATTERNS的用法,只是这个Tag是供EXCLUDE所使用。EXAMPLE_PATTERNS       =# 是否递归遍历示例程序目录的子目录,寻找被文档化的程序源文件EXAMPLE_RECURSIVE      = NO# 在最后生成的文档中,把所有的源代码包含在其中SOURCE_BROWSER         = YES# 允许程序文档中显示本文档化的函数相互调用关系 REFERENCED_BY_RELATION = YESREFERENCES_RELATION    = YESREFERENCES_LINK_SOURCE = YES# 是否生成 latex 格式的程序文档GENERATE_LATEX         = NO# 在程序文档中允许以图例形式显示函数调用关系,前提是你已经安装了 graphviz 软件包HAVE_DOT               = YESCALL_GRAPH             = YESCALLER_GRAPH           = YES# 这会在 HTML 文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系GENERATE TREEVIEW = ALL

0 0