CanFestival: Graph Legend

Graph Legend

nico@207: Consider the following example:

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

MAX_DOT_GRAPH_HEIGHT

nico@207:

nico@207: The boxes in the above graph have the following meaning:

nico@207:

nico@207: A filled black box represents the struct or class for which the graph is generated.

nico@207:

nico@207: A box with a black border denotes a documented struct or class.

nico@207:

nico@207: A box with a grey border denotes an undocumented struct or class.

nico@207:

nico@207: 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.

nico@207:

nico@207: A dark blue arrow is used to visualize a public inheritance relation between two classes.

nico@207:

nico@207: A dark green arrow is used for protected inheritance.

nico@207:

nico@207: A dark red arrow is used for private inheritance.

nico@207:

nico@207: 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.

nico@207:

nico@207: 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.

nico@207:

Generated on Mon Jul 2 19:10:44 2007 for CanFestival by nico@207: nico@207: doxygen

1.5.1