Leyenda del Gráfico

Esta página explica como interpretar los gráficos que son generados por doxygen.

Considere 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 { };

/*! Clase plantilla */
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 hija */
class Used { };

/*! Super-Clase que hereda de varias otras clases */
class Inherited : public PublicBase,
                  protected ProtectedBase,
                  private PrivateBase,
                  public Undocumented,
                  public Templ<int>
{
  private:
    Used *m_usedClass;
};

Si la etiqueta MAX_DOT_GRAPH_HEIGHT en el archivo de configuración tiene valor 240 resultará en el siguiente gráfico:

Las cajas en el gráfico arriba tienen el significado que sigue:

• Una caja llena negra representa la estructura o clase para la cuálse generó el gráfico.
• Una caja con borde negro señala una estructura o clase documentada.
• Una caja con borde griz señala una estructura o clase no documentada.
• una caja con borde rojo señala una estructura o clase documentada de la cuál no toda las relaciones de jerarquía/contenido son mostradas. El gráfico sera truncado si este no calza dentro de los límites especificados.

Las flechas tienen el siguiente significado:

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

---