doc/doxygen/html/graph_legend.html
author nico
Tue, 05 Jun 2007 18:43:21 +0200
changeset 210 6b5a4c21e061
parent 207 b6572d0336c3
child 215 f49e5a6b7804
permissions -rw-r--r--
Manual and Documentation finish
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
<title>CanFestival: Graph Legend</title>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
<link href="doxygen.css" rel="stylesheet" type="text/css">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
<link href="tabs.css" rel="stylesheet" type="text/css">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
</head><body>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
<!-- Generated by Doxygen 1.5.1 -->
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
<div class="tabs">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
  <ul>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
    <li><a href="files.html"><span>Files</span></a></li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
  </ul></div>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
<h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
<span class="keyword">class </span>Invisible { };
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
<span class="comment"></span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
<span class="comment">/* Class not documented with doxygen comments */</span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
<span class="keyword">class </span>Undocumented { };
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
<span class="comment"></span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
<span class="comment">/*! Class that is inherited using public inheritance */</span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
<span class="comment"></span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
<span class="comment">/*! A template class */</span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
<span class="comment"></span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
<span class="comment">/*! Class that is inherited using protected inheritance */</span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
<span class="keyword">class </span>ProtectedBase { };
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
<span class="comment"></span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
<span class="comment">/*! Class that is inherited using private inheritance */</span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
<span class="keyword">class </span>PrivateBase { };
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
<span class="comment"></span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
<span class="comment">/*! Class that is used by the Inherited class */</span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
<span class="keyword">class </span>Used { };
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
<span class="comment"></span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
<span class="comment">/*! Super class that inherits a number of other classes */</span>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
                  <span class="keyword">protected</span> ProtectedBase,
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
                  <span class="keyword">private</span> PrivateBase,
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
                  <span class="keyword">public</span> Undocumented
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
                  <span class="keyword">public</span> Templ&lt;int&gt;
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
  <span class="keyword">private</span>:
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
    Used *m_usedClass;
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
};
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
</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>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
<center><div align="center">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
<img src="graph_legend.png" alt="graph_legend.png">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
</div>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
</center> <p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
The boxes in the above graph have the following meaning: <ul>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
<li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
A filled black box represents the struct or class for which the graph is generated. </li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
<li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
A box with a black border denotes a documented struct or class. </li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
<li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
A box with a grey border denotes an undocumented struct or class. </li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
<li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
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>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
</ul>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
The arrows have the following meaning: <ul>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
<li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
<li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
A dark green arrow is used for protected inheritance. </li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
<li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
A dark red arrow is used for private inheritance. </li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
<li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
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>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
<li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
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>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
</ul>
210
6b5a4c21e061 Manual and Documentation finish
nico
parents: 207
diff changeset
    75
<hr size="1"><address style="align: right;"><small>Generated on Tue Jun 5 18:32:11 2007 for CanFestival by&nbsp;
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
<a href="http://www.doxygen.org/index.html">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
</body>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
</html>