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