git.m6w6.name Git - m6w6/ext-raphf/blob - 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>Resource and persistent handle factory API: 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="navtree.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="resize.js"></script>
  13 <script type="text/javascript" src="navtreedata.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <script type="text/javascript">
  16   $(document).ready(initResizable);
  17   $(window).load(resizeHeight);
  18 </script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { init_search(); });
  24 </script>
  25 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  26 </head>
  27 <body>
  28 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  29 <div id="titlearea">
  30 <table cellspacing="0" cellpadding="0">
  31  <tbody>
  32  <tr style="height: 56px;">
  33   <td id="projectlogo"><img alt="Logo" src="raphf.png"/></td>
  34   <td style="padding-left: 0.5em;">
  35    <div id="projectname">Resource and persistent handle factory API
  36    </div>
  37    <div id="projectbrief">A facility to manage possibly persistent resources with a comprehensible API.  Provides simliar functionality like the zend_list API, but with more flexiblity and freedom.</div>
  38   </td>
  39  </tr>
  40  </tbody>
  41 </table>
  42 </div>
  43 <!-- end header part -->
  44 <!-- Generated by Doxygen 1.8.9.1 -->
  45 <script type="text/javascript">
  46 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  47 </script>
  48   <div id="navrow1" class="tabs">
  49     <ul class="tablist">
  50       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  51       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  52       <li><a href="files.html"><span>Files</span></a></li>
  53       <li>
  54         <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <img id="MSearchSelect" src="search/mag_sel.png"
  57                onmouseover="return searchBox.OnSearchSelectShow()"
  58                onmouseout="return searchBox.OnSearchSelectHide()"
  59                alt=""/>
  60           <input type="text" id="MSearchField" value="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  66           </span>
  67         </div>
  68       </li>
  69     </ul>
  70   </div>
  71 </div><!-- top -->
  72 <div id="side-nav" class="ui-resizable side-nav-resizable">
  73   <div id="nav-tree">
  74     <div id="nav-tree-contents">
  75       <div id="nav-sync" class="sync"></div>
  76     </div>
  77   </div>
  78   <div id="splitbar" style="-moz-user-select:none;"
  79        class="ui-resizable-handle">
  80   </div>
  81 </div>
  82 <script type="text/javascript">
  83 $(document).ready(function(){initNavTree('graph_legend.html','');});
  84 </script>
  85 <div id="doc-content">
  86 <!-- window showing the filter options -->
  87 <div id="MSearchSelectWindow"
  88      onmouseover="return searchBox.OnSearchSelectShow()"
  89      onmouseout="return searchBox.OnSearchSelectHide()"
  90      onkeydown="return searchBox.OnSearchSelectKey(event)">
  91 </div>
  92
  93 <!-- iframe showing the search results (closed by default) -->
  94 <div id="MSearchResultsWindow">
  95 <iframe src="javascript:void(0)" frameborder="0"
  96         name="MSearchResults" id="MSearchResults">
  97 </iframe>
  98 </div>
  99
 100 <div class="header">
 101   <div class="headertitle">
 102 <div class="title">Graph Legend</div>  </div>
 103 </div><!--header-->
 104 <div class="contents">
 105 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
 106 <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>
 107 <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;class Invisible { };</div>
 108 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div>
 109 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;/*! Truncated class, inheritance relation is hidden */</div>
 110 <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;class Truncated : public Invisible { };</div>
 111 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div>
 112 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;/* Class not documented with doxygen comments */</div>
 113 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;class Undocumented { };</div>
 114 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div>
 115 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;/*! Class that is inherited using public inheritance */</div>
 116 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;class PublicBase : public Truncated { };</div>
 117 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
 118 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;/*! A template class */</div>
 119 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;template&lt;class T&gt; class Templ { };</div>
 120 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
 121 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;/*! Class that is inherited using protected inheritance */</div>
 122 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;class ProtectedBase { };</div>
 123 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
 124 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;/*! Class that is inherited using private inheritance */</div>
 125 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;class PrivateBase { };</div>
 126 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
 127 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;/*! Class that is used by the Inherited class */</div>
 128 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;class Used { };</div>
 129 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
 130 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;/*! Super class that inherits a number of other classes */</div>
 131 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;class Inherited : public PublicBase,</div>
 132 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;                  protected ProtectedBase,</div>
 133 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;                  private PrivateBase,</div>
 134 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;                  public Undocumented,</div>
 135 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;                  public Templ&lt;int&gt;</div>
 136 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;{</div>
 137 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;  private:</div>
 138 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    Used *m_usedClass;</div>
 139 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;};</div>
 140 </div><!-- fragment --><p> This will result in the following graph:</p>
 141 <center><div class="image">
 142 <img src="graph_legend.png" />
 143 </div>
 144 </center><p>The boxes in the above graph have the following meaning: </p>
 145 <ul>
 146 <li>
 147 A filled gray box represents the struct or class for which the graph is generated. </li>
 148 <li>
 149 A box with a black border denotes a documented struct or class. </li>
 150 <li>
 151 A box with a grey border denotes an undocumented struct or class. </li>
 152 <li>
 153 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>
 154 </ul>
 155 <p>The arrows have the following meaning: </p>
 156 <ul>
 157 <li>
 158 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
 159 <li>
 160 A dark green arrow is used for protected inheritance. </li>
 161 <li>
 162 A dark red arrow is used for private inheritance. </li>
 163 <li>
 164 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>
 165 <li>
 166 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>
 167 </ul>
 168 </div><!-- contents -->
 169 </div><!-- doc-content -->
 170 <!-- start footer part -->
 171 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 172   <ul>
 173     <li class="footer">Generated by
 174     <a href="http://www.doxygen.org/index.html">
 175     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
 176   </ul>
 177 </div>
 178 </body>
 179 </html>