Graph Legend

This page explains how to read the graphs generated by the doxygen tool.

Consider the following examples.

/*! Omitted and invisible class */
class Invisible { };

/*! Omitted class (inheritance hidden) */
class Truncated :public Invisible { };

/* Class with no doxygen comment documentation  */
class Undocumented { };

/*! Public and inherited class */
class PublicBase :public Truncated { };

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

/*! Protected and inherited class */
class ProtectedBase { };

/*! Private and inherited class */
class PrivateBase { };

/*! Class used by an inherited class */
class Used { };

/*! High-level class inheriting from multiple classes */
class Inherited :public PublicBase,
                  protected ProtectedBase,
                  private PrivateBase,
                  public Undocumented,
                  public Templ<int>
{
  private:
    Used *m_usedClass;
};

Setting the MAX_DOT_GRAPH_HEIGHT tag in the configuration file to a value of 200 produces the following graph.

graph_legend.png

The boxes in the graph above have the following meanings.

Arrows have the following meanings.



CONFIDENTIAL