vnfs/VES5.0/doxygen-1.8.12/html/examples/diagrams/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.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>Diagrams: Graph Legend</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.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 id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">Diagrams
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.12 -->
  30 <script type="text/javascript" src="menudata.js"></script>
  31 <script type="text/javascript" src="menu.js"></script>
  32 <script type="text/javascript">
  33 $(function() {
  34   initMenu('',false,false,'search.php','Search');
  35 });
  36 </script>
  37 <div id="main-nav"></div>
  38 </div><!-- top -->
  39 <div class="header">
  40   <div class="headertitle">
  41 <div class="title">Graph Legend</div>  </div>
  42 </div><!--header-->
  43 <div class="contents">
  44 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
  45 <p>Consider the following example: </p><div class="fragment"><div class="line">/*! Invisible class because of truncation */</div><div class="line">class Invisible { };</div><div class="line"></div><div class="line">/*! Truncated class, inheritance relation is hidden */</div><div class="line">class Truncated : public Invisible { };</div><div class="line"></div><div class="line">/* Class not documented with doxygen comments */</div><div class="line">class Undocumented { };</div><div class="line"></div><div class="line">/*! Class that is inherited using public inheritance */</div><div class="line">class PublicBase : public Truncated { };</div><div class="line"></div><div class="line">/*! A template class */</div><div class="line">template&lt;class T&gt; class Templ { };</div><div class="line"></div><div class="line">/*! Class that is inherited using protected inheritance */</div><div class="line">class ProtectedBase { };</div><div class="line"></div><div class="line">/*! Class that is inherited using private inheritance */</div><div class="line">class PrivateBase { };</div><div class="line"></div><div class="line">/*! Class that is used by the Inherited class */</div><div class="line">class Used { };</div><div class="line"></div><div class="line">/*! Super class that inherits a number of other classes */</div><div class="line">class Inherited : public PublicBase,</div><div class="line">                  protected ProtectedBase,</div><div class="line">                  private PrivateBase,</div><div class="line">                  public Undocumented,</div><div class="line">                  public Templ&lt;int&gt;</div><div class="line">{</div><div class="line">  private:</div><div class="line">    Used *m_usedClass;</div><div class="line">};</div></div><!-- fragment --><p> This will result in the following graph:</p>
  46 <center><div class="image">
  47 <img src="graph_legend.png"/>
  48 </div>
  49 </center><p>The boxes in the above graph have the following meaning: </p>
  50 <ul>
  51 <li>
  52 A filled gray 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 gray 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 <p>The arrows have the following meaning: </p>
  61 <ul>
  62 <li>
  63 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
  64 <li>
  65 A dark green arrow is used for protected inheritance. </li>
  66 <li>
  67 A dark red arrow is used for private inheritance. </li>
  68 <li>
  69 A purple dashed arrow is used if a class is contained or used by another class. The arrow is labelled with the variable(s) through which the pointed class or struct is accessible. </li>
  70 <li>
  71 A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labelled with the template parameters of the instance. </li>
  72 </ul>
  73 </div><!-- contents -->
  74 <!-- start footer part -->
  75 <hr class="footer"/><address class="footer"><small>
  76 Generated by &#160;<a href="http://www.doxygen.org/index.html">
  77 <img class="footer" src="doxygen.png" alt="doxygen"/>
  78 </a> 1.8.12
  79 </small></address>
  80 </body>
  81 </html>