diff options
Diffstat (limited to 'doc/doxyout/hdb/html/graph_legend.html')
| -rw-r--r-- | doc/doxyout/hdb/html/graph_legend.html | 91 |
1 files changed, 0 insertions, 91 deletions
diff --git a/doc/doxyout/hdb/html/graph_legend.html b/doc/doxyout/hdb/html/graph_legend.html deleted file mode 100644 index 9244e7b7888e..000000000000 --- a/doc/doxyout/hdb/html/graph_legend.html +++ /dev/null @@ -1,91 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> -<title>Graph Legend</title> -<link href="doxygen.css" rel="stylesheet" type="text/css"> -<link href="tabs.css" rel="stylesheet" type="text/css"> -</head><body> -<p> -<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> -</p> -<!-- end of header marker --> -<!-- Generated by Doxygen 1.9.1 --> -<script type="text/javascript" src="menudata.js"></script> -<script type="text/javascript" src="menu.js"></script> -<script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ -$(function() { - initMenu('',false,false,'search.php','Search'); -}); -/* @license-end */</script> -<div id="main-nav"></div> -</div><!-- top --> -<div class="header"> - <div class="headertitle"> -<div class="title">Graph Legend</div> </div> -</div><!--header--> -<div class="contents"> -<p>This page explains how to interpret the graphs that are generated by doxygen.</p> -<p>Consider the following example: </p><div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div> -<div class="line"><span class="keyword">class </span>Invisible { };</div> -<div class="line"><span class="comment"></span> </div> -<div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div> -<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div> -<div class="line"> </div> -<div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div> -<div class="line"><span class="keyword">class </span>Undocumented { };</div> -<div class="line"><span class="comment"></span> </div> -<div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div> -<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div> -<div class="line"><span class="comment"></span> </div> -<div class="line"><span class="comment">/*! A template class */</span></div> -<div class="line"><span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };</div> -<div class="line"><span class="comment"></span> </div> -<div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div> -<div class="line"><span class="keyword">class </span>ProtectedBase { };</div> -<div class="line"><span class="comment"></span> </div> -<div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div> -<div class="line"><span class="keyword">class </span>PrivateBase { };</div> -<div class="line"><span class="comment"></span> </div> -<div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div> -<div class="line"><span class="keyword">class </span>Used { };</div> -<div class="line"><span class="comment"></span> </div> -<div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div> -<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div> -<div class="line"> <span class="keyword">protected</span> ProtectedBase,</div> -<div class="line"> <span class="keyword">private</span> PrivateBase,</div> -<div class="line"> <span class="keyword">public</span> Undocumented,</div> -<div class="line"> <span class="keyword">public</span> Templ<int></div> -<div class="line">{</div> -<div class="line"> <span class="keyword">private</span>:</div> -<div class="line"> Used *m_usedClass;</div> -<div class="line">};</div> -</div><!-- fragment --><p> This will result in the following graph:</p> -<center><img src="graph_legend.png" alt="" class="inline"/></center><p>The boxes in the above graph have the following meaning: </p> -<ul> -<li> -A filled gray box represents the struct or class for which the graph is generated. </li> -<li> -A box with a black border denotes a documented struct or class. </li> -<li> -A box with a gray border denotes an undocumented struct or class. </li> -<li> -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> -</ul> -<p>The arrows have the following meaning: </p> -<ul> -<li> -A dark blue arrow is used to visualize a public inheritance relation between two classes. </li> -<li> -A dark green arrow is used for protected inheritance. </li> -<li> -A dark red arrow is used for private inheritance. </li> -<li> -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> -<li> -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> -</ul> -</div><!-- contents --> -<hr size="1"><address style="text-align: right;"><small> -Generated on Tue Nov 15 2022 14:04:25 for Heimdal hdb library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address> -</body> -</html> |