cannam@0:

Graph Legend

This page explains how to interpret the graphs that are generated by doxygen.

cannam@0: Consider the following example:

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

This will result in the following graph:

cannam@0:

cannam@0: The boxes in the above graph have the following meaning:

cannam@0: A filled gray box represents the struct or class for which the graph is generated.
cannam@0: A box with a black border denotes a documented struct or class.
cannam@0: A box with a grey border denotes an undocumented struct or class.
cannam@0: A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.

cannam@0: The arrows have the following meaning:

cannam@0: A dark blue arrow is used to visualize a public inheritance relation between two classes.
cannam@0: A dark green arrow is used for protected inheritance.
cannam@0: A dark red arrow is used for private inheritance.
cannam@0: A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible.
cannam@0: A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labeled with the template parameters of the instance.

cannam@0: