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