docs/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.13"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>ThorVG: 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="search/search.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="search/searchdata.js"></script>
  14 <script type="text/javascript" src="search/search.js"></script>
  15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
  17 </head>
  18 <body>
  19 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20 <div id="titlearea">
  21 <table cellspacing="0" cellpadding="0">
  22  <tbody>
  23  <tr style="height: 56px;">
  24   <td id="projectlogo"><img alt="Logo" src="small_logo.svg"/></td>
  25   <td id="projectalign" style="padding-left: 0.5em;">
  26    <div id="projectname">ThorVG
  27    &#160;<span id="projectnumber">v0.4</span>
  28    </div>
  29   </td>
  30  </tr>
  31  </tbody>
  32 </table>
  33 </div>
  34 <!-- end header part -->
  35 <!-- Generated by Doxygen 1.8.13 -->
  36 <script type="text/javascript">
  37 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38 </script>
  39 <script type="text/javascript" src="menudata.js"></script>
  40 <script type="text/javascript" src="menu.js"></script>
  41 <script type="text/javascript">
  42 $(function() {
  43   initMenu('',true,false,'search.php','Search');
  44   $(document).ready(function() { init_search(); });
  45 });
  46 </script>
  47 <div id="main-nav"></div>
  48 </div><!-- top -->
  49 <!-- window showing the filter options -->
  50 <div id="MSearchSelectWindow"
  51      onmouseover="return searchBox.OnSearchSelectShow()"
  52      onmouseout="return searchBox.OnSearchSelectHide()"
  53      onkeydown="return searchBox.OnSearchSelectKey(event)">
  54 </div>
  55
  56 <!-- iframe showing the search results (closed by default) -->
  57 <div id="MSearchResultsWindow">
  58 <iframe src="javascript:void(0)" frameborder="0"
  59         name="MSearchResults" id="MSearchResults">
  60 </iframe>
  61 </div>
  62
  63 <div class="header">
  64   <div class="headertitle">
  65 <div class="title">Graph Legend</div>  </div>
  66 </div><!--header-->
  67 <div class="contents">
  68 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
  69 <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>
  70 <center><div class="image">
  71 <img src="graph_legend.png"/>
  72 </div>
  73 </center><p>The boxes in the above graph have the following meaning: </p>
  74 <ul>
  75 <li>
  76 A filled gray box represents the struct or class for which the graph is generated. </li>
  77 <li>
  78 A box with a black border denotes a documented struct or class. </li>
  79 <li>
  80 A box with a gray border denotes an undocumented struct or class. </li>
  81 <li>
  82 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>
  83 </ul>
  84 <p>The arrows have the following meaning: </p>
  85 <ul>
  86 <li>
  87 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
  88 <li>
  89 A dark green arrow is used for protected inheritance. </li>
  90 <li>
  91 A dark red arrow is used for private inheritance. </li>
  92 <li>
  93 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>
  94 <li>
  95 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>
  96 </ul>
  97 </div><!-- contents -->
  98 <!-- start footer part -->
  99 <hr class="footer"/><address class="footer"><small>
 100 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 101 <img class="footer" src="doxygen.png" alt="doxygen"/>
 102 </a> 1.8.13
 103 </small></address>
 104 </body>
 105 </html>