binaries/src/ViennaRNA/doc/html/graph_legend.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>RNAlib-2.1.2: Graph Legend</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javascript" src="jquery.js"></script>
   9 <script type="text/javascript" src="dynsections.js"></script>
  10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="resize.js"></script>
  12 <script type="text/javascript" src="navtree.js"></script>
  13 <script type="text/javascript">
  14   $(document).ready(initResizable);
  15 </script>
  16 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17 </head>
  18 <body>
  19 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20 <div id="titlearea">
  21 <table cellspacing="0" cellpadding="0">
  22  <tbody>
  23  <tr style="height: 56px;">
  24   <td style="padding-left: 0.5em;">
  25    <div id="projectname">RNAlib-2.1.2
  26    </div>
  27   </td>
  28  </tr>
  29  </tbody>
  30 </table>
  31 </div>
  32 <!-- end header part -->
  33 <!-- Generated by Doxygen 1.8.1.1 -->
  34   <div id="navrow1" class="tabs">
  35     <ul class="tablist">
  36       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  37       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  38       <li><a href="modules.html"><span>Modules</span></a></li>
  39       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  40       <li><a href="files.html"><span>Files</span></a></li>
  41     </ul>
  42   </div>
  43 </div><!-- top -->
  44 <div id="side-nav" class="ui-resizable side-nav-resizable">
  45   <div id="nav-tree">
  46     <div id="nav-tree-contents">
  47     </div>
  48   </div>
  49   <div id="splitbar" style="-moz-user-select:none;"
  50        class="ui-resizable-handle">
  51   </div>
  52 </div>
  53 <script type="text/javascript">
  54 $(document).ready(function(){initNavTree('graph_legend.html','');});
  55 </script>
  56 <div id="doc-content">
  57 <div class="header">
  58   <div class="headertitle">
  59 <div class="title">Graph Legend</div>  </div>
  60 </div><!--header-->
  61 <div class="contents">
  62 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
  63 <p>Consider the following example: </p>
  64 <div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
  65 <div class="line"><span class="keyword">class </span>Invisible { };</div>
  66 <div class="line"><span class="comment"></span></div>
  67 <div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
  68 <div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
  69 <div class="line"></div>
  70 <div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
  71 <div class="line"><span class="keyword">class </span>Undocumented { };</div>
  72 <div class="line"><span class="comment"></span></div>
  73 <div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
  74 <div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
  75 <div class="line"><span class="comment"></span></div>
  76 <div class="line"><span class="comment">/*! A template class */</span></div>
  77 <div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>
  78 <div class="line"><span class="comment"></span></div>
  79 <div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
  80 <div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
  81 <div class="line"><span class="comment"></span></div>
  82 <div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
  83 <div class="line"><span class="keyword">class </span>PrivateBase { };</div>
  84 <div class="line"><span class="comment"></span></div>
  85 <div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
  86 <div class="line"><span class="keyword">class </span>Used { };</div>
  87 <div class="line"><span class="comment"></span></div>
  88 <div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
  89 <div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
  90 <div class="line">                  <span class="keyword">protected</span> ProtectedBase,</div>
  91 <div class="line">                  <span class="keyword">private</span> PrivateBase,</div>
  92 <div class="line">                  <span class="keyword">public</span> Undocumented,</div>
  93 <div class="line">                  <span class="keyword">public</span> Templ&lt;int&gt;</div>
  94 <div class="line">{</div>
  95 <div class="line">  <span class="keyword">private</span>:</div>
  96 <div class="line">    Used *m_usedClass;</div>
  97 <div class="line">};</div>
  98 </div><!-- fragment --><p> This will result in the following graph:</p>
  99 <center><div class="image">
 100 <img src="graph_legend.png" />
 101 </div>
 102 </center><p>The boxes in the above graph have the following meaning: </p>
 103 <ul>
 104 <li>
 105 A filled gray box represents the struct or class for which the graph is generated. </li>
 106 <li>
 107 A box with a black border denotes a documented struct or class. </li>
 108 <li>
 109 A box with a grey border denotes an undocumented struct or class. </li>
 110 <li>
 111 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>
 112 </ul>
 113 <p>The arrows have the following meaning: </p>
 114 <ul>
 115 <li>
 116 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
 117 <li>
 118 A dark green arrow is used for protected inheritance. </li>
 119 <li>
 120 A dark red arrow is used for private inheritance. </li>
 121 <li>
 122 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>
 123 <li>
 124 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>
 125 </ul>
 126 </div><!-- contents -->
 127 </div><!-- doc-content -->
 128 <!-- start footer part -->
 129 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 130   <ul>
 131     <li class="footer">Generated on Wed Jul 24 2013 13:39:00 for RNAlib-2.1.2 by
 132     <a href="http://www.doxygen.org/index.html">
 133     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
 134   </ul>
 135 </div>
 136 </body>
 137 </html>