1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 3<title>HeimdalGSS-APIlibrary: Graph Legend</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5<link href="tabs.css" rel="stylesheet" type="text/css"> 6</head><body> 7<p> 8<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> 9</p> 10<!-- end of header marker --> 11<!-- Generated by Doxygen 1.5.6 --> 12<div class="navigation" id="top"> 13 <div class="tabs"> 14 <ul> 15 <li><a href="index.html"><span>Main Page</span></a></li> 16 <li><a href="pages.html"><span>Related Pages</span></a></li> 17 <li><a href="modules.html"><span>Modules</span></a></li> 18 </ul> 19 </div> 20</div> 21<div class="contents"> 22<h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p> 23Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span> 24<span class="keyword">class </span>Invisible { }; 25<span class="comment"></span> 26<span class="comment">/*! Truncated class, inheritance relation is hidden */</span> 27<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { }; 28 29<span class="comment">/* Class not documented with doxygen comments */</span> 30<span class="keyword">class </span>Undocumented { }; 31<span class="comment"></span> 32<span class="comment">/*! Class that is inherited using public inheritance */</span> 33<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { }; 34<span class="comment"></span> 35<span class="comment">/*! A template class */</span> 36<span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { }; 37<span class="comment"></span> 38<span class="comment">/*! Class that is inherited using protected inheritance */</span> 39<span class="keyword">class </span>ProtectedBase { }; 40<span class="comment"></span> 41<span class="comment">/*! Class that is inherited using private inheritance */</span> 42<span class="keyword">class </span>PrivateBase { }; 43<span class="comment"></span> 44<span class="comment">/*! Class that is used by the Inherited class */</span> 45<span class="keyword">class </span>Used { }; 46<span class="comment"></span> 47<span class="comment">/*! Super class that inherits a number of other classes */</span> 48<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase, 49 <span class="keyword">protected</span> ProtectedBase, 50 <span class="keyword">private</span> PrivateBase, 51 <span class="keyword">public</span> Undocumented, 52 <span class="keyword">public</span> Templ<int> 53{ 54 <span class="keyword">private</span>: 55 Used *m_usedClass; 56}; 57</pre></div> If the <code>MAX_DOT_GRAPH_HEIGHT</code> tag in the configuration file is set to 240 this will result in the following graph:<p> 58<center><div align="center"> 59<img src="graph_legend.png" alt="graph_legend.png"> 60</div> 61</center> <p> 62The boxes in the above graph have the following meaning: <ul> 63<li> 64A filled gray box represents the struct or class for which the graph is generated. </li> 65<li> 66A box with a black border denotes a documented struct or class. </li> 67<li> 68A box with a grey border denotes an undocumented struct or class. </li> 69<li> 70A 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> 71</ul> 72The arrows have the following meaning: <ul> 73<li> 74A dark blue arrow is used to visualize a public inheritance relation between two classes. </li> 75<li> 76A dark green arrow is used for protected inheritance. </li> 77<li> 78A dark red arrow is used for private inheritance. </li> 79<li> 80A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible. </li> 81<li> 82A 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> 83</ul> 84</div> 85<hr size="1"><address style="text-align: right;"><small> 86Generated on Wed Jan 11 14:07:44 2012 for HeimdalGSS-APIlibrary by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address> 87</body> 88</html> 89
