flatmax@597:

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

flatmax@597:

Consider the following example:

flatmax@597:

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

This will result in the following graph:

flatmax@597:

The boxes in the above graph have the following meaning:

flatmax@597:

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

flatmax@597:

The arrows have the following meaning:

flatmax@597:

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

flatmax@597: