120 lines
6.2 KiB
HTML
120 lines
6.2 KiB
HTML
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0//EN'>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>Oroshi Documentation</title>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="SoC.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head>
|
|
<h1 id="pagetop" class="header">Oroshi - Analog Devices Layouts</h1>
|
|
<!--
|
|
<center class="header">
|
|
<table class="header">
|
|
<tr>
|
|
<td><a href="customSummary.html">Summary</a></td>
|
|
<td><a href="namespaces.html">Namespaces</a></td>
|
|
<td><a href="customHierarchy.html">Class Hierarchy</a></td>
|
|
<td><a href="annotated.html">Classes</a></td>
|
|
<td><a href="functions.html">Member Index</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
-->
|
|
<br>
|
|
<body onload="javascript:toggleLevel(1)">
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Graph Legend</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
|
|
<p>Consider the following example: </p><div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
|
|
<div class="line"><span class="keyword">class </span>Invisible { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
|
|
<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
|
|
<div class="line"><span class="keyword">class </span>Undocumented { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
|
|
<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! A template class */</span></div>
|
|
<div class="line"><span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
|
|
<div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
|
|
<div class="line"><span class="keyword">class </span>PrivateBase { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
|
|
<div class="line"><span class="keyword">class </span>Used { };</div>
|
|
<div class="line"><span class="comment"></span> </div>
|
|
<div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
|
|
<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
|
|
<div class="line"> <span class="keyword">protected</span> ProtectedBase,</div>
|
|
<div class="line"> <span class="keyword">private</span> PrivateBase,</div>
|
|
<div class="line"> <span class="keyword">public</span> Undocumented,</div>
|
|
<div class="line"> <span class="keyword">public</span> Templ<int></div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="keyword">private</span>:</div>
|
|
<div class="line"> Used *m_usedClass;</div>
|
|
<div class="line">};</div>
|
|
</div><!-- fragment --><p> This will result in the following graph:</p>
|
|
<center><img src="graph_legend.png" alt="" class="inline"/></center><p>The boxes in the above graph have the following meaning: </p>
|
|
<ul>
|
|
<li>
|
|
A filled gray box represents the struct or class for which the graph is generated. </li>
|
|
<li>
|
|
A box with a black border denotes a documented struct or class. </li>
|
|
<li>
|
|
A box with a gray border denotes an undocumented struct or class. </li>
|
|
<li>
|
|
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>
|
|
</ul>
|
|
<p>The arrows have the following meaning: </p>
|
|
<ul>
|
|
<li>
|
|
A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
|
|
<li>
|
|
A dark green arrow is used for protected inheritance. </li>
|
|
<li>
|
|
A dark red arrow is used for private inheritance. </li>
|
|
<li>
|
|
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>
|
|
<li>
|
|
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>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<br>
|
|
<hr>
|
|
<table class="footer1">
|
|
<tr>
|
|
<td class="LFooter"><small>Generated by doxygen 1.9.1 on Tue Feb 21 2023</small></td>
|
|
<td class="RFooter"><a href='#pagetop'><small>Return to top of page</small></a></td>
|
|
</tr>
|
|
</table>
|
|
<table class="footer2">
|
|
<tr>
|
|
<td class="LFooter">Oroshi - Analog Devices Layouts</td>
|
|
<td class="RFooter"><small>Copyright © 2018-2020 Sorbonne Universite, All rights reserved</small></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|