cannam@50: cannam@50: cannam@50:
cannam@50: cannam@0:
cannam@50: VampPluginSDK
cannam@50: 2.1
cannam@50:
cannam@50:
cannam@50: |
cannam@50:
cannam@50:
cannam@50:
cannam@50:
This page explains how to interpret the graphs that are generated by doxygen.
cannam@50:Consider the following example:
cannam@50:/*! Invisible class because of truncation */ cannam@0: class Invisible { }; cannam@0: cannam@0: /*! Truncated class, inheritance relation is hidden */ cannam@0: class Truncated : public Invisible { }; cannam@0: cannam@0: /* Class not documented with doxygen comments */ cannam@0: class Undocumented { }; cannam@0: cannam@0: /*! Class that is inherited using public inheritance */ cannam@0: class PublicBase : public Truncated { }; cannam@0: cannam@0: /*! A template class */ cannam@0: template<class T> class Templ { }; cannam@0: cannam@0: /*! Class that is inherited using protected inheritance */ cannam@0: class ProtectedBase { }; cannam@0: cannam@0: /*! Class that is inherited using private inheritance */ cannam@0: class PrivateBase { }; cannam@0: cannam@0: /*! Class that is used by the Inherited class */ cannam@0: class Used { }; cannam@0: cannam@0: /*! Super class that inherits a number of other classes */ cannam@0: class Inherited : public PublicBase, cannam@0: protected ProtectedBase, cannam@0: private PrivateBase, cannam@0: public Undocumented, cannam@0: public Templ<int> cannam@0: { cannam@0: private: cannam@0: Used *m_usedClass; cannam@0: }; cannam@50:
This will result in the following graph:
cannam@50:The boxes in the above graph have the following meaning:
cannam@50:The arrows have the following meaning:
cannam@50: