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