Zde naleznete vysvětlení, jak mají být interpretovány grafy, které byly generovány programem doxygen.
Uvažujte následující příklad:
1 /*! Neviditelná třída, která se v grafu nezobrazuje, protože došlo k ořezání grafu. */
4 /*! Třída, u které došlo k ořezání grafu. Vztah dědičnosti je skryt. */
5 class Truncated : public Invisible { };
7 /* Třída, která není dokumentována komentáři programu doxygen. */
8 class Undocumented { };
10 /*! Bázová třída děděná veřejně (public inheritance). */
11 class PublicBase : public Truncated { };
14 template<class T> class Templ { };
16 /*! Bázová třída, použitá pro chráněné dědění (protected inheritance). */
17 class ProtectedBase { };
19 /*! Bázová třída, využitá pro privátní dědění (private inheritance). */
20 class PrivateBase { };
22 /*! Třída, která je využívána třídou Inherited. */
25 /*! Odvozená třída, která dědí z více tříd. */
26 class Inherited : public PublicBase,
27 protected ProtectedBase,
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.