git repos / PlatformFolders

blame: html/doxygen/4.2.0/graph_legend.html

normal view · raw

d359b830 Poul Sander 2022-02-06 17:49 1 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
d359b830 Poul Sander 2022-02-06 17:49 2 
<html xmlns="http://www.w3.org/1999/xhtml">
d359b830 Poul Sander 2022-02-06 17:49 3 
<head>
d359b830 Poul Sander 2022-02-06 17:49 4 
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
d359b830 Poul Sander 2022-02-06 17:49 5 
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
d359b830 Poul Sander 2022-02-06 17:49 6 
<meta name="generator" content="Doxygen 1.9.1"/>
d359b830 Poul Sander 2022-02-06 17:49 7 
<meta name="viewport" content="width=device-width, initial-scale=1"/>
d359b830 Poul Sander 2022-02-06 17:49 8 
<title>My Project: Graph Legend</title>
d359b830 Poul Sander 2022-02-06 17:49 9 
<link href="tabs.css" rel="stylesheet" type="text/css"/>
d359b830 Poul Sander 2022-02-06 17:49 10 
<script type="text/javascript" src="jquery.js"></script>
d359b830 Poul Sander 2022-02-06 17:49 11 
<script type="text/javascript" src="dynsections.js"></script>
d359b830 Poul Sander 2022-02-06 17:49 12 
<link href="search/search.css" rel="stylesheet" type="text/css"/>
d359b830 Poul Sander 2022-02-06 17:49 13 
<script type="text/javascript" src="search/searchdata.js"></script>
d359b830 Poul Sander 2022-02-06 17:49 14 
<script type="text/javascript" src="search/search.js"></script>
d359b830 Poul Sander 2022-02-06 17:49 15 
<link href="doxygen.css" rel="stylesheet" type="text/css" />
d359b830 Poul Sander 2022-02-06 17:49 16 
</head>
d359b830 Poul Sander 2022-02-06 17:49 17 
<body>
d359b830 Poul Sander 2022-02-06 17:49 18 
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
d359b830 Poul Sander 2022-02-06 17:49 19 
<div id="titlearea">
d359b830 Poul Sander 2022-02-06 17:49 20 
<table cellspacing="0" cellpadding="0">
d359b830 Poul Sander 2022-02-06 17:49 21 
 <tbody>
d359b830 Poul Sander 2022-02-06 17:49 22 
 <tr style="height: 56px;">
d359b830 Poul Sander 2022-02-06 17:49 23 
  <td id="projectalign" style="padding-left: 0.5em;">
d359b830 Poul Sander 2022-02-06 17:49 24 
   <div id="projectname">My Project
d359b830 Poul Sander 2022-02-06 17:49 25 
   </div>
d359b830 Poul Sander 2022-02-06 17:49 26 
  </td>
d359b830 Poul Sander 2022-02-06 17:49 27 
 </tr>
d359b830 Poul Sander 2022-02-06 17:49 28 
 </tbody>
d359b830 Poul Sander 2022-02-06 17:49 29 
</table>
d359b830 Poul Sander 2022-02-06 17:49 30 
</div>
d359b830 Poul Sander 2022-02-06 17:49 31 
<!-- end header part -->
d359b830 Poul Sander 2022-02-06 17:49 32 
<!-- Generated by Doxygen 1.9.1 -->
d359b830 Poul Sander 2022-02-06 17:49 33 
<script type="text/javascript">
d359b830 Poul Sander 2022-02-06 17:49 34 
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
d359b830 Poul Sander 2022-02-06 17:49 35 
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
d359b830 Poul Sander 2022-02-06 17:49 36 
/* @license-end */
d359b830 Poul Sander 2022-02-06 17:49 37 
</script>
d359b830 Poul Sander 2022-02-06 17:49 38 
<script type="text/javascript" src="menudata.js"></script>
d359b830 Poul Sander 2022-02-06 17:49 39 
<script type="text/javascript" src="menu.js"></script>
d359b830 Poul Sander 2022-02-06 17:49 40 
<script type="text/javascript">
d359b830 Poul Sander 2022-02-06 17:49 41 
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
d359b830 Poul Sander 2022-02-06 17:49 42 
$(function() {
d359b830 Poul Sander 2022-02-06 17:49 43 
  initMenu('',true,false,'search.php','Search');
d359b830 Poul Sander 2022-02-06 17:49 44 
  $(document).ready(function() { init_search(); });
d359b830 Poul Sander 2022-02-06 17:49 45 
});
d359b830 Poul Sander 2022-02-06 17:49 46 
/* @license-end */</script>
d359b830 Poul Sander 2022-02-06 17:49 47 
<div id="main-nav"></div>
d359b830 Poul Sander 2022-02-06 17:49 48 
</div><!-- top -->
d359b830 Poul Sander 2022-02-06 17:49 49 
<!-- window showing the filter options -->
d359b830 Poul Sander 2022-02-06 17:49 50 
<div id="MSearchSelectWindow"
d359b830 Poul Sander 2022-02-06 17:49 51 
     onmouseover="return searchBox.OnSearchSelectShow()"
d359b830 Poul Sander 2022-02-06 17:49 52 
     onmouseout="return searchBox.OnSearchSelectHide()"
d359b830 Poul Sander 2022-02-06 17:49 53 
     onkeydown="return searchBox.OnSearchSelectKey(event)">
d359b830 Poul Sander 2022-02-06 17:49 54 
</div>
d359b830 Poul Sander 2022-02-06 17:49 55 






d359b830
Poul Sander
2022-02-06 17:49
56

<!-- iframe showing the search results (closed by default) -->






d359b830
Poul Sander
2022-02-06 17:49
57

<div id="MSearchResultsWindow">






d359b830
Poul Sander
2022-02-06 17:49
58

<iframe src="javascript:void(0)" frameborder="0" 






d359b830
Poul Sander
2022-02-06 17:49
59

        name="MSearchResults" id="MSearchResults">






d359b830
Poul Sander
2022-02-06 17:49
60

</iframe>






d359b830
Poul Sander
2022-02-06 17:49
61

</div>






d359b830
Poul Sander
2022-02-06 17:49
62







d359b830
Poul Sander
2022-02-06 17:49
63

<div class="header">






d359b830
Poul Sander
2022-02-06 17:49
64

  <div class="headertitle">






d359b830
Poul Sander
2022-02-06 17:49
65

<div class="title">Graph Legend</div>  </div>






d359b830
Poul Sander
2022-02-06 17:49
66

</div><!--header-->






d359b830
Poul Sander
2022-02-06 17:49
67

<div class="contents">






d359b830
Poul Sander
2022-02-06 17:49
68

<p>This page explains how to interpret the graphs that are generated by doxygen.</p>






d359b830
Poul Sander
2022-02-06 17:49
69

<p>Consider the following example: </p><div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>






d359b830
Poul Sander
2022-02-06 17:49
70

<div class="line"><span class="keyword">class </span>Invisible { };</div>






d359b830
Poul Sander
2022-02-06 17:49
71

<div class="line"><span class="comment"></span> </div>






d359b830
Poul Sander
2022-02-06 17:49
72

<div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>






d359b830
Poul Sander
2022-02-06 17:49
73

<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>






d359b830
Poul Sander
2022-02-06 17:49
74

<div class="line"> </div>






d359b830
Poul Sander
2022-02-06 17:49
75

<div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>






d359b830
Poul Sander
2022-02-06 17:49
76

<div class="line"><span class="keyword">class </span>Undocumented { };</div>






d359b830
Poul Sander
2022-02-06 17:49
77

<div class="line"><span class="comment"></span> </div>






d359b830
Poul Sander
2022-02-06 17:49
78

<div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>






d359b830
Poul Sander
2022-02-06 17:49
79

<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>






d359b830
Poul Sander
2022-02-06 17:49
80

<div class="line"><span class="comment"></span> </div>






d359b830
Poul Sander
2022-02-06 17:49
81

<div class="line"><span class="comment">/*! A template class */</span></div>






d359b830
Poul Sander
2022-02-06 17:49
82

<div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>






d359b830
Poul Sander
2022-02-06 17:49
83

<div class="line"><span class="comment"></span> </div>






d359b830
Poul Sander
2022-02-06 17:49
84

<div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>






d359b830
Poul Sander
2022-02-06 17:49
85

<div class="line"><span class="keyword">class </span>ProtectedBase { };</div>






d359b830
Poul Sander
2022-02-06 17:49
86

<div class="line"><span class="comment"></span> </div>






d359b830
Poul Sander
2022-02-06 17:49
87

<div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>






d359b830
Poul Sander
2022-02-06 17:49
88

<div class="line"><span class="keyword">class </span>PrivateBase { };</div>






d359b830
Poul Sander
2022-02-06 17:49
89

<div class="line"><span class="comment"></span> </div>






d359b830
Poul Sander
2022-02-06 17:49
90

<div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>






d359b830
Poul Sander
2022-02-06 17:49
91

<div class="line"><span class="keyword">class </span>Used { };</div>






d359b830
Poul Sander
2022-02-06 17:49
92

<div class="line"><span class="comment"></span> </div>






d359b830
Poul Sander
2022-02-06 17:49
93

<div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>






d359b830
Poul Sander
2022-02-06 17:49
94

<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>






d359b830
Poul Sander
2022-02-06 17:49
95

<div class="line">                  <span class="keyword">protected</span> ProtectedBase,</div>






d359b830
Poul Sander
2022-02-06 17:49
96

<div class="line">                  <span class="keyword">private</span> PrivateBase,</div>






d359b830
Poul Sander
2022-02-06 17:49
97

<div class="line">                  <span class="keyword">public</span> Undocumented,</div>






d359b830
Poul Sander
2022-02-06 17:49
98

<div class="line">                  <span class="keyword">public</span> Templ&lt;int&gt;</div>






d359b830
Poul Sander
2022-02-06 17:49
99

<div class="line">{</div>






d359b830
Poul Sander
2022-02-06 17:49
100

<div class="line">  <span class="keyword">private</span>:</div>






d359b830
Poul Sander
2022-02-06 17:49
101

<div class="line">    Used *m_usedClass;</div>






d359b830
Poul Sander
2022-02-06 17:49
102

<div class="line">};</div>






d359b830
Poul Sander
2022-02-06 17:49
103

</div><!-- fragment --><p> This will result in the following graph:</p>






d359b830
Poul Sander
2022-02-06 17:49
104

<center><img src="graph_legend.png" alt="" class="inline"/></center><p>The boxes in the above graph have the following meaning: </p>






d359b830
Poul Sander
2022-02-06 17:49
105

<ul>






d359b830
Poul Sander
2022-02-06 17:49
106

<li>






d359b830
Poul Sander
2022-02-06 17:49
107

A filled gray box represents the struct or class for which the graph is generated. </li>






d359b830
Poul Sander
2022-02-06 17:49
108

<li>






d359b830
Poul Sander
2022-02-06 17:49
109

A box with a black border denotes a documented struct or class. </li>






d359b830
Poul Sander
2022-02-06 17:49
110

<li>






d359b830
Poul Sander
2022-02-06 17:49
111

A box with a gray border denotes an undocumented struct or class. </li>






d359b830
Poul Sander
2022-02-06 17:49
112

<li>






d359b830
Poul Sander
2022-02-06 17:49
113

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>






d359b830
Poul Sander
2022-02-06 17:49
114

</ul>






d359b830
Poul Sander
2022-02-06 17:49
115

<p>The arrows have the following meaning: </p>






d359b830
Poul Sander
2022-02-06 17:49
116

<ul>






d359b830
Poul Sander
2022-02-06 17:49
117

<li>






d359b830
Poul Sander
2022-02-06 17:49
118

A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>






d359b830
Poul Sander
2022-02-06 17:49
119

<li>






d359b830
Poul Sander
2022-02-06 17:49
120

A dark green arrow is used for protected inheritance. </li>






d359b830
Poul Sander
2022-02-06 17:49
121

<li>






d359b830
Poul Sander
2022-02-06 17:49
122

A dark red arrow is used for private inheritance. </li>






d359b830
Poul Sander
2022-02-06 17:49
123

<li>






d359b830
Poul Sander
2022-02-06 17:49
124

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>






d359b830
Poul Sander
2022-02-06 17:49
125

<li>






d359b830
Poul Sander
2022-02-06 17:49
126

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>






d359b830
Poul Sander
2022-02-06 17:49
127

</ul>






d359b830
Poul Sander
2022-02-06 17:49
128

</div><!-- contents -->






d359b830
Poul Sander
2022-02-06 17:49
129

<!-- start footer part -->






d359b830
Poul Sander
2022-02-06 17:49
130

<hr class="footer"/><address class="footer"><small>






d359b830
Poul Sander
2022-02-06 17:49
131

Generated 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






d359b830
Poul Sander
2022-02-06 17:49
132

</small></address>






d359b830
Poul Sander
2022-02-06 17:49
133

</body>






d359b830
Poul Sander
2022-02-06 17:49
134

</html>








1970-01-01 00:00
135