Mercurial > hg > vamp-docs

comparison code-docs/graph_legend.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

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