图例

此页面解释了如何解释 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;
};

这将生成以下图形

上图中的框具有以下含义

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

箭头具有以下含义

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