Llegenda del Gràfic

Aquesta pàgina explica com s'interpreten els gràfics generats per doxygen.

Considera aquest exemple:

/*! Classe invisible per culpa del retall */
class Invisible { };
 
/*! Classe truncada, l'herència està amagada */
class Truncated : public Invisible { };
 
/* Classe no documentada amb comentaris doxygen */
class Undocumented { };
 
/*! Classe heredada amb herència pública */
class PublicBase : public Truncated { };
 
/*! Una classe Template */
template<class T> class Templ { };
 
/*! Classe heredada utilitzant herència protegida */
class ProtectedBase { };
 
/*! Classe heredada utiltzant herència privada */
class PrivateBase { };
 
/*! Classe usada per la classe heretada */
class Used { };
 
/*! Super classe que hereda una quantitat de classes */
class Inherited : public PublicBase,
                  protected ProtectedBase,
                  private PrivateBase,
                  public Undocumented,
                  public Templ<int>
{
  private:
    Used *m_usedClass;
};

Resultarà el gràfic següent:

Les caixes del gràfic superior tenen aquesta interpretació:

• Una caixa negra plena represent l'estructura o classe per la qual el gràfic s'ha generat.
• Una caixa de vora negra representa una estructura o classe documentada.
• Una caixa de vora verda representa una estructura o classe indocumentada.
• Una caixa de vora vermalla representa una estructura o classe documentada de la qual no es mostren totes les relacions d'herència/inclusió. Un gràfic és truncat si no s'ajusta als límits.

Les sagetes tenen aquest significat:

• Una sageta blau fosc remarca una relació d'herència de tipus pública entre dues classes.
• Una sageta verd fosc remarca una relació d'herència de tipus protegida entre dues classes.
• Una sageta roig fosc remarca una relació d'herència de tipus privada entre dues classes.
• Una sageta puntejada de color porpra indica que una classe és continguda o usada per una altra classe. La sageta s'etiqueta amb la variable o variables a través de les quals la classe o estructura apuntada és accessible.
• Una sageta puntejada de color groc indica la relació entre una instància template i la classe template de què ha set instanciada. La sageta s'etiqueta amb els paràmetres template de la instància.