|
Chris@1
|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
Chris@1
|
2 <html xmlns="http://www.w3.org/1999/xhtml">
|
|
Chris@1
|
3 <head>
|
|
Chris@1
|
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
Chris@1
|
5 <title>VampPluginSDK: Graph Legend</title>
|
|
Chris@1
|
6
|
|
Chris@1
|
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
Chris@1
|
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
Chris@1
|
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
Chris@1
|
10 <script type="text/javascript" src="jquery.js"></script>
|
|
Chris@1
|
11 <script type="text/javascript" src="resize.js"></script>
|
|
Chris@1
|
12 <script type="text/javascript" src="navtree.js"></script>
|
|
Chris@1
|
13 <script type="text/javascript">
|
|
Chris@1
|
14 $(document).ready(initResizable);
|
|
Chris@1
|
15 </script>
|
|
Chris@1
|
16
|
|
Chris@1
|
17
|
|
Chris@1
|
18 </head>
|
|
Chris@1
|
19 <body>
|
|
Chris@1
|
20 <div id="top"><!-- do not remove this div! -->
|
|
Chris@1
|
21
|
|
Chris@1
|
22
|
|
Chris@1
|
23 <div id="titlearea">
|
|
Chris@1
|
24 <table cellspacing="0" cellpadding="0">
|
|
Chris@1
|
25 <tbody>
|
|
Chris@1
|
26 <tr style="height: 56px;">
|
|
Chris@1
|
27
|
|
Chris@1
|
28
|
|
Chris@1
|
29 <td style="padding-left: 0.5em;">
|
|
Chris@1
|
30 <div id="projectname">VampPluginSDK
|
|
Chris@1
|
31  <span id="projectnumber">2.1</span>
|
|
Chris@1
|
32 </div>
|
|
Chris@1
|
33
|
|
Chris@1
|
34 </td>
|
|
Chris@1
|
35
|
|
Chris@1
|
36
|
|
Chris@1
|
37
|
|
Chris@1
|
38 </tr>
|
|
Chris@1
|
39 </tbody>
|
|
Chris@1
|
40 </table>
|
|
Chris@1
|
41 </div>
|
|
Chris@1
|
42
|
|
Chris@1
|
43 <!-- Generated by Doxygen 1.7.5.1 -->
|
|
Chris@1
|
44 <div id="navrow1" class="tabs">
|
|
Chris@1
|
45 <ul class="tablist">
|
|
Chris@1
|
46 <li><a href="index.html"><span>Main Page</span></a></li>
|
|
Chris@1
|
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
Chris@1
|
48 <li><a href="annotated.html"><span>Classes</span></a></li>
|
|
Chris@1
|
49 <li><a href="files.html"><span>Files</span></a></li>
|
|
Chris@1
|
50 <li><a href="dirs.html"><span>Directories</span></a></li>
|
|
Chris@1
|
51 </ul>
|
|
Chris@1
|
52 </div>
|
|
Chris@1
|
53 </div>
|
|
Chris@1
|
54 <div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
Chris@1
|
55 <div id="nav-tree">
|
|
Chris@1
|
56 <div id="nav-tree-contents">
|
|
Chris@1
|
57 </div>
|
|
Chris@1
|
58 </div>
|
|
Chris@1
|
59 <div id="splitbar" style="-moz-user-select:none;"
|
|
Chris@1
|
60 class="ui-resizable-handle">
|
|
Chris@1
|
61 </div>
|
|
Chris@1
|
62 </div>
|
|
Chris@1
|
63 <script type="text/javascript">
|
|
Chris@1
|
64 initNavTree('graph_legend.html','');
|
|
Chris@1
|
65 </script>
|
|
Chris@1
|
66 <div id="doc-content">
|
|
Chris@1
|
67 <div class="header">
|
|
Chris@1
|
68 <div class="headertitle">
|
|
Chris@1
|
69 <div class="title">Graph Legend</div> </div>
|
|
Chris@1
|
70 </div>
|
|
Chris@1
|
71 <div class="contents">
|
|
Chris@1
|
72 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
|
|
Chris@1
|
73 <p>Consider the following example: </p>
|
|
Chris@1
|
74 <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
|
|
Chris@1
|
75 <span class="keyword">class </span>Invisible { };
|
|
Chris@1
|
76 <span class="comment"></span>
|
|
Chris@1
|
77 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
|
|
Chris@1
|
78 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
|
|
Chris@1
|
79
|
|
Chris@1
|
80 <span class="comment">/* Class not documented with doxygen comments */</span>
|
|
Chris@1
|
81 <span class="keyword">class </span>Undocumented { };
|
|
Chris@1
|
82 <span class="comment"></span>
|
|
Chris@1
|
83 <span class="comment">/*! Class that is inherited using public inheritance */</span>
|
|
Chris@1
|
84 <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
|
|
Chris@1
|
85 <span class="comment"></span>
|
|
Chris@1
|
86 <span class="comment">/*! A template class */</span>
|
|
Chris@1
|
87 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };
|
|
Chris@1
|
88 <span class="comment"></span>
|
|
Chris@1
|
89 <span class="comment">/*! Class that is inherited using protected inheritance */</span>
|
|
Chris@1
|
90 <span class="keyword">class </span>ProtectedBase { };
|
|
Chris@1
|
91 <span class="comment"></span>
|
|
Chris@1
|
92 <span class="comment">/*! Class that is inherited using private inheritance */</span>
|
|
Chris@1
|
93 <span class="keyword">class </span>PrivateBase { };
|
|
Chris@1
|
94 <span class="comment"></span>
|
|
Chris@1
|
95 <span class="comment">/*! Class that is used by the Inherited class */</span>
|
|
Chris@1
|
96 <span class="keyword">class </span>Used { };
|
|
Chris@1
|
97 <span class="comment"></span>
|
|
Chris@1
|
98 <span class="comment">/*! Super class that inherits a number of other classes */</span>
|
|
Chris@1
|
99 <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
|
|
Chris@1
|
100 <span class="keyword">protected</span> ProtectedBase,
|
|
Chris@1
|
101 <span class="keyword">private</span> PrivateBase,
|
|
Chris@1
|
102 <span class="keyword">public</span> Undocumented,
|
|
Chris@1
|
103 <span class="keyword">public</span> Templ<int>
|
|
Chris@1
|
104 {
|
|
Chris@1
|
105 <span class="keyword">private</span>:
|
|
Chris@1
|
106 Used *m_usedClass;
|
|
Chris@1
|
107 };
|
|
Chris@1
|
108 </pre></div><p> This will result in the following graph:</p>
|
|
Chris@1
|
109 <center><div class="image">
|
|
Chris@1
|
110 <img src="graph_legend.png" alt="graph_legend.png"/>
|
|
Chris@1
|
111 </div>
|
|
Chris@1
|
112 </center> <p>The boxes in the above graph have the following meaning: </p>
|
|
Chris@1
|
113 <ul>
|
|
Chris@1
|
114 <li>
|
|
Chris@1
|
115 A filled gray box represents the struct or class for which the graph is generated. </li>
|
|
Chris@1
|
116 <li>
|
|
Chris@1
|
117 A box with a black border denotes a documented struct or class. </li>
|
|
Chris@1
|
118 <li>
|
|
Chris@1
|
119 A box with a grey border denotes an undocumented struct or class. </li>
|
|
Chris@1
|
120 <li>
|
|
Chris@1
|
121 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>
|
|
Chris@1
|
122 </ul>
|
|
Chris@1
|
123 <p>The arrows have the following meaning: </p>
|
|
Chris@1
|
124 <ul>
|
|
Chris@1
|
125 <li>
|
|
Chris@1
|
126 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
|
|
Chris@1
|
127 <li>
|
|
Chris@1
|
128 A dark green arrow is used for protected inheritance. </li>
|
|
Chris@1
|
129 <li>
|
|
Chris@1
|
130 A dark red arrow is used for private inheritance. </li>
|
|
Chris@1
|
131 <li>
|
|
Chris@1
|
132 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>
|
|
Chris@1
|
133 <li>
|
|
Chris@1
|
134 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>
|
|
Chris@1
|
135 </ul>
|
|
Chris@1
|
136 </div>
|
|
Chris@1
|
137 </div>
|
|
Chris@1
|
138 <div id="nav-path" class="navpath">
|
|
Chris@1
|
139 <ul>
|
|
Chris@1
|
140
|
|
Chris@1
|
141 <li class="footer">Generated on Tue Oct 4 2011 14:38:53 for VampPluginSDK by
|
|
Chris@1
|
142 <a href="http://www.doxygen.org/index.html">
|
|
Chris@1
|
143 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
|
|
Chris@1
|
144 </ul>
|
|
Chris@1
|
145 </div>
|
|
Chris@1
|
146
|
|
Chris@1
|
147
|
|
Chris@1
|
148 </body>
|
|
Chris@1
|
149 </html>
|
