embedaddon/libnet/doc/html/graph_legend.html - view

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / libnet / doc / html / graph_legend.html
Revision 1.1.1.1 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Tue Feb 21 22:14:23 2012 UTC (12 years, 10 months ago) by misho
Branches: libnet, MAIN
CVS tags: v1_1_2_1, HEAD

libnet

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>libnet: Graph Legend</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body>  <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> <h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen. Consider the following example: <div class="fragment"><pre>/*! Invisible class because of truncation */ class Invisible { };  /*! Truncated class, inheritance relation is hidden */ class Truncated : public Invisible { }; /* Class not documented with doxygen comments */ class Undocumented { };  /*! Class that is inherited using public inheritance */ class PublicBase : public Truncated { };  /*! A template class */ template<class T> class Templ { };  /*! Class that is inherited using protected inheritance */ class ProtectedBase { };  /*! Class that is inherited using private inheritance */ class PrivateBase { };  /*! Class that is used by the Inherited class */ class Used { };  /*! Super class that inherits a number of other classes */ class Inherited : public PublicBase, protected ProtectedBase, private PrivateBase, public Undocumented public Templ<int> { private: Used *m_usedClass; }; </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: <center><div align="center"> <img src="graph_legend.png" alt="graph_legend.png"> </div> </center>  The boxes in the above graph have the following meaning: <ul> <li> A filled black box represents the struct or class for which the graph is generated. </li> <li> A box with a black border denotes a documented struct or class. </li> <li> A box with a grey border denotes an undocumented struct or class. </li> <li> 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> </ul> The arrows have the following meaning: <ul> <li> A dark blue arrow is used to visualize a public inheritance relation between two classes. </li> <li> A dark green arrow is used for protected inheritance. </li> <li> A dark red arrow is used for private inheritance. </li> <li> 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> <li> 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> </ul> <hr size="1"><address style="align: right;">Generated on Wed Mar 10 13:23:38 2004 for libnet by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.4 </address> </body> </html>