|
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@3
|
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
Chris@6
|
6 <meta name="generator" content="Doxygen 1.8.13"/>
|
|
Chris@6
|
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
Chris@1
|
8 <title>VampPluginSDK: Graph Legend</title>
|
|
Chris@1
|
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
Chris@6
|
10 <script type="text/javascript" src="jquery.js"></script>
|
|
Chris@6
|
11 <script type="text/javascript" src="dynsections.js"></script>
|
|
Chris@1
|
12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
Chris@1
|
13 <script type="text/javascript" src="resize.js"></script>
|
|
Chris@6
|
14 <script type="text/javascript" src="navtreedata.js"></script>
|
|
Chris@1
|
15 <script type="text/javascript" src="navtree.js"></script>
|
|
Chris@1
|
16 <script type="text/javascript">
|
|
Chris@1
|
17 $(document).ready(initResizable);
|
|
Chris@1
|
18 </script>
|
|
Chris@6
|
19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
Chris@1
|
20 </head>
|
|
Chris@1
|
21 <body>
|
|
Chris@6
|
22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
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@6
|
27 <td id="projectalign" style="padding-left: 0.5em;">
|
|
Chris@1
|
28 <div id="projectname">VampPluginSDK
|
|
Chris@6
|
29  <span id="projectnumber">2.7</span>
|
|
Chris@1
|
30 </div>
|
|
Chris@1
|
31 </td>
|
|
Chris@1
|
32 </tr>
|
|
Chris@1
|
33 </tbody>
|
|
Chris@1
|
34 </table>
|
|
Chris@1
|
35 </div>
|
|
Chris@6
|
36 <!-- end header part -->
|
|
Chris@6
|
37 <!-- Generated by Doxygen 1.8.13 -->
|
|
Chris@6
|
38 <script type="text/javascript" src="menudata.js"></script>
|
|
Chris@6
|
39 <script type="text/javascript" src="menu.js"></script>
|
|
Chris@6
|
40 <script type="text/javascript">
|
|
Chris@6
|
41 $(function() {
|
|
Chris@6
|
42 initMenu('',false,false,'search.php','Search');
|
|
Chris@6
|
43 });
|
|
Chris@6
|
44 </script>
|
|
Chris@6
|
45 <div id="main-nav"></div>
|
|
Chris@6
|
46 </div><!-- top -->
|
|
Chris@1
|
47 <div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
Chris@1
|
48 <div id="nav-tree">
|
|
Chris@1
|
49 <div id="nav-tree-contents">
|
|
Chris@6
|
50 <div id="nav-sync" class="sync"></div>
|
|
Chris@1
|
51 </div>
|
|
Chris@1
|
52 </div>
|
|
Chris@1
|
53 <div id="splitbar" style="-moz-user-select:none;"
|
|
Chris@1
|
54 class="ui-resizable-handle">
|
|
Chris@1
|
55 </div>
|
|
Chris@1
|
56 </div>
|
|
Chris@1
|
57 <script type="text/javascript">
|
|
Chris@6
|
58 $(document).ready(function(){initNavTree('graph_legend.html','');});
|
|
Chris@1
|
59 </script>
|
|
Chris@1
|
60 <div id="doc-content">
|
|
Chris@1
|
61 <div class="header">
|
|
Chris@1
|
62 <div class="headertitle">
|
|
Chris@1
|
63 <div class="title">Graph Legend</div> </div>
|
|
Chris@3
|
64 </div><!--header-->
|
|
Chris@1
|
65 <div class="contents">
|
|
Chris@1
|
66 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
|
|
Chris@6
|
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<class T> 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<int></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>
|
|
Chris@1
|
68 <center><div class="image">
|
|
Chris@6
|
69 <img src="graph_legend.png"/>
|
|
Chris@1
|
70 </div>
|
|
Chris@3
|
71 </center><p>The boxes in the above graph have the following meaning: </p>
|
|
Chris@1
|
72 <ul>
|
|
Chris@1
|
73 <li>
|
|
Chris@1
|
74 A filled gray box represents the struct or class for which the graph is generated. </li>
|
|
Chris@1
|
75 <li>
|
|
Chris@1
|
76 A box with a black border denotes a documented struct or class. </li>
|
|
Chris@1
|
77 <li>
|
|
Chris@6
|
78 A box with a gray border denotes an undocumented struct or class. </li>
|
|
Chris@1
|
79 <li>
|
|
Chris@1
|
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>
|
|
Chris@1
|
81 </ul>
|
|
Chris@3
|
82 <p>The arrows have the following meaning: </p>
|
|
Chris@1
|
83 <ul>
|
|
Chris@1
|
84 <li>
|
|
Chris@1
|
85 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
|
|
Chris@1
|
86 <li>
|
|
Chris@1
|
87 A dark green arrow is used for protected inheritance. </li>
|
|
Chris@1
|
88 <li>
|
|
Chris@1
|
89 A dark red arrow is used for private inheritance. </li>
|
|
Chris@1
|
90 <li>
|
|
Chris@6
|
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>
|
|
Chris@1
|
92 <li>
|
|
Chris@6
|
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>
|
|
Chris@1
|
94 </ul>
|
|
Chris@3
|
95 </div><!-- contents -->
|
|
Chris@6
|
96 </div><!-- doc-content -->
|
|
Chris@6
|
97 <!-- start footer part -->
|
|
Chris@6
|
98 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
Chris@6
|
99 <ul>
|
|
Chris@6
|
100 <li class="footer">Generated by
|
|
Chris@6
|
101 <a href="http://www.doxygen.org/index.html">
|
|
Chris@6
|
102 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
Chris@6
|
103 </ul>
|
|
Chris@1
|
104 </div>
|
|
Chris@1
|
105 </body>
|
|
Chris@1
|
106 </html>
|
