Doxygen_files/example/graph_legend.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\r
   2 <html>\r
   3 <head>\r
   4         <title>IEPairsClassDocumentationExample  Doxygen Documentation</title>\r
   5         <link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">\r
   6         <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">\r
   7 </head>\r
   8 <body bgcolor="black">\r
   9 \r
  10 <div align="center">\r
  11 \r
  12 <table cellpadding="0" cellspacing="0" border="0" width="94%">\r
  13  <tr>\r
  14   <td>\r
  15    <img src="../images/top-title.gif" alt="" width="254" height="92">\r
  16   </td>\r
  17   <td background="../images/top-tile.gif" valign="top" align="right" width="100%">\r
  18    <br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">\r
  19   </td>\r
  20   <td align="left">\r
  21    <img src="../images/top-right.gif" alt="" width="12" height="92">\r
  22   </td>\r
  23  </tr>\r
  24 </table>\r
  25 \r
  26 <table cellpadding="0" cellspacing="0" border="0" width="95%">\r
  27  <tr>\r
  28   <td valign="top" align="left">\r
  29    <img src="../images/body-upper-left.gif" alt="" width="19" height="12">\r
  30   </td>\r
  31   <td valign="top" background="../images/body-upper-tile.gif">\r
  32    <img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">\r
  33   </td>\r
  34   <td valign="top" align="right">\r
  35    <img src="../images/body-upper-right.gif" alt="" width="19" height="12">\r
  36   </td>\r
  37         </tr>\r
  38         <tr>\r
  39    <td background="../images/body-left-tile.gif" height="100%">&nbsp;</td>\r
  40    <td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>\r
  41    <br><hr>\r
  42    \r
  43         <center>\r
  44         <table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>\r
  45 \r
  46 <!-- ----------------- End Header ----------------- -->\r
  47 \r
  48                 \r
  49 <!-- Generated by Doxygen 1.2.8.1 -->\r
  50 <center>\r
  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>\r
  52 <hr><h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.\r
  53 <p>\r
  54  Consider the following example: <div class="fragment"><pre><font class="comment">/*! Invisible class because of truncation */</font>\r
  55 <font class="keyword">class </font>Invisible { };\r
  56 <font class="comment"></font>\r
  57 <font class="comment">/*! Truncated class, inheritance relation is hidden */</font>\r
  58 <font class="keyword">class </font>Truncated : <font class="keyword">public</font> Invisible { };\r
  59 \r
  60 <font class="comment">/* Class not documented with doxygen comments */</font>\r
  61 <font class="keyword">class </font>Undocumented { };\r
  62 <font class="comment"></font>\r
  63 <font class="comment">/*! Class that is inherited using public inheritance */</font>\r
  64 <font class="keyword">class </font>PublicBase : <font class="keyword">public</font> Truncated { };\r
  65 <font class="comment"></font>\r
  66 <font class="comment">/*! Class that is inherited using protected inheritance */</font>\r
  67 <font class="keyword">class </font>ProtectedBase { };\r
  68 <font class="comment"></font>\r
  69 <font class="comment">/*! Class that is inherited using private inheritance */</font>\r
  70 <font class="keyword">class </font>PrivateBase { };\r
  71 <font class="comment"></font>\r
  72 <font class="comment">/*! Class that is used by the Inherited class */</font>\r
  73 <font class="keyword">class </font>Used { };\r
  74 <font class="comment"></font>\r
  75 <font class="comment">/*! Super class that inherits a number of other classes */</font>\r
  76 <font class="keyword">class </font>Inherited : <font class="keyword">public</font> PublicBase,\r
  77                   <font class="keyword">protected</font> ProtectedBase,\r
  78                   <font class="keyword">private</font> PrivateBase,\r
  79                   <font class="keyword">public</font> Undocumented\r
  80 {\r
  81   <font class="keyword">private</font>:\r
  82     Used *m_usedClass;\r
  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:\r
  84 <p>\r
  85 <center>\r
  86 <img src="graph_legend.gif"></center>\r
  87  \r
  88 <p>\r
  89  The boxes in the above graph have the following meaning: <ul>\r
  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>\r
  91  The arrows have the following meaning: <ul>\r
  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>\r
  93  \r
  94                 <!--  ---------------- Start Footer ----------------- -->\r
  95                 </td></tr></table>\r
  96                 </center>\r
  97 \r
  98                 <br><br>\r
  99                 <div align="center">\r
 100                         <table width="95%" cellpadding="1" cellspacing="0">\r
 101                         <tr>\r
 102                                 <td width="50%">\r
 103                                         <i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>\r
 104                                 </td>\r
 105                                 <td align="right">\r
 106                                         <a href="mailto:ttimo@idsoftware.com">\r
 107                                                 <i>ttimo@idsoftware.com</i>\r
 108                                         </a>\r
 109                                 </td>\r
 110                         </tr>\r
 111                         </table>\r
 112                 </div>\r
 113                 \r
 114                 <br>\r
 115                 <br>\r
 116                 </div></td>\r
 117          <td background="../images/body-right-tile.gif" height="100%">&nbsp;</td>\r
 118         </tr>\r
 119         <tr>\r
 120                 <td valign="top" align="left">\r
 121                  <img src="../images/body-lower-left.gif" alt="" width="19" height="12">\r
 122                 </td>\r
 123                 <td valign="top" background="../images/body-lower-tile.gif">\r
 124                  <img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">\r
 125                 </td>\r
 126                 <td valign="top" align="right">\r
 127                  <img src="../images/body-lower-right.gif" alt="" width="19" height="12">\r
 128                 </td>\r
 129         </tr>\r
 130 </table>\r
 131 \r
 132 </td>\r
 133 <td valign="top">\r
 134 </td>\r
 135 </tr>\r
 136 </table>\r
 137 \r
 138 </div>\r
 139 \r
 140 </body>\r
 141 </html>\r