mirror of
https://github.com/ChronosX88/netsukuku.git
synced 2024-11-22 02:02:20 +00:00
180 lines
9.6 KiB
HTML
180 lines
9.6 KiB
HTML
<!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">
|
|
<head>
|
|
<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.6"/>
|
|
<title>The Netsukuku Project: Graph Legend</title>
|
|
<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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="Logo_netsukuku.jpg"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">The Netsukuku Project
|
|
 <span id="projectnumber">0.0.9</span>
|
|
</div>
|
|
<div id="projectbrief">An Alternative routing method</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.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>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('graph_legend.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<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><div class="image">
|
|
<img src="graph_legend.png" />
|
|
</div>
|
|
</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 grey 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 labeled 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 labeled with the template parameters of the instance. </li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated on Wed Feb 19 2014 16:29:53 for The Netsukuku Project by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|