nico@207: nico@207: nico@207: CanFestival: Graph Legend nico@207: nico@207: nico@207: nico@207: nico@207:
nico@207:
nico@207:

Graph Legend

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

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: 
If the MAX_DOT_GRAPH_HEIGHT tag in the configuration file is set to 240 this will result in the following graph:

nico@207:

nico@207: graph_legend.png nico@207:
nico@207:

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

nico@207: The arrows have the following meaning: nico@207:
Generated on Mon Jun 4 16:28:52 2007 for CanFestival by  nico@207: nico@207: doxygen 1.5.1
nico@207: nico@207: