← Back to branch summary

~ubuntu-branches/ubuntu/saucy/atkmm1.6/saucy-proposed

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2013-05-28 13:04:34 UTC
  • mfrom: (0.1.6 sid)
  • Revision ID: package-import@ubuntu.com-20130528130434-e0esxsm4eo8bn8tf
Tags: 2.22.7-1ubuntu1
https://launchpad.net/bugs/902703
* Resynchronize on Debian, remaining diff
* Convert to multiarch (LP: #902703):
  - Pass --libdir with multiarch path to configure
  - Adjust .install files to refer to /usr/lib subdirs
  - Add multiarch Pre-Depends
  - Bump debhelper and cdbs build-deps for ${misc:Pre-Depends} and
    $(DEB_HOST_MULTIARCH) support, respectively
* debian/compat: update to 9.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/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"/>
 
6
<meta name="generator" content="Doxygen 1.8.3.1"/>
5
7
<title>atkmm: Graph Legend</title>
6
8
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
 
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
9
<script type="text/javascript" src="jquery.js"></script>
 
10
<script type="text/javascript" src="dynsections.js"></script>
 
11
<link href="doxygen.css" rel="stylesheet" type="text/css" />
8
12
</head>
9
13
<body>
10
 
<!-- Generated by Doxygen 1.7.4 -->
11
 
<div id="top">
 
14
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
12
15
<div id="titlearea">
13
16
<table cellspacing="0" cellpadding="0">
14
17
 <tbody>
15
18
 <tr style="height: 56px;">
16
19
  <td style="padding-left: 0.5em;">
17
 
   <div id="projectname">atkmm&#160;<span id="projectnumber">2.22.6</span></div>
 
20
   <div id="projectname">atkmm
 
21
   &#160;<span id="projectnumber">2.22.7</span>
 
22
   </div>
18
23
  </td>
19
24
 </tr>
20
25
 </tbody>
21
26
</table>
22
27
</div>
 
28
<!-- end header part -->
 
29
<!-- Generated by Doxygen 1.8.3.1 -->
23
30
  <div id="navrow1" class="tabs">
24
31
    <ul class="tablist">
25
32
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
29
36
      <li><a href="annotated.html"><span>Classes</span></a></li>
30
37
    </ul>
31
38
  </div>
32
 
</div>
 
39
</div><!-- top -->
33
40
<div class="header">
34
41
  <div class="headertitle">
35
 
<div class="title">Graph Legend</div> </div>
36
 
</div>
 
42
<div class="title">Graph Legend</div>  </div>
 
43
</div><!--header-->
37
44
<div class="contents">
38
45
<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
39
46
<p>Consider the following example: </p>
40
 
<div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
41
 
<span class="keyword">class </span>Invisible { };
42
 
<span class="comment"></span>
43
 
<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
44
 
<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
45
 
 
46
 
<span class="comment">/* Class not documented with doxygen comments */</span>
47
 
<span class="keyword">class </span>Undocumented { };
48
 
<span class="comment"></span>
49
 
<span class="comment">/*! Class that is inherited using public inheritance */</span>
50
 
<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
51
 
<span class="comment"></span>
52
 
<span class="comment">/*! A template class */</span>
53
 
<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
54
 
<span class="comment"></span>
55
 
<span class="comment">/*! Class that is inherited using protected inheritance */</span>
56
 
<span class="keyword">class </span>ProtectedBase { };
57
 
<span class="comment"></span>
58
 
<span class="comment">/*! Class that is inherited using private inheritance */</span>
59
 
<span class="keyword">class </span>PrivateBase { };
60
 
<span class="comment"></span>
61
 
<span class="comment">/*! Class that is used by the Inherited class */</span>
62
 
<span class="keyword">class </span>Used { };
63
 
<span class="comment"></span>
64
 
<span class="comment">/*! Super class that inherits a number of other classes */</span>
65
 
<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
66
 
                  <span class="keyword">protected</span> ProtectedBase,
67
 
                  <span class="keyword">private</span> PrivateBase,
68
 
                  <span class="keyword">public</span> Undocumented,
69
 
                  <span class="keyword">public</span> Templ&lt;int&gt;
70
 
{
71
 
  <span class="keyword">private</span>:
72
 
    Used *m_usedClass;
73
 
};
74
 
</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>
75
82
<center><div class="image">
76
 
<img src="graph_legend.png" alt="graph_legend.png"/>
 
83
<img src="graph_legend.png" />
77
84
</div>
78
 
</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>
79
86
<ul>
80
87
<li>
81
88
A filled gray box represents the struct or class for which the graph is generated. </li>
99
106
<li>
100
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>
101
108
</ul>
102
 
</div>
103
 
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 26 2011 13:06:40 for atkmm by&#160;
104
 
<a href="http://www.doxygen.org/index.html">
105
 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
 
109
</div><!-- contents -->
 
110
<!-- start footer part -->
 
111
<hr class="footer"/><address class="footer"><small>
 
112
Generated on Wed Apr 24 2013 11:08:12 for atkmm by &#160;<a href="http://www.doxygen.org/index.html">
 
113
<img class="footer" src="doxygen.png" alt="doxygen"/>
 
114
</a> 1.8.3.1
 
115
</small></address>
106
116
</body>
107
117
</html>