service/protocol-plugin/lib/cpluff/doc/reference/c-api/graph_legend.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>C-Pluff C API: Graph Legend</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.1 -->
   8 <div class="tabs">
   9   <ul>
  10     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11     <li><a href="modules.html"><span>Modules</span></a></li>
  12     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  13     <li><a href="files.html"><span>Files</span></a></li>
  14     <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  15   </ul></div>
  16 <h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
  17 Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
  18 <span class="keyword">class </span>Invisible { };
  19 <span class="comment"></span>
  20 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
  21 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
  22
  23 <span class="comment">/* Class not documented with doxygen comments */</span>
  24 <span class="keyword">class </span>Undocumented { };
  25 <span class="comment"></span>
  26 <span class="comment">/*! Class that is inherited using public inheritance */</span>
  27 <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
  28 <span class="comment"></span>
  29 <span class="comment">/*! A template class */</span>
  30 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
  31 <span class="comment"></span>
  32 <span class="comment">/*! Class that is inherited using protected inheritance */</span>
  33 <span class="keyword">class </span>ProtectedBase { };
  34 <span class="comment"></span>
  35 <span class="comment">/*! Class that is inherited using private inheritance */</span>
  36 <span class="keyword">class </span>PrivateBase { };
  37 <span class="comment"></span>
  38 <span class="comment">/*! Class that is used by the Inherited class */</span>
  39 <span class="keyword">class </span>Used { };
  40 <span class="comment"></span>
  41 <span class="comment">/*! Super class that inherits a number of other classes */</span>
  42 <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
  43                   <span class="keyword">protected</span> ProtectedBase,
  44                   <span class="keyword">private</span> PrivateBase,
  45                   <span class="keyword">public</span> Undocumented
  46                   <span class="keyword">public</span> Templ&lt;int&gt;
  47 {
  48   <span class="keyword">private</span>:
  49     Used *m_usedClass;
  50 };
  51 </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>
  52 <center><div align="center">
  53 <img src="graph_legend.png" alt="graph_legend.png">
  54 </div>
  55 </center> <p>
  56 The boxes in the above graph have the following meaning: <ul>
  57 <li>
  58 A filled black box represents the struct or class for which the graph is generated. </li>
  59 <li>
  60 A box with a black border denotes a documented struct or class. </li>
  61 <li>
  62 A box with a grey border denotes an undocumented struct or class. </li>
  63 <li>
  64 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>
  65 </ul>
  66 The arrows have the following meaning: <ul>
  67 <li>
  68 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
  69 <li>
  70 A dark green arrow is used for protected inheritance. </li>
  71 <li>
  72 A dark red arrow is used for private inheritance. </li>
  73 <li>
  74 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>
  75 <li>
  76 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>
  77 </ul>
  78 <hr size="1">
  79 <p class="footer">
  80 <a href="http://www.c-pluff.org/">C-Pluff</a>, a plug-in framework for C<br>
  81 Copyright 2007 <a href="http://www.jlehtinen.net/">Johannes Lehtinen</a>
  82 </p>
  83 <p class="generated-by">
  84 Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1
  85 </p>
  86 </body>
  87 </html>