← Back to branch summary

~ubuntu-branches/ubuntu/trusty/glibmm2.4/trusty

« back to all changes in this revision

Viewing changes to docs/reference/html/graph_legend.html

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2012-09-12 09:46:50 UTC
  • mfrom: (1.2.76)
  • Revision ID: package-import@ubuntu.com-20120912094650-36b1cyv60x66yv8m
Tags: 2.33.12-0ubuntu1
* New upstream bugfix release
* debian/control:
  - Bump build-depends on libglib2.0-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/graph_legend.html
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
5
6
<title>glibmm: Graph Legend</title>
6
 
 
7
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
8
 
<link href="/home/murrayc/checkouts/gnome30/glibmm/docs/doxygen.css" rel="stylesheet" type="text/css" />
9
 
 
10
 
 
11
 
 
 
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" />
12
11
</head>
13
12
<body>
14
 
<div id="top"><!-- do not remove this div! -->
15
 
 
16
 
 
 
13
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
17
14
<div id="titlearea">
18
15
<table cellspacing="0" cellpadding="0">
19
16
 <tbody>
20
17
 <tr style="height: 56px;">
21
 
  
22
 
  
23
18
  <td style="padding-left: 0.5em;">
24
19
   <div id="projectname">glibmm
25
 
   &#160;<span id="projectnumber">2.33.3</span>
 
20
   &#160;<span id="projectnumber">2.33.12</span>
26
21
   </div>
27
 
   
28
22
  </td>
29
 
  
30
 
  
31
 
  
32
23
 </tr>
33
24
 </tbody>
34
25
</table>
35
26
</div>
36
 
 
37
 
<!-- Generated by Doxygen 1.7.5 -->
 
27
<!-- end header part -->
 
28
<!-- Generated by Doxygen 1.8.1.1 -->
38
29
  <div id="navrow1" class="tabs">
39
30
    <ul class="tablist">
40
31
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
45
36
      <li><a href="examples.html"><span>Examples</span></a></li>
46
37
    </ul>
47
38
  </div>
48
 
</div>
 
39
</div><!-- top -->
49
40
<div class="header">
50
41
  <div class="headertitle">
51
42
<div class="title">Graph Legend</div> </div>
52
 
</div>
 
43
</div><!--header-->
53
44
<div class="contents">
54
45
<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
55
46
<p>Consider the following example: </p>
56
 
<div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
57
 
<span class="keyword">class </span>Invisible { };
58
 
<span class="comment"></span>
59
 
<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
60
 
<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
61
 
 
62
 
<span class="comment">/* Class not documented with doxygen comments */</span>
63
 
<span class="keyword">class </span>Undocumented { };
64
 
<span class="comment"></span>
65
 
<span class="comment">/*! Class that is inherited using public inheritance */</span>
66
 
<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
67
 
<span class="comment"></span>
68
 
<span class="comment">/*! A template class */</span>
69
 
<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
70
 
<span class="comment"></span>
71
 
<span class="comment">/*! Class that is inherited using protected inheritance */</span>
72
 
<span class="keyword">class </span>ProtectedBase { };
73
 
<span class="comment"></span>
74
 
<span class="comment">/*! Class that is inherited using private inheritance */</span>
75
 
<span class="keyword">class </span>PrivateBase { };
76
 
<span class="comment"></span>
77
 
<span class="comment">/*! Class that is used by the Inherited class */</span>
78
 
<span class="keyword">class </span>Used { };
79
 
<span class="comment"></span>
80
 
<span class="comment">/*! Super class that inherits a number of other classes */</span>
81
 
<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
82
 
                  <span class="keyword">protected</span> ProtectedBase,
83
 
                  <span class="keyword">private</span> PrivateBase,
84
 
                  <span class="keyword">public</span> Undocumented,
85
 
                  <span class="keyword">public</span> Templ&lt;int&gt;
86
 
{
87
 
  <span class="keyword">private</span>:
88
 
    Used *m_usedClass;
89
 
};
90
 
</pre></div><p> This will result in the following graph:</p>
 
47
<div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
 
48
<div class="line"><span class="keyword">class </span>Invisible { };</div>
 
49
<div class="line"><span class="comment"></span></div>
 
50
<div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
 
51
<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
 
52
<div class="line"></div>
 
53
<div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
 
54
<div class="line"><span class="keyword">class </span>Undocumented { };</div>
 
55
<div class="line"><span class="comment"></span></div>
 
56
<div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
 
57
<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
 
58
<div class="line"><span class="comment"></span></div>
 
59
<div class="line"><span class="comment">/*! A template class */</span></div>
 
60
<div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>
 
61
<div class="line"><span class="comment"></span></div>
 
62
<div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
 
63
<div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
 
64
<div class="line"><span class="comment"></span></div>
 
65
<div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
 
66
<div class="line"><span class="keyword">class </span>PrivateBase { };</div>
 
67
<div class="line"><span class="comment"></span></div>
 
68
<div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
 
69
<div class="line"><span class="keyword">class </span>Used { };</div>
 
70
<div class="line"><span class="comment"></span></div>
 
71
<div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
 
72
<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
 
73
<div class="line"> <span class="keyword">protected</span> ProtectedBase,</div>
 
74
<div class="line"> <span class="keyword">private</span> PrivateBase,</div>
 
75
<div class="line"> <span class="keyword">public</span> Undocumented,</div>
 
76
<div class="line"> <span class="keyword">public</span> Templ&lt;int&gt;</div>
 
77
<div class="line">{</div>
 
78
<div class="line"> <span class="keyword">private</span>:</div>
 
79
<div class="line"> Used *m_usedClass;</div>
 
80
<div class="line">};</div>
 
81
</div><!-- fragment --><p> This will result in the following graph:</p>
91
82
<center><div class="image">
92
 
<img src="graph_legend.png" alt="graph_legend.png"/>
 
83
<img src="graph_legend.png" />
93
84
</div>
94
 
</center> <p>The boxes in the above graph have the following meaning: </p>
 
85
</center><p>The boxes in the above graph have the following meaning: </p>
95
86
<ul>
96
87
<li>
97
88
A filled gray box represents the struct or class for which the graph is generated. </li>
115
106
<li>
116
107
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>
117
108
</ul>
118
 
</div>
119
 
 
120
 
 
 
109
</div><!-- contents -->
 
110
<!-- start footer part -->
121
111
<hr class="footer"/><address class="footer"><small>
122
 
Generated on Tue Jul 10 2012 11:54:24 for glibmm by &#160;<a href="http://www.doxygen.org/index.html">
 
112
Generated on Fri Sep 7 2012 11:00:18 for glibmm by &#160;<a href="http://www.doxygen.org/index.html">
123
113
<img class="footer" src="doxygen.png" alt="doxygen"/>
124
 
</a> 1.7.5
 
114
</a> 1.8.1.1
125
115
</small></address>
126
 
 
127
116
</body>
128
117
</html>