Mercurial > hg > vamp-docs

comparison code-docs/graph_legend.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
comparison
equal deleted inserted replaced
2:52d16fb98e80 3:5c2683745b33
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 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"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
5 <title>VampPluginSDK: Graph Legend</title> 6 <title>VampPluginSDK: Graph Legend</title>
6 7
7 <link href="tabs.css" rel="stylesheet" type="text/css"/> 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/> 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
26 <tr style="height: 56px;"> 27 <tr style="height: 56px;">
27 28
28 29
29 <td style="padding-left: 0.5em;"> 30 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK 31 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span> 32 &#160;<span id="projectnumber">2.4</span>
32 </div> 33 </div>
33 34
34 </td> 35 </td>
35 36
36 37
38 </tr> 39 </tr>
39 </tbody> 40 </tbody>
40 </table> 41 </table>
41 </div> 42 </div>
42 43
43 <!-- Generated by Doxygen 1.7.5.1 --> 44 <!-- Generated by Doxygen 1.8.0 -->
44 <div id="navrow1" class="tabs"> 45 <div id="navrow1" class="tabs">
45 <ul class="tablist"> 46 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 47 <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="namespaces.html"><span>Namespaces</span></a></li>
48 <li><a href="annotated.html"><span>Classes</span></a></li> 49 <li><a href="annotated.html"><span>Classes</span></a></li>
65 </script> 66 </script>
66 <div id="doc-content"> 67 <div id="doc-content">
67 <div class="header"> 68 <div class="header">
68 <div class="headertitle"> 69 <div class="headertitle">
69 <div class="title">Graph Legend</div> </div> 70 <div class="title">Graph Legend</div> </div>
70 </div> 71 </div><!--header-->
71 <div class="contents"> 72 <div class="contents">
72 <p>This page explains how to interpret the graphs that are generated by doxygen.</p> 73 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
73 <p>Consider the following example: </p> 74 <p>Consider the following example: </p>
74 <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span> 75 <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="keyword">class </span>Invisible { };
105 <span class="keyword">private</span>: 106 <span class="keyword">private</span>:
106 Used *m_usedClass; 107 Used *m_usedClass;
107 }; 108 };
108 </pre></div><p> This will result in the following graph:</p> 109 </pre></div><p> This will result in the following graph:</p>
109 <center><div class="image"> 110 <center><div class="image">
110 <img src="graph_legend.png" alt="graph_legend.png"/> 111 <img src="graph_legend.png" />
111 </div> 112 </div>
112 </center> <p>The boxes in the above graph have the following meaning: </p> 113 </center><p>The boxes in the above graph have the following meaning: </p>
113 <ul> 114 <ul>
114 <li> 115 <li>
115 A filled gray box represents the struct or class for which the graph is generated. </li> 116 A filled gray box represents the struct or class for which the graph is generated. </li>
116 <li> 117 <li>
117 A box with a black border denotes a documented struct or class. </li> 118 A box with a black border denotes a documented struct or class. </li>
118 <li> 119 <li>
119 A box with a grey border denotes an undocumented struct or class. </li> 120 A box with a grey border denotes an undocumented struct or class. </li>
120 <li> 121 <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 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 </ul>
123 <p>The arrows have the following meaning: </p> 124 <p>The arrows have the following meaning: </p>
124 <ul> 125 <ul>
125 <li> 126 <li>
126 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li> 127 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
127 <li> 128 <li>
128 A dark green arrow is used for protected inheritance. </li> 129 A dark green arrow is used for protected inheritance. </li>
131 <li> 132 <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 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 <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 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 </ul>
136 </div> 137 </div><!-- contents -->
137 </div> 138 </div>
138 <div id="nav-path" class="navpath"> 139 <div id="nav-path" class="navpath">
139 <ul> 140 <ul>
140 141
141 <li class="footer">Generated on Tue Oct 4 2011 14:38:53 for VampPluginSDK by 142 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
142 <a href="http://www.doxygen.org/index.html"> 143 <a href="http://www.doxygen.org/index.html">
143 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> 144 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
144 </ul> 145 </ul>
145 </div> 146 </div>
146 147
147 148
148 </body> 149 </body>