Legenda do Grafo

Esta página explica como interpretar os grafos gerados pelo doxygen.

Considere o seguinte exemplo:

/*! Invisible class because of truncation */
class Invisible { };

/*! Truncated class, inheritance relation is hidden */
class Truncated : public Invisible { };

/* Class not documented with doxygen comments */
class Undocumented { };

/*! Class that is inherited using public inheritance */
class PublicBase : public Truncated { };

/*! A template class */
template<class T> class Templ { };

/*! Class that is inherited using protected inheritance */
class ProtectedBase { };

/*! Class that is inherited using private inheritance */
class PrivateBase { };

/*! Class that is used by the Inherited class */
class Used { };

/*! Super class that inherits a number of other classes */
class Inherited : public PublicBase,
                  protected ProtectedBase,
                  private PrivateBase,
                  public Undocumented,
                  public Templ<int>
{
  private:
    Used *m_usedClass;
};

Isto irá gerar o seguinte gráfo:

As caixas no grafo acima tem as seguintes interpretações:

• Uma caixa inteiramente preta representa a estrutura ou a classe para qual o grafo foi gerado.
• Uma caixa com bordas pretas denota uma estrutura ou classe documentada.
• Uma caixa com bordas cinzas denota uma estrutura ou classe não documentada.
• Uma caixa com bordas vermelhas denota uma estrutura ou classe documentada para a qual nem todas as heranças ou componentes são mostradas no grafo. Um grafo é truncado quando este é maior que o tamanho especificado.

As setas tem os seguintes significados:

• Uma seta azul escura é utilizada para denotar uma relação de herança pública entre duas classes.
• Uma seta verde escura é utilizada para denotar uma herança protegida.
• Uma seta vermelho escura é utilizada para denotar uma herança privada.
• Uma seta púrpura pontilhada é usada se uma classe está contida ou é utilizadapor outra classe. A seta é marcada com a(s) variável(eis) através das quais a classe ou estrutura apontada está acessível.