Spec-Zone.ru › PointCloudLibrary

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

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

/*! 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;
};

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

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

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

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

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

© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/graph_legend.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API