Legenda del grafo

Questa pagina spiega come interpretare i grafi generati da doxygen.

Considerate l'esempio seguente:

/*! Classe invisibile per troncamento */
class Invisible { };

/*! Classe troncata, la relazione di ereditarietà e nascosta */
class Truncated : public Invisible { };

/* Classe non documentata con i commenti speciali di doxygen*/
class Undocumented { };

/*! Classe che utilizza una ereditarietà pubblica */
class PublicBase : public Truncated { };

/*! Classe che utilizza una ereditarietà protetta*/
class ProtectedBase { };

/*! Classe che utilizza una ereditarietà  privata*/
class PrivateBase { };

/*! Classe utilizzata dalla classe Inherited */
class Used { };

/*! Classe che eredita da varie classi*/
class Inherited : public PublicBase,
                  protected ProtectedBase,
                  private PrivateBase,
                  public Undocumented
{
  private:
    Used *m_usedClass;
};

Se il tag MAX_DOT_GRAPH_HEIGHT nel file di configurazione è impostato a 200 verrà prodotto il grafo seguente:

I riquadri nel grafo qui sopra hanno il seguente significato:

• Il riquadro nero pieno rappresenta la struct o la classe per la quale il grafo è stato generato.
• Un riquadro con un bordo nero denota una struct o una classe documentata.
• Un riquadro con un bordo grigio indica una struct o una classe non documentata.
• Un riquadro con un bordo rosso indica una struct o una classe per la quale non sono mostrate tutte le relazioni di ereditarietà/contenimento (un grafo viene troncato se non rientra nei limiti prestabiliti).

Le frecce hanno il seguente significato:

• Una freccia blu scuro indica una relazione di ereditarietà pubblica tra due classi.
• Una freccia verde indica un'ereditarietà protetta.
• Una freccia rossa indica un'ereditarietà privata.
• Una freccia viola tratteggiata indica che una classe è contenuta o usata da un'altra classe. La freccia viene etichettata con la o le variabili attraverso cui la struct o la classe puntata dalla freccia è accessibile.

---