1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
4 <title>IEPairsClassDocumentationExample Doxygen Documentation</title>
5 <link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
6 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
12 <table cellpadding="0" cellspacing="0" border="0" width="94%">
15 <img src="../images/top-title.gif" alt="" width="254" height="92">
17 <td background="../images/top-tile.gif" valign="top" align="right" width="100%">
18 <br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
21 <img src="../images/top-right.gif" alt="" width="12" height="92">
26 <table cellpadding="0" cellspacing="0" border="0" width="95%">
28 <td valign="top" align="left">
29 <img src="../images/body-upper-left.gif" alt="" width="19" height="12">
31 <td valign="top" background="../images/body-upper-tile.gif">
32 <img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
34 <td valign="top" align="right">
35 <img src="../images/body-upper-right.gif" alt="" width="19" height="12">
39 <td background="../images/body-left-tile.gif" height="100%"> </td>
40 <td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
44 <table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
46 <!-- ----------------- End Header ----------------- -->
49 <!-- Generated by Doxygen 1.2.8.1 -->
51 <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
52 <hr><h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.
54 Consider the following example: <div class="fragment"><pre><font class="comment">/*! Invisible class because of truncation */</font>
55 <font class="keyword">class </font>Invisible { };
56 <font class="comment"></font>
57 <font class="comment">/*! Truncated class, inheritance relation is hidden */</font>
58 <font class="keyword">class </font>Truncated : <font class="keyword">public</font> Invisible { };
60 <font class="comment">/* Class not documented with doxygen comments */</font>
61 <font class="keyword">class </font>Undocumented { };
62 <font class="comment"></font>
63 <font class="comment">/*! Class that is inherited using public inheritance */</font>
64 <font class="keyword">class </font>PublicBase : <font class="keyword">public</font> Truncated { };
65 <font class="comment"></font>
66 <font class="comment">/*! Class that is inherited using protected inheritance */</font>
67 <font class="keyword">class </font>ProtectedBase { };
68 <font class="comment"></font>
69 <font class="comment">/*! Class that is inherited using private inheritance */</font>
70 <font class="keyword">class </font>PrivateBase { };
71 <font class="comment"></font>
72 <font class="comment">/*! Class that is used by the Inherited class */</font>
73 <font class="keyword">class </font>Used { };
74 <font class="comment"></font>
75 <font class="comment">/*! Super class that inherits a number of other classes */</font>
76 <font class="keyword">class </font>Inherited : <font class="keyword">public</font> PublicBase,
77 <font class="keyword">protected</font> ProtectedBase,
78 <font class="keyword">private</font> PrivateBase,
79 <font class="keyword">public</font> Undocumented
81 <font class="keyword">private</font>:
83 };</pre></div> If the <code>MAX_DOT_GRAPH_HEIGHT</code> tag in the configuration file is set to 200 this will result in the following graph:
86 <img src="graph_legend.gif"></center>
89 The boxes in the above graph have the following meaning: <ul>
90 <li>A filled black box represents the struct or class for which the graph is generated. <li>A box with a black border denotes a documented struct or class. <li>A box with a grey border denotes an undocumented struct or class. <li>A box with a red border denotes a documented struct or class for which not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.</ul>
91 The arrows have the following meaning: <ul>
92 <li>A dark blue arrow is used to visualize a public inheritance relation between two classes. <li>A dark green arrow is used for protected inheritance. <li>A dark red arrow is used for private inheritance. <li>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. </ul>
94 <!-- ---------------- Start Footer ----------------- -->
100 <table width="95%" cellpadding="1" cellspacing="0">
103 <i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
106 <a href="mailto:ttimo@idsoftware.com">
107 <i>ttimo@idsoftware.com</i>
117 <td background="../images/body-right-tile.gif" height="100%"> </td>
120 <td valign="top" align="left">
121 <img src="../images/body-lower-left.gif" alt="" width="19" height="12">
123 <td valign="top" background="../images/body-lower-tile.gif">
124 <img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
126 <td valign="top" align="right">
127 <img src="../images/body-lower-right.gif" alt="" width="19" height="12">