graph_legend.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
  6. <meta name="generator" content="Doxygen 1.9.3"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Deep network: 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="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  17. <script type="text/javascript" src="search/searchdata.js"></script>
  18. <script type="text/javascript" src="search/search.js"></script>
  19. <script type="text/x-mathjax-config">
  20. MathJax.Hub.Config({
  21. extensions: ["tex2jax.js"],
  22. jax: ["input/TeX","output/HTML-CSS"],
  23. });
  24. </script>
  25. <script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
  26. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  27. </head>
  28. <body>
  29. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  30. <div id="titlearea">
  31. <table cellspacing="0" cellpadding="0">
  32. <tbody>
  33. <tr id="projectrow">
  34. <td id="projectalign">
  35. <div id="projectname">Deep network
  36. </div>
  37. </td>
  38. </tr>
  39. </tbody>
  40. </table>
  41. </div>
  42. <!-- end header part -->
  43. <!-- Generated by Doxygen 1.9.3 -->
  44. <script type="text/javascript">
  45. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  46. var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  47. /* @license-end */
  48. </script>
  49. <script type="text/javascript" src="menudata.js"></script>
  50. <script type="text/javascript" src="menu.js"></script>
  51. <script type="text/javascript">
  52. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  53. $(function() {
  54. initMenu('',true,false,'search.php','Search');
  55. $(document).ready(function() { init_search(); });
  56. });
  57. /* @license-end */
  58. </script>
  59. <div id="main-nav"></div>
  60. </div><!-- top -->
  61. <div id="side-nav" class="ui-resizable side-nav-resizable">
  62. <div id="nav-tree">
  63. <div id="nav-tree-contents">
  64. <div id="nav-sync" class="sync"></div>
  65. </div>
  66. </div>
  67. <div id="splitbar" style="-moz-user-select:none;"
  68. class="ui-resizable-handle">
  69. </div>
  70. </div>
  71. <script type="text/javascript">
  72. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  73. $(document).ready(function(){initNavTree('graph_legend.html',''); initResizable(); });
  74. /* @license-end */
  75. </script>
  76. <div id="doc-content">
  77. <!-- window showing the filter options -->
  78. <div id="MSearchSelectWindow"
  79. onmouseover="return searchBox.OnSearchSelectShow()"
  80. onmouseout="return searchBox.OnSearchSelectHide()"
  81. onkeydown="return searchBox.OnSearchSelectKey(event)">
  82. </div>
  83. <!-- iframe showing the search results (closed by default) -->
  84. <div id="MSearchResultsWindow">
  85. <iframe src="javascript:void(0)" frameborder="0"
  86. name="MSearchResults" id="MSearchResults">
  87. </iframe>
  88. </div>
  89. <div class="header">
  90. <div class="headertitle"><div class="title">Graph Legend</div></div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <p >This page explains how to interpret the graphs that are generated by doxygen.</p>
  94. <p >Consider the following example: </p><div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
  95. <div class="line"><span class="keyword">class </span>Invisible { };</div>
  96. <div class="line"><span class="comment"></span> </div>
  97. <div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
  98. <div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
  99. <div class="line"> </div>
  100. <div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
  101. <div class="line"><span class="keyword">class </span>Undocumented { };</div>
  102. <div class="line"><span class="comment"></span> </div>
  103. <div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
  104. <div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
  105. <div class="line"><span class="comment"></span> </div>
  106. <div class="line"><span class="comment">/*! A template class */</span></div>
  107. <div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>
  108. <div class="line"><span class="comment"></span> </div>
  109. <div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
  110. <div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
  111. <div class="line"><span class="comment"></span> </div>
  112. <div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
  113. <div class="line"><span class="keyword">class </span>PrivateBase { };</div>
  114. <div class="line"><span class="comment"></span> </div>
  115. <div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
  116. <div class="line"><span class="keyword">class </span>Used { };</div>
  117. <div class="line"><span class="comment"></span> </div>
  118. <div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
  119. <div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
  120. <div class="line"> <span class="keyword">protected</span> ProtectedBase,</div>
  121. <div class="line"> <span class="keyword">private</span> PrivateBase,</div>
  122. <div class="line"> <span class="keyword">public</span> Undocumented,</div>
  123. <div class="line"> <span class="keyword">public</span> Templ&lt;int&gt;</div>
  124. <div class="line">{</div>
  125. <div class="line"> <span class="keyword">private</span>:</div>
  126. <div class="line"> Used *m_usedClass;</div>
  127. <div class="line">};</div>
  128. </div><!-- fragment --><p> This will result in the following graph:</p>
  129. <center><img src="graph_legend.png" alt="" class="inline"/></center><p >The boxes in the above graph have the following meaning: </p>
  130. <ul>
  131. <li>
  132. A filled gray box represents the struct or class for which the graph is generated. </li>
  133. <li>
  134. A box with a black border denotes a documented struct or class. </li>
  135. <li>
  136. A box with a gray border denotes an undocumented struct or class. </li>
  137. <li>
  138. 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>
  139. </ul>
  140. <p >The arrows have the following meaning: </p>
  141. <ul>
  142. <li>
  143. A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
  144. <li>
  145. A dark green arrow is used for protected inheritance. </li>
  146. <li>
  147. A dark red arrow is used for private inheritance. </li>
  148. <li>
  149. 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>
  150. <li>
  151. 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>
  152. </ul>
  153. </div><!-- contents -->
  154. </div><!-- doc-content -->
  155. <!-- start footer part -->
  156. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  157. <ul>
  158. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
  159. </ul>
  160. </div>
  161. </body>
  162. </html>