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>Heimdalntlmlibrary: Graph Legend</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
8 <a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
10 <!-- end of header marker -->
11 <!-- Generated by Doxygen 1.5.6 -->
12 <div class="navigation" id="top">
15 <li><a href="index.html"><span>Main Page</span></a></li>
16 <li><a href="modules.html"><span>Modules</span></a></li>
17 <li><a href="annotated.html"><span>Data Structures</span></a></li>
18 <li><a href="examples.html"><span>Examples</span></a></li>
22 <div class="contents">
23 <h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
24 Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
25 <span class="keyword">class </span>Invisible { };
26 <span class="comment"></span>
27 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
28 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
30 <span class="comment">/* Class not documented with doxygen comments */</span>
31 <span class="keyword">class </span>Undocumented { };
32 <span class="comment"></span>
33 <span class="comment">/*! Class that is inherited using public inheritance */</span>
34 <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
35 <span class="comment"></span>
36 <span class="comment">/*! A template class */</span>
37 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };
38 <span class="comment"></span>
39 <span class="comment">/*! Class that is inherited using protected inheritance */</span>
40 <span class="keyword">class </span>ProtectedBase { };
41 <span class="comment"></span>
42 <span class="comment">/*! Class that is inherited using private inheritance */</span>
43 <span class="keyword">class </span>PrivateBase { };
44 <span class="comment"></span>
45 <span class="comment">/*! Class that is used by the Inherited class */</span>
46 <span class="keyword">class </span>Used { };
47 <span class="comment"></span>
48 <span class="comment">/*! Super class that inherits a number of other classes */</span>
49 <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
50 <span class="keyword">protected</span> ProtectedBase,
51 <span class="keyword">private</span> PrivateBase,
52 <span class="keyword">public</span> Undocumented,
53 <span class="keyword">public</span> Templ<int>
55 <span class="keyword">private</span>:
58 </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>
59 <center><div align="center">
60 <img src="graph_legend.png" alt="graph_legend.png">
63 The boxes in the above graph have the following meaning: <ul>
65 A filled gray box represents the struct or class for which the graph is generated. </li>
67 A box with a black border denotes a documented struct or class. </li>
69 A box with a grey border denotes an undocumented struct or class. </li>
71 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>
73 The arrows have the following meaning: <ul>
75 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
77 A dark green arrow is used for protected inheritance. </li>
79 A dark red arrow is used for private inheritance. </li>
81 A 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>
83 A 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>
86 <hr size="1"><address style="text-align: right;"><small>
87 Generated on Wed Jan 11 14:07:51 2012 for Heimdalntlmlibrary 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>