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.5"/>
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=
"navtree.js"></script>
14 <script type=
"text/javascript">
15 $(document).ready(initResizable);
16 $(window).load(resizeHeight);
18 <link href=
"search/search.css" rel=
"stylesheet" type=
"text/css"/>
19 <script type=
"text/javascript" src=
"search/search.js"></script>
20 <script type=
"text/javascript">
21 $(document).ready(function() { searchBox.OnSelectItem(
0); });
23 <link href=
"doxygen.css" rel=
"stylesheet" type=
"text/css" />
26 <div id=
"top"><!-- do not remove this div, it is closed by doxygen! -->
28 <table cellspacing=
"0" cellpadding=
"0">
30 <tr style=
"height: 56px;">
31 <td style=
"padding-left: 0.5em;">
32 <div id=
"projectname">Property proxy API
34 <div id=
"projectbrief">A facility to manage extension object properties tied to C-struct members
</div>
40 <!-- end header part -->
41 <!-- Generated by Doxygen 1.8.5 -->
42 <script type=
"text/javascript">
43 var searchBox = new SearchBox(
"searchBox",
"search",false,'Search');
45 <div id=
"navrow1" class=
"tabs">
47 <li><a href=
"index.html"><span>Main
 Page
</span></a></li>
48 <li><a href=
"annotated.html"><span>Data
 Structures
</span></a></li>
49 <li><a href=
"files.html"><span>Files
</span></a></li>
51 <div id=
"MSearchBox" class=
"MSearchBoxInactive">
53 <img id=
"MSearchSelect" src=
"search/mag_sel.png"
54 onmouseover=
"return searchBox.OnSearchSelectShow()"
55 onmouseout=
"return searchBox.OnSearchSelectHide()"
57 <input type=
"text" id=
"MSearchField" value=
"Search" accesskey=
"S"
58 onfocus=
"searchBox.OnSearchFieldFocus(true)"
59 onblur=
"searchBox.OnSearchFieldFocus(false)"
60 onkeyup=
"searchBox.OnSearchFieldChange(event)"/>
61 </span><span class=
"right">
62 <a id=
"MSearchClose" href=
"javascript:searchBox.CloseResultsWindow()"><img id=
"MSearchCloseImg" border=
"0" src=
"search/close.png" alt=
""/></a>
69 <div id=
"side-nav" class=
"ui-resizable side-nav-resizable">
71 <div id=
"nav-tree-contents">
72 <div id=
"nav-sync" class=
"sync"></div>
75 <div id=
"splitbar" style=
"-moz-user-select:none;"
76 class=
"ui-resizable-handle">
79 <script type=
"text/javascript">
80 $(document).ready(function(){initNavTree('graph_legend.html','');});
82 <div id=
"doc-content">
83 <!-- window showing the filter options -->
84 <div id=
"MSearchSelectWindow"
85 onmouseover=
"return searchBox.OnSearchSelectShow()"
86 onmouseout=
"return searchBox.OnSearchSelectHide()"
87 onkeydown=
"return searchBox.OnSearchSelectKey(event)">
88 <a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(0)"><span class=
"SelectionMark"> </span>All
</a><a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(1)"><span class=
"SelectionMark"> </span>Data Structures
</a><a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(2)"><span class=
"SelectionMark"> </span>Files
</a><a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(3)"><span class=
"SelectionMark"> </span>Functions
</a><a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(4)"><span class=
"SelectionMark"> </span>Variables
</a><a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(5)"><span class=
"SelectionMark"> </span>Typedefs
</a></div>
90 <!-- iframe showing the search results (closed by default) -->
91 <div id=
"MSearchResultsWindow">
92 <iframe src=
"javascript:void(0)" frameborder=
"0"
93 name=
"MSearchResults" id=
"MSearchResults">
98 <div class=
"headertitle">
99 <div class=
"title">Graph Legend
</div> </div>
101 <div class=
"contents">
102 <p>This page explains how to interpret the graphs that are generated by doxygen.
</p>
103 <p>Consider the following example:
</p>
104 <div class=
"fragment"><div class=
"line"><span class=
"comment">/*! Invisible class because of truncation */
</span></div>
105 <div class=
"line"><span class=
"keyword">class
</span>Invisible { };
</div>
106 <div class=
"line"><span class=
"comment"></span></div>
107 <div class=
"line"><span class=
"comment">/*! Truncated class, inheritance relation is hidden */
</span></div>
108 <div class=
"line"><span class=
"keyword">class
</span>Truncated :
<span class=
"keyword">public
</span> Invisible { };
</div>
109 <div class=
"line"></div>
110 <div class=
"line"><span class=
"comment">/* Class not documented with doxygen comments */
</span></div>
111 <div class=
"line"><span class=
"keyword">class
</span>Undocumented { };
</div>
112 <div class=
"line"><span class=
"comment"></span></div>
113 <div class=
"line"><span class=
"comment">/*! Class that is inherited using public inheritance */
</span></div>
114 <div class=
"line"><span class=
"keyword">class
</span>PublicBase :
<span class=
"keyword">public
</span> Truncated { };
</div>
115 <div class=
"line"><span class=
"comment"></span></div>
116 <div class=
"line"><span class=
"comment">/*! A template class */
</span></div>
117 <div class=
"line"><span class=
"keyword">template
</span><<span class=
"keyword">class
</span> T
> <span class=
"keyword">class
</span>Templ { };
</div>
118 <div class=
"line"><span class=
"comment"></span></div>
119 <div class=
"line"><span class=
"comment">/*! Class that is inherited using protected inheritance */
</span></div>
120 <div class=
"line"><span class=
"keyword">class
</span>ProtectedBase { };
</div>
121 <div class=
"line"><span class=
"comment"></span></div>
122 <div class=
"line"><span class=
"comment">/*! Class that is inherited using private inheritance */
</span></div>
123 <div class=
"line"><span class=
"keyword">class
</span>PrivateBase { };
</div>
124 <div class=
"line"><span class=
"comment"></span></div>
125 <div class=
"line"><span class=
"comment">/*! Class that is used by the Inherited class */
</span></div>
126 <div class=
"line"><span class=
"keyword">class
</span>Used { };
</div>
127 <div class=
"line"><span class=
"comment"></span></div>
128 <div class=
"line"><span class=
"comment">/*! Super class that inherits a number of other classes */
</span></div>
129 <div class=
"line"><span class=
"keyword">class
</span>Inherited :
<span class=
"keyword">public
</span> PublicBase,
</div>
130 <div class=
"line"> <span class=
"keyword">protected
</span> ProtectedBase,
</div>
131 <div class=
"line"> <span class=
"keyword">private
</span> PrivateBase,
</div>
132 <div class=
"line"> <span class=
"keyword">public
</span> Undocumented,
</div>
133 <div class=
"line"> <span class=
"keyword">public
</span> Templ
<int
></div>
134 <div class=
"line">{
</div>
135 <div class=
"line"> <span class=
"keyword">private
</span>:
</div>
136 <div class=
"line"> Used *m_usedClass;
</div>
137 <div class=
"line">};
</div>
138 </div><!-- fragment --><p> This will result in the following graph:
</p>
139 <center><div class=
"image">
140 <img src=
"graph_legend.png" />
142 </center><p>The boxes in the above graph have the following meaning:
</p>
145 A filled gray box represents the struct or class for which the graph is generated.
</li>
147 A box with a black border denotes a documented struct or class.
</li>
149 A box with a grey border denotes an undocumented struct or class.
</li>
151 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>
153 <p>The arrows have the following meaning:
</p>
156 A dark blue arrow is used to visualize a public inheritance relation between two classes.
</li>
158 A dark green arrow is used for protected inheritance.
</li>
160 A dark red arrow is used for private inheritance.
</li>
162 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>
164 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>
166 </div><!-- contents -->
167 </div><!-- doc-content -->
168 <!-- start footer part -->
169 <div id=
"nav-path" class=
"navpath"><!-- id is needed for treeview function! -->
171 <li class=
"footer">Generated by
172 <a href=
"http://www.doxygen.org/index.html">
173 <img class=
"footer" src=
"doxygen.png" alt=
"doxygen"/></a> 1.8.5 </li>