OpenCores
URL https://opencores.org/ocsvn/single-14-segment-display-driver-w-decoder/single-14-segment-display-driver-w-decoder/trunk

Subversion Repositories single-14-segment-display-driver-w-decoder

[/] [single-14-segment-display-driver-w-decoder/] [trunk/] [Documentation/] [html/] [graph_legend.html] - Blame information for rev 4

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 4 liubenoff
<!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>Single 14 Segment Display Driver with Limited ASCII Decoder: 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">Single 14 Segment Display Driver with Limited ASCII Decoder
25
   &#160;<span id="projectnumber">0.1</span>
26
   </div>
27
  </td>
28
 </tr>
29
 </tbody>
30
</table>
31
</div>
32
<!-- end header part -->
33
<!-- Generated by Doxygen 1.8.13 -->
34
<script type="text/javascript">
35
var searchBox = new SearchBox("searchBox", "search",false,'Search');
36
</script>
37
<script type="text/javascript" src="menudata.js"></script>
38
<script type="text/javascript" src="menu.js"></script>
39
<script type="text/javascript">
40
$(function() {
41
  initMenu('',true,false,'search.php','Search');
42
  $(document).ready(function() { init_search(); });
43
});
44
</script>
45
<div id="main-nav"></div>
46
</div><!-- top -->
47
<!-- window showing the filter options -->
48
<div id="MSearchSelectWindow"
49
     onmouseover="return searchBox.OnSearchSelectShow()"
50
     onmouseout="return searchBox.OnSearchSelectHide()"
51
     onkeydown="return searchBox.OnSearchSelectKey(event)">
52
</div>
53
 
54
<!-- iframe showing the search results (closed by default) -->
55
<div id="MSearchResultsWindow">
56
<iframe src="javascript:void(0)" frameborder="0"
57
        name="MSearchResults" id="MSearchResults">
58
</iframe>
59
</div>
60
 
61
<div class="header">
62
  <div class="headertitle">
63
<div class="title">Graph Legend</div>  </div>
64
</div><!--header-->
65
<div class="contents">
66
<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
67
<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&lt;class T&gt; 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&lt;int&gt;</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>
68
<center><div class="image">
69
<img src="graph_legend.png"/>
70
</div>
71
</center><p>The boxes in the above graph have the following meaning: </p>
72
<ul>
73
<li>
74
A filled gray box represents the struct or class for which the graph is generated. </li>
75
<li>
76
A box with a black border denotes a documented struct or class. </li>
77
<li>
78
A box with a gray border denotes an undocumented struct or class. </li>
79
<li>
80
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>
81
</ul>
82
<p>The arrows have the following meaning: </p>
83
<ul>
84
<li>
85
A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
86
<li>
87
A dark green arrow is used for protected inheritance. </li>
88
<li>
89
A dark red arrow is used for private inheritance. </li>
90
<li>
91
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>
92
<li>
93
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>
94
</ul>
95
</div><!-- contents -->
96
<!-- start footer part -->
97
<hr class="footer"/><address class="footer"><small>
98
Generated by &#160;<a href="http://www.doxygen.org/index.html">
99
<img class="footer" src="doxygen.png" alt="doxygen"/>
100
</a> 1.8.13
101
</small></address>
102
</body>
103
</html>

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.