Annotation of embedaddon/libnet/doc/html/graph_legend.html, revision 1.1
1.1 ! misho 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
! 2: <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
! 3: <title>libnet: Graph Legend</title>
! 4: <link href="doxygen.css" rel="stylesheet" type="text/css">
! 5: </head><body>
! 6: <!-- Generated by Doxygen 1.3.4 -->
! 7: <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
! 8: <h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.<p>
! 9: Consider the following example: <div class="fragment"><pre><span class="comment">/*! Invisible class because of truncation */</span>
! 10: <span class="keyword">class </span>Invisible { };
! 11: <span class="comment"></span>
! 12: <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
! 13: <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
! 14:
! 15: <span class="comment">/* Class not documented with doxygen comments */</span>
! 16: <span class="keyword">class </span>Undocumented { };
! 17: <span class="comment"></span>
! 18: <span class="comment">/*! Class that is inherited using public inheritance */</span>
! 19: <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
! 20: <span class="comment"></span>
! 21: <span class="comment">/*! A template class */</span>
! 22: <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };
! 23: <span class="comment"></span>
! 24: <span class="comment">/*! Class that is inherited using protected inheritance */</span>
! 25: <span class="keyword">class </span>ProtectedBase { };
! 26: <span class="comment"></span>
! 27: <span class="comment">/*! Class that is inherited using private inheritance */</span>
! 28: <span class="keyword">class </span>PrivateBase { };
! 29: <span class="comment"></span>
! 30: <span class="comment">/*! Class that is used by the Inherited class */</span>
! 31: <span class="keyword">class </span>Used { };
! 32: <span class="comment"></span>
! 33: <span class="comment">/*! Super class that inherits a number of other classes */</span>
! 34: <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
! 35: <span class="keyword">protected</span> ProtectedBase,
! 36: <span class="keyword">private</span> PrivateBase,
! 37: <span class="keyword">public</span> Undocumented
! 38: <span class="keyword">public</span> Templ<int>
! 39: {
! 40: <span class="keyword">private</span>:
! 41: Used *m_usedClass;
! 42: };
! 43: </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>
! 44: <center><div align="center">
! 45: <img src="graph_legend.png" alt="graph_legend.png">
! 46: </div>
! 47: </center> <p>
! 48: The boxes in the above graph have the following meaning: <ul>
! 49: <li>
! 50: A filled black box represents the struct or class for which the graph is generated. </li>
! 51: <li>
! 52: A box with a black border denotes a documented struct or class. </li>
! 53: <li>
! 54: A box with a grey border denotes an undocumented struct or class. </li>
! 55: <li>
! 56: 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>
! 57: </ul>
! 58: The arrows have the following meaning: <ul>
! 59: <li>
! 60: A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
! 61: <li>
! 62: A dark green arrow is used for protected inheritance. </li>
! 63: <li>
! 64: A dark red arrow is used for private inheritance. </li>
! 65: <li>
! 66: 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>
! 67: <li>
! 68: 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>
! 69: </ul>
! 70: <hr size="1"><address style="align: right;"><small>Generated on Wed Mar 10 13:23:38 2004 for libnet by
! 71: <a href="http://www.doxygen.org/index.html">
! 72: <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
! 73: </a>1.3.4 </small></address>
! 74: </body>
! 75: </html>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to graph_legend.html CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libnet / doc / html