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