source: s10k/CommonLibs/quazip-0.7.2/doc/html/graph_legend.html@ 1149

Last change on this file since 1149 was 1096, checked in by s10k, 8 years ago

Added zlib, quazip, basicxmlsyntaxhighlighter, conditionalsemaphore and linenumberdisplay libraries. zlib and quazip are pre-compiled, but you can compile them yourself, just delete the dll files (or equivalent binary files to your OS)
File size: 4.9 KB
Line 
1<!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>QuaZIP: 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.7.4 -->
11<div id="top">
12<div id="titlearea">
13<table cellspacing="0" cellpadding="0">
14 <tbody>
15 <tr style="height: 56px;">
16 <td style="padding-left: 0.5em;">
17 <div id="projectname">QuaZIP&#160;<span id="projectnumber">quazip-0-7-2</span></div>
18 </td>
19 </tr>
20 </tbody>
21</table>
22</div>
23 <div id="navrow1" class="tabs">
24 <ul class="tablist">
25 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
26 <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
27 <li><a href="annotated.html"><span>Classes</span></a></li>
28 <li><a href="files.html"><span>Files</span></a></li>
29 <li><a href="dirs.html"><span>Directories</span></a></li>
30 </ul>
31 </div>
32</div>
33<div class="header">
34 <div class="headertitle">
35<div class="title">Graph Legend</div> </div>
36</div>
37<div class="contents">
38<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
39<p>Consider the following example: </p>
40<div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
41<span class="keyword">class </span>Invisible { };
42<span class="comment"></span>
43<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
44<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
45
46<span class="comment">/* Class not documented with doxygen comments */</span>
47<span class="keyword">class </span>Undocumented { };
48<span class="comment"></span>
49<span class="comment">/*! Class that is inherited using public inheritance */</span>
50<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
51<span class="comment"></span>
52<span class="comment">/*! A template class */</span>
53<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
54<span class="comment"></span>
55<span class="comment">/*! Class that is inherited using protected inheritance */</span>
56<span class="keyword">class </span>ProtectedBase { };
57<span class="comment"></span>
58<span class="comment">/*! Class that is inherited using private inheritance */</span>
59<span class="keyword">class </span>PrivateBase { };
60<span class="comment"></span>
61<span class="comment">/*! Class that is used by the Inherited class */</span>
62<span class="keyword">class </span>Used { };
63<span class="comment"></span>
64<span class="comment">/*! Super class that inherits a number of other classes */</span>
65<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
66 <span class="keyword">protected</span> ProtectedBase,
67 <span class="keyword">private</span> PrivateBase,
68 <span class="keyword">public</span> Undocumented,
69 <span class="keyword">public</span> Templ&lt;int&gt;
70{
71 <span class="keyword">private</span>:
72 Used *m_usedClass;
73};
74</pre></div><p> This will result in the following graph:</p>
75<center><div class="image">
76<img src="graph_legend.png" alt="graph_legend.png"/>
77</div>
78</center> <p>The boxes in the above graph have the following meaning: </p>
79<ul>
80<li>
81A filled gray box represents the struct or class for which the graph is generated. </li>
82<li>
83A box with a black border denotes a documented struct or class. </li>
84<li>
85A box with a grey border denotes an undocumented struct or class. </li>
86<li>
87A 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>
88</ul>
89<p>The arrows have the following meaning: </p>
90<ul>
91<li>
92A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
93<li>
94A dark green arrow is used for protected inheritance. </li>
95<li>
96A dark red arrow is used for private inheritance. </li>
97<li>
98A 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>
99<li>
100A 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>
101</ul>
102</div>
103<hr class="footer"/><address class="footer"><small>Generated on Sun Apr 3 2016 08:26:25 for QuaZIP by&#160;
104<a href="http://www.doxygen.org/index.html">
105<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
106</body>
107</html>
Note: See TracBrowser for help on using the repository browser.