Mercurial > hg > vamp-website

comparison code-doc/graph_legend.html @ 50:8260c0f4e05b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs for 2.3
author cannam
date Tue, 04 Oct 2011 13:47:23 +0000
parents 0976232e353b
children
comparison
equal deleted inserted replaced
49:f75f330aa130 50:8260c0f4e05b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
3 <title>VampPluginSDK: Graph Legend</title> 5 <title>VampPluginSDK: Graph Legend</title>
4 <link href="tabs.css" rel="stylesheet" type="text/css"> 6
5 <link href="doxygen.css" rel="stylesheet" type="text/css"> 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
6 </head><body> 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
7 <!-- Generated by Doxygen 1.5.8 --> 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
8 <div class="navigation" id="top"> 10 <script type="text/javascript" src="jquery.js"></script>
9 <div class="tabs"> 11 <script type="text/javascript" src="resize.js"></script>
10 <ul> 12 <script type="text/javascript" src="navtree.js"></script>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 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>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13 <li><a href="annotated.html"><span>Classes</span></a></li> 48 <li><a href="annotated.html"><span>Classes</span></a></li>
14 <li><a href="files.html"><span>Files</span></a></li> 49 <li><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li> 50 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul> 51 </ul>
17 </div> 52 </div>
18 </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>
19 <div class="contents"> 71 <div class="contents">
20 <h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p> 72 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
21 Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span> 73 <p>Consider the following example: </p>
74 <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
22 <span class="keyword">class </span>Invisible { }; 75 <span class="keyword">class </span>Invisible { };
23 <span class="comment"></span> 76 <span class="comment"></span>
24 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span> 77 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
25 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { }; 78 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
26 79
50 <span class="keyword">public</span> Templ&lt;int&gt; 103 <span class="keyword">public</span> Templ&lt;int&gt;
51 { 104 {
52 <span class="keyword">private</span>: 105 <span class="keyword">private</span>:
53 Used *m_usedClass; 106 Used *m_usedClass;
54 }; 107 };
55 </pre></div> This will result in the following graph:<p> 108 </pre></div><p> This will result in the following graph:</p>
56 <center><div align="center"> 109 <center><div class="image">
57 <img src="graph_legend.png" alt="graph_legend.png"> 110 <img src="graph_legend.png" alt="graph_legend.png"/>
58 </div> 111 </div>
59 </center> <p> 112 </center> <p>The boxes in the above graph have the following meaning: </p>
60 The boxes in the above graph have the following meaning: <ul> 113 <ul>
61 <li> 114 <li>
62 A filled gray box represents the struct or class for which the graph is generated. </li> 115 A filled gray box represents the struct or class for which the graph is generated. </li>
63 <li> 116 <li>
64 A box with a black border denotes a documented struct or class. </li> 117 A box with a black border denotes a documented struct or class. </li>
65 <li> 118 <li>
66 A box with a grey border denotes an undocumented struct or class. </li> 119 A box with a grey border denotes an undocumented struct or class. </li>
67 <li> 120 <li>
68 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> 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>
69 </ul> 122 </ul>
70 The arrows have the following meaning: <ul> 123 <p>The arrows have the following meaning: </p>
124 <ul>
71 <li> 125 <li>
72 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li> 126 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
73 <li> 127 <li>
74 A dark green arrow is used for protected inheritance. </li> 128 A dark green arrow is used for protected inheritance. </li>
75 <li> 129 <li>
78 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> 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>
79 <li> 133 <li>
80 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> 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>
81 </ul> 135 </ul>
82 </div> 136 </div>
83 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp; 137 </div>
84 <a href="http://www.doxygen.org/index.html"> 138 <div id="nav-path" class="navpath">
85 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 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
86 </body> 148 </body>
87 </html> 149 </html>