1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>Light Media Scanner: Graph Legend</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top">
11 <li><a href="index.html"><span>Main Page</span></a></li>
12 <li><a href="modules.html"><span>Modules</span></a></li>
13 <li><a href="classes.html"><span>Data Structures</span></a></li>
14 <li><a href="files.html"><span>Files</span></a></li>
18 <div class="contents">
19 <h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
20 Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
21 <span class="keyword">class </span>Invisible { };
22 <span class="comment"></span>
23 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
24 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
26 <span class="comment">/* Class not documented with doxygen comments */</span>
27 <span class="keyword">class </span>Undocumented { };
28 <span class="comment"></span>
29 <span class="comment">/*! Class that is inherited using public inheritance */</span>
30 <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
31 <span class="comment"></span>
32 <span class="comment">/*! A template class */</span>
33 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };
34 <span class="comment"></span>
35 <span class="comment">/*! Class that is inherited using protected inheritance */</span>
36 <span class="keyword">class </span>ProtectedBase { };
37 <span class="comment"></span>
38 <span class="comment">/*! Class that is inherited using private inheritance */</span>
39 <span class="keyword">class </span>PrivateBase { };
40 <span class="comment"></span>
41 <span class="comment">/*! Class that is used by the Inherited class */</span>
42 <span class="keyword">class </span>Used { };
43 <span class="comment"></span>
44 <span class="comment">/*! Super class that inherits a number of other classes */</span>
45 <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
46 <span class="keyword">protected</span> ProtectedBase,
47 <span class="keyword">private</span> PrivateBase,
48 <span class="keyword">public</span> Undocumented,
49 <span class="keyword">public</span> Templ<int>
51 <span class="keyword">private</span>:
54 </pre></div> If the <code>MAX_DOT_GRAPH_HEIGHT</code> tag in the configuration file is set to 240 this will result in the following graph:<p>
55 <center><div align="center">
56 <img src="graph_legend.png" alt="graph_legend.png">
59 The boxes in the above graph have the following meaning: <ul>
61 A filled gray box represents the struct or class for which the graph is generated. </li>
63 A box with a black border denotes a documented struct or class. </li>
65 A box with a grey border denotes an undocumented struct or class. </li>
67 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>
69 The arrows have the following meaning: <ul>
71 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
73 A dark green arrow is used for protected inheritance. </li>
75 A dark red arrow is used for private inheritance. </li>
77 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>
79 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>
82 <hr size="1"><address style="text-align: right;"><small>Generated on Sun Oct 5 12:24:59 2008 for Light Media Scanner by
83 <a href="http://www.doxygen.org/index.html">
84 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>