一:基本配置
必要的配置
(1)Wizard-->Project-->DOXYFILE_ENCODING Doxygen 文件的编码方式默认为UTF-,若希望支持中文,最好设置为GB2312。
(2)Wizard-->Project-->PROJECT_NAME 项目名项目 的名字,以一个单词为主,多个单词请使用双引号括住。
*(3)Wizard-->Project-->Scan recursively :yes 递归扫描
(4)Wozard-->Project-->Source code directory 源代码目录
(5)Wizard-->Project-->Destination directory 输出Html页面的目录
(6)Wizard-->Mode --> All Entities
(7)Wizard-->Mode --> Include cross-referenced
(8)Wizard-->Diagrams --> Use dot tool from the GraphViz package 全选(使用GraphViz画图,需要安装GraphViz)
(9)Expert-->Project-->OUTPUT_LANGUAGE-->Chinese 输出语言
(10)Expert-->Dot-->CLASS_DIAGRAMS yes
(11)Expert-->Dot-->UML_LOOK yes 显示UML图
(12)Expert-->Dot-->CALL_GRAPH yes
(13)Expert-->Dot-->CALLER_GRAPH yes
(14)Expert-->Dot-->DOT_ATH D:\Program Files (x86)\Graphviz2.38\bin
(一)
1,
二,分类配置介绍
(一)
1,源码路径、工作路径、输出路径等
所有的配置可以在Expert中的Project中设置。
2,
(二)
1,
(1)DOXYFILE_ENCODING Doxygen 文件的编码方式
默认为UTF-8,若希望支持中文,最好设置为GB2312。
(2)PROJECT_NAME 项目名
项目 的名字,以一个单词为主,多个单词请使用双引号括住。
(3)PROJECT_VERSION 项目的版本号
(4)PROJECT_BRIEF 项目描述
使用PROJECT_BRIEF
标签可以为出现在每个页面顶部的项目提供可选的一行描述,并且应该让观众快速了解项目的目的。保持简短。
(4)OUT_DIRECTORY
输出路径。产生的文件会放在这个路径之下。如果没有填这个路径,将会以目前所在路径作为输出路径。
(1)OUTPUT_LANGUAGE
输出语言是中文,选择Chinese
2,
3,
4,
5,
6,
Expert-->Input-->recursive: yes 允许递归
Expert-->Dot-->UML_LOOK: yes :显示UML图
Expert-->CLASS_DIAGRAMS:yes
<HAVE_DOT>
:如果这个标记设置为 Yes,doxygen 就使用 dot 工具生成更强大的图形,比如帮助理解类成员及其数据结构的协作图。注意,如果这个标记设置为 Yes,<CLASS_DIAGRAMS>
标记就无效了。<CLASS_GRAPH>
:如果<HAVE_DOT>
标记和这个标记同时设置为 Yes,就使用dot
生成继承层次结构图,而且其外观比只使用<CLASS_DIAGRAMS>
时更丰富。<COLLABORATION_GRAPH>
:如果<HAVE_DOT>
标记和这个标记同时设置为 Yes,doxygen 会生成协作图(还有继承图),显示各个类成员(即包含)及其继承层次结构。
DOT_PATH中填入graphviz的安装路径
D:\Program Files (x86)\Graphviz2.38\bin
DOXYFILE_ENCODING | Doxygen 文件的编码方式,默认为UTF-8,若希望支持中文,最好设置为GB2312 |
项目名 | 项目 的名字,以一个单词为主,多个单词请使用双引号括住。 |
PROJECT_VERSION | 项目的版本号码酒店。 |
输出目录 | 输出路径。产生的文件会放在这个路径之下。如果没有填这个路径,将会以目前所在路径作为输出路径。 |
OUTPUT_LANGUAGE | 输出语言, 默认为英语。 |
提取所有 | 为NO,只解释有doxygen格式注释的代码;为YES,解析所有代码,即使没有注释 |
EXTRACT_PRIVATE | 是否解析类的私有成员 |
EXTRACT_STATIC | 是否解析静态项 |
EXTRACT_LOCAL_CLASSES | 是否解析源文件(CPP文件)中定义的类 |
INPUT | 指定加载或找寻要处理的程序代码文件路径。这边是一个表列式的型态。并且可指定档案及路径。 |
FILE_PATTERNS | 如果您的输入标签 中指定了目录您可以透过这个标签来要求的Doxygen的在处理时,只针对特定的档案进行动作例如:您希望对目录下的扩展名为.C,的的.cpp及。 H的档案作处理。您可以设定FILE_PATTERNS = * .c,* .cpp,* .h。 |
递归 | 这是一个布尔值的标签,只接受YES或NO。当设定为YES时,INPUT所指目录的所有子目录都会被处理。 |
排除 | 如果您有某几个特定档案或是目录,不希望经过Doxygen的处理。您可在这个标签中指定。 |
EXCLUDE_PATTERNS | 类似于FILE_PATTERNS的用法,只是这个标签是供排除所使用。 |
SOURCE_BROWSER | 如果设定为是,则Doxygen会产生出源文件的列表,以供查阅。 |
INLINE_SOURCES | 如果设定为YES ,则函数和类的实现代码被包含在文档中 |
ALPHABETICAL_INDEX | 如果设定为YES,则一个依照字母排序的列表会加入在产生的文件中。(有很多类,结构等项时建议设为YES) |
GENERATE_HTML | 若设定为YES ,就会产生HTML版本的说明文件。HTML文件是Doxygen预设产生的格式之一。 |
HTML_OUTPUT | HTML文件的输出目录。这是一个相对路径,所以实际的路径为OUTPUT_DIRECTORY加上HTML_OUTPUT。这个设定预设为html。 |
GENERATE_HTMLHELP | 是否生成压缩HTML格式文档(.chm) |
HTML_FILE_EXTENSION | HTML文件的扩展名。预设为.html。 |
HTML_HEADER | 要使用在每一页HTML文件中的Header。如果没有指定,Doxygen会使用自己预设的Header。 |
HTML_FOOTER | 要使用在每一页HTML文件中的Footer。如果没有指定,Doxygen会使用自己预设的Footer。 |
HTML_STYLESHEET | 您可给定一个CSS 的设定,让HTML的输出结果更完美。 |
GENERATE_HTMLHELP | 如设定为YES,Doxygen会产生一个索引文件。这个索引文件在您需要制作windows 上的HTML格式的HELP档案时会用的上。 |
GENERATE_TREEVIEW | 若设定为YES,Doxygen会帮您产生一个树状结构,在画面左侧。这个树状结构是以JavaScript所写成。所以需要新版的Browser才能正确显示。 |
TREEVIEW_WIDTH | 用来设定树状结构在画面上的宽度。 |
GENERATE_LATEX | 设定为YES 时,会产生LaTeX 的文件。不过您的系统必需要有安装LaTeX 的相关工具。 |
LATEX_OUTPUT | LaTeX文件的输出目录,与HTML_OUTPUT用法相同,一样是指在OUTPUT_DIRECTORY之下的路径。预设为latex。 |
LATEX_CMD_NAME | LaTeX程序的命令名称及档案所在。预设为latex。 |
GENERATE_RTF | 若设定为YES ,则会产生RTF 格式的说明档。 |
RTF_OUTPUT | 与HTML_OUTPUT 用法相同,用来指定RTF 输出档案路径。预设为rtf。 |
GENERATE_MAN | 若设定为YES ,则会产生Unix Man Page 格式的说明文件。 |
MAN_OUTPUT | 与HTML_OUTPUT 用法相同,用来指定Man Page的输出目录。预设为man。 |
GENERATE_XML | 若设定为YES ,则会产生XML 格式的说明文件。 |
ENABLE_PREPROCESSING | 若设定为YES ,则Doxygen 会激活C 的前置处理器来处理原始档。 |
PREDEFINED | 可以让您自行定义一些宏。类似于gcc 中的-D选项。 |
CLASS_DIAGRAMS | 这个标记用来生成类继承层次结构图。要想生成更好的视图,可以从Graphviz 下载站点下载dot工具.Doxyfile中的以下标记用来生成图表: |
HAVE_DOT | 如果这个标记设置为 是,doxygen 就使用了 dot 工具生成更强大的图形,比如帮助理解类成员及其数据结构的协作图。注意,如果这个标记设置为 Yes ,<CLASS_DIAGRAMS> 标记就无效了 |
CLASS_GRAPH | 如果 <HAVE_DOT> 标记和这个标记同时设置为 Yes ,就使用 dot 生成继承层次结构图 |
GRAPHICAL_HIERARCHY | 设置为YES 时,将会绘制一个图形表示的类图结构 |
引用这是doxygen官方的配置项说明
:http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_generate_treeview