Легенда графа

В этой статье объясняется, как интерпретировать графы, созданные doxygen.

Рассматривается следующий пример:

/*! Класс скрыт из-за сокращения */
class Invisible { };
 
/*! Класс Truncated, отношение наследования скрыто */
class Truncated : public Invisible { };
 
/* Класс не задокументирован комментариями doxygen */
class Undocumented { };
 
/*! Класс, созданный с использованием публичного наследования */
class PublicBase : public Truncated { };
 
/*! Шаблонный класс */
template<class T> class Templ { };
 
/*! Класс, созданный с использованием защищённого наследования */
class ProtectedBase { };
 
/*! Класс, созданный с использованием частного наследования */
class PrivateBase { };
 
/*! Класс, который используется классом Inherited */
class Used { };
 
/*! Суперкласс, наследующий ряду других классов */
class Inherited : public PublicBase,
                  protected ProtectedBase,
                  private PrivateBase,
                  public Undocumented,
                  public Templ<int>
{
  private:
    Used *m_usedClass;
};

В результате получится следующий граф:

Прямоугольники на приведённом выше графе имеют следующие значения:

• Закрашенный серый прямоугольник представляет структуру или класс, для которого создаётся граф.
• Прямоугольник с чёрной рамкой обозначает задокументированную структуру или класс.
• Прямоугольник с серой рамкой обозначает недокументированную структуру или класс.
• Прямоугольник с красной рамкой обозначает задокументированную структуру или класс, для которых показаны не все отношения наследования/композиции. Граф обрезается, если он не помещается в указанные границы.

Стрелки имеют следующее значение:

• Синяя стрелка используется для визуализации отношения публичного наследования между двумя классами.
• Тёмно-зеленая стрелка используется для защищённого наследования.
• Тёмно-красная стрелка используется для частного наследования.
• Фиолетовая пунктирная стрелка используется, если класс содержится в другом классе или используется им. Стрелка помечена переменной (переменными), с помощью которой доступен указанный класс или структура.
• Жёлтая пунктирная стрелка обозначает связь между шаблонным экземпляром и шаблонным классом, из которого он был создан. Стрелка помечена параметрами шаблонного экземпляра.