diff options
Diffstat (limited to 'doc/api-documentation/html/graph_legend.html')
| -rw-r--r-- | doc/api-documentation/html/graph_legend.html | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/doc/api-documentation/html/graph_legend.html b/doc/api-documentation/html/graph_legend.html index 8c7f1a8..7c03285 100644 --- a/doc/api-documentation/html/graph_legend.html +++ b/doc/api-documentation/html/graph_legend.html @@ -3,58 +3,58 @@ <title>Graph Legend</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.2.15 --> +<!-- Generated by Doxygen 1.2.17 --> <center> -<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> </center> <hr><h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen. <p> - Consider the following example: <div class="fragment"><pre><font class="comment">/*! Invisible class because of truncation */</font> -<font class="keyword">class </font>Invisible { }; -<font class="comment"></font> -<font class="comment">/*! Truncated class, inheritance relation is hidden */</font> -<font class="keyword">class </font>Truncated : <font class="keyword">public</font> Invisible { }; + Consider the following example: <div class="fragment"><pre><span class="comment">/*! Invisible class because of truncation */</span> +<span class="keyword">class </span>Invisible { }; +<span class="comment"></span> +<span class="comment">/*! Truncated class, inheritance relation is hidden */</span> +<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { }; -<font class="comment">/* Class not documented with doxygen comments */</font> -<font class="keyword">class </font>Undocumented { }; -<font class="comment"></font> -<font class="comment">/*! Class that is inherited using public inheritance */</font> -<font class="keyword">class </font>PublicBase : <font class="keyword">public</font> Truncated { }; -<font class="comment"></font> -<font class="comment">/*! A template class */</font> -<font class="keyword">template</font><<font class="keyword">class</font> T> <font class="keyword">class </font>Templ { }; -<font class="comment"></font> -<font class="comment">/*! Class that is inherited using protected inheritance */</font> -<font class="keyword">class </font>ProtectedBase { }; -<font class="comment"></font> -<font class="comment">/*! Class that is inherited using private inheritance */</font> -<font class="keyword">class </font>PrivateBase { }; -<font class="comment"></font> -<font class="comment">/*! Class that is used by the Inherited class */</font> -<font class="keyword">class </font>Used { }; -<font class="comment"></font> -<font class="comment">/*! Super class that inherits a number of other classes */</font> -<font class="keyword">class </font>Inherited : <font class="keyword">public</font> PublicBase, - <font class="keyword">protected</font> ProtectedBase, - <font class="keyword">private</font> PrivateBase, - <font class="keyword">public</font> Undocumented - <font class="keyword">public</font> Templ<int> +<span class="comment">/* Class not documented with doxygen comments */</span> +<span class="keyword">class </span>Undocumented { }; +<span class="comment"></span> +<span class="comment">/*! Class that is inherited using public inheritance */</span> +<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { }; +<span class="comment"></span> +<span class="comment">/*! A template class */</span> +<span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { }; +<span class="comment"></span> +<span class="comment">/*! Class that is inherited using protected inheritance */</span> +<span class="keyword">class </span>ProtectedBase { }; +<span class="comment"></span> +<span class="comment">/*! Class that is inherited using private inheritance */</span> +<span class="keyword">class </span>PrivateBase { }; +<span class="comment"></span> +<span class="comment">/*! Class that is used by the Inherited class */</span> +<span class="keyword">class </span>Used { }; +<span class="comment"></span> +<span class="comment">/*! Super class that inherits a number of other classes */</span> +<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase, + <span class="keyword">protected</span> ProtectedBase, + <span class="keyword">private</span> PrivateBase, + <span class="keyword">public</span> Undocumented + <span class="keyword">public</span> Templ<int> { - <font class="keyword">private</font>: + <span class="keyword">private</span>: 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: <p> <center> -<img src="graph_legend.png"></center> +<img alt="" src="graph_legend.jpg"></center> <p> 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>A box with a black border denotes a documented struct or class. <li>A box with a grey border denotes an undocumented struct or class. <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. </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>A dark green arrow is used for protected inheritance. <li>A dark red arrow is used for private inheritance. <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>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. </ul> -<hr><address align="right"><small>Generated on Thu Jun 20 22:13:05 2002 for The Sword Project by +<hr><address style="align: right;"><small>Generated on Thu Oct 31 12:11:38 2002 for The Sword Project by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 -width=110 height=53></a>1.2.15 </small></address> +width=110 height=53></a>1.2.17 </small></address> </body> </html> |