git.maemo.org Git - tpsession/blob - www/doxygen/graph_legend.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html
   3     PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6   <title>tpsession: Graph Legend</title>
   7   <link href="doxygen.css" rel="stylesheet" type="text/css" />
   8 </head>
   9 <body>
  10 <table border="0" cellpadding="0" cellspacing="0" width="100%">
  11 <tr>
  12 <td width="1">&nbsp;&nbsp;</td>
  13 <td class="postheader" valign="center">
  14 <a href="index.html">
  15 <font color="#004faf">Home</font></a>&nbsp;&middot;
  16 <a href="classes.html">
  17 <font color="#004faf">All Classes</font></a>&nbsp;&middot;
  18 <a href="namespaces.html">
  19 <font color="#004faf">All Namespaces</font></a>&nbsp;&middot;
  20 <a href="modules.html">
  21 <font color="#004faf">Modules</font></a>&nbsp;&middot;
  22 <a href="functions.html">
  23 <font color="#004faf">Functions</font></a>&nbsp;&middot;
  24 <a href="files.html">
  25 <font color="#004faf">Files</font></a>
  26 </td>
  27 </tr>
  28 </table>
  29 </body>
  30 </html>
  31 <!-- Generated by Doxygen 1.5.6 -->
  32 <div class="contents">
  33 <h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
  34 Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
  35 <span class="keyword">class </span>Invisible { };
  36 <span class="comment"></span>
  37 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
  38 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
  39
  40 <span class="comment">/* Class not documented with doxygen comments */</span>
  41 <span class="keyword">class </span>Undocumented { };
  42 <span class="comment"></span>
  43 <span class="comment">/*! Class that is inherited using public inheritance */</span>
  44 <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
  45 <span class="comment"></span>
  46 <span class="comment">/*! A template class */</span>
  47 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
  48 <span class="comment"></span>
  49 <span class="comment">/*! Class that is inherited using protected inheritance */</span>
  50 <span class="keyword">class </span>ProtectedBase { };
  51 <span class="comment"></span>
  52 <span class="comment">/*! Class that is inherited using private inheritance */</span>
  53 <span class="keyword">class </span>PrivateBase { };
  54 <span class="comment"></span>
  55 <span class="comment">/*! Class that is used by the Inherited class */</span>
  56 <span class="keyword">class </span>Used { };
  57 <span class="comment"></span>
  58 <span class="comment">/*! Super class that inherits a number of other classes */</span>
  59 <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
  60                   <span class="keyword">protected</span> ProtectedBase,
  61                   <span class="keyword">private</span> PrivateBase,
  62                   <span class="keyword">public</span> Undocumented,
  63                   <span class="keyword">public</span> Templ&lt;int&gt;
  64 {
  65   <span class="keyword">private</span>:
  66     Used *m_usedClass;
  67 };
  68 </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>
  69 <center><div align="center">
  70 <img src="graph_legend.png" alt="graph_legend.png">
  71 </div>
  72 </center> <p>
  73 The boxes in the above graph have the following meaning: <ul>
  74 <li>
  75 A filled gray box represents the struct or class for which the graph is generated. </li>
  76 <li>
  77 A box with a black border denotes a documented struct or class. </li>
  78 <li>
  79 A box with a grey border denotes an undocumented struct or class. </li>
  80 <li>
  81 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>
  82 </ul>
  83 The arrows have the following meaning: <ul>
  84 <li>
  85 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
  86 <li>
  87 A dark green arrow is used for protected inheritance. </li>
  88 <li>
  89 A dark red arrow is used for private inheritance. </li>
  90 <li>
  91 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>
  92 <li>
  93 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>
  94 </ul>
  95 </div>
  96 <p /><address><hr /><div align="center">
  97 <table width="100%" cellspacing="0" border="0"><tr class="address">
  98 <td width="30%">Copyright &copy; 2010 Nokia Corporation</td>
  99 <td width="30%" align="right"><div align="right">TpSession </div></td>
 100 </tr></table></div></address>
 101 </body>
 102 </html>