|
cannam@0
|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
cannam@0
|
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
cannam@0
|
3 <title>VampPluginSDK: Graph Legend</title>
|
|
cannam@0
|
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
cannam@0
|
5 <link href="tabs.css" rel="stylesheet" type="text/css">
|
|
cannam@0
|
6 </head><body>
|
|
cannam@0
|
7 <!-- Generated by Doxygen 1.5.5 -->
|
|
cannam@0
|
8 <div class="navigation" id="top">
|
|
cannam@0
|
9 <div class="tabs">
|
|
cannam@0
|
10 <ul>
|
|
cannam@0
|
11 <li><a href="main.html"><span>Main Page</span></a></li>
|
|
cannam@0
|
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
cannam@0
|
13 <li><a href="annotated.html"><span>Classes</span></a></li>
|
|
cannam@0
|
14 <li><a href="files.html"><span>Files</span></a></li>
|
|
cannam@0
|
15 <li><a href="dirs.html"><span>Directories</span></a></li>
|
|
cannam@0
|
16 </ul>
|
|
cannam@0
|
17 </div>
|
|
cannam@0
|
18 </div>
|
|
cannam@0
|
19 <div class="contents">
|
|
cannam@0
|
20 <h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
|
|
cannam@0
|
21 Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
|
|
cannam@0
|
22 <span class="keyword">class </span>Invisible { };
|
|
cannam@0
|
23 <span class="comment"></span>
|
|
cannam@0
|
24 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
|
|
cannam@0
|
25 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
|
|
cannam@0
|
26
|
|
cannam@0
|
27 <span class="comment">/* Class not documented with doxygen comments */</span>
|
|
cannam@0
|
28 <span class="keyword">class </span>Undocumented { };
|
|
cannam@0
|
29 <span class="comment"></span>
|
|
cannam@0
|
30 <span class="comment">/*! Class that is inherited using public inheritance */</span>
|
|
cannam@0
|
31 <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
|
|
cannam@0
|
32 <span class="comment"></span>
|
|
cannam@0
|
33 <span class="comment">/*! A template class */</span>
|
|
cannam@0
|
34 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };
|
|
cannam@0
|
35 <span class="comment"></span>
|
|
cannam@0
|
36 <span class="comment">/*! Class that is inherited using protected inheritance */</span>
|
|
cannam@0
|
37 <span class="keyword">class </span>ProtectedBase { };
|
|
cannam@0
|
38 <span class="comment"></span>
|
|
cannam@0
|
39 <span class="comment">/*! Class that is inherited using private inheritance */</span>
|
|
cannam@0
|
40 <span class="keyword">class </span>PrivateBase { };
|
|
cannam@0
|
41 <span class="comment"></span>
|
|
cannam@0
|
42 <span class="comment">/*! Class that is used by the Inherited class */</span>
|
|
cannam@0
|
43 <span class="keyword">class </span>Used { };
|
|
cannam@0
|
44 <span class="comment"></span>
|
|
cannam@0
|
45 <span class="comment">/*! Super class that inherits a number of other classes */</span>
|
|
cannam@0
|
46 <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
|
|
cannam@0
|
47 <span class="keyword">protected</span> ProtectedBase,
|
|
cannam@0
|
48 <span class="keyword">private</span> PrivateBase,
|
|
cannam@0
|
49 <span class="keyword">public</span> Undocumented,
|
|
cannam@0
|
50 <span class="keyword">public</span> Templ<int>
|
|
cannam@0
|
51 {
|
|
cannam@0
|
52 <span class="keyword">private</span>:
|
|
cannam@0
|
53 Used *m_usedClass;
|
|
cannam@0
|
54 };
|
|
cannam@0
|
55 </pre></div> If the <code>MAX_DOT_GRAPH_HEIGHT</code> tag in the configuration file is set to 240 this will result in the following graph:<p>
|
|
cannam@0
|
56 <center><div align="center">
|
|
cannam@0
|
57 <img src="graph_legend.png" alt="graph_legend.png">
|
|
cannam@0
|
58 </div>
|
|
cannam@0
|
59 </center> <p>
|
|
cannam@0
|
60 The boxes in the above graph have the following meaning: <ul>
|
|
cannam@0
|
61 <li>
|
|
cannam@0
|
62 A filled gray box represents the struct or class for which the graph is generated. </li>
|
|
cannam@0
|
63 <li>
|
|
cannam@0
|
64 A box with a black border denotes a documented struct or class. </li>
|
|
cannam@0
|
65 <li>
|
|
cannam@0
|
66 A box with a grey border denotes an undocumented struct or class. </li>
|
|
cannam@0
|
67 <li>
|
|
cannam@0
|
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>
|
|
cannam@0
|
69 </ul>
|
|
cannam@0
|
70 The arrows have the following meaning: <ul>
|
|
cannam@0
|
71 <li>
|
|
cannam@0
|
72 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
|
|
cannam@0
|
73 <li>
|
|
cannam@0
|
74 A dark green arrow is used for protected inheritance. </li>
|
|
cannam@0
|
75 <li>
|
|
cannam@0
|
76 A dark red arrow is used for private inheritance. </li>
|
|
cannam@0
|
77 <li>
|
|
cannam@0
|
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>
|
|
cannam@0
|
79 <li>
|
|
cannam@0
|
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>
|
|
cannam@0
|
81 </ul>
|
|
cannam@0
|
82 </div>
|
|
cannam@0
|
83 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:11 2008 for VampPluginSDK by
|
|
cannam@0
|
84 <a href="http://www.doxygen.org/index.html">
|
|
cannam@0
|
85 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
|
|
cannam@0
|
86 </body>
|
|
cannam@0
|
87 </html>
|
