docs/reference/html/graph_legend.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.9.1"/>
   7 <title>libsigc++: Graph Legend</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td style="padding-left: 0.5em;">
  21    <div id="projectname">libsigc++
  22    &#160;<span id="projectnumber">2.9.2</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.9.1 -->
  31   <div id="navrow1" class="tabs">
  32     <ul class="tablist">
  33       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  34       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  35       <li><a href="modules.html"><span>Modules</span></a></li>
  36       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  37       <li><a href="annotated.html"><span>Classes</span></a></li>
  38     </ul>
  39   </div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="headertitle">
  43 <div class="title">Graph Legend</div>  </div>
  44 </div><!--header-->
  45 <div class="contents">
  46 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
  47 <p>Consider the following example: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;/*! Invisible class because of truncation */</div>
  48 <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;class Invisible { };</div>
  49 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div>
  50 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;/*! Truncated class, inheritance relation is hidden */</div>
  51 <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;class Truncated : public Invisible { };</div>
  52 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div>
  53 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;/* Class not documented with doxygen comments */</div>
  54 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;class Undocumented { };</div>
  55 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div>
  56 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;/*! Class that is inherited using public inheritance */</div>
  57 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;class PublicBase : public Truncated { };</div>
  58 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
  59 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;/*! A template class */</div>
  60 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;template&lt;class T&gt; class Templ { };</div>
  61 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
  62 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;/*! Class that is inherited using protected inheritance */</div>
  63 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;class ProtectedBase { };</div>
  64 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
  65 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;/*! Class that is inherited using private inheritance */</div>
  66 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;class PrivateBase { };</div>
  67 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
  68 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;/*! Class that is used by the Inherited class */</div>
  69 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;class Used { };</div>
  70 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
  71 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;/*! Super class that inherits a number of other classes */</div>
  72 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;class Inherited : public PublicBase,</div>
  73 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;                  protected ProtectedBase,</div>
  74 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;                  private PrivateBase,</div>
  75 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;                  public Undocumented,</div>
  76 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;                  public Templ&lt;int&gt;</div>
  77 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;{</div>
  78 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;  private:</div>
  79 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    Used *m_usedClass;</div>
  80 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;};</div>
  81 </div><!-- fragment --><p> This will result in the following graph:</p>
  82 <center><div class="image">
  83 <img src="graph_legend.png" />
  84 </div>
  85 </center><p>The boxes in the above graph have the following meaning: </p>
  86 <ul>
  87 <li>
  88 A filled gray box represents the struct or class for which the graph is generated. </li>
  89 <li>
  90 A box with a black border denotes a documented struct or class. </li>
  91 <li>
  92 A box with a grey border denotes an undocumented struct or class. </li>
  93 <li>
  94 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>
  95 </ul>
  96 <p>The arrows have the following meaning: </p>
  97 <ul>
  98 <li>
  99 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
 100 <li>
 101 A dark green arrow is used for protected inheritance. </li>
 102 <li>
 103 A dark red arrow is used for private inheritance. </li>
 104 <li>
 105 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>
 106 <li>
 107 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>
 108 </ul>
 109 </div><!-- contents -->
 110 <!-- start footer part -->
 111 <hr class="footer"/><address class="footer"><small>
 112 Generated on Fri Apr 8 2016 10:54:32 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 113 <img class="footer" src="doxygen.png" alt="doxygen"/>
 114 </a> 1.8.9.1
 115 </small></address>
 116 </body>
 117 </html>