| Line 1... |
Line 1... |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
<head>
|
<head>
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.4"/>
|
<title>AES Avalon Slave (avs_aes): Graph Legend</title>
|
<title>AES Avalon Slave (avs_aes): Graph Legend</title>
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
</head>
|
</head>
|
<body>
|
<body>
|
<!-- Generated by Doxygen 1.6.1 -->
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
<script type="text/javascript">
|
<div id="titlearea">
|
<!--
|
<table cellspacing="0" cellpadding="0">
|
function changeDisplayState (e){
|
<tbody>
|
var num=this.id.replace(/[^[0-9]/g,'');
|
<tr style="height: 56px;">
|
var button=this.firstChild;
|
<td style="padding-left: 0.5em;">
|
var sectionDiv=document.getElementById('dynsection'+num);
|
<div id="projectname">AES Avalon Slave (avs_aes)
|
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
|
</div>
|
sectionDiv.style.display='block';
|
</td>
|
button.src='open.gif';
|
</tr>
|
}else{
|
</tbody>
|
sectionDiv.style.display='none';
|
</table>
|
button.src='closed.gif';
|
</div>
|
}
|
<!-- end header part -->
|
}
|
<!-- Generated by Doxygen 1.8.4 -->
|
function initDynSections(){
|
<div id="navrow1" class="tabs">
|
var divs=document.getElementsByTagName('div');
|
<ul class="tablist">
|
var sectionCounter=1;
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
for(var i=0;i<divs.length-1;i++){
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
var header=divs[i];
|
|
var section=divs[i+1];
|
|
var button=header.firstChild;
|
|
if (button!='IMG'){
|
|
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
|
|
button=document.createElement('img');
|
|
divs[i].insertBefore(button,divs[i].firstChild);
|
|
}
|
|
header.style.cursor='pointer';
|
|
header.onclick=changeDisplayState;
|
|
header.id='dynheader'+sectionCounter;
|
|
button.src='closed.gif';
|
|
section.id='dynsection'+sectionCounter;
|
|
section.style.display='none';
|
|
section.style.marginLeft='14px';
|
|
sectionCounter++;
|
|
}
|
|
}
|
|
}
|
|
window.onload = initDynSections;
|
|
-->
|
|
</script>
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
<li><a href="files.html"><span>Files</span></a></li>
|
</ul>
|
</ul>
|
</div>
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
</div>
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('graph_legend.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Graph Legend</div> </div>
|
|
</div><!--header-->
|
<div class="contents">
|
<div class="contents">
|
<h1>Graph Legend</h1><p>This page explains how to interpret the graphs that are generated by doxygen.</p>
|
<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
|
<p>Consider the following example: </p>
|
<p>Consider the following example: </p>
|
<div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
|
<div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
|
<span class="keyword">class </span>Invisible { };
|
<div class="line"><span class="keyword">class </span>Invisible { };</div>
|
<span class="comment"></span>
|
<div class="line"><span class="comment"></span></div>
|
<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
|
<div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
|
<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
|
<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
|
|
<div class="line"></div>
|
<span class="comment">/* Class not documented with doxygen comments */</span>
|
<div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
|
<span class="keyword">class </span>Undocumented { };
|
<div class="line"><span class="keyword">class </span>Undocumented { };</div>
|
<span class="comment"></span>
|
<div class="line"><span class="comment"></span></div>
|
<span class="comment">/*! Class that is inherited using public inheritance */</span>
|
<div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
|
<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
|
<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
|
<span class="comment"></span>
|
<div class="line"><span class="comment"></span></div>
|
<span class="comment">/*! A template class */</span>
|
<div class="line"><span class="comment">/*! A template class */</span></div>
|
<span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };
|
<div class="line"><span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };</div>
|
<span class="comment"></span>
|
<div class="line"><span class="comment"></span></div>
|
<span class="comment">/*! Class that is inherited using protected inheritance */</span>
|
<div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
|
<span class="keyword">class </span>ProtectedBase { };
|
<div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
|
<span class="comment"></span>
|
<div class="line"><span class="comment"></span></div>
|
<span class="comment">/*! Class that is inherited using private inheritance */</span>
|
<div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
|
<span class="keyword">class </span>PrivateBase { };
|
<div class="line"><span class="keyword">class </span>PrivateBase { };</div>
|
<span class="comment"></span>
|
<div class="line"><span class="comment"></span></div>
|
<span class="comment">/*! Class that is used by the Inherited class */</span>
|
<div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
|
<span class="keyword">class </span>Used { };
|
<div class="line"><span class="keyword">class </span>Used { };</div>
|
<span class="comment"></span>
|
<div class="line"><span class="comment"></span></div>
|
<span class="comment">/*! Super class that inherits a number of other classes */</span>
|
<div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
|
<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
|
<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
|
<span class="keyword">protected</span> ProtectedBase,
|
<div class="line"> <span class="keyword">protected</span> ProtectedBase,</div>
|
<span class="keyword">private</span> PrivateBase,
|
<div class="line"> <span class="keyword">private</span> PrivateBase,</div>
|
<span class="keyword">public</span> Undocumented,
|
<div class="line"> <span class="keyword">public</span> Undocumented,</div>
|
<span class="keyword">public</span> Templ<int>
|
<div class="line"> <span class="keyword">public</span> Templ<int></div>
|
{
|
<div class="line">{</div>
|
<span class="keyword">private</span>:
|
<div class="line"> <span class="keyword">private</span>:</div>
|
Used *m_usedClass;
|
<div class="line"> Used *m_usedClass;</div>
|
};
|
<div class="line">};</div>
|
</pre></div><p> This will result in the following graph:</p>
|
</div><!-- fragment --><p> This will result in the following graph:</p>
|
<center><div align="center">
|
<center><div class="image">
|
<img src="graph_legend.png" alt="graph_legend.png"/>
|
<img src="graph_legend.png" />
|
</div>
|
</div>
|
</center> <p>The boxes in the above graph have the following meaning: </p>
|
</center> <p>The boxes in the above graph have the following meaning: </p>
|
<ul>
|
<ul>
|
<li>
|
<li>
|
A filled gray box represents the struct or class for which the graph is generated. </li>
|
A filled gray box represents the struct or class for which the graph is generated. </li>
|
| Line 121... |
Line 123... |
<li>
|
<li>
|
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>
|
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>
|
<li>
|
<li>
|
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>
|
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>
|
</ul>
|
</ul>
|
</div>
|
</div><!-- contents -->
|
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Apr 2 23:22:36 2010 for AES Avalon Slave (avs_aes) by
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated on Sat Apr 19 2014 17:55:55 for AES Avalon Slave (avs_aes) by
|
<a href="http://www.doxygen.org/index.html">
|
<a href="http://www.doxygen.org/index.html">
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li>
|
|
</ul>
|
|
</div>
|
</body>
|
</body>
|
</html>
|
</html>
|
|
|
No newline at end of file
|
No newline at end of file
|
