docs/module-doc/graph_legend.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>Graph Legend</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc3 -->
   7 <center>
   8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</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="globals.html">File Members</a> &nbsp; </center>
   9 <hr><h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
  10 Consider the following example: <div class="fragment"><pre><span class="comment"></span>
  11 <span class="comment">/*! Invisible class because of truncation */</span>
  12 <span class="keyword">class </span>Invisible { };
  13 <span class="comment"></span>
  14 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
  15 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
  16
  17 <span class="comment">/* Class not documented with doxygen comments */</span>
  18 <span class="keyword">class </span>Undocumented { };
  19 <span class="comment"></span>
  20 <span class="comment">/*! Class that is inherited using public inheritance */</span>
  21 <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
  22 <span class="comment"></span>
  23 <span class="comment">/*! A template class */</span>
  24 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
  25 <span class="comment"></span>
  26 <span class="comment">/*! Class that is inherited using protected inheritance */</span>
  27 <span class="keyword">class </span>ProtectedBase { };
  28 <span class="comment"></span>
  29 <span class="comment">/*! Class that is inherited using private inheritance */</span>
  30 <span class="keyword">class </span>PrivateBase { };
  31 <span class="comment"></span>
  32 <span class="comment">/*! Class that is used by the Inherited class */</span>
  33 <span class="keyword">class </span>Used { };
  34 <span class="comment"></span>
  35 <span class="comment">/*! Super class that inherits a number of other classes */</span>
  36 <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
  37                   <span class="keyword">protected</span> ProtectedBase,
  38                   <span class="keyword">private</span> PrivateBase,
  39                   <span class="keyword">public</span> Undocumented
  40                   <span class="keyword">public</span> Templ&lt;int&gt;
  41 {
  42   <span class="keyword">private</span>:
  43     Used *m_usedClass;
  44 };
  45 </pre></div>If the <code>MAX_DOT_GRAPH_HEIGHT</code> tag in the configuration file is set to 240 this will result in the following graph:<p>
  46 <center><div align="center">
  47 <img src="graph_legend.gif" alt="graph_legend.gif">
  48 </div>
  49 </center> <p>
  50 The boxes in the above graph have the following meaning: <ul>
  51 <li>
  52 A filled black box represents the struct or class for which the graph is generated. </li>
  53 <li>
  54 A box with a black border denotes a documented struct or class. </li>
  55 <li>
  56 A box with a grey border denotes an undocumented struct or class. </li>
  57 <li>
  58 A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries. </li>
  59 </ul>
  60 The arrows have the following meaning: <ul>
  61 <li>
  62 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
  63 <li>
  64 A dark green arrow is used for protected inheritance. </li>
  65 <li>
  66 A dark red arrow is used for private inheritance. </li>
  67 <li>
  68 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. </li>
  69 <li>
  70 A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labeled with the template parameters of the instance. </li>
  71 </ul>
  72 <hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:34 2004 for InspIRCd by
  73 <a href="http://www.doxygen.org/index.html">
  74 <img src="doxygen.png" alt="doxygen" align="middle" border=0
  75 width=110 height=53></a>1.3-rc3 </small></address>
  76 </body>
  77 </html>