doxygen 配置说明
2016-03-17 15:14
295 查看
# Doxygen文件的编码方式,默认为UTF-8,若希望支持中文,最好设置为 GB2312 DOXYFILE_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 语言没有所谓的域 / 名字空间这样的概念,所以此处设置为 YES HIDE_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 = YES REFERENCES_RELATION = YES REFERENCES_LINK_SOURCE = YES # 是否生成 latex 格式的程序文档 GENERATE_LATEX = NO # 在程序文档中允许以图例形式显示函数调用关系,前提是你已经安装了 graphviz 软件包 HAVE_DOT = YES CALL_GRAPH = YES CALLER_GRAPH = YES # 这会在 HTML 文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系 GENERATE TREEVIEW = ALL
相关文章推荐
- ElasticSearch实战-日志监控平台架构方案
- android 二维码 helloworld (二维码的生成与扫描)
- gdb 多线程调试
- iOS边练边学--自定义非等高的cell
- Operating Systems: Three Easy Pieces(操作系统:三个简单方面)4.3进程创建的更多细节
- 古堡算式
- “人脸识别”在未来的一些可能方向
- C++面向对象编程分享03----20160317_李楚煌
- 关于如何解决tomcat8080端口被占用的问题
- 数据库操作语句类型(DQL、DML、DDL、DCL)简介
- php 单例设计模式 example
- copy和strong
- 在自己的对象里实现IEnumerator和IEnumerable
- Spark的搭建
- elasticsearch.yml基本配置说明
- ubuntu技巧--ubuntu pycharm
- cooklie的另一种设置方式
- android之handler messagequene looper threadlocal 之间的详细解读
- R简单实用总结
- 哈希冲突之散列法