YSTest: 图例

YSTest PreAlpha_b700_20160611 The YSLib Test Project

- 首页
- 相关页面
- 模块
- 命名空间
- 类
- 文件

图例

本页将向您解释如何理解由 doxygen 生成的图.

考虑如下例子:

1 /*! 由于截断而使 Invisible 不可见 */
2 class Invisible { };
3
4 /*! Truncated 的继承关系将被隐藏 */
5 class Truncated : public Invisible { };
6
7 /* 没有被doxygen文档化的类 */
8 class Undocumented { };
9
10 /*! public 继承关系的类 */
11 class PublicBase : public Truncated { };
12
13 /*! 一个模板类 */
14 template<class T> class Templ { };
15
16 /*! protected 继承关系的类 */
17 class ProtectedBase { };
18
19 /*! private 继承关系的类 */
20 class PrivateBase { };
21
22 /*! 被 Inherited 使用的类 */
23 class Used { };
24
25 /*! 继承自其它若干类的超级类 */
26 class Inherited : public PublicBase,
27 protected ProtectedBase,
28 private PrivateBase,
29 public Undocumented,
30 public Templ<int>
31 {
32 private:
33 Used *m_usedClass;
34 };

结果将会生成以下图:

上图中的矩形有如下意义:

- 灰色填充的矩形 表示上图是由该结构体或类生成.
- 黑色边框的矩形 表示已经被文档化的结构体或类.
- 灰色边框的矩形 表示未被文档化的结构体或类.
- 红色边框的矩形 表示该结构体或类的关系没有被完全显示.如果生成的图不能调整到制定的尺寸，有一些关系就会被截断而不显示出来.

箭头有如下意义:

- 深蓝色的箭头被用于展示 public 的继承关系.
- 深绿色的箭头表示 protected 的继承关系.
- 深红色的箭头说明了是 privated 的继承关系.
- 紫色虚线箭头用来表示两个类之间的聚合关系. 被箭头指向的类的类型的变量,可以通过箭头旁标明的变量去访问.
- 黄色虚线箭头表示模板类实例和模板类之间的关系. 箭头旁边标明了模板类实例化的参数.