<?xml version="1.0" encoding="UTF-8"?> <!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" lang="en" xml:lang="en"> <head> <title>lomoco: Graph Legend</title> <style type="text/css"> .cp-doNotDisplay { display: none; } @media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }} .cp-edit { text-align: right; } @media print, embossed { .cp-edit { display: none; }} </style> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <meta name="MSSmartTagsPreventParsing" content="true" /> <meta name="robots" content="all" /> <link rel="stylesheet" type="text/css" href="doxygen.css" /> <link rel="stylesheet" media="screen" type="text/css" href="csync.css" /> <link rel="stylesheet" media="print, embossed" type="text/css" href="print.css" /> </head> <body> <ul class="cp-doNotDisplay"> <li><a href="#cp-content" accesskey="2">Skip to content</a></li> <li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li> </ul> <div id="container"> <div id="header"> <div id="header_top"><div><div style="padding: 10px 30px;"> <!-- <img alt ="" src="top-kde.jpg"/> --> csync API Reference </div></div></div> <div id="header_bottom"> <div id="location"> <ul> <li><a href="index.html">csync</a></li> </ul> </div> <div id="menu"> <ul><li><a href="http://www.csync.org/">Sitemap</a></li> <li><a href="http://www.csync.org/">Contact Us</a></li> </ul> </div> </div> </div> <!-- End page header --> <div id="body_wrapper"> <div id="body"> <!-- begin main content --> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <!-- <h2><a name="content"></a>lomoco</h2> --> <!-- BC --> <!-- Generated by Doxygen 1.5.9 --> <div class="contents"> <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 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> 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: <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> 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> </div> </div> </div> </div> <div id="left"> <div class="menu_box"> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">lomoco</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "lomoco"</a> </div></div> <!-- menu --> <div class="menu_box"> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">API Documentation</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "@topname@"</a> </div></div> <div class="nav_list"> <ul> <!-- gmenu --> </ul></div></div> </div> </div> <div class="clearer"></div> </div> <div class="clearer"></div> </div> <div id="end_body"></div> <div id="footer"><div id="footer_text"> Generated with <a href="http://www.stack.nl/~dimitri/doxygen/" target="_blank">Doxygen</a> </div></div> </div> </body> </html>