graph_legend.html 5.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
  3. <title>PowerVR SDK</title>
  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
  5. <link href="tabs.css" rel="stylesheet" type="text/css">
  6. <table width="100%">
  7. <tr>
  8. <td width="33%">
  9. <p align="left">&nbsp;<a href="http://www.imgtec.com"><img border="0" src="IMGLogo.jpg" width="200" height="30"></a></p>
  10. </td>
  11. <td width="33%">
  12. <p align="center"><font color="#808080" face="Arial" size="2">PowerVR Software Development Kit</a></font></p>
  13. </td>
  14. <td width="34%">
  15. <p align="right"><a href="http://www.powervr.com"><img border="0" src="PVRlogo.jpg" width="200" height="27"></a></p>
  16. </td>
  17. </tr>
  18. </table>
  19. <hr>
  20. </head><body>
  21. <!-- Generated by Doxygen 1.3.6 -->
  22. <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
  23. <h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
  24. Consider the following example: <pre class="fragment"><div><span class="comment">/*! Invisible class because of truncation */</span>
  25. <span class="keyword">class </span>Invisible { };
  26. <span class="comment"></span>
  27. <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
  28. <span class="keyword">class </span>Truncated : <span class="keyword">public</span> <a class="code" href="classInvisible.html">Invisible</a> { };
  29. <span class="comment">/* Class not documented with doxygen comments */</span>
  30. <span class="keyword">class </span>Undocumented { };
  31. <span class="comment"></span>
  32. <span class="comment">/*! Class that is inherited using public inheritance */</span>
  33. <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> <a class="code" href="classTruncated.html">Truncated</a> { };
  34. <span class="comment"></span>
  35. <span class="comment">/*! A template class */</span>
  36. <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
  37. <span class="comment"></span>
  38. <span class="comment">/*! Class that is inherited using protected inheritance */</span>
  39. <span class="keyword">class </span>ProtectedBase { };
  40. <span class="comment"></span>
  41. <span class="comment">/*! Class that is inherited using private inheritance */</span>
  42. <span class="keyword">class </span>PrivateBase { };
  43. <span class="comment"></span>
  44. <span class="comment">/*! Class that is used by the Inherited class */</span>
  45. <span class="keyword">class </span>Used { };
  46. <span class="comment"></span>
  47. <span class="comment">/*! Super class that inherits a number of other classes */</span>
  48. <span class="keyword">class </span>Inherited : <span class="keyword">public</span> <a class="code" href="classPublicBase.html">PublicBase</a>,
  49. <span class="keyword">protected</span> <a class="code" href="classProtectedBase.html">ProtectedBase</a>,
  50. <span class="keyword">private</span> <a class="code" href="classPrivateBase.html">PrivateBase</a>,
  51. <span class="keyword">public</span> <a class="code" href="classUndocumented.html">Undocumented</a>
  52. <span class="keyword">public</span> <a class="code" href="classTempl.html">Templ</a>&lt;int&gt;
  53. {
  54. <span class="keyword">private</span>:
  55. <a class="code" href="classUsed.html">Used</a> *m_usedClass;
  56. };
  57. </div></pre>If the <code>MAX_DOT_GRAPH_HEIGHT</code> tag in the configuration file is set to 240 this will result in the following graph:<p>
  58. <center><div align="center">
  59. <img src="graph_legend.png" alt="graph_legend.png" alt>
  60. </div>
  61. </center> <p>
  62. The boxes in the above graph have the following meaning: <ul>
  63. <li>
  64. A filled black box represents the struct or class for which the graph is generated. </li>
  65. <li>
  66. A box with a black border denotes a documented struct or class. </li>
  67. <li>
  68. A box with a grey border denotes an undocumented struct or class. </li>
  69. <li>
  70. 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>
  71. </ul>
  72. The arrows have the following meaning: <ul>
  73. <li>
  74. A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
  75. <li>
  76. A dark green arrow is used for protected inheritance. </li>
  77. <li>
  78. A dark red arrow is used for private inheritance. </li>
  79. <li>
  80. 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>
  81. <li>
  82. 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>
  83. </ul>
  84. <br>
  85. <br>
  86. <P align=left><FONT size=2><STRONG><A
  87. href="http://www.imgtec.com/powervr/insider/legal/index.asp">Copyright</A> ©
  88. 1999-2008, Imagination Technologies Ltd.</STRONG></FONT></P>
  89. <hr>
  90. <address style="align: left;"><small><FONT color=f0f>
  91. Generated by <a href="http://www.doxygen.org/index.html">DOXYGEN</a> 1.3.6</small></address>
  92. </body>
  93. </html>