← Back to branch summary

~ubuntu-branches/ubuntu/raring/heimdal/raring

« back to all changes in this revision

Viewing changes to doc/doxyout/hdb/html/graph_legend.html

  • Committer: Package Import Robot
  • Author(s): Jelmer Vernooij
  • Date: 2011-10-03 23:50:05 UTC
  • mfrom: (1.1.15) (2.2.23 sid)
  • Revision ID: package-import@ubuntu.com-20111003235005-0voibbgdhyqmtp6w
Tags: 1.5.dfsg.1-3
http://bugs.debian.org/644138
Add conflicts with kcc to heimdal-clients. Closes: #644138

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/doxyout/hdb/html/graph_legend.html
 
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>Heimdalhdblibrary: Graph Legend</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
<link href="tabs.css" rel="stylesheet" type="text/css">
 
6
</head><body>
 
7
<p>
 
8
<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
 
9
</p>
 
10
<!-- end of header marker -->
 
11
<!-- Generated by Doxygen 1.5.6 -->
 
12
<div class="navigation" id="top">
 
13
  <div class="tabs">
 
14
    <ul>
 
15
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
16
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 
17
    </ul>
 
18
  </div>
 
19
</div>
 
20
<div class="contents">
 
21
<h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
 
22
Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
 
23
<span class="keyword">class </span>Invisible { };
 
24
<span class="comment"></span>
 
25
<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
 
26
<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
 
27
 
 
28
<span class="comment">/* Class not documented with doxygen comments */</span>
 
29
<span class="keyword">class </span>Undocumented { };
 
30
<span class="comment"></span>
 
31
<span class="comment">/*! Class that is inherited using public inheritance */</span>
 
32
<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
 
33
<span class="comment"></span>
 
34
<span class="comment">/*! A template class */</span>
 
35
<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
 
36
<span class="comment"></span>
 
37
<span class="comment">/*! Class that is inherited using protected inheritance */</span>
 
38
<span class="keyword">class </span>ProtectedBase { };
 
39
<span class="comment"></span>
 
40
<span class="comment">/*! Class that is inherited using private inheritance */</span>
 
41
<span class="keyword">class </span>PrivateBase { };
 
42
<span class="comment"></span>
 
43
<span class="comment">/*! Class that is used by the Inherited class */</span>
 
44
<span class="keyword">class </span>Used { };
 
45
<span class="comment"></span>
 
46
<span class="comment">/*! Super class that inherits a number of other classes */</span>
 
47
<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
 
48
                  <span class="keyword">protected</span> ProtectedBase,
 
49
                  <span class="keyword">private</span> PrivateBase,
 
50
                  <span class="keyword">public</span> Undocumented,
 
51
                  <span class="keyword">public</span> Templ&lt;int&gt;
 
52
{
 
53
  <span class="keyword">private</span>:
 
54
    Used *m_usedClass;
 
55
};
 
56
</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>
 
57
<center><div align="center">
 
58
<img src="graph_legend.png" alt="graph_legend.png">
 
59
</div>
 
60
</center> <p>
 
61
The boxes in the above graph have the following meaning: <ul>
 
62
<li>
 
63
A filled gray box represents the struct or class for which the graph is generated. </li>
 
64
<li>
 
65
A box with a black border denotes a documented struct or class. </li>
 
66
<li>
 
67
A box with a grey border denotes an undocumented struct or class. </li>
 
68
<li>
 
69
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>
 
70
</ul>
 
71
The arrows have the following meaning: <ul>
 
72
<li>
 
73
A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
 
74
<li>
 
75
A dark green arrow is used for protected inheritance. </li>
 
76
<li>
 
77
A dark red arrow is used for private inheritance. </li>
 
78
<li>
 
79
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>
 
80
<li>
 
81
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
</ul>
 
83
</div>
 
84
<hr size="1"><address style="text-align: right;"><small>
 
85
Generated on Sat Jul 30 13:45:38 2011 for Heimdalhdblibrary by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
 
86
</body>
 
87
</html>