グラフの凡例

このページでは、doxygenが生成するグラフの読み方を説明する。

次の例を考える。

/*! Invisible class because of truncation */
class Invisible { };
 
/*! Truncated class, inheritance relation is hidden */
class Truncated : public Invisible { };
 
/* Class not documented with doxygen comments */
class Undocumented { };
 
/*! Class that is inherited using public inheritance */
class PublicBase : public Truncated { };
 
/*! A template class */
template<class T> class Templ { };
 
/*! Class that is inherited using protected inheritance */
class ProtectedBase { };
 
/*! Class that is inherited using private inheritance */
class PrivateBase { };
 
/*! Class that is used by the Inherited class */
class Used { };
 
/*! Super class that inherits a number of other classes */
class Inherited : public PublicBase,
 protected ProtectedBase,
 private PrivateBase,
 public Undocumented,
 public Templ<int>
{
 private:
    Used *m_usedClass;
};

これにより次のグラフが生成される。

上記のグラフ内のボックスは次の意味を持つ。

• 灰色で塗りつぶされたボックスは、グラフの生成対象である構造体またはクラスを表す。
• 黒い枠線のボックスは、ドキュメント化された構造体またはクラスを表す。
• 灰色の枠線のボックスは、ドキュメント化されていない構造体またはクラスを表す。
• 赤い枠線のボックスは、すべての継承/包含関係が表示されていないドキュメント化された構造体またはクラスを表す。グラフは、指定された範囲に収まらない場合に切り詰められる。

矢印は次の意味を持つ。

• 青い矢印は、2つのクラス間の public 継承関係を可視化するために使用される。
• 濃い緑の矢印は protected 継承に使用される。
• 濃い赤の矢印は private 継承に使用される。
• 紫の破線矢印は、あるクラスが別のクラスに含まれる、または使用される場合に用いられる。矢印には、指し示すクラスまたは構造体にアクセスするための変数のラベルが付けられる。
• 黄色の破線矢印は、テンプレートインスタンスと、そのインスタンス化元のテンプレートクラスとの関係を表す。矢印には、インスタンスのテンプレートパラメータのラベルが付けられる。