140 lines
6.9 KiB
HTML
140 lines
6.9 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"/>
|
||
|
|
<title>CTHN.de - LEDCube - commandline client: Graph Legend</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
||
|
|
</head>
|
||
|
|
<body onload='searchBox.OnSelectItem(0);'>
|
||
|
|
<!-- Generated by Doxygen 1.7.4 -->
|
||
|
|
<script type="text/javascript"><!--
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
--></script>
|
||
|
|
<div id="top">
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">CTHN.de - LEDCube - commandline client</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
||
|
|
<li id="searchli">
|
||
|
|
<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>
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Graph Legend</div> </div>
|
||
|
|
</div>
|
||
|
|
<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"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
|
||
|
|
<span class="keyword">class </span>Invisible { };
|
||
|
|
<span class="comment"></span>
|
||
|
|
<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
|
||
|
|
<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
|
||
|
|
|
||
|
|
<span class="comment">/* Class not documented with doxygen comments */</span>
|
||
|
|
<span class="keyword">class </span>Undocumented { };
|
||
|
|
<span class="comment"></span>
|
||
|
|
<span class="comment">/*! Class that is inherited using public inheritance */</span>
|
||
|
|
<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
|
||
|
|
<span class="comment"></span>
|
||
|
|
<span class="comment">/*! A template class */</span>
|
||
|
|
<span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };
|
||
|
|
<span class="comment"></span>
|
||
|
|
<span class="comment">/*! Class that is inherited using protected inheritance */</span>
|
||
|
|
<span class="keyword">class </span>ProtectedBase { };
|
||
|
|
<span class="comment"></span>
|
||
|
|
<span class="comment">/*! Class that is inherited using private inheritance */</span>
|
||
|
|
<span class="keyword">class </span>PrivateBase { };
|
||
|
|
<span class="comment"></span>
|
||
|
|
<span class="comment">/*! Class that is used by the Inherited class */</span>
|
||
|
|
<span class="keyword">class </span>Used { };
|
||
|
|
<span class="comment"></span>
|
||
|
|
<span class="comment">/*! Super class that inherits a number of other classes */</span>
|
||
|
|
<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
|
||
|
|
<span class="keyword">protected</span> ProtectedBase,
|
||
|
|
<span class="keyword">private</span> PrivateBase,
|
||
|
|
<span class="keyword">public</span> Undocumented,
|
||
|
|
<span class="keyword">public</span> Templ<int>
|
||
|
|
{
|
||
|
|
<span class="keyword">private</span>:
|
||
|
|
Used *m_usedClass;
|
||
|
|
};
|
||
|
|
</pre></div><p> This will result in the following graph:</p>
|
||
|
|
<center><div class="image">
|
||
|
|
<img src="graph_legend.png" alt="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>
|
||
|
|
<!-- 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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Defines</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>
|
||
|
|
|
||
|
|
<hr class="footer"/><address class="footer"><small>Generated on Sun Dec 25 2011 13:37:31 for CTHN.de - LEDCube - commandline client by 
|
||
|
|
<a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|