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">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
<title>gtkmm: Graph Legend</title>
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
8
<script type="text/javascript" src="jquery.js"></script>
9
<script type="text/javascript" src="dynsections.js"></script>
10
<link href="doxygen.css" rel="stylesheet" type="text/css" />
13
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15
<table cellspacing="0" cellpadding="0">
17
<tr style="height: 56px;">
18
<td style="padding-left: 0.5em;">
19
<div id="projectname">gtkmm
20
 <span id="projectnumber">3.5.13</span>
27
<!-- end header part -->
28
<!-- Generated by Doxygen 1.8.1.1 -->
29
<div id="navrow1" class="tabs">
31
<li><a href="index.html"><span>Main Page</span></a></li>
32
<li><a href="pages.html"><span>Related Pages</span></a></li>
33
<li><a href="modules.html"><span>Modules</span></a></li>
34
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
35
<li><a href="annotated.html"><span>Classes</span></a></li>
40
<div class="headertitle">
41
<div class="title">Graph Legend</div> </div>
43
<div class="contents">
44
<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
45
<p>Consider the following example: </p>
46
<div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
47
<div class="line"><span class="keyword">class </span>Invisible { };</div>
48
<div class="line"><span class="comment"></span></div>
49
<div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
50
<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
51
<div class="line"></div>
52
<div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
53
<div class="line"><span class="keyword">class </span>Undocumented { };</div>
54
<div class="line"><span class="comment"></span></div>
55
<div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
56
<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
57
<div class="line"><span class="comment"></span></div>
58
<div class="line"><span class="comment">/*! A template class */</span></div>
59
<div class="line"><span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };</div>
60
<div class="line"><span class="comment"></span></div>
61
<div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
62
<div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
63
<div class="line"><span class="comment"></span></div>
64
<div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
65
<div class="line"><span class="keyword">class </span>PrivateBase { };</div>
66
<div class="line"><span class="comment"></span></div>
67
<div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
68
<div class="line"><span class="keyword">class </span>Used { };</div>
69
<div class="line"><span class="comment"></span></div>
70
<div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
71
<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
72
<div class="line"> <span class="keyword">protected</span> ProtectedBase,</div>
73
<div class="line"> <span class="keyword">private</span> PrivateBase,</div>
74
<div class="line"> <span class="keyword">public</span> Undocumented,</div>
75
<div class="line"> <span class="keyword">public</span> Templ<int></div>
76
<div class="line">{</div>
77
<div class="line"> <span class="keyword">private</span>:</div>
78
<div class="line"> Used *m_usedClass;</div>
79
<div class="line">};</div>
80
</div><!-- fragment --><p> This will result in the following graph:</p>
81
<center><div class="image">
82
<img src="graph_legend.png" />
84
</center><p>The boxes in the above graph have the following meaning: </p>
87
A filled gray box represents the struct or class for which the graph is generated. </li>
89
A box with a black border denotes a documented struct or class. </li>
91
A box with a grey border denotes an undocumented struct or class. </li>
93
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>
95
<p>The arrows have the following meaning: </p>
98
A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
100
A dark green arrow is used for protected inheritance. </li>
102
A dark red arrow is used for private inheritance. </li>
104
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>
106
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>
108
</div><!-- contents -->
109
<!-- start footer part -->
110
<hr class="footer"/><address class="footer"><small>
111
Generated by  <a href="http://www.doxygen.org/index.html">
112
<img class="footer" src="doxygen.png" alt="doxygen"/>
added
removed
docs/reference/html/graph_legend.html
