POSNET COMBO LIBRARY: Legenda wykresu

# Legenda wykresu

Ta strona wyjaśnia jak interpretować wykresy, które są wygenerowane przez doxygen.

Rozważ następujący przykład:

    /*! Klasa Niewidzialna z powodu okrojenia */
    class Niewidzialna { };

    /*! Klasa Okrojona, relacja dziedziczenia jest ukryta */
    class Okrojona : public Niewidzialna { };

    /* Klasa nie udokumentowana komentarzami doxygen */
    class Nieudokumentowana { };

    /*! Klasa, która jest dziedziczona publicznie */
    class PublicznaBaza : public Okrojona { };

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

    /*! Klasa, która jest dziedziczona przy użyciu dziedziczenia chronionego */
    class ChronionaBaza { };

    /*! Klasa, która jest dziedziczona prywatnie */
    class PrywatnaBaza { };

    /*! Klasa, która jest użyta przez klasę Dziedziczona */
    class Uzyta { };

    /*! Superklasa, która dziedziczy kilka innych klas */
    class Dziedziczona : public PublicznaBaza,
                         protected ChronionaBaza,
                         private PrywatnaBaza,
                         public Nieudokumentowana,
                         public Templ<int>
    {
      private:
        Uzyta *m_usedClass;
    };

Jeśli znacznik `MAX_DOT_GRAPH_HEIGHT` w pliku konfiguracji jest ustawiony na 200, odniesie to rezultat w następującym wykresie:

Prostokąty w powyższym wykresie mają następujące znaczenie:

- Wypełniony czarny prostokąt reprezentuje strukturę lub klasę dla której został wygenerowany wykres.
- Prostokąt z czarną obwolutą oznacza udokumentowaną strukturę lub klasę.
- Prostokąt z szarą obwolutą oznacza nieudokumentowaną strukturę lub klasę.
- Prostokąt z czerwoną obwolutą oznacza udokumentowaną strukturę lub klasę dla której nie są pokazane wszystkie relacje dziedziczenia/zawierania. Wykres jest okrojony, jeśli nie mieści się w określonych brzegach.

Strzałki mają następujące znaczenie:

- Ciemno niebieska strzałka jest używana do wizualizacji relacji dziedziczenia publicznego pomiędzy dwiema klasami.
- Ciemno zielona strzałka jest używana dla dziedziczenia chronionego.
- Ciemno czerwona strzałka jest używana dla dziedziczenia prywatnego.
- Fioletowa przerywana strzałka jest używana jeśli klasa jest zawarta lub użyta przez inną klasę. Strzałka jest podpisana zmienną(ymi) przez które wskazywana klasa lub struktura jest dostępna.