--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\r
+<html>\r
+<head>\r
+ <title>IEPairsClassDocumentationExample Doxygen Documentation</title>\r
+ <link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">\r
+ <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">\r
+</head>\r
+<body bgcolor="black">\r
+\r
+<div align="center">\r
+\r
+<table cellpadding="0" cellspacing="0" border="0" width="94%">\r
+ <tr>\r
+ <td>\r
+ <img src="../images/top-title.gif" alt="" width="254" height="92">\r
+ </td>\r
+ <td background="../images/top-tile.gif" valign="top" align="right" width="100%">\r
+ <br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">\r
+ </td>\r
+ <td align="left">\r
+ <img src="../images/top-right.gif" alt="" width="12" height="92">\r
+ </td>\r
+ </tr>\r
+</table>\r
+\r
+<table cellpadding="0" cellspacing="0" border="0" width="95%">\r
+ <tr>\r
+ <td valign="top" align="left">\r
+ <img src="../images/body-upper-left.gif" alt="" width="19" height="12">\r
+ </td>\r
+ <td valign="top" background="../images/body-upper-tile.gif">\r
+ <img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">\r
+ </td>\r
+ <td valign="top" align="right">\r
+ <img src="../images/body-upper-right.gif" alt="" width="19" height="12">\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td background="../images/body-left-tile.gif" height="100%"> </td>\r
+ <td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>\r
+ <br><hr>\r
+ \r
+ <center>\r
+ <table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>\r
+\r
+<!-- ----------------- End Header ----------------- -->\r
+\r
+ \r
+<!-- Generated by Doxygen 1.2.8.1 -->\r
+<center>\r
+<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>\r
+<hr><h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.\r
+<p>\r
+ Consider the following example: <div class="fragment"><pre><font class="comment">/*! Invisible class because of truncation */</font>\r
+<font class="keyword">class </font>Invisible { };\r
+<font class="comment"></font>\r
+<font class="comment">/*! Truncated class, inheritance relation is hidden */</font>\r
+<font class="keyword">class </font>Truncated : <font class="keyword">public</font> Invisible { };\r
+\r
+<font class="comment">/* Class not documented with doxygen comments */</font>\r
+<font class="keyword">class </font>Undocumented { };\r
+<font class="comment"></font>\r
+<font class="comment">/*! Class that is inherited using public inheritance */</font>\r
+<font class="keyword">class </font>PublicBase : <font class="keyword">public</font> Truncated { };\r
+<font class="comment"></font>\r
+<font class="comment">/*! Class that is inherited using protected inheritance */</font>\r
+<font class="keyword">class </font>ProtectedBase { };\r
+<font class="comment"></font>\r
+<font class="comment">/*! Class that is inherited using private inheritance */</font>\r
+<font class="keyword">class </font>PrivateBase { };\r
+<font class="comment"></font>\r
+<font class="comment">/*! Class that is used by the Inherited class */</font>\r
+<font class="keyword">class </font>Used { };\r
+<font class="comment"></font>\r
+<font class="comment">/*! Super class that inherits a number of other classes */</font>\r
+<font class="keyword">class </font>Inherited : <font class="keyword">public</font> PublicBase,\r
+ <font class="keyword">protected</font> ProtectedBase,\r
+ <font class="keyword">private</font> PrivateBase,\r
+ <font class="keyword">public</font> Undocumented\r
+{\r
+ <font class="keyword">private</font>:\r
+ Used *m_usedClass;\r
+};</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:\r
+<p>\r
+<center>\r
+<img src="graph_legend.gif"></center>\r
+ \r
+<p>\r
+ The boxes in the above graph have the following meaning: <ul>\r
+ <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>\r
+ The arrows have the following meaning: <ul>\r
+ <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>\r
+ \r
+ <!-- ---------------- Start Footer ----------------- -->\r
+ </td></tr></table>\r
+ </center>\r
+\r
+ <br><br>\r
+ <div align="center">\r
+ <table width="95%" cellpadding="1" cellspacing="0">\r
+ <tr>\r
+ <td width="50%">\r
+ <i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>\r
+ </td>\r
+ <td align="right">\r
+ <a href="mailto:ttimo@idsoftware.com">\r
+ <i>ttimo@idsoftware.com</i>\r
+ </a>\r
+ </td>\r
+ </tr>\r
+ </table>\r
+ </div>\r
+ \r
+ <br>\r
+ <br>\r
+ </div></td>\r
+ <td background="../images/body-right-tile.gif" height="100%"> </td>\r
+ </tr>\r
+ <tr>\r
+ <td valign="top" align="left">\r
+ <img src="../images/body-lower-left.gif" alt="" width="19" height="12">\r
+ </td>\r
+ <td valign="top" background="../images/body-lower-tile.gif">\r
+ <img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">\r
+ </td>\r
+ <td valign="top" align="right">\r
+ <img src="../images/body-lower-right.gif" alt="" width="19" height="12">\r
+ </td>\r
+ </tr>\r
+</table>\r
+\r
+</td>\r
+<td valign="top">\r
+</td>\r
+</tr>\r
+</table>\r
+\r
+</div>\r
+\r
+</body>\r
+</html>\r
projects / xonotic / netradiant.git / blobdiff