Mercurial > hg > vamp-website

annotate code-doc/graph_legend.html @ 128:817c3988afc7 website tip

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