forked from OSchip/llvm-project
101 lines
5.5 KiB
HTML
101 lines
5.5 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
|
|
<html><head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
|
||
|
|
<meta name="keywords" content="LLDB,C++,doxygen,API,documentation"/>
|
||
|
|
<meta name="description" content="C++ source code API documentation for LLDB."/>
|
||
|
|
<title>LLVM: Graph Legend</title>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
||
|
|
</head><body>
|
||
|
|
<p class="title">LLDB API Documentation</p>
|
||
|
|
<!-- Generated by Doxygen 1.8.1.2 -->
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
||
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</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><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 -->
|
||
|
|
<hr>
|
||
|
|
<p class="footer">
|
||
|
|
Generated on Fri Jul 19 2013 13:25:55 for <a href="http://lldb.llvm.org/">LLVM</a> by
|
||
|
|
<a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen"
|
||
|
|
align="middle" border="0"/>1.8.1.2</a><br>
|
||
|
|
Copyright © 2003-2013 University of Illinois at Urbana-Champaign.
|
||
|
|
All Rights Reserved.</p>
|
||
|
|
<hr>
|
||
|
|
<!--#include virtual="/attrib.incl" -->
|
||
|
|
</body>
|
||
|
|
</html>
|