图例

此页面解释如何解读由Doxygen生成的图表。

请考虑以下示例

/*! 因截断而不可见的类 */
class Invisible { };
 
/*! 被截断的类，继承关系隐藏 */
class Truncated : public Invisible { };
 
/* 未使用Doxygen注释进行文档化的类 */
class Undocumented { };
 
/*! 使用公有继承继承的类 */
class PublicBase : public Truncated { };
 
/*! 模板类 */
template<class T> class Templ { };
 
/*! 使用保护继承继承的类 */
class ProtectedBase { };
 
/*! 使用私有继承继承的类 */
class PrivateBase { };
 
/*! 被Inherited类使用的类 */
class Used { };
 
/*! 继承多个其他类的超类 */
class Inherited : public PublicBase,
                  protected ProtectedBase,
                  private PrivateBase,
                  public Undocumented,
                  public Templ<int>
{
  private:
Used *m_usedClass;
};

这将生成以下图表

上图中的方框具有以下含义：

• 填充的灰色方框表示生成图表的结构体或类。
• 带有黑色边框的方框表示已记录的结构体或类。
• 带有灰色边框的方框表示未记录的结构体或类。
• 带有红色边框的方框表示已记录的结构体或类，但并非所有继承/包含关系都显示。如果图表不符合指定的边界，则图表会被截断。

箭头具有以下含义：

• 蓝色箭头用于可视化两个类之间的公有继承关系。
• 深绿色箭头用于保护继承。
• 深红色箭头用于私有继承。
• 紫色虚线箭头用于表示一个类被另一个类包含或使用。箭头标注了可以通过哪些变量访问指向的类或结构体。
• 黄色虚线箭头表示模板实例与其实例化的模板类之间的关系。箭头标注了实例的模板参数。