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 11

Go to most recent revision | 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 
<title>AES Avalon Slave (avs_aes): Graph Legend</title>
6 
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7 
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8 
</head>
9 
<body>
10 
<!-- Generated by Doxygen 1.6.1 -->
11 
<script type="text/javascript">
12 
<!--
13 
function changeDisplayState (e){
14 
  var num=this.id.replace(/[^[0-9]/g,'');
15 
  var button=this.firstChild;
16 
  var sectionDiv=document.getElementById('dynsection'+num);
17 
  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
18 
    sectionDiv.style.display='block';
19 
    button.src='open.gif';
20 
  }else{
21 
    sectionDiv.style.display='none';
22 
    button.src='closed.gif';
23 
  }
24 
}
25 
function initDynSections(){
26 
  var divs=document.getElementsByTagName('div');
27 
  var sectionCounter=1;
28 
  for(var i=0;i<divs.length-1;i++){
29 
    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
30 
      var header=divs[i];
31 
      var section=divs[i+1];
32 
      var button=header.firstChild;
33 
      if (button!='IMG'){
34 
        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
35 
        button=document.createElement('img');
36 
        divs[i].insertBefore(button,divs[i].firstChild);
37 
      }
38 
      header.style.cursor='pointer';
39 
      header.onclick=changeDisplayState;
40 
      header.id='dynheader'+sectionCounter;
41 
      button.src='closed.gif';
42 
      section.id='dynsection'+sectionCounter;
43 
      section.style.display='none';
44 
      section.style.marginLeft='14px';
45 
      sectionCounter++;
46 
    }
47 
  }
48 
}
49 
window.onload = initDynSections;
50 
-->
51 
</script>
52 
<div class="navigation" id="top">
53 
  <div class="tabs">
54 
    <ul>
55 
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
56 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
57 
      <li><a href="files.html"><span>Files</span></a></li>
58 
    </ul>
59 
  </div>
60 
</div>
61 
<div class="contents">
62 
<h1>Graph Legend</h1><p>This page explains how to interpret the graphs that are generated by doxygen.</p>
63 
<p>Consider the following example: </p>
64 
<div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
65 
<span class="keyword">class </span>Invisible { };
66 
<span class="comment"></span>
67 
<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
68 
<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
69 
 
70 
<span class="comment">/* Class not documented with doxygen comments */</span>
71 
<span class="keyword">class </span>Undocumented { };
72 
<span class="comment"></span>
73 
<span class="comment">/*! Class that is inherited using public inheritance */</span>
74 
<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
75 
<span class="comment"></span>
76 
<span class="comment">/*! A template class */</span>
77 
<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
78 
<span class="comment"></span>
79 
<span class="comment">/*! Class that is inherited using protected inheritance */</span>
80 
<span class="keyword">class </span>ProtectedBase { };
81 
<span class="comment"></span>
82 
<span class="comment">/*! Class that is inherited using private inheritance */</span>
83 
<span class="keyword">class </span>PrivateBase { };
84 
<span class="comment"></span>
85 
<span class="comment">/*! Class that is used by the Inherited class */</span>
86 
<span class="keyword">class </span>Used { };
87 
<span class="comment"></span>
88 
<span class="comment">/*! Super class that inherits a number of other classes */</span>
89 
<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
90 
                  <span class="keyword">protected</span> ProtectedBase,
91 
                  <span class="keyword">private</span> PrivateBase,
92 
                  <span class="keyword">public</span> Undocumented,
93 
                  <span class="keyword">public</span> Templ&lt;int&gt;
94 
{
95 
  <span class="keyword">private</span>:
96 
    Used *m_usedClass;
97 
};
98 
</pre></div><p> This will result in the following graph:</p>
99 
<center><div align="center">
100 
<img src="graph_legend.png" alt="graph_legend.png"/>
101 
</div>
102 
</center> <p>The boxes in the above graph have the following meaning:  </p>
103 
<ul>
104 
<li>
105 
A filled gray box represents the struct or class for which the graph is generated. </li>
106 
<li>
107 
A box with a black border denotes a documented struct or class. </li>
108 
<li>
109 
A box with a grey border denotes an undocumented struct or class. </li>
110 
<li>
111 
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>
112 
</ul>
113 
<p>The arrows have the following meaning:  </p>
114 
<ul>
115 
<li>
116 
A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
117 
<li>
118 
A dark green arrow is used for protected inheritance. </li>
119 
<li>
120 
A dark red arrow is used for private inheritance. </li>
121 
<li>
122 
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>
123 
<li>
124 
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>
125 
</ul>
126 
</div>
127 
<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&nbsp;
128 
<a href="http://www.doxygen.org/index.html">
129 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
130 
</body>
131 
</html>

powered by: WebSVN 2.1.0

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