图例

本页面解释如何解读 doxygen 生成的图表。

请看下面的示例

/*! 因截断而不可见的类 */
class Invisible { };
 
/*! 截断的类，继承关系已隐藏 */
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 继承关系。
• 紫色虚线箭头表示一个类被另一个类包含或使用。箭头旁的标签表示访问被指向的类或结构体所通过的变量。
• 黄色虚线箭头表示模板实例与其实例化自的模板类之间的关系。箭头旁的标签表示实例的模板参数。