Mercurial > hg > vamp-docs

comparison code-docs/graph_legend.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
comparison
equal deleted inserted replaced
5:5c95f546f0b4 6:27319718b1f8
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 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
6 <title>VampPluginSDK: Graph Legend</title> 8 <title>VampPluginSDK: Graph Legend</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="navtree.css" rel="stylesheet" type="text/css"/> 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="resize.js"></script> 13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
13 <script type="text/javascript" src="navtree.js"></script> 15 <script type="text/javascript" src="navtree.js"></script>
14 <script type="text/javascript"> 16 <script type="text/javascript">
15 $(document).ready(initResizable); 17 $(document).ready(initResizable);
16 </script> 18 </script>
17 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
18
19 </head> 20 </head>
20 <body> 21 <body>
21 <div id="top"><!-- do not remove this div! --> 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
22
23
24 <div id="titlearea"> 23 <div id="titlearea">
25 <table cellspacing="0" cellpadding="0"> 24 <table cellspacing="0" cellpadding="0">
26 <tbody> 25 <tbody>
27 <tr style="height: 56px;"> 26 <tr style="height: 56px;">
28 27 <td id="projectalign" style="padding-left: 0.5em;">
29
30 <td style="padding-left: 0.5em;">
31 <div id="projectname">VampPluginSDK 28 <div id="projectname">VampPluginSDK
32 &#160;<span id="projectnumber">2.4</span> 29 &#160;<span id="projectnumber">2.7</span>
33 </div> 30 </div>
34
35 </td> 31 </td>
36
37
38
39 </tr> 32 </tr>
40 </tbody> 33 </tbody>
41 </table> 34 </table>
42 </div> 35 </div>
43 36 <!-- end header part -->
44 <!-- Generated by Doxygen 1.8.0 --> 37 <!-- Generated by Doxygen 1.8.13 -->
45 <div id="navrow1" class="tabs"> 38 <script type="text/javascript" src="menudata.js"></script>
46 <ul class="tablist"> 39 <script type="text/javascript" src="menu.js"></script>
47 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 40 <script type="text/javascript">
48 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 41 $(function() {
49 <li><a href="annotated.html"><span>Classes</span></a></li> 42 initMenu('',false,false,'search.php','Search');
50 <li><a href="files.html"><span>Files</span></a></li> 43 });
51 <li><a href="dirs.html"><span>Directories</span></a></li> 44 </script>
52 </ul> 45 <div id="main-nav"></div>
53 </div> 46 </div><!-- top -->
54 </div>
55 <div id="side-nav" class="ui-resizable side-nav-resizable"> 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
56 <div id="nav-tree"> 48 <div id="nav-tree">
57 <div id="nav-tree-contents"> 49 <div id="nav-tree-contents">
50 <div id="nav-sync" class="sync"></div>
58 </div> 51 </div>
59 </div> 52 </div>
60 <div id="splitbar" style="-moz-user-select:none;" 53 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle"> 54 class="ui-resizable-handle">
62 </div> 55 </div>
63 </div> 56 </div>
64 <script type="text/javascript"> 57 <script type="text/javascript">
65 initNavTree('graph_legend.html',''); 58 $(document).ready(function(){initNavTree('graph_legend.html','');});
66 </script> 59 </script>
67 <div id="doc-content"> 60 <div id="doc-content">
68 <div class="header"> 61 <div class="header">
69 <div class="headertitle"> 62 <div class="headertitle">
70 <div class="title">Graph Legend</div> </div> 63 <div class="title">Graph Legend</div> </div>
71 </div><!--header--> 64 </div><!--header-->
72 <div class="contents"> 65 <div class="contents">
73 <p>This page explains how to interpret the graphs that are generated by doxygen.</p> 66 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
74 <p>Consider the following example: </p> 67 <p>Consider the following example: </p><div class="fragment"><div class="line">/*! Invisible class because of truncation */</div><div class="line">class Invisible { };</div><div class="line"></div><div class="line">/*! Truncated class, inheritance relation is hidden */</div><div class="line">class Truncated : public Invisible { };</div><div class="line"></div><div class="line">/* Class not documented with doxygen comments */</div><div class="line">class Undocumented { };</div><div class="line"></div><div class="line">/*! Class that is inherited using public inheritance */</div><div class="line">class PublicBase : public Truncated { };</div><div class="line"></div><div class="line">/*! A template class */</div><div class="line">template&lt;class T&gt; class Templ { };</div><div class="line"></div><div class="line">/*! Class that is inherited using protected inheritance */</div><div class="line">class ProtectedBase { };</div><div class="line"></div><div class="line">/*! Class that is inherited using private inheritance */</div><div class="line">class PrivateBase { };</div><div class="line"></div><div class="line">/*! Class that is used by the Inherited class */</div><div class="line">class Used { };</div><div class="line"></div><div class="line">/*! Super class that inherits a number of other classes */</div><div class="line">class Inherited : public PublicBase,</div><div class="line"> protected ProtectedBase,</div><div class="line"> private PrivateBase,</div><div class="line"> public Undocumented,</div><div class="line"> public Templ&lt;int&gt;</div><div class="line">{</div><div class="line"> private:</div><div class="line"> Used *m_usedClass;</div><div class="line">};</div></div><!-- fragment --><p> This will result in the following graph:</p>
75 <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
76 <span class="keyword">class </span>Invisible { };
77 <span class="comment"></span>
78 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
79 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
80
81 <span class="comment">/* Class not documented with doxygen comments */</span>
82 <span class="keyword">class </span>Undocumented { };
83 <span class="comment"></span>
84 <span class="comment">/*! Class that is inherited using public inheritance */</span>
85 <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
86 <span class="comment"></span>
87 <span class="comment">/*! A template class */</span>
88 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
89 <span class="comment"></span>
90 <span class="comment">/*! Class that is inherited using protected inheritance */</span>
91 <span class="keyword">class </span>ProtectedBase { };
92 <span class="comment"></span>
93 <span class="comment">/*! Class that is inherited using private inheritance */</span>
94 <span class="keyword">class </span>PrivateBase { };
95 <span class="comment"></span>
96 <span class="comment">/*! Class that is used by the Inherited class */</span>
97 <span class="keyword">class </span>Used { };
98 <span class="comment"></span>
99 <span class="comment">/*! Super class that inherits a number of other classes */</span>
100 <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
101 <span class="keyword">protected</span> ProtectedBase,
102 <span class="keyword">private</span> PrivateBase,
103 <span class="keyword">public</span> Undocumented,
104 <span class="keyword">public</span> Templ&lt;int&gt;
105 {
106 <span class="keyword">private</span>:
107 Used *m_usedClass;
108 };
109 </pre></div><p> This will result in the following graph:</p>
110 <center><div class="image"> 68 <center><div class="image">
111 <img src="graph_legend.png" /> 69 <img src="graph_legend.png"/>
112 </div> 70 </div>
113 </center><p>The boxes in the above graph have the following meaning: </p> 71 </center><p>The boxes in the above graph have the following meaning: </p>
114 <ul> 72 <ul>
115 <li> 73 <li>
116 A filled gray box represents the struct or class for which the graph is generated. </li> 74 A filled gray box represents the struct or class for which the graph is generated. </li>
117 <li> 75 <li>
118 A box with a black border denotes a documented struct or class. </li> 76 A box with a black border denotes a documented struct or class. </li>
119 <li> 77 <li>
120 A box with a grey border denotes an undocumented struct or class. </li> 78 A box with a gray border denotes an undocumented struct or class. </li>
121 <li> 79 <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> 80 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>
123 </ul> 81 </ul>
124 <p>The arrows have the following meaning: </p> 82 <p>The arrows have the following meaning: </p>
125 <ul> 83 <ul>
128 <li> 86 <li>
129 A dark green arrow is used for protected inheritance. </li> 87 A dark green arrow is used for protected inheritance. </li>
130 <li> 88 <li>
131 A dark red arrow is used for private inheritance. </li> 89 A dark red arrow is used for private inheritance. </li>
132 <li> 90 <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> 91 A purple dashed arrow is used if a class is contained or used by another class. The arrow is labelled with the variable(s) through which the pointed class or struct is accessible. </li>
134 <li> 92 <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> 93 A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labelled with the template parameters of the instance. </li>
136 </ul> 94 </ul>
137 </div><!-- contents --> 95 </div><!-- contents -->
96 </div><!-- doc-content -->
97 <!-- start footer part -->
98 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
99 <ul>
100 <li class="footer">Generated by
101 <a href="http://www.doxygen.org/index.html">
102 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
103 </ul>
138 </div> 104 </div>
139 <div id="nav-path" class="navpath">
140 <ul>
141
142 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
143 <a href="http://www.doxygen.org/index.html">
144 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
145 </ul>
146 </div>
147
148
149 </body> 105 </body>
150 </html> 106 </html>