1226031Sstas<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2226031Sstas<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 3226031Sstas<title>HeimdalGSS-APIlibrary: Graph Legend</title> 4226031Sstas<link href="doxygen.css" rel="stylesheet" type="text/css"> 5226031Sstas<link href="tabs.css" rel="stylesheet" type="text/css"> 6226031Sstas</head><body> 7226031Sstas<p> 8226031Sstas<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> 9226031Sstas</p> 10226031Sstas<!-- end of header marker --> 11226031Sstas<!-- Generated by Doxygen 1.5.6 --> 12226031Sstas<div class="navigation" id="top"> 13226031Sstas <div class="tabs"> 14226031Sstas <ul> 15226031Sstas <li><a href="index.html"><span>Main Page</span></a></li> 16226031Sstas <li><a href="pages.html"><span>Related Pages</span></a></li> 17226031Sstas <li><a href="modules.html"><span>Modules</span></a></li> 18226031Sstas </ul> 19226031Sstas </div> 20226031Sstas</div> 21226031Sstas<div class="contents"> 22226031Sstas<h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p> 23226031SstasConsider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span> 24226031Sstas<span class="keyword">class </span>Invisible { }; 25226031Sstas<span class="comment"></span> 26226031Sstas<span class="comment">/*! Truncated class, inheritance relation is hidden */</span> 27226031Sstas<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { }; 28226031Sstas 29226031Sstas<span class="comment">/* Class not documented with doxygen comments */</span> 30226031Sstas<span class="keyword">class </span>Undocumented { }; 31226031Sstas<span class="comment"></span> 32226031Sstas<span class="comment">/*! Class that is inherited using public inheritance */</span> 33226031Sstas<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { }; 34226031Sstas<span class="comment"></span> 35226031Sstas<span class="comment">/*! A template class */</span> 36226031Sstas<span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { }; 37226031Sstas<span class="comment"></span> 38226031Sstas<span class="comment">/*! Class that is inherited using protected inheritance */</span> 39226031Sstas<span class="keyword">class </span>ProtectedBase { }; 40226031Sstas<span class="comment"></span> 41226031Sstas<span class="comment">/*! Class that is inherited using private inheritance */</span> 42226031Sstas<span class="keyword">class </span>PrivateBase { }; 43226031Sstas<span class="comment"></span> 44226031Sstas<span class="comment">/*! Class that is used by the Inherited class */</span> 45226031Sstas<span class="keyword">class </span>Used { }; 46226031Sstas<span class="comment"></span> 47226031Sstas<span class="comment">/*! Super class that inherits a number of other classes */</span> 48226031Sstas<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase, 49226031Sstas <span class="keyword">protected</span> ProtectedBase, 50226031Sstas <span class="keyword">private</span> PrivateBase, 51226031Sstas <span class="keyword">public</span> Undocumented, 52226031Sstas <span class="keyword">public</span> Templ<int> 53226031Sstas{ 54226031Sstas <span class="keyword">private</span>: 55226031Sstas Used *m_usedClass; 56226031Sstas}; 57226031Sstas</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> 58226031Sstas<center><div align="center"> 59226031Sstas<img src="graph_legend.png" alt="graph_legend.png"> 60226031Sstas</div> 61226031Sstas</center> <p> 62226031SstasThe boxes in the above graph have the following meaning: <ul> 63226031Sstas<li> 64226031SstasA filled gray box represents the struct or class for which the graph is generated. </li> 65226031Sstas<li> 66226031SstasA box with a black border denotes a documented struct or class. </li> 67226031Sstas<li> 68226031SstasA box with a grey border denotes an undocumented struct or class. </li> 69226031Sstas<li> 70226031SstasA 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> 71226031Sstas</ul> 72226031SstasThe arrows have the following meaning: <ul> 73226031Sstas<li> 74226031SstasA dark blue arrow is used to visualize a public inheritance relation between two classes. </li> 75226031Sstas<li> 76226031SstasA dark green arrow is used for protected inheritance. </li> 77226031Sstas<li> 78226031SstasA dark red arrow is used for private inheritance. </li> 79226031Sstas<li> 80226031SstasA 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> 81226031Sstas<li> 82226031SstasA 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> 83226031Sstas</ul> 84226031Sstas</div> 85226031Sstas<hr size="1"><address style="text-align: right;"><small> 86234027SstasGenerated 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> 87226031Sstas</body> 88226031Sstas</html> 89
