acid-drop- Hacking the planet from a LilyGo T-Deck using custom firmware |
| git clone git://git.acid.vegas/acid-drop.git |
| Log | Files | Refs | Archive | README | LICENSE |
graph_legend.html (5932B)
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.13"/> 7 <meta name="viewport" content="width=device-width, initial-scale=1"/> 8 <title>AceButton: 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="search/search.css" rel="stylesheet" type="text/css"/> 13 <script type="text/javascript" src="search/searchdata.js"></script> 14 <script type="text/javascript" src="search/search.js"></script> 15 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 16 </head> 17 <body> 18 <div id="top"><!-- do not remove this div, it is closed by doxygen! --> 19 <div id="titlearea"> 20 <table cellspacing="0" cellpadding="0"> 21 <tbody> 22 <tr style="height: 56px;"> 23 <td id="projectalign" style="padding-left: 0.5em;"> 24 <div id="projectname">AceButton 25  <span id="projectnumber">1.3.3</span> 26 </div> 27 <div id="projectbrief">An adjustable, compact, event-driven button library for Arduino.</div> 28 </td> 29 </tr> 30 </tbody> 31 </table> 32 </div> 33 <!-- end header part --> 34 <!-- Generated by Doxygen 1.8.13 --> 35 <script type="text/javascript"> 36 var searchBox = new SearchBox("searchBox", "search",false,'Search'); 37 </script> 38 <script type="text/javascript" src="menudata.js"></script> 39 <script type="text/javascript" src="menu.js"></script> 40 <script type="text/javascript"> 41 $(function() { 42 initMenu('',true,false,'search.php','Search'); 43 $(document).ready(function() { init_search(); }); 44 }); 45 </script> 46 <div id="main-nav"></div> 47 </div><!-- top --> 48 <!-- window showing the filter options --> 49 <div id="MSearchSelectWindow" 50 onmouseover="return searchBox.OnSearchSelectShow()" 51 onmouseout="return searchBox.OnSearchSelectHide()" 52 onkeydown="return searchBox.OnSearchSelectKey(event)"> 53 </div> 54 55 <!-- iframe showing the search results (closed by default) --> 56 <div id="MSearchResultsWindow"> 57 <iframe src="javascript:void(0)" frameborder="0" 58 name="MSearchResults" id="MSearchResults"> 59 </iframe> 60 </div> 61 62 <div class="header"> 63 <div class="headertitle"> 64 <div class="title">Graph Legend</div> </div> 65 </div><!--header--> 66 <div class="contents"> 67 <p>This page explains how to interpret the graphs that are generated by doxygen.</p> 68 <p>Consider the following example: </p><div class="fragment"><div class="line">/*! Invisible class because of truncation */</div><div class="line">class Invisible { };</div><div class="line"></div><div class="line">/*! Truncated class, inheritance relation is hidden */</div><div class="line">class Truncated : public Invisible { };</div><div class="line"></div><div class="line">/* Class not documented with doxygen comments */</div><div class="line">class Undocumented { };</div><div class="line"></div><div class="line">/*! Class that is inherited using public inheritance */</div><div class="line">class PublicBase : public Truncated { };</div><div class="line"></div><div class="line">/*! A template class */</div><div class="line">template<class T> class Templ { };</div><div class="line"></div><div class="line">/*! Class that is inherited using protected inheritance */</div><div class="line">class ProtectedBase { };</div><div class="line"></div><div class="line">/*! Class that is inherited using private inheritance */</div><div class="line">class PrivateBase { };</div><div class="line"></div><div class="line">/*! Class that is used by the Inherited class */</div><div class="line">class Used { };</div><div class="line"></div><div class="line">/*! Super class that inherits a number of other classes */</div><div class="line">class Inherited : public PublicBase,</div><div class="line"> protected ProtectedBase,</div><div class="line"> private PrivateBase,</div><div class="line"> public Undocumented,</div><div class="line"> public Templ<int></div><div class="line">{</div><div class="line"> private:</div><div class="line"> Used *m_usedClass;</div><div class="line">};</div></div><!-- fragment --><p> This will result in the following graph:</p> 69 <center><div class="image"> 70 <img src="graph_legend.png"/> 71 </div> 72 </center><p>The boxes in the above graph have the following meaning: </p> 73 <ul> 74 <li> 75 A filled gray box represents the struct or class for which the graph is generated. </li> 76 <li> 77 A box with a black border denotes a documented struct or class. </li> 78 <li> 79 A box with a gray border denotes an undocumented struct or class. </li> 80 <li> 81 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> 82 </ul> 83 <p>The arrows have the following meaning: </p> 84 <ul> 85 <li> 86 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li> 87 <li> 88 A dark green arrow is used for protected inheritance. </li> 89 <li> 90 A dark red arrow is used for private inheritance. </li> 91 <li> 92 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> 93 <li> 94 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> 95 </ul> 96 </div><!-- contents --> 97 <!-- start footer part --> 98 <hr class="footer"/><address class="footer"><small> 99 Generated by  <a href="http://www.doxygen.org/index.html"> 100 <img class="footer" src="doxygen.png" alt="doxygen"/> 101 </a> 1.8.13 102 </small></address> 103 </body> 104 </html>