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

Revision 472, 5.6 kB (checked in by mido, 15 years ago)

obnovena dokumentace, vcetne pridani mnoha novych doc-souboru do svn

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="annotated.html"><span>Classes</span></a></li>
55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58</div>
59<div class="contents">
60<h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
61Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
62<span class="keyword">class </span>Invisible { };
63<span class="comment"></span>
64<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
65<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
66
67<span class="comment">/* Class not documented with doxygen comments */</span>
68<span class="keyword">class </span>Undocumented { };
69<span class="comment"></span>
70<span class="comment">/*! Class that is inherited using public inheritance */</span>
71<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
72<span class="comment"></span>
73<span class="comment">/*! A template class */</span>
74<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
75<span class="comment"></span>
76<span class="comment">/*! Class that is inherited using protected inheritance */</span>
77<span class="keyword">class </span>ProtectedBase { };
78<span class="comment"></span>
79<span class="comment">/*! Class that is inherited using private inheritance */</span>
80<span class="keyword">class </span>PrivateBase { };
81<span class="comment"></span>
82<span class="comment">/*! Class that is used by the Inherited class */</span>
83<span class="keyword">class </span>Used { };
84<span class="comment"></span>
85<span class="comment">/*! Super class that inherits a number of other classes */</span>
86<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
87                  <span class="keyword">protected</span> ProtectedBase,
88                  <span class="keyword">private</span> PrivateBase,
89                  <span class="keyword">public</span> Undocumented,
90                  <span class="keyword">public</span> Templ&lt;int&gt;
91{
92  <span class="keyword">private</span>:
93    Used *m_usedClass;
94};
95</pre></div> This will result in the following graph:<p>
96<center><div align="center">
97<img src="graph_legend.png" alt="graph_legend.png">
98</div>
99</center> <p>
100The boxes in the above graph have the following meaning: <ul>
101<li>
102A filled gray box represents the struct or class for which the graph is generated. </li>
103<li>
104A box with a black border denotes a documented struct or class. </li>
105<li>
106A box with a grey border denotes an undocumented struct or class. </li>
107<li>
108A 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>
109</ul>
110The arrows have the following meaning: <ul>
111<li>
112A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
113<li>
114A dark green arrow is used for protected inheritance. </li>
115<li>
116A dark red arrow is used for private inheritance. </li>
117<li>
118A 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>
119<li>
120A 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>
121</ul>
122</div>
123<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 5 00:07:03 2009 for mixpp by&nbsp;
124<a href="http://www.doxygen.org/index.html">
125<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
126</body>
127</html>
Note: See TracBrowser for help on using the browser.