| RMVL 2.3.0 Robotic Manipulation and Vision Library

载入中...
搜索中...
未找到
图例

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

考虑如下例子:

/*! 由于截断而使 Invisible 不可见 */
class Invisible { };
/*! Truncated 的继承关系将被隐藏 */
class Truncated : public Invisible { };
/* 没有被 doxygen 文档化的类 */
class Undocumented { };
/*! public 继承关系的基类 */
class PublicBase : public Truncated { };
/*! 一个模板类 */
template<class T> class Templ { };
/*! protected 继承关系的基类 */
class ProtectedBase { };
/*! private 继承关系的基类 */
class PrivateBase { };
/*! 被 Inherited 使用的类 */
class Used { };
/*! 继承自其它若干类的超级类 */
class Inherited : public PublicBase,
protected ProtectedBase,
private PrivateBase,
public Undocumented,
public Templ<int>
{
private:
Used *m_usedClass;
};

结果将会生成以下图:

上图中的矩形含义为:

- 灰色填充的矩形 表示生成上图的结构体或类.
- 黑色边框的矩形 表示已经被文档化的结构体或类.
- 灰色边框的矩形 表示未被文档化的结构体或类.
- 红色边框的矩形 表示该结构体或类的关系没有被完全显示.如果生成的图超出了指定的尺寸范围，有一些关系就会被截断而无法显示.

箭头的含义为:

- 蓝色的箭头 表示 public 继承关系.
- 深绿色的箭头 表示 protected 继承关系.
- 深红色的箭头 表示 private 继承关系.
- 紫色虚线箭头 表示两个类之间的聚合关系. 可以通过箭头旁标明的变量访问箭头指向的类或结构体实例.
- 黄色虚线箭头 表示模板类实例和模板类之间的关系. 箭头旁边标明了模板类实例化时所用的模板参数.