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