OpenCores
URL https://opencores.org/ocsvn/avs_aes/avs_aes/trunk

Subversion Repositories avs_aes

[/] [avs_aes/] [trunk/] [doc/] [sw/] [html/] [graph_legend.html] - Blame information for rev 21

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 11 ruschi 
<!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 21 ruschi 
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 
<meta name="generator" content="Doxygen 1.8.4"/>
7 11 ruschi 
<title>AES Avalon Slave (avs_aes): Graph Legend</title>
8 
<link href="tabs.css" rel="stylesheet" type="text/css"/>
9 21 ruschi 
<script type="text/javascript" src="jquery.js"></script>
10 
<script type="text/javascript" src="dynsections.js"></script>
11 
<link href="navtree.css" rel="stylesheet" type="text/css"/>
12 
<script type="text/javascript" src="resize.js"></script>
13 
<script type="text/javascript" src="navtree.js"></script>
14 
<script type="text/javascript">
15 
  $(document).ready(initResizable);
16 
  $(window).load(resizeHeight);
17 
</script>
18 
<link href="doxygen.css" rel="stylesheet" type="text/css" />
19 11 ruschi 
</head>
20 
<body>
21 21 ruschi 
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
22 
<div id="titlearea">
23 
<table cellspacing="0" cellpadding="0">
24 
 <tbody>
25 
 <tr style="height: 56px;">
26 
  <td style="padding-left: 0.5em;">
27 
   <div id="projectname">AES Avalon Slave (avs_aes)
28 
   </div>
29 
  </td>
30 
 </tr>
31 
 </tbody>
32 
</table>
33 
</div>
34 
<!-- end header part -->
35 
<!-- Generated by Doxygen 1.8.4 -->
36 
  <div id="navrow1" class="tabs">
37 
    <ul class="tablist">
38 
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
39 
      <li><a href="modules.html"><span>Modules</span></a></li>
40 
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
41 11 ruschi 
      <li><a href="files.html"><span>Files</span></a></li>
42 
    </ul>
43 
  </div>
44 21 ruschi 
</div><!-- top -->
45 
<div id="side-nav" class="ui-resizable side-nav-resizable">
46 
  <div id="nav-tree">
47 
    <div id="nav-tree-contents">
48 
      <div id="nav-sync" class="sync"></div>
49 
    </div>
50 
  </div>
51 
  <div id="splitbar" style="-moz-user-select:none;"
52 
       class="ui-resizable-handle">
53 
  </div>
54 11 ruschi 
</div>
55 21 ruschi 
<script type="text/javascript">
56 
$(document).ready(function(){initNavTree('graph_legend.html','');});
57 
</script>
58 
<div id="doc-content">
59 
<div class="header">
60 
  <div class="headertitle">
61 
<div class="title">Graph Legend</div>  </div>
62 
</div><!--header-->
63 11 ruschi 
<div class="contents">
64 21 ruschi 
<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
65 11 ruschi 
<p>Consider the following example: </p>
66 21 ruschi 
<div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
67 
<div class="line"><span class="keyword">class </span>Invisible { };</div>
68 
<div class="line"><span class="comment"></span></div>
69 
<div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
70 
<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
71 
<div class="line"></div>
72 
<div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
73 
<div class="line"><span class="keyword">class </span>Undocumented { };</div>
74 
<div class="line"><span class="comment"></span></div>
75 
<div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
76 
<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
77 
<div class="line"><span class="comment"></span></div>
78 
<div class="line"><span class="comment">/*! A template class */</span></div>
79 
<div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>
80 
<div class="line"><span class="comment"></span></div>
81 
<div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
82 
<div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
83 
<div class="line"><span class="comment"></span></div>
84 
<div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
85 
<div class="line"><span class="keyword">class </span>PrivateBase { };</div>
86 
<div class="line"><span class="comment"></span></div>
87 
<div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
88 
<div class="line"><span class="keyword">class </span>Used { };</div>
89 
<div class="line"><span class="comment"></span></div>
90 
<div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
91 
<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
92 
<div class="line">                  <span class="keyword">protected</span> ProtectedBase,</div>
93 
<div class="line">                  <span class="keyword">private</span> PrivateBase,</div>
94 
<div class="line">                  <span class="keyword">public</span> Undocumented,</div>
95 
<div class="line">                  <span class="keyword">public</span> Templ&lt;int&gt;</div>
96 
<div class="line">{</div>
97 
<div class="line">  <span class="keyword">private</span>:</div>
98 
<div class="line">    Used *m_usedClass;</div>
99 
<div class="line">};</div>
100 
</div><!-- fragment --><p> This will result in the following graph:</p>
101 
<center><div class="image">
102 
<img src="graph_legend.png" />
103 11 ruschi 
</div>
104 21 ruschi 
</center><p>The boxes in the above graph have the following meaning: </p>
105 11 ruschi 
<ul>
106 
<li>
107 
A filled gray box represents the struct or class for which the graph is generated. </li>
108 
<li>
109 
A box with a black border denotes a documented struct or class. </li>
110 
<li>
111 
A box with a grey border denotes an undocumented struct or class. </li>
112 
<li>
113 
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>
114 
</ul>
115 21 ruschi 
<p>The arrows have the following meaning: </p>
116 11 ruschi 
<ul>
117 
<li>
118 
A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
119 
<li>
120 
A dark green arrow is used for protected inheritance. </li>
121 
<li>
122 
A dark red arrow is used for private inheritance. </li>
123 
<li>
124 
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>
125 
<li>
126 
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>
127 
</ul>
128 21 ruschi 
</div><!-- contents -->
129 
</div><!-- doc-content -->
130 
<!-- start footer part -->
131 
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
132 
  <ul>
133 
    <li class="footer">Generated on Sat Apr 19 2014 17:55:55 for AES Avalon Slave (avs_aes) by
134 
    <a href="http://www.doxygen.org/index.html">
135 
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li>
136 
  </ul>
137 11 ruschi 
</div>
138 
</body>
139 
</html>

powered by: WebSVN 2.1.0

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