Doxygen 配置学习笔记

 

CALL_GRAPH调用图，设置调用图为Yes显示被调用的关系

CALLER_GRAPH被调用图，设置被调用图为Yes显示调用者的关系

关键问题

1如何使类协作图不调用内嵌类型的变量?

 

---

 

key关键在于设置Dot中的HIDE_UNDOC_RELATIONS：设置为YES则合作图中将出现各种对没有文档文件的变量进行的引用和调用设置为NO则可以隐藏这些引用和调用。因此一般设置为NO。但是这样设置后的一个缺点是看不出MFC中自带的一些继承关系，例如CAboutDlg继承自CDialog的关系。

2如何使用正确的字符集

 

---

 

 

key 在project中的 DOXYFILE_ENCODING 设置为UTF-8 同时OUTPUT_LANGUAGE语言设置为Chinese或者English

在Input中INPUT_ENCODING设置为GBK

3关于各文件的包含/依赖关系可通过设置INCLUDE_GRAPH及INCLUDE_BY_GRAPH来显示

 

---

 

 

4一般需要修改默认设置的配置选项

 

---

 

 

Project：PROJECT_NAME

OUTPUT_DIRECTORY

OUTPUT_LANGUAGE

INLINE_INHERITED_MEMB ： 设置为YES显示所有类的派生成员：例如A 继承自 B 则关于类A的文档将显示继承

       自B的成员变量及成员函数

Build：EXTRACT_ALL：若设为 YES, doxygen 会假定文档中的所有主体将被文档化，即使在未提供文档的情况下。私有

     类成员和文件静态成员将隐藏，直到 EXTRACT_PRIVATE 和EXTRACT_STATIC 标记设为YES。实现

     过程中发现，当EXTRACT_ALL设置为NO时在对类的描述文档中没有了以下几项：构造及析构函数文档

     ，成员函数文档，成员数据文档。同时成员函数文档中的调用图和被调用图也就没有显示了。这样

     CALL_GRAPH及CALLER_GRAPH即使设置为YES也不起作用了。同时在树型目录结构中的文件成员及

     组合类型成员都不显示(原因?)

MAX_INITIALIZER_LINES： 能接受的最大的初始化表达式的行数

Input： INPUT: 要输入的文件的目录

INPUT_ENCODING

RECURSIVE：是否要递归检索子目录

SB： SOURCE_BROWSER：设置为YES后，所有的源代码文件将被显示在输出文件中，且文件中的函数或者类的定义可以相互

引用。如果不显示任何源代码文件的内容。除了本项设置为NO外，VERBATIM_HEADERS也应该设置

为NO。

REFERENCED_BY_RELATION

REFERENCED_RELATION

HTML:HTML_OUTPUT

GENERATE_TREEVIEW

Dot：HAVE_DOT

UML_LOOK：该选项没有设置为YES时，关于类的文档中的协作图没有类的成员函数和成员变量，一般设置为YES

TEMPLATE_RELATIONS：设置为YES后，继承图和协作图会显示模版和其实例的关系

CALL_GRAPH

CALLER_GRAPH

DOT_PATH：Dot工具的路径

DOT_GRAPH_MAX_NODES