Chris@1:

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

Chris@1:

Consider the following example:

Chris@1:

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

This will result in the following graph:

Chris@1:

Chris@3:

Chris@1:

Chris@3:

The boxes in the above graph have the following meaning:

Chris@1:

Chris@1: A filled gray box represents the struct or class for which the graph is generated.
Chris@1: A box with a black border denotes a documented struct or class.
Chris@1: A box with a grey border denotes an undocumented struct or class.
Chris@1: 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.

Chris@3:

The arrows have the following meaning:

Chris@1:

Chris@1: A dark blue arrow is used to visualize a public inheritance relation between two classes.
Chris@1: A dark green arrow is used for protected inheritance.
Chris@1: A dark red arrow is used for private inheritance.
Chris@1: 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.
Chris@1: 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.

Chris@3: