From c9458897ebbb739d8db83c80e06512d8a612f743 Mon Sep 17 00:00:00 2001 From: danglassey Date: Wed, 14 Aug 2002 09:57:17 +0000 Subject: *** empty log message *** --- doc/api-documentation/html/graph_legend.html | 60 ++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 doc/api-documentation/html/graph_legend.html (limited to 'doc/api-documentation/html/graph_legend.html') diff --git a/doc/api-documentation/html/graph_legend.html b/doc/api-documentation/html/graph_legend.html new file mode 100644 index 0000000..8c7f1a8 --- /dev/null +++ b/doc/api-documentation/html/graph_legend.html @@ -0,0 +1,60 @@ + + +Graph Legend + + + + +Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members +

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;
+};
+

If the MAX_DOT_GRAPH_HEIGHT tag in the configuration file is set to 240 this will result in the following graph: +

+ +

+ The boxes in the above graph have the following meaning:

A filled black box represents the struct or class for which the graph is generated.
A box with a black border denotes a documented struct or class.
A box with a grey border denotes an undocumented struct or class.
A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.

+The arrows have the following meaning:

A dark blue arrow is used to visualize a public inheritance relation between two classes.
A dark green arrow is used for protected inheritance.
A dark red arrow is used for private inheritance.
A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible.
A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labeled with the template parameters of the instance.

Generated on Thu Jun 20 22:13:05 2002 for The Sword Project by + +

1.2.15

+ + -- cgit