From 04fec063699f742fcd2ea552ef8c77fb402ce870 Mon Sep 17 00:00:00 2001 From: Niklas Date: Wed, 9 Nov 2011 15:27:51 +0100 Subject: some documentation changes (adding comments) and doxygen files) --- doxygen/html/graph_legend.html | 167 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 167 insertions(+) create mode 100644 doxygen/html/graph_legend.html (limited to 'doxygen/html/graph_legend.html') diff --git a/doxygen/html/graph_legend.html b/doxygen/html/graph_legend.html new file mode 100644 index 0000000..a03a96b --- /dev/null +++ b/doxygen/html/graph_legend.html @@ -0,0 +1,167 @@ + + + + +ndgui/NetworkDiscovery: Graph Legend + + + + + + + + + + + + + +
+
+ + + + + + +
+
ndgui/NetworkDiscovery
+
+
+ +
+
+ +
+
+
+ +
+
+
+

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:

+
+graph_legend.png +
+

The boxes in the above graph have the following meaning:

+ +

The arrows have the following meaning:

+ +
+
+ + +
+ All Classes Files Functions Variables Defines
+ + +
+ +
+ + + + -- cgit v1.2.3-55-g7522