图例

本页向您展示如何理解由Doxygen生成的图形。

请考虑如下示例：

/*! 由于截取而使该类不可见 */
class Invisible { };

/*! 被截取的类，继承关系被隐藏起来了 */
class Truncated : public Invisible { };

/* 没有被doxygen的注释文档化的类 */
class Undocumented { };

/*! 被公有继承的类 */
class PublicBase : public Truncated { };

/*! 被保护继承的类 */
class ProtectedBase { };

/*! 被私有继承的类 */
class PrivateBase { };

/*! 被使用的类 */
class Used { };

/*! 继承了若干其它类的类 */
class Inherited : public PublicBase,
                  protected ProtectedBase,
                  private PrivateBase,
                  public Undocumented
{
  private:
    Used *m_usedClass;
};

如果在配置文件中指定了MAX_DOT_GRAPH_HEIGHT的值为200，则Doxygen将生成如下的图形：

以上图形中的矩形有如下的含义：

• 被黑色填充的矩形代表当前的类或结构。
• 黑色边框的矩形代表文档化的类或结构。
• 灰色边框的矩形代表没有文档化的类或结构。
• 红色边框的矩形代表继承/包含关系没有被完整显示出的类或结构。如果一幅图像的尺寸大于指定尺寸，它将被截取。

各个箭头有如下的含义：

• 深蓝色的箭头用于显示两个类之间的公有继承关系。
• 深绿色的箭头用于显示保护继承关系。
• 深红色的箭头用于显示私有继承关系。
• 紫色点状线条的箭头用于显示两个类之间包含或者使用的关系。通过箭头旁边的变量可以访问到箭头所指的类或结构。

---