Esta página explica como interpretar los gráficos que son generados por doxygen.
Considere el siguiente ejemplo:
1 /*! Clase invisible por truncamiento */
4 /*! Clase truncada, relación de herencia escondida */
5 class Truncated : public Invisible { };
7 /* Clase no documentada con comentarios de doxygen */
8 class Undocumented { };
10 /*! Clase que es heredera usando herencia publica */
11 class PublicBase : public Truncated { };
13 /*! Clase plantilla */
14 template<class T> class Templ { };
16 /*! Clase que es heredera usando herencia protegida */
17 class ProtectedBase { };
19 /*! Clase que es heredera usando herencia privada */
20 class PrivateBase { };
22 /*! Clase que es usada por la clase heredada */
25 /*! Super-Clase que hereda de varias otras clases */
26 class Inherited : public PublicBase,
27 protected ProtectedBase,
Dará como resultado el siguiente gráfico:
Las cajas en el gráfico arriba tienen el siguiente significado:
-
Una caja llena gris 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 oscuro es usada para herencia protegida.
-
Una flecha rojo oscuro 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.