1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns=
"http://www.w3.org/1999/xhtml">
4 <meta http-equiv=
"Content-Type" content=
"text/xhtml;charset=UTF-8"/>
5 <meta http-equiv=
"X-UA-Compatible" content=
"IE=9"/>
6 <meta name=
"generator" content=
"Doxygen 1.8.10"/>
7 <title>Property proxy API: Graph Legend
</title>
8 <link href=
"tabs.css" rel=
"stylesheet" type=
"text/css"/>
9 <script type=
"text/javascript" src=
"jquery.js"></script>
10 <script type=
"text/javascript" src=
"dynsections.js"></script>
11 <link href=
"navtree.css" rel=
"stylesheet" type=
"text/css"/>
12 <script type=
"text/javascript" src=
"resize.js"></script>
13 <script type=
"text/javascript" src=
"navtreedata.js"></script>
14 <script type=
"text/javascript" src=
"navtree.js"></script>
15 <script type=
"text/javascript">
16 $(document).ready(initResizable);
17 $(window).load(resizeHeight);
19 <link href=
"search/search.css" rel=
"stylesheet" type=
"text/css"/>
20 <script type=
"text/javascript" src=
"search/searchdata.js"></script>
21 <script type=
"text/javascript" src=
"search/search.js"></script>
22 <script type=
"text/javascript">
23 $(document).ready(function() { init_search(); });
25 <link href=
"doxygen.css" rel=
"stylesheet" type=
"text/css" />
28 <div id=
"top"><!-- do not remove this div, it is closed by doxygen! -->
30 <table cellspacing=
"0" cellpadding=
"0">
32 <tr style=
"height: 56px;">
33 <td id=
"projectalign" style=
"padding-left: 0.5em;">
34 <div id=
"projectname">Property proxy API
36 <div id=
"projectbrief">A facility to manage extension object properties tied to C-struct members
</div>
42 <!-- end header part -->
43 <!-- Generated by Doxygen 1.8.10 -->
44 <script type=
"text/javascript">
45 var searchBox = new SearchBox(
"searchBox",
"search",false,'Search');
47 <div id=
"navrow1" class=
"tabs">
49 <li><a href=
"index.html"><span>Main
 Page
</span></a></li>
50 <li><a href=
"annotated.html"><span>Data
 Structures
</span></a></li>
51 <li><a href=
"files.html"><span>Files
</span></a></li>
53 <div id=
"MSearchBox" class=
"MSearchBoxInactive">
55 <img id=
"MSearchSelect" src=
"search/mag_sel.png"
56 onmouseover=
"return searchBox.OnSearchSelectShow()"
57 onmouseout=
"return searchBox.OnSearchSelectHide()"
59 <input type=
"text" id=
"MSearchField" value=
"Search" accesskey=
"S"
60 onfocus=
"searchBox.OnSearchFieldFocus(true)"
61 onblur=
"searchBox.OnSearchFieldFocus(false)"
62 onkeyup=
"searchBox.OnSearchFieldChange(event)"/>
63 </span><span class=
"right">
64 <a id=
"MSearchClose" href=
"javascript:searchBox.CloseResultsWindow()"><img id=
"MSearchCloseImg" border=
"0" src=
"search/close.png" alt=
""/></a>
71 <div id=
"side-nav" class=
"ui-resizable side-nav-resizable">
73 <div id=
"nav-tree-contents">
74 <div id=
"nav-sync" class=
"sync"></div>
77 <div id=
"splitbar" style=
"-moz-user-select:none;"
78 class=
"ui-resizable-handle">
81 <script type=
"text/javascript">
82 $(document).ready(function(){initNavTree('graph_legend.html','');});
84 <div id=
"doc-content">
85 <!-- window showing the filter options -->
86 <div id=
"MSearchSelectWindow"
87 onmouseover=
"return searchBox.OnSearchSelectShow()"
88 onmouseout=
"return searchBox.OnSearchSelectHide()"
89 onkeydown=
"return searchBox.OnSearchSelectKey(event)">
92 <!-- iframe showing the search results (closed by default) -->
93 <div id=
"MSearchResultsWindow">
94 <iframe src=
"javascript:void(0)" frameborder=
"0"
95 name=
"MSearchResults" id=
"MSearchResults">
100 <div class=
"headertitle">
101 <div class=
"title">Graph Legend
</div> </div>
103 <div class=
"contents">
104 <p>This page explains how to interpret the graphs that are generated by doxygen.
</p>
105 <p>Consider the following example:
</p><div class=
"fragment"><div class=
"line"><a name=
"l00001"></a><span class=
"lineno"> 1</span> /*! Invisible class because of truncation */
</div>
106 <div class=
"line"><a name=
"l00002"></a><span class=
"lineno"> 2</span> class Invisible { };
</div>
107 <div class=
"line"><a name=
"l00003"></a><span class=
"lineno"> 3</span> </div>
108 <div class=
"line"><a name=
"l00004"></a><span class=
"lineno"> 4</span> /*! Truncated class, inheritance relation is hidden */
</div>
109 <div class=
"line"><a name=
"l00005"></a><span class=
"lineno"> 5</span> class Truncated : public Invisible { };
</div>
110 <div class=
"line"><a name=
"l00006"></a><span class=
"lineno"> 6</span> </div>
111 <div class=
"line"><a name=
"l00007"></a><span class=
"lineno"> 7</span> /* Class not documented with doxygen comments */
</div>
112 <div class=
"line"><a name=
"l00008"></a><span class=
"lineno"> 8</span> class Undocumented { };
</div>
113 <div class=
"line"><a name=
"l00009"></a><span class=
"lineno"> 9</span> </div>
114 <div class=
"line"><a name=
"l00010"></a><span class=
"lineno"> 10</span> /*! Class that is inherited using public inheritance */
</div>
115 <div class=
"line"><a name=
"l00011"></a><span class=
"lineno"> 11</span> class PublicBase : public Truncated { };
</div>
116 <div class=
"line"><a name=
"l00012"></a><span class=
"lineno"> 12</span> </div>
117 <div class=
"line"><a name=
"l00013"></a><span class=
"lineno"> 13</span> /*! A template class */
</div>
118 <div class=
"line"><a name=
"l00014"></a><span class=
"lineno"> 14</span> template
<class T
> class Templ { };
</div>
119 <div class=
"line"><a name=
"l00015"></a><span class=
"lineno"> 15</span> </div>
120 <div class=
"line"><a name=
"l00016"></a><span class=
"lineno"> 16</span> /*! Class that is inherited using protected inheritance */
</div>
121 <div class=
"line"><a name=
"l00017"></a><span class=
"lineno"> 17</span> class ProtectedBase { };
</div>
122 <div class=
"line"><a name=
"l00018"></a><span class=
"lineno"> 18</span> </div>
123 <div class=
"line"><a name=
"l00019"></a><span class=
"lineno"> 19</span> /*! Class that is inherited using private inheritance */
</div>
124 <div class=
"line"><a name=
"l00020"></a><span class=
"lineno"> 20</span> class PrivateBase { };
</div>
125 <div class=
"line"><a name=
"l00021"></a><span class=
"lineno"> 21</span> </div>
126 <div class=
"line"><a name=
"l00022"></a><span class=
"lineno"> 22</span> /*! Class that is used by the Inherited class */
</div>
127 <div class=
"line"><a name=
"l00023"></a><span class=
"lineno"> 23</span> class Used { };
</div>
128 <div class=
"line"><a name=
"l00024"></a><span class=
"lineno"> 24</span> </div>
129 <div class=
"line"><a name=
"l00025"></a><span class=
"lineno"> 25</span> /*! Super class that inherits a number of other classes */
</div>
130 <div class=
"line"><a name=
"l00026"></a><span class=
"lineno"> 26</span> class Inherited : public PublicBase,
</div>
131 <div class=
"line"><a name=
"l00027"></a><span class=
"lineno"> 27</span>  protected ProtectedBase,
</div>
132 <div class=
"line"><a name=
"l00028"></a><span class=
"lineno"> 28</span>  private PrivateBase,
</div>
133 <div class=
"line"><a name=
"l00029"></a><span class=
"lineno"> 29</span>  public Undocumented,
</div>
134 <div class=
"line"><a name=
"l00030"></a><span class=
"lineno"> 30</span>  public Templ
<int
></div>
135 <div class=
"line"><a name=
"l00031"></a><span class=
"lineno"> 31</span> {
</div>
136 <div class=
"line"><a name=
"l00032"></a><span class=
"lineno"> 32</span>  private:
</div>
137 <div class=
"line"><a name=
"l00033"></a><span class=
"lineno"> 33</span>  Used *m_usedClass;
</div>
138 <div class=
"line"><a name=
"l00034"></a><span class=
"lineno"> 34</span> };
</div>
139 </div><!-- fragment --><p> This will result in the following graph:
</p>
140 <center><div class=
"image">
141 <img src=
"graph_legend.png" />
143 </center><p>The boxes in the above graph have the following meaning:
</p>
146 A filled gray box represents the struct or class for which the graph is generated.
</li>
148 A box with a black border denotes a documented struct or class.
</li>
150 A box with a gray border denotes an undocumented struct or class.
</li>
152 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.
</li>
154 <p>The arrows have the following meaning:
</p>
157 A dark blue arrow is used to visualize a public inheritance relation between two classes.
</li>
159 A dark green arrow is used for protected inheritance.
</li>
161 A dark red arrow is used for private inheritance.
</li>
163 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.
</li>
165 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.
</li>
167 </div><!-- contents -->
168 </div><!-- doc-content -->
169 <!-- start footer part -->
170 <div id=
"nav-path" class=
"navpath"><!-- id is needed for treeview function! -->
172 <li class=
"footer">Generated by
173 <a href=
"http://www.doxygen.org/index.html">
174 <img class=
"footer" src=
"doxygen.png" alt=
"doxygen"/></a> 1.8.10 </li>