PageRenderTime 50ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/api/graph_legend.html

http://openbiz-cubi.googlecode.com/
HTML | 181 lines | 174 code | 2 blank | 5 comment | 0 complexity | 13f1f77dfea21709a542e3192c571b6c MD5 | raw file
Possible License(s): GPL-2.0, LGPL-3.0 
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.3"/>
    7. 

  7. <title>Openbiz Framework API: Graph Legend</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    12. 

  12. <script type="text/javascript" src="resize.js"></script>
    13. 

  13. <script type="text/javascript" src="navtree.js"></script>
    14. 

  14. <script type="text/javascript">
    15. 

  15.   $(document).ready(initResizable);
    16. 

  16.   $(window).load(resizeHeight);
    17. 

  17. </script>
    18. 

  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    19. 

  19. <script type="text/javascript" src="search/search.js"></script>
    20. 

  20. <script type="text/javascript">
    21. 

  21.   $(document).ready(function() { searchBox.OnSelectItem(0); });
    22. 

  22. </script>
    23. 

  23. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    24. 

  24. <link href="doc-style.css" rel="stylesheet" type="text/css"/>
    25. 

  25. </head>
    26. 

  26. <body>
    27. 

  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    28. 

  28. <div id="titlearea">
    29. 

  29. <table cellspacing="0" cellpadding="0">
    30. 

  30.  <tbody>
    31. 

  31.  <tr style="height: 56px;">
    32. 

  32.   <td id="projectlogo"><img alt="Logo" src="openbiz-logo.png"/></td>
    33. 

  33.   <td style="padding-left: 0.5em;">
    34. 

  34.    <div id="projectname">Openbiz Framework API
    35. 

  35.    &#160;<span id="projectnumber">3.1</span>
    36. 

  36.    </div>
    37. 

  37.    <div id="projectbrief">Open source PHP Framework that designed for building web application.</div>
    38. 

  38.   </td>
    39. 

  39.  </tr>
    40. 

  40.  </tbody>
    41. 

  41. </table>
    42. 

  42. </div>
    43. 

  43. <!-- end header part -->
    44. 

  44. <!-- Generated by Doxygen 1.8.3 -->
    45. 

  45. <script type="text/javascript">
    46. 

  46. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    47. 

  47. </script>
    48. 

  48.   <div id="navrow1" class="tabs">
    49. 

  49.     <ul class="tablist">
    50. 

  50.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    51. 

  51.       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    52. 

  52.       <li><a href="files.html"><span>Files</span></a></li>
    53. 

  53.       <li><a href="examples.html"><span>Examples</span></a></li>
    54. 

  54.       <li>
    55. 

  55.         <div id="MSearchBox" class="MSearchBoxInactive">
    56. 

  56.         <span class="left">
    57. 

  57.           <img id="MSearchSelect" src="search/mag_sel.png"
    58. 

  58.                onmouseover="return searchBox.OnSearchSelectShow()"
    59. 

  59.                onmouseout="return searchBox.OnSearchSelectHide()"
    60. 

  60.                alt=""/>
    61. 

  61.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    62. 

  62.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    63. 

  63.                onblur="searchBox.OnSearchFieldFocus(false)" 
    64. 

  64.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    65. 

  65.           </span><span class="right">
    66. 

  66.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    67. 

  67.           </span>
    68. 

  68.         </div>
    69. 

  69.       </li>
    70. 

  70.     </ul>
    71. 

  71.   </div>
    72. 

  72. </div><!-- top -->
    73. 

  73. <div id="side-nav" class="ui-resizable side-nav-resizable">
    74. 

  74.   <div id="nav-tree">
    75. 

  75.     <div id="nav-tree-contents">
    76. 

  76.       <div id="nav-sync" class="sync"></div>
    77. 

  77.     </div>
    78. 

  78.   </div>
    79. 

  79.   <div id="splitbar" style="-moz-user-select:none;" 
    80. 

  80.        class="ui-resizable-handle">
    81. 

  81.   </div>
    82. 

  82. </div>
    83. 

  83. <script type="text/javascript">
    84. 

  84. $(document).ready(function(){initNavTree('graph_legend.html','');});
    85. 

  85. </script>
    86. 

  86. <div id="doc-content">
    87. 

  87. <!-- window showing the filter options -->
    88. 

  88. <div id="MSearchSelectWindow"
    89. 

  89.      onmouseover="return searchBox.OnSearchSelectShow()"
    90. 

  90.      onmouseout="return searchBox.OnSearchSelectHide()"
    91. 

  91.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    92. 

  92. <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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a></div>
    93. 

  93. 

  94. <!-- iframe showing the search results (closed by default) -->
    95. 

  95. <div id="MSearchResultsWindow">
    96. 

  96. <iframe src="javascript:void(0)" frameborder="0" 
    97. 

  97.         name="MSearchResults" id="MSearchResults">
    98. 

  98. </iframe>
    99. 

  99. </div>
    100. 

  100. 

  101. <div class="header">
    102. 

  102.   <div class="headertitle">
    103. 

  103. <div class="title">Graph Legend</div>  </div>
    104. 

  104. </div><!--header-->
    105. 

  105. <div class="contents">
    106. 

  106. <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
    107. 

  107. <p>Consider the following example: </p>
    108. 

  108. <div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
    109. 

  109. <div class="line"><span class="keyword">class </span>Invisible { };</div>
    110. 

  110. <div class="line"><span class="comment"></span></div>
    111. 

  111. <div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
    112. 

  112. <div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
    113. 

  113. <div class="line"></div>
    114. 

  114. <div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
    115. 

  115. <div class="line"><span class="keyword">class </span>Undocumented { };</div>
    116. 

  116. <div class="line"><span class="comment"></span></div>
    117. 

  117. <div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
    118. 

  118. <div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
    119. 

  119. <div class="line"><span class="comment"></span></div>
    120. 

  120. <div class="line"><span class="comment">/*! A template class */</span></div>
    121. 

  121. <div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>
    122. 

  122. <div class="line"><span class="comment"></span></div>
    123. 

  123. <div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
    124. 

  124. <div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
    125. 

  125. <div class="line"><span class="comment"></span></div>
    126. 

  126. <div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
    127. 

  127. <div class="line"><span class="keyword">class </span>PrivateBase { };</div>
    128. 

  128. <div class="line"><span class="comment"></span></div>
    129. 

  129. <div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
    130. 

  130. <div class="line"><span class="keyword">class </span>Used { };</div>
    131. 

  131. <div class="line"><span class="comment"></span></div>
    132. 

  132. <div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
    133. 

  133. <div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
    134. 

  134. <div class="line">                  <span class="keyword">protected</span> ProtectedBase,</div>
    135. 

  135. <div class="line">                  <span class="keyword">private</span> PrivateBase,</div>
    136. 

  136. <div class="line">                  <span class="keyword">public</span> Undocumented,</div>
    137. 

  137. <div class="line">                  <span class="keyword">public</span> Templ&lt;int&gt;</div>
    138. 

  138. <div class="line">{</div>
    139. 

  139. <div class="line">  <span class="keyword">private</span>:</div>
    140. 

  140. <div class="line">    Used *m_usedClass;</div>
    141. 

  141. <div class="line">};</div>
    142. 

  142. </div><!-- fragment --><p> This will result in the following graph:</p>
    143. 

  143. <center><div class="image">
    144. 

  144. <img src="../../graph_legend.png" />
    145. 

  145. </div>
    146. 

  146. </center><p>The boxes in the above graph have the following meaning: </p>
    147. 

  147. <ul>
    148. 

  148. <li>
    149. 

  149. A filled gray box represents the struct or class for which the graph is generated. </li>
    150. 

  150. <li>
    151. 

  151. A box with a black border denotes a documented struct or class. </li>
    152. 

  152. <li>
    153. 

  153. A box with a grey border denotes an undocumented struct or class. </li>
    154. 

  154. <li>
    155. 

  155. 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>
    156. 

  156. </ul>
    157. 

  157. <p>The arrows have the following meaning: </p>
    158. 

  158. <ul>
    159. 

  159. <li>
    160. 

  160. A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
    161. 

  161. <li>
    162. 

  162. A dark green arrow is used for protected inheritance. </li>
    163. 

  163. <li>
    164. 

  164. A dark red arrow is used for private inheritance. </li>
    165. 

  165. <li>
    166. 

  166. 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>
    167. 

  167. <li>
    168. 

  168. 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>
    169. 

  169. </ul>
    170. 

  170. </div><!-- contents -->
    171. 

  171. </div><!-- doc-content -->
    172. 

  172. <!-- start footer part -->
    173. 

  173. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    174. 

  174.   <ul>
    175. 

  175.     <li class="footer">Generated on Tue Jan 22 2013 11:50:00 for Openbiz Framework API by
    176. 

  176.     <a href="http://www.doxygen.org/index.html">
    177. 

  177.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
    178. 

  178.   </ul>
    179. 

  179. </div>
    180. 

  180. </body>
    181. 

  181. </html>
    182. 

  182.