86 |
This page explains how to interpret the graphs that are generated by doxygen.
87 |
Consider the following example:
/*! Invisible class because of truncation */
class Invisible { };
/*! Truncated class, inheritance relation is hidden */
class Truncated : public Invisible { };
/* Class not documented with doxygen comments */
class Undocumented { };
/*! Class that is inherited using public inheritance */
class PublicBase : public Truncated { };
/*! A template class */
template<class T> class Templ { };
/*! Class that is inherited using protected inheritance */
class ProtectedBase { };
/*! Class that is inherited using private inheritance */
class PrivateBase { };
/*! Class that is used by the Inherited class */
class Used { };
/*! Super class that inherits a number of other classes */
class Inherited : public PublicBase,
protected ProtectedBase,
private PrivateBase,
public Undocumented,
public Templ<int>
{
private:
Used *m_usedClass;
};
This will result in the following graph:
88 |
89 |
90 |
The boxes in the above graph have the following meaning:
92 |
93 | -
94 | A filled gray box represents the struct or class for which the graph is generated.
95 | -
96 | A box with a black border denotes a documented struct or class.
97 | -
98 | A box with a gray border denotes an undocumented struct or class.
99 | -
100 | 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.
101 |
102 |
The arrows have the following meaning:
103 |
104 | -
105 | A dark blue arrow is used to visualize a public inheritance relation between two classes.
106 | -
107 | A dark green arrow is used for protected inheritance.
108 | -
109 | A dark red arrow is used for private inheritance.
110 | -
111 | A purple dashed arrow is used if a class is contained or used by another class. The arrow is labelled with the variable(s) through which the pointed class or struct is accessible.
112 | -
113 | A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labelled with the template parameters of the instance.
114 |
115 |
97 |
101 | 
90 |
93 | 
