صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
sweproj.com
/
SdFat
2
0
انشعاب 0
پرونده‌ها مشکلات 0 درخواست واکشی 0 ویکی
درخت: e4190e50a4
شاخه‌ها تگ‌ها
SdFat
/
extras
/
html
/
graph_legend.html

graph_legend.html 8.5 KB
تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152 
  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.10"/>
    7. 

  7. <title>SdFat: 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="search/search.css" rel="stylesheet" type="text/css"/>
    12. 

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

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

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

  15.   $(document).ready(function() { init_search(); });
    16. 

  16. </script>
    17. 

  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    18. 

  18. </head>
    19. 

  19. <body>
    20. 

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

  21. <div id="titlearea">
    22. 

  22. <table cellspacing="0" cellpadding="0">
    23. 

  23.  <tbody>
    24. 

  24.  <tr style="height: 56px;">
    25. 

  25.   <td id="projectalign" style="padding-left: 0.5em;">
    26. 

  26.    <div id="projectname">SdFat
    27. 

  27.    </div>
    28. 

  28.   </td>
    29. 

  29.  </tr>
    30. 

  30.  </tbody>
    31. 

  31. </table>
    32. 

  32. </div>
    33. 

  33. <!-- end header part -->
    34. 

  34. <!-- Generated by Doxygen 1.8.10 -->
    35. 

  35. <script type="text/javascript">
    36. 

  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    37. 

  37. </script>
    38. 

  38.   <div id="navrow1" class="tabs">
    39. 

  39.     <ul class="tablist">
    40. 

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

  41.       <li><a href="annotated.html"><span>Classes</span></a></li>
    42. 

  42.       <li><a href="files.html"><span>Files</span></a></li>
    43. 

  43.       <li>
    44. 

  44.         <div id="MSearchBox" class="MSearchBoxInactive">
    45. 

  45.         <span class="left">
    46. 

  46.           <img id="MSearchSelect" src="search/mag_sel.png"
    47. 

  47.                onmouseover="return searchBox.OnSearchSelectShow()"
    48. 

  48.                onmouseout="return searchBox.OnSearchSelectHide()"
    49. 

  49.                alt=""/>
    50. 

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    51. 

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    52. 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 
    53. 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    54. 

  54.           </span><span class="right">
    55. 

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

  56.           </span>
    57. 

  57.         </div>
    58. 

  58.       </li>
    59. 

  59.     </ul>
    60. 

  60.   </div>
    61. 

  61. </div><!-- top -->
    62. 

  62. <!-- window showing the filter options -->
    63. 

  63. <div id="MSearchSelectWindow"
    64. 

  64.      onmouseover="return searchBox.OnSearchSelectShow()"
    65. 

  65.      onmouseout="return searchBox.OnSearchSelectHide()"
    66. 

  66.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    67. 

  67. </div>
    68. 

  68. 

  69. <!-- iframe showing the search results (closed by default) -->
    70. 

  70. <div id="MSearchResultsWindow">
    71. 

  71. <iframe src="javascript:void(0)" frameborder="0" 
    72. 

  72.         name="MSearchResults" id="MSearchResults">
    73. 

  73. </iframe>
    74. 

  74. </div>
    75. 

  75. 

  76. <div class="header">
    77. 

  77.   <div class="headertitle">
    78. 

  78. <div class="title">Graph Legend</div>  </div>
    79. 

  79. </div><!--header-->
    80. 

  80. <div class="contents">
    81. 

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

  82. <p>Consider the following example: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;/*! Invisible class because of truncation */</div>
    83. 

  83. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;class Invisible { };</div>
    84. 

  84. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div>
    85. 

  85. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;/*! Truncated class, inheritance relation is hidden */</div>
    86. 

  86. <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;class Truncated : public Invisible { };</div>
    87. 

  87. <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div>
    88. 

  88. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;/* Class not documented with doxygen comments */</div>
    89. 

  89. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;class Undocumented { };</div>
    90. 

  90. <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div>
    91. 

  91. <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;/*! Class that is inherited using public inheritance */</div>
    92. 

  92. <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;class PublicBase : public Truncated { };</div>
    93. 

  93. <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
    94. 

  94. <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;/*! A template class */</div>
    95. 

  95. <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;template&lt;class T&gt; class Templ { };</div>
    96. 

  96. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
    97. 

  97. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;/*! Class that is inherited using protected inheritance */</div>
    98. 

  98. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;class ProtectedBase { };</div>
    99. 

  99. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
    100. 

  100. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;/*! Class that is inherited using private inheritance */</div>
    101. 

  101. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;class PrivateBase { };</div>
    102. 

  102. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
    103. 

  103. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;/*! Class that is used by the Inherited class */</div>
    104. 

  104. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;class Used { };</div>
    105. 

  105. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
    106. 

  106. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;/*! Super class that inherits a number of other classes */</div>
    107. 

  107. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;class Inherited : public PublicBase,</div>
    108. 

  108. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;                  protected ProtectedBase,</div>
    109. 

  109. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;                  private PrivateBase,</div>
    110. 

  110. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;                  public Undocumented,</div>
    111. 

  111. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;                  public Templ&lt;int&gt;</div>
    112. 

  112. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;{</div>
    113. 

  113. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;  private:</div>
    114. 

  114. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    Used *m_usedClass;</div>
    115. 

  115. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;};</div>
    116. 

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

  117. <center><div class="image">
    118. 

  118. <img src="graph_legend.png" />
    119. 

  119. </div>
    120. 

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

  121. <ul>
    122. 

  122. <li>
    123. 

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

  124. <li>
    125. 

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

  126. <li>
    127. 

  127. A box with a gray border denotes an undocumented struct or class. </li>
    128. 

  128. <li>
    129. 

  129. 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>
    130. 

  130. </ul>
    131. 

  131. <p>The arrows have the following meaning: </p>
    132. 

  132. <ul>
    133. 

  133. <li>
    134. 

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

  135. <li>
    136. 

  136. A dark green arrow is used for protected inheritance. </li>
    137. 

  137. <li>
    138. 

  138. A dark red arrow is used for private inheritance. </li>
    139. 

  139. <li>
    140. 

  140. 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>
    141. 

  141. <li>
    142. 

  142. 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>
    143. 

  143. </ul>
    144. 

  144. </div><!-- contents -->
    145. 

  145. <!-- start footer part -->
    146. 

  146. <hr class="footer"/><address class="footer"><small>
    147. 

  147. Generated on Mon Sep 5 2016 10:18:53 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
    148. 

  148. <img class="footer" src="doxygen.png" alt="doxygen"/>
    149. 

  149. </a> 1.8.10
    150. 

  150. </small></address>
    151. 

  151. </body>
    152. 

  152. </html>
    153.