Mercurial > hg > vamp-website
comparison code-doc/graph_legend.html @ 0:351c4ebce5f9 website
* Move website from vamp-website/trunk to plain website
| author | cannam |
|---|---|
| date | Mon, 22 Sep 2008 13:01:46 +0000 |
| parents | |
| children | cc0be37dc9d3 |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:351c4ebce5f9 |
|---|---|
| 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>VampPluginSDK: 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 <!-- Generated by Doxygen 1.5.5 --> | |
| 8 <div class="navigation" id="top"> | |
| 9 <div class="tabs"> | |
| 10 <ul> | |
| 11 <li><a href="main.html"><span>Main Page</span></a></li> | |
| 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> | |
| 13 <li><a href="annotated.html"><span>Classes</span></a></li> | |
| 14 <li><a href="files.html"><span>Files</span></a></li> | |
| 15 <li><a href="dirs.html"><span>Directories</span></a></li> | |
| 16 </ul> | |
| 17 </div> | |
| 18 </div> | |
| 19 <div class="contents"> | |
| 20 <h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p> | |
| 21 Consider the following example: <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span> | |
| 22 <span class="keyword">class </span>Invisible { }; | |
| 23 <span class="comment"></span> | |
| 24 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span> | |
| 25 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { }; | |
| 26 | |
| 27 <span class="comment">/* Class not documented with doxygen comments */</span> | |
| 28 <span class="keyword">class </span>Undocumented { }; | |
| 29 <span class="comment"></span> | |
| 30 <span class="comment">/*! Class that is inherited using public inheritance */</span> | |
| 31 <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { }; | |
| 32 <span class="comment"></span> | |
| 33 <span class="comment">/*! A template class */</span> | |
| 34 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { }; | |
| 35 <span class="comment"></span> | |
| 36 <span class="comment">/*! Class that is inherited using protected inheritance */</span> | |
| 37 <span class="keyword">class </span>ProtectedBase { }; | |
| 38 <span class="comment"></span> | |
| 39 <span class="comment">/*! Class that is inherited using private inheritance */</span> | |
| 40 <span class="keyword">class </span>PrivateBase { }; | |
| 41 <span class="comment"></span> | |
| 42 <span class="comment">/*! Class that is used by the Inherited class */</span> | |
| 43 <span class="keyword">class </span>Used { }; | |
| 44 <span class="comment"></span> | |
| 45 <span class="comment">/*! Super class that inherits a number of other classes */</span> | |
| 46 <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase, | |
| 47 <span class="keyword">protected</span> ProtectedBase, | |
| 48 <span class="keyword">private</span> PrivateBase, | |
| 49 <span class="keyword">public</span> Undocumented, | |
| 50 <span class="keyword">public</span> Templ<int> | |
| 51 { | |
| 52 <span class="keyword">private</span>: | |
| 53 Used *m_usedClass; | |
| 54 }; | |
| 55 </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> | |
| 56 <center><div align="center"> | |
| 57 <img src="graph_legend.png" alt="graph_legend.png"> | |
| 58 </div> | |
| 59 </center> <p> | |
| 60 The boxes in the above graph have the following meaning: <ul> | |
| 61 <li> | |
| 62 A filled gray box represents the struct or class for which the graph is generated. </li> | |
| 63 <li> | |
| 64 A box with a black border denotes a documented struct or class. </li> | |
| 65 <li> | |
| 66 A box with a grey border denotes an undocumented struct or class. </li> | |
| 67 <li> | |
| 68 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> | |
| 69 </ul> | |
| 70 The arrows have the following meaning: <ul> | |
| 71 <li> | |
| 72 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li> | |
| 73 <li> | |
| 74 A dark green arrow is used for protected inheritance. </li> | |
| 75 <li> | |
| 76 A dark red arrow is used for private inheritance. </li> | |
| 77 <li> | |
| 78 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> | |
| 79 <li> | |
| 80 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> | |
| 81 </ul> | |
| 82 </div> | |
| 83 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:11 2008 for VampPluginSDK by | |
| 84 <a href="http://www.doxygen.org/index.html"> | |
| 85 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> | |
| 86 </body> | |
| 87 </html> |