source: tspsg-svn/trunk/docs/html/graph_legend.html @ 118

Last change on this file since 118 was 112, checked in by laleppa, 15 years ago

Updated translations and regenerated documentation.
File size: 8.7 KB
RevLine 
[68]1<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<title>TSPSG: TSP Solver and Generator: Graph Legend</title>
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="search/search.css" rel="stylesheet" type="text/css"/>
9<script type="text/javaScript" src="search/search.js"></script>
10<link href="doxygen.css" rel="stylesheet" type="text/css"/>
11</head>
12<body onload='searchBox.OnSelectItem(0);'>
13<!-- Generated by Doxygen 1.6.1 -->
14<script type="text/javascript"><!--
15var searchBox = new SearchBox("searchBox", "search",false,'Search');
16--></script>
17<script type="text/javascript">
18<!--
19function changeDisplayState (e){
20  var num=this.id.replace(/[^[0-9]/g,'');
21  var button=this.firstChild;
22  var sectionDiv=document.getElementById('dynsection'+num);
23  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
24    sectionDiv.style.display='block';
25    button.src='open.gif';
26  }else{
27    sectionDiv.style.display='none';
28    button.src='closed.gif';
29  }
30}
31function initDynSections(){
32  var divs=document.getElementsByTagName('div');
33  var sectionCounter=1;
34  for(var i=0;i<divs.length-1;i++){
35    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
36      var header=divs[i];
37      var section=divs[i+1];
38      var button=header.firstChild;
39      if (button!='IMG'){
40        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
41        button=document.createElement('img');
42        divs[i].insertBefore(button,divs[i].firstChild);
43      }
44      header.style.cursor='pointer';
45      header.onclick=changeDisplayState;
46      header.id='dynheader'+sectionCounter;
47      button.src='closed.gif';
48      section.id='dynsection'+sectionCounter;
49      section.style.display='none';
50      section.style.marginLeft='14px';
51      sectionCounter++;
52    }
53  }
54}
55window.onload = initDynSections;
56-->
57</script>
58<div class="navigation" id="top">
59  <div class="tabs">
60    <ul>
61      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
62      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
[112]63      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
[68]64      <li><a href="annotated.html"><span>Classes</span></a></li>
65      <li><a href="files.html"><span>Files</span></a></li>
66      <li>
67        <div id="MSearchBox" class="MSearchBoxInactive">
68        <img id="MSearchSelect" src="search/search.png"
69             onmouseover="return searchBox.OnSearchSelectShow()"
70             onmouseout="return searchBox.OnSearchSelectHide()"
71             alt=""/>
72        <input type="text" id="MSearchField" value="Search" accesskey="S"
73             onfocus="searchBox.OnSearchFieldFocus(true)" 
74             onblur="searchBox.OnSearchFieldFocus(false)" 
75             onkeyup="searchBox.OnSearchFieldChange(event)"/>
76        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
77        </div>
78      </li>
79    </ul>
80  </div>
81</div>
82<div class="contents">
83<h1>Graph Legend</h1><p>This page explains how to interpret the graphs that are generated by doxygen.</p>
84<p>Consider the following example: </p>
85<div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
86<span class="keyword">class </span>Invisible { };
87<span class="comment"></span>
88<span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
89<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
90
91<span class="comment">/* Class not documented with doxygen comments */</span>
92<span class="keyword">class </span>Undocumented { };
93<span class="comment"></span>
94<span class="comment">/*! Class that is inherited using public inheritance */</span>
95<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
96<span class="comment"></span>
97<span class="comment">/*! A template class */</span>
98<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
99<span class="comment"></span>
100<span class="comment">/*! Class that is inherited using protected inheritance */</span>
101<span class="keyword">class </span>ProtectedBase { };
102<span class="comment"></span>
103<span class="comment">/*! Class that is inherited using private inheritance */</span>
104<span class="keyword">class </span>PrivateBase { };
105<span class="comment"></span>
106<span class="comment">/*! Class that is used by the Inherited class */</span>
107<span class="keyword">class </span>Used { };
108<span class="comment"></span>
109<span class="comment">/*! Super class that inherits a number of other classes */</span>
110<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
111                  <span class="keyword">protected</span> ProtectedBase,
112                  <span class="keyword">private</span> PrivateBase,
113                  <span class="keyword">public</span> Undocumented,
114                  <span class="keyword">public</span> Templ&lt;int&gt;
115{
116  <span class="keyword">private</span>:
117    Used *m_usedClass;
118};
119</pre></div><p> This will result in the following graph:</p>
120<center><div align="center">
121<img src="graph_legend.png" alt="graph_legend.png"/>
122</div>
123</center> <p>The boxes in the above graph have the following meaning:  </p>
124<ul>
125<li>
126A filled gray box represents the struct or class for which the graph is generated. </li>
127<li>
128A box with a black border denotes a documented struct or class. </li>
129<li>
130A box with a grey border denotes an undocumented struct or class. </li>
131<li>
132A 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>
133</ul>
134<p>The arrows have the following meaning:  </p>
135<ul>
136<li>
137A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
138<li>
139A dark green arrow is used for protected inheritance. </li>
140<li>
141A dark red arrow is used for private inheritance. </li>
142<li>
143A 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>
144<li>
145A 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>
146</ul>
147</div>
148<!--- window showing the filter options -->
149<div id="MSearchSelectWindow"
150     onmouseover="return searchBox.OnSearchSelectShow()"
151     onmouseout="return searchBox.OnSearchSelectHide()"
152     onkeydown="return searchBox.OnSearchSelectKey(event)">
[112]153<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>
[68]154
155<!-- iframe showing the search results (closed by default) -->
156<div id="MSearchResultsWindow">
157<iframe src="" frameborder="0" 
158        name="MSearchResults" id="MSearchResults">
159</iframe>
160</div>
161
[112]162<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Apr 28 02:47:21 2010 for TSPSG: TSP Solver and Generator by&nbsp;
[68]163<a href="http://www.doxygen.org/index.html">
164<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
165</body>
166</html>
Note: See TracBrowser for help on using the repository browser.