Leyenda del gráfico

Esta página explica cómo interpretar los gráficos generados por doxygen.

Considérese el siguiente ejemplo:

/*! Clase invisible por truncamiento */
class Invisible { };
 
/*! Clase truncada, relación de herencia escondida */
class Truncated : public Invisible { };
 
/* Clase no documentada con comentarios de doxygen */
class Undocumented { };
 
/*! Clase que es heredera usando herencia publica */
class PublicBase : public Truncated { };
 
/*! Plantilla de clases */
template<class T> class Templ { };
 
/*! Clase que es heredera usando herencia protegida  */
class ProtectedBase { };
 
/*! Clase que es heredera usando herencia privada  */
class PrivateBase { };
 
/*! Clase que es usada por la clase heredada */
class Used { };
 
/*! Superclase que hereda de varias otras clases */
class Inherited : public PublicBase,
                  protected ProtectedBase,
                  private PrivateBase,
                  public Undocumented,
                  public Templ<int>
{
  private:
    Used *m_usedClass;
};

Dará como resultado el siguiente gráfico:

Las cajas del gráfico superior tienen el siguiente significado:

• Una caja gris rellena representa la estructura o clase para la cual se generó el gráfico.
• Una caja con borde negro indica una estructura o clase documentada.
• Una caja con borde gris indica una estructura o clase no documentada.
• Una caja con borde rojo indica una estructura o clase documentada de la que no todas las relaciones de herencia/asociación se muestran. Un gráfico queda cortado si no encaja dentro de los límites especificados.

Las flechas tienen el siguiente significado:

• Una flecha azul oscuro se usa para mostrar una relación de herencia publica entre dos clases.
• Una flecha verde oscuro se usa para una herencia protegida.
• Una flecha rojo oscuro se usa para herencia privada.
• Una flecha púrpura discontinua se usa si la clase está contenida o se usa por otra clase. La flecha está etiquetada por la variable con que se accede a la clase o estructura apuntada.
• Una flecha amarilla discontinua indica la relación entre una instancia de plantilla y la clase de plantilla de la que se ha instanciado. La flecha se etiqueta con los parámetros de plantilla de la instancia.