]> git.tdb.fi Git - ext/sigc++-2.0.git/blob - untracked/docs/reference/html/graph_legend.html
Import libsigc++ 2.10.8 sources
[ext/sigc++-2.0.git] / untracked / docs / reference / html / graph_legend.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
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.9.1"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>libsigc++: Graph Legend</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
14 </head>
15 <body>
16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
17 <div id="titlearea">
18 <table cellspacing="0" cellpadding="0">
19  <tbody>
20  <tr style="height: 56px;">
21   <td id="projectalign" style="padding-left: 0.5em;">
22    <div id="projectname">libsigc++
23    &#160;<span id="projectnumber">2.10.8</span>
24    </div>
25   </td>
26  </tr>
27  </tbody>
28 </table>
29 </div>
30 <!-- end header part -->
31 <!-- Generated by Doxygen 1.9.1 -->
32 <script type="text/javascript" src="menudata.js"></script>
33 <script type="text/javascript" src="menu.js"></script>
34 <script type="text/javascript">
35 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
36 $(function() {
37   initMenu('',false,false,'search.php','Search');
38 });
39 /* @license-end */</script>
40 <div id="main-nav"></div>
41 </div><!-- top -->
42 <div class="header">
43   <div class="headertitle">
44 <div class="title">Graph Legend</div>  </div>
45 </div><!--header-->
46 <div class="contents">
47 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
48 <p>Consider the following example: </p><div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
49 <div class="line"><span class="keyword">class </span>Invisible { };</div>
50 <div class="line"><span class="comment"></span> </div>
51 <div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
52 <div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
53 <div class="line"> </div>
54 <div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
55 <div class="line"><span class="keyword">class </span>Undocumented { };</div>
56 <div class="line"><span class="comment"></span> </div>
57 <div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
58 <div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
59 <div class="line"><span class="comment"></span> </div>
60 <div class="line"><span class="comment">/*! A template class */</span></div>
61 <div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>
62 <div class="line"><span class="comment"></span> </div>
63 <div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
64 <div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
65 <div class="line"><span class="comment"></span> </div>
66 <div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
67 <div class="line"><span class="keyword">class </span>PrivateBase { };</div>
68 <div class="line"><span class="comment"></span> </div>
69 <div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
70 <div class="line"><span class="keyword">class </span>Used { };</div>
71 <div class="line"><span class="comment"></span> </div>
72 <div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
73 <div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
74 <div class="line">                  <span class="keyword">protected</span> ProtectedBase,</div>
75 <div class="line">                  <span class="keyword">private</span> PrivateBase,</div>
76 <div class="line">                  <span class="keyword">public</span> Undocumented,</div>
77 <div class="line">                  <span class="keyword">public</span> Templ&lt;int&gt;</div>
78 <div class="line">{</div>
79 <div class="line">  <span class="keyword">private</span>:</div>
80 <div class="line">    Used *m_usedClass;</div>
81 <div class="line">};</div>
82 </div><!-- fragment --><p> This will result in the following graph:</p>
83 <center><img src="graph_legend.png" alt="" class="inline"/></center><p>The boxes in the above graph have the following meaning: </p>
84 <ul>
85 <li>
86 A filled gray box represents the struct or class for which the graph is generated. </li>
87 <li>
88 A box with a black border denotes a documented struct or class. </li>
89 <li>
90 A box with a gray border denotes an undocumented struct or class. </li>
91 <li>
92 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>
93 </ul>
94 <p>The arrows have the following meaning: </p>
95 <ul>
96 <li>
97 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
98 <li>
99 A dark green arrow is used for protected inheritance. </li>
100 <li>
101 A dark red arrow is used for private inheritance. </li>
102 <li>
103 A purple dashed arrow is used if a class is contained or used by another class. The arrow is labelled with the variable(s) through which the pointed class or struct is accessible. </li>
104 <li>
105 A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labelled with the template parameters of the instance. </li>
106 </ul>
107 </div><!-- contents -->
108 <!-- start footer part -->
109 <hr class="footer"/><address class="footer"><small>
110 Generated on Fri Feb 11 2022 15:40:59 for libsigc++ by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
111 </small></address>
112 </body>
113 </html>