xalan-c/apiDocs/graph_legend.html - xalan-site - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <title>Xalan-C++ API : Main Page</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
 </head>
 <!-- The head section is copied from Doxygen 1.7.1 generated default output -->
 <body>
 <h2 align="center">Xalan-C++ API Documentation</h2>
 <h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
 <hr/>
 <!-- Generated by Doxygen 1.7.1 -->
 <div class="navigation" id="top">
   <div class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
       <li><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
   </div>
 </div>
 <div class="header">
   <div class="headertitle">
 <h1>Graph Legend</h1>  </div>
 </div>
 <div class="contents">
 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
 <p>Consider the following example: </p>
 <div class="fragment"><pre class="fragment"><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 { };

 <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>&lt;<span class="keyword">class</span> T&gt; <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&lt;int&gt;
 {
   <span class="keyword">private</span>:
     Used *m_usedClass;
 };
 </pre></div><p> This will result in the following graph:</p>
 <center><div align="center">
 <img src="graph_legend.png" alt="graph_legend.png"/>
 </div>
 </center> <p>The boxes in the above graph have the following meaning:  </p>
 <ul>
 <li>
 A filled gray 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>
 <p>The arrows have the following meaning:  </p>
 <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>
 </div>
 <p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
 <p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
 <i><a href="http://www.doxygen.org/">Doxygen</a> and
 <a href="http://www.graphviz.org/">GraphViz</a> are
 used to generate this API documentation from the Xalan-C header files.</i></font></p>

 <table border="0" cellpadding="0" cellspacing="0" width="80%">
  <tr>
   <td width="80%" valign="top">
 	<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
 	Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
 	All Rights Reserved.</p>
   </td>
  </tr>
  <tr>
   <td width="100%">
 	<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
   </td>
  </tr>
 </table>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<title>Xalan-C++ API : Main Page</title>
	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	<link href="doxygen.css" rel="stylesheet" type="text/css"/>
	</head>
	<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
	<body>
	<h2 align="center">Xalan-C++ API Documentation</h2>
	<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
	<hr/>
	<!-- Generated by Doxygen 1.7.1 -->
	<div class="navigation" id="top">
	<div class="tabs">
	<ul class="tablist">
	<li><a href="index.html"><span>Main Page</span></a></li>
	<li><a href="pages.html"><span>Related Pages</span></a></li>
	<li><a href="annotated.html"><span>Classes</span></a></li>
	<li><a href="files.html"><span>Files</span></a></li>
	</ul>
	</div>
	</div>
	<div class="header">
	<div class="headertitle">
	<h1>Graph Legend</h1> </div>
	</div>
	<div class="contents">
	<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
	<p>Consider the following example: </p>
	<div class="fragment"><pre class="fragment"><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 { };

	<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>
	{
	<span class="keyword">private</span>:
	Used *m_usedClass;
	};
	</pre></div><p> This will result in the following graph:</p>
	<center><div align="center">
	<img src="graph_legend.png" alt="graph_legend.png"/>
	</div>
	</center> <p>The boxes in the above graph have the following meaning: </p>
	<ul>
	<li>
	A filled gray 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>
	<p>The arrows have the following meaning: </p>
	<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>
	</div>
	<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
	<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
	<i><a href="http://www.doxygen.org/">Doxygen</a> and
	<a href="http://www.graphviz.org/">GraphViz</a> are
	used to generate this API documentation from the Xalan-C header files.</i></font></p>

	<table border="0" cellpadding="0" cellspacing="0" width="80%">
	<tr>
	<td width="80%" valign="top">
	<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
	Copyright © 1999-2012 The Apache Software Foundation.<br/>
	All Rights Reserved.</p>
	</td>
	</tr>
	<tr>
	<td width="100%">
	<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
	</td>
	</tr>
	</table>
	</body>
	</html>