X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=v1.0.x%2Fgraph_legend.html;h=347d943316b1149aed88065982ad7dced6b04e35;hb=3fe393f093ada1856dffecb79388be0c33712307;hp=94ec6a8735110f016a3fafd2c5bc59720b499831;hpb=1d9bb866738b09085bc6f387e83690c16d26c762;p=m6w6%2Fext-propro diff --git a/v1.0.x/graph_legend.html b/v1.0.x/graph_legend.html index 94ec6a8..347d943 100644 --- a/v1.0.x/graph_legend.html +++ b/v1.0.x/graph_legend.html @@ -3,22 +3,24 @@ - + Property proxy API: Graph Legend + + @@ -28,7 +30,7 @@ -
+
Property proxy API
A facility to manage extension object properties tied to C-struct members
@@ -38,13 +40,14 @@
- + +
@@ -100,41 +103,40 @@ $(document).ready(function(){initNavTree('graph_legend.html','');});

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

Consider the following example:

1 /*! Invisible class because of truncation */
+
2 class Invisible { };
+
3 
+
4 /*! Truncated class, inheritance relation is hidden */
+
5 class Truncated : public Invisible { };
+
6 
+
7 /* Class not documented with doxygen comments */
+
8 class Undocumented { };
+
9 
+
10 /*! Class that is inherited using public inheritance */
+
11 class PublicBase : public Truncated { };
+
12 
+
13 /*! A template class */
+
14 template<class T> class Templ { };
+
15 
+
16 /*! Class that is inherited using protected inheritance */
+
17 class ProtectedBase { };
+
18 
+
19 /*! Class that is inherited using private inheritance */
+
20 class PrivateBase { };
+
21 
+
22 /*! Class that is used by the Inherited class */
+
23 class Used { };
+
24 
+
25 /*! Super class that inherits a number of other classes */
+
26 class Inherited : public PublicBase,
+
27  protected ProtectedBase,
+
28  private PrivateBase,
+
29  public Undocumented,
+
30  public Templ<int>
+
31 {
+
32  private:
+
33  Used *m_usedClass;
+
34 };

This will result in the following graph:

@@ -146,7 +148,7 @@ A filled gray box represents the struct or class for which the graph is generate
  • 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 gray 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.
    • @@ -170,7 +172,7 @@ A yellow dashed arrow denotes a relation between a template instance and the tem
    • Generated by - doxygen 1.8.5
      • + doxygen 1.8.10