root/library/doc/html/graph_legend.html @ 661

Revision 661, 5.7 kB (checked in by smidl, 15 years ago)

doc

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>mixpp: 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.6.1 -->
11<script type="text/javascript">
12<!--
13function changeDisplayState (e){
14  var num=this.id.replace(/[^[0-9]/g,'');
15  var button=this.firstChild;
16  var sectionDiv=document.getElementById('dynsection'+num);
17  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
18    sectionDiv.style.display='block';
19    button.src='open.gif';
20  }else{
21    sectionDiv.style.display='none';
22    button.src='closed.gif';
23  }
24}
25function initDynSections(){
26  var divs=document.getElementsByTagName('div');
27  var sectionCounter=1;
28  for(var i=0;i<divs.length-1;i++){
29    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
30      var header=divs[i];
31      var section=divs[i+1];
32      var button=header.firstChild;
33      if (button!='IMG'){
34        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
35        button=document.createElement('img');
36        divs[i].insertBefore(button,divs[i].firstChild);
37      }
38      header.style.cursor='pointer';
39      header.onclick=changeDisplayState;
40      header.id='dynheader'+sectionCounter;
41      button.src='closed.gif';
42      section.id='dynsection'+sectionCounter;
43      section.style.display='none';
44      section.style.marginLeft='14px';
45      sectionCounter++;
46    }
47  }
48}
49window.onload = initDynSections;
50-->
51</script>
52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
57      <li><a href="annotated.html"><span>Classes</span></a></li>
58      <li><a href="files.html"><span>Files</span></a></li>
59    </ul>
60  </div>
61</div>
62<div class="contents">
63<h1>Graph Legend</h1><p>This page explains how to interpret the graphs that are generated by doxygen.</p>
64<p>Consider the following example: </p>
65<div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
66<span class="keyword">class </span>Invisible { };
67<span class="comment"></span>
68<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
69<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
70
71<span class="comment">/* Class not documented with doxygen comments */</span>
72<span class="keyword">class </span>Undocumented { };
73<span class="comment"></span>
74<span class="comment">/*! Class that is inherited using public inheritance */</span>
75<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
76<span class="comment"></span>
77<span class="comment">/*! A template class */</span>
78<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
79<span class="comment"></span>
80<span class="comment">/*! Class that is inherited using protected inheritance */</span>
81<span class="keyword">class </span>ProtectedBase { };
82<span class="comment"></span>
83<span class="comment">/*! Class that is inherited using private inheritance */</span>
84<span class="keyword">class </span>PrivateBase { };
85<span class="comment"></span>
86<span class="comment">/*! Class that is used by the Inherited class */</span>
87<span class="keyword">class </span>Used { };
88<span class="comment"></span>
89<span class="comment">/*! Super class that inherits a number of other classes */</span>
90<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
91                  <span class="keyword">protected</span> ProtectedBase,
92                  <span class="keyword">private</span> PrivateBase,
93                  <span class="keyword">public</span> Undocumented,
94                  <span class="keyword">public</span> Templ&lt;int&gt;
95{
96  <span class="keyword">private</span>:
97    Used *m_usedClass;
98};
99</pre></div><p> This will result in the following graph:</p>
100<center><div align="center">
101<img src="graph_legend.png" alt="graph_legend.png"/>
102</div>
103</center> <p>The boxes in the above graph have the following meaning:  </p>
104<ul>
105<li>
106A filled gray box represents the struct or class for which the graph is generated. </li>
107<li>
108A box with a black border denotes a documented struct or class. </li>
109<li>
110A box with a grey border denotes an undocumented struct or class. </li>
111<li>
112A 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>
113</ul>
114<p>The arrows have the following meaning:  </p>
115<ul>
116<li>
117A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
118<li>
119A dark green arrow is used for protected inheritance. </li>
120<li>
121A dark red arrow is used for private inheritance. </li>
122<li>
123A 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>
124<li>
125A 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>
126</ul>
127</div>
128<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Oct 15 00:07:50 2009 for mixpp by&nbsp;
129<a href="http://www.doxygen.org/index.html">
130<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
131</body>
132</html>
Note: See TracBrowser for help on using the browser.