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