From c8193665975686fb8a344bee3dc94914a3d3558a Mon Sep 17 00:00:00 2001 From: Thales Lima Oliveira Date: Thu, 9 Nov 2017 18:58:45 -0200 Subject: Documentation graphs with Graphviz --- docs/doxygen/html/graph_legend.html | 107 ++++++++++++++++++++++++++++++++++++ 1 file changed, 107 insertions(+) create mode 100644 docs/doxygen/html/graph_legend.html (limited to 'docs/doxygen/html/graph_legend.html') diff --git a/docs/doxygen/html/graph_legend.html b/docs/doxygen/html/graph_legend.html new file mode 100644 index 0000000..c989572 --- /dev/null +++ b/docs/doxygen/html/graph_legend.html @@ -0,0 +1,107 @@ + + + + + + + + + +Graph Legend + + + + + + + + + + +
+
+ + + + + + +
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+
Graph Legend
+
+
+

This page explains how to interpret the graphs that are generated by doxygen.

+

Consider the following example:

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

This will result in the following graph:

+
+ +
+

The boxes in the above graph have the following meaning:

+ +

The arrows have the following meaning:

+ +
+ + + + -- cgit