グラフの凡例

Doxygen が生成したグラフを読み方について。

次のコード例をご覧ください。

/*! 全体の大きさの関係で見えなくなるクラスです。 */
class Invisible { };

/*! 表示を切り捨てられたクラス(Invisibleクラスの分が見えません) */
class Truncated : public Invisible { };

/* Doxygen 用のコメントコードがないクラス */
class Undocumented { };

/*! 公開継承されているクラス */
class PublicBase : public Truncated { };

/*! A template class */
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;
};

MAX_DOT_GRAPH_HEIGHT タグに 200 を与えた設定ファイルを使うと、次のようなグラフとなります。

グラフ内の矩形は構造体やクラスを表しています。色の意味は次の通りです。

• 中を黒く塗られた四角は、図が注目している起点です。
• 黒枠は詳解があることを示しています。
• 灰色枠で示されたクラス等には詳解がありません。
• 赤枠で示されたものは詳解を持つクラスですが、指定された大きさに収まらないことから一部の継承・包含関係が省略されていることを表します。

矢印の意味は次の通りです。

• 青い矢印は二つのクラス間の公開継承関係を示します。
• 緑の矢印は限定公開の継承関係を示します。
• 赤の矢印は非公開の継承関係を示します。
• 紫の破線矢印は、そのクラスが他のクラスに含まれているか、利用されていることを示します。また、矢印のラベルは矢の先にあるクラス等をアクセスしている矢の根本のメンバを表しています。