better override lightSamplesInsist (-samples +1, +2, +3, +4 skip the samples preset...
[divverent/netradiant.git] / Doxygen_files / example / graph_legend.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html>
3 <head>
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">
7 </head>
8 <body bgcolor="black">
9
10 <div align="center">
11
12 <table cellpadding="0" cellspacing="0" border="0" width="94%">
13  <tr>
14   <td>
15    <img src="../images/top-title.gif" alt="" width="254" height="92">
16   </td>
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">
19   </td>
20   <td align="left">
21    <img src="../images/top-right.gif" alt="" width="12" height="92">
22   </td>
23  </tr>
24 </table>
25
26 <table cellpadding="0" cellspacing="0" border="0" width="95%">
27  <tr>
28   <td valign="top" align="left">
29    <img src="../images/body-upper-left.gif" alt="" width="19" height="12">
30   </td>
31   <td valign="top" background="../images/body-upper-tile.gif">
32    <img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
33   </td>
34   <td valign="top" align="right">
35    <img src="../images/body-upper-right.gif" alt="" width="19" height="12">
36   </td>
37         </tr>
38         <tr>
39    <td background="../images/body-left-tile.gif" height="100%">&nbsp;</td>
40    <td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
41    <br><hr>
42    
43         <center>
44         <table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
45
46 <!-- ----------------- End Header ----------------- -->
47
48                 
49 <!-- Generated by Doxygen 1.2.8.1 -->
50 <center>
51 <a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; </center>
52 <hr><h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.
53 <p>
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 { };
59
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
80 {
81   <font class="keyword">private</font>:
82     Used *m_usedClass;
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:
84 <p>
85 <center>
86 <img src="graph_legend.gif"></center>
87  
88 <p>
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>
93  
94                 <!--  ---------------- Start Footer ----------------- -->
95                 </td></tr></table>
96                 </center>
97
98                 <br><br>
99                 <div align="center">
100                         <table width="95%" cellpadding="1" cellspacing="0">
101                         <tr>
102                                 <td width="50%">
103                                         <i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
104                                 </td>
105                                 <td align="right">
106                                         <a href="mailto:ttimo@idsoftware.com">
107                                                 <i>ttimo@idsoftware.com</i>
108                                         </a>
109                                 </td>
110                         </tr>
111                         </table>
112                 </div>
113                 
114                 <br>
115                 <br>
116                 </div></td>
117          <td background="../images/body-right-tile.gif" height="100%">&nbsp;</td>
118         </tr>
119         <tr>
120                 <td valign="top" align="left">
121                  <img src="../images/body-lower-left.gif" alt="" width="19" height="12">
122                 </td>
123                 <td valign="top" background="../images/body-lower-tile.gif">
124                  <img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
125                 </td>
126                 <td valign="top" align="right">
127                  <img src="../images/body-lower-right.gif" alt="" width="19" height="12">
128                 </td>
129         </tr>
130 </table>
131
132 </td>
133 <td valign="top">
134 </td>
135 </tr>
136 </table>
137
138 </div>
139
140 </body>
141 </html>