Zde naleznete vysvětlení, jak mají být interpretovány grafy, které byly generovány programem doxygen.
Uvažujte následující příklad:
/*! Neviditelná třída, která se v grafu nezobrazuje, protože došlo k ořezání grafu. */
class Invisible { };
/*! Třída, u které došlo k ořezání grafu. Vztah dědičnosti je skryt. */
class Truncated : public Invisible { };
/* Třída, která není dokumentována komentáři programu doxygen. */
class Undocumented { };
/*! Bázová třída děděná veřejně (public inheritance). */
class PublicBase : public Truncated { };
/*! Šablona třídy. */
template<class T> class Templ { };
/*! Bázová třída, použitá pro chráněné dědění (protected inheritance). */
class ProtectedBase { };
/*! Bázová třída, využitá pro privátní dědění (private inheritance). */
class PrivateBase { };
/*! Třída, která je využívána třídou Inherited. */
class Used { };
/*! Odvozená třída, která dědí z více tříd. */
class Inherited : public PublicBase,
protected ProtectedBase,
private PrivateBase,
public Undocumented,
public Templ<int>
{
private:
Used *m_usedClass;
};
K výše uvedenému bude vygenerován následující graf:
Bloky (tj. uzly) v uvedeném grafu mají následující význam:
- Šedě vyplněný obdélník reprezentuje strukturu nebo třídu, pro kterou byl graf generován.
- Obdélník s černým obrysem označuje dokumentovanou strukturu nebo třídu.
- Obdélník s šedým obrysem označuje nedokumentovanou strukturu nebo třídu.
- Obdélník s červeným obrysem označuje dokumentovanou strukturu nebo třídu, pro kterou nejsou zobrazeny všechny vztahy dědičnosti nebo obsažení. Graf je ořezán v případě, kdy jej není možné umístit do vymezeného prostoru.
Šipky (tj. hrany grafu) mají následující význam:
- Tmavě modrá šipka se používá pro označení vztahu veřejné dědičnosti (public) mezi dvěma třídami.
- Tmavě zelená šipka označuje vztah chráněné dědičnosti (protected).
- Tmavě červená šipka označuje vztah privátní dědičnosti (private).
- Purpurová šipka kreslená čárkovaně se používá v případě, kdy je třída obsažena v jiné třídě, nebo kdy je používána jinou třídou. Je označena identifikátorem jedné nebo více proměných, přes které je třída nebo struktura zpřístupněna.
- Žlutá šipka kreslená čárkovaně vyjadřuje vztah mezi instancí šablony a šablonou třídy, na základě které byla instance šablony vytvořena. V popisu šipky jsou uvedeny příslušné parametry šablony.
