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

Revision 396, 5.7 kB (checked in by mido, 15 years ago)

UI documentation almost finished; UIException redesigned and used instead of UI::ui_error function

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