| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
| 3 |
<title>libSPF v1.0: Graph Legend</title> |
| 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
</head><body> |
| 6 |
<!-- Generated by Doxygen 1.3.8 --> |
| 7 |
<div class="qindex"> <form class="search" action="search.php" method="get"> |
| 8 |
<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> |
| 9 |
<h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p> |
| 10 |
Consider the following example: <div class="fragment"><pre><span class="comment">/*! Invisible class because of truncation */</span> |
| 11 |
<span class="keyword">class </span>Invisible { }; |
| 12 |
<span class="comment"></span> |
| 13 |
<span class="comment">/*! Truncated class, inheritance relation is hidden */</span> |
| 14 |
<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { }; |
| 15 |
|
| 16 |
<span class="comment">/* Class not documented with doxygen comments */</span> |
| 17 |
<span class="keyword">class </span>Undocumented { }; |
| 18 |
<span class="comment"></span> |
| 19 |
<span class="comment">/*! Class that is inherited using public inheritance */</span> |
| 20 |
<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { }; |
| 21 |
<span class="comment"></span> |
| 22 |
<span class="comment">/*! A template class */</span> |
| 23 |
<span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { }; |
| 24 |
<span class="comment"></span> |
| 25 |
<span class="comment">/*! Class that is inherited using protected inheritance */</span> |
| 26 |
<span class="keyword">class </span>ProtectedBase { }; |
| 27 |
<span class="comment"></span> |
| 28 |
<span class="comment">/*! Class that is inherited using private inheritance */</span> |
| 29 |
<span class="keyword">class </span>PrivateBase { }; |
| 30 |
<span class="comment"></span> |
| 31 |
<span class="comment">/*! Class that is used by the Inherited class */</span> |
| 32 |
<span class="keyword">class </span>Used { }; |
| 33 |
<span class="comment"></span> |
| 34 |
<span class="comment">/*! Super class that inherits a number of other classes */</span> |
| 35 |
<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase, |
| 36 |
<span class="keyword">protected</span> ProtectedBase, |
| 37 |
<span class="keyword">private</span> PrivateBase, |
| 38 |
<span class="keyword">public</span> Undocumented |
| 39 |
<span class="keyword">public</span> Templ<int> |
| 40 |
{ |
| 41 |
<span class="keyword">private</span>: |
| 42 |
Used *m_usedClass; |
| 43 |
}; |
| 44 |
</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> |
| 45 |
<center><div align="center"> |
| 46 |
<img src="graph_legend.png" alt="graph_legend.png" alt> |
| 47 |
</div> |
| 48 |
</center> <p> |
| 49 |
The boxes in the above graph have the following meaning: <ul> |
| 50 |
<li> |
| 51 |
A filled black box represents the struct or class for which the graph is generated. </li> |
| 52 |
<li> |
| 53 |
A box with a black border denotes a documented struct or class. </li> |
| 54 |
<li> |
| 55 |
A box with a grey border denotes an undocumented struct or class. </li> |
| 56 |
<li> |
| 57 |
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> |
| 58 |
</ul> |
| 59 |
The arrows have the following meaning: <ul> |
| 60 |
<li> |
| 61 |
A dark blue arrow is used to visualize a public inheritance relation between two classes. </li> |
| 62 |
<li> |
| 63 |
A dark green arrow is used for protected inheritance. </li> |
| 64 |
<li> |
| 65 |
A dark red arrow is used for private inheritance. </li> |
| 66 |
<li> |
| 67 |
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> |
| 68 |
<li> |
| 69 |
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> |
| 70 |
</ul> |
| 71 |
<hr size="1"><address style="align: right;"><small>Generated on Thu Sep 16 18:10:52 2004 for libSPF v1.0 by |
| 72 |
<a href="http://www.doxygen.org/index.html"> |
| 73 |
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address> |
| 74 |
</body> |
| 75 |
</html> |
