graph_legend.html 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  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>Qwt Polar User&#39;s Guide: 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="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.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 style="padding-left: 0.5em;">
  25. <div id="projectname">Qwt Polar User&#39;s Guide
  26. &#160;<span id="projectnumber">1.1.1</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.5 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="annotated.html"><span>Classes</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. </div><!-- top -->
  62. <!-- window showing the filter options -->
  63. <div id="MSearchSelectWindow"
  64. onmouseover="return searchBox.OnSearchSelectShow()"
  65. onmouseout="return searchBox.OnSearchSelectHide()"
  66. onkeydown="return searchBox.OnSearchSelectKey(event)">
  67. <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>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  68. <!-- iframe showing the search results (closed by default) -->
  69. <div id="MSearchResultsWindow">
  70. <iframe src="javascript:void(0)" frameborder="0"
  71. name="MSearchResults" id="MSearchResults">
  72. </iframe>
  73. </div>
  74. <div class="header">
  75. <div class="headertitle">
  76. <div class="title">Graph Legend</div> </div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
  80. <p>Consider the following example: </p>
  81. <div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
  82. <div class="line"><span class="keyword">class </span>Invisible { };</div>
  83. <div class="line"><span class="comment"></span></div>
  84. <div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
  85. <div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
  86. <div class="line"></div>
  87. <div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
  88. <div class="line"><span class="keyword">class </span>Undocumented { };</div>
  89. <div class="line"><span class="comment"></span></div>
  90. <div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
  91. <div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
  92. <div class="line"><span class="comment"></span></div>
  93. <div class="line"><span class="comment">/*! A template class */</span></div>
  94. <div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>
  95. <div class="line"><span class="comment"></span></div>
  96. <div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
  97. <div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
  98. <div class="line"><span class="comment"></span></div>
  99. <div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
  100. <div class="line"><span class="keyword">class </span>PrivateBase { };</div>
  101. <div class="line"><span class="comment"></span></div>
  102. <div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
  103. <div class="line"><span class="keyword">class </span>Used { };</div>
  104. <div class="line"><span class="comment"></span></div>
  105. <div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
  106. <div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
  107. <div class="line"> <span class="keyword">protected</span> ProtectedBase,</div>
  108. <div class="line"> <span class="keyword">private</span> PrivateBase,</div>
  109. <div class="line"> <span class="keyword">public</span> Undocumented,</div>
  110. <div class="line"> <span class="keyword">public</span> Templ&lt;int&gt;</div>
  111. <div class="line">{</div>
  112. <div class="line"> <span class="keyword">private</span>:</div>
  113. <div class="line"> Used *m_usedClass;</div>
  114. <div class="line">};</div>
  115. </div><!-- fragment --><p> This will result in the following graph:</p>
  116. <center><div class="image">
  117. <img src="graph_legend.png" />
  118. </div>
  119. </center><p>The boxes in the above graph have the following meaning: </p>
  120. <ul>
  121. <li>
  122. A filled gray box represents the struct or class for which the graph is generated. </li>
  123. <li>
  124. A box with a black border denotes a documented struct or class. </li>
  125. <li>
  126. A box with a grey border denotes an undocumented struct or class. </li>
  127. <li>
  128. 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>
  129. </ul>
  130. <p>The arrows have the following meaning: </p>
  131. <ul>
  132. <li>
  133. A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
  134. <li>
  135. A dark green arrow is used for protected inheritance. </li>
  136. <li>
  137. A dark red arrow is used for private inheritance. </li>
  138. <li>
  139. 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>
  140. <li>
  141. 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>
  142. </ul>
  143. </div><!-- contents -->
  144. <!-- start footer part -->
  145. <hr class="footer"/><address class="footer"><small>
  146. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  147. <img class="footer" src="doxygen.png" alt="doxygen"/>
  148. </a> 1.8.5
  149. </small></address>
  150. </body>
  151. </html>