Mercurial > hg > aimc

annotate trunk/C++/api/html/graph_legend.html @ 597:359bcd461dd1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
First commit. Refer to the api [1] 'Philosophy of the implementation' for information on the approach used to implement CARFAC in C++. [1] aimc/C++/api/html/index.html
author flatmax
date Sat, 09 Feb 2013 23:53:48 +0000
parents
children b4323584c9fa
rev   line source
flatmax@597 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
flatmax@597 2 <html xmlns="http://www.w3.org/1999/xhtml">
flatmax@597 3 <head>
flatmax@597 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
flatmax@597 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
flatmax@597 6 <title>CARFAC C++: Graph Legend</title>
flatmax@597 7
flatmax@597 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
flatmax@597 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
flatmax@597 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
flatmax@597 11 <script type="text/javascript" src="jquery.js"></script>
flatmax@597 12 <script type="text/javascript" src="resize.js"></script>
flatmax@597 13 <script type="text/javascript" src="navtree.js"></script>
flatmax@597 14 <script type="text/javascript">
flatmax@597 15 $(document).ready(initResizable);
flatmax@597 16 </script>
flatmax@597 17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
flatmax@597 18 <script type="text/javascript" src="search/search.js"></script>
flatmax@597 19 <script type="text/javascript">
flatmax@597 20 $(document).ready(function() { searchBox.OnSelectItem(0); });
flatmax@597 21 </script>
flatmax@597 22
flatmax@597 23 </head>
flatmax@597 24 <body>
flatmax@597 25 <div id="top"><!-- do not remove this div! -->
flatmax@597 26
flatmax@597 27
flatmax@597 28 <div id="titlearea">
flatmax@597 29 <table cellspacing="0" cellpadding="0">
flatmax@597 30 <tbody>
flatmax@597 31 <tr style="height: 56px;">
flatmax@597 32
flatmax@597 33 <td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
flatmax@597 34
flatmax@597 35
flatmax@597 36 <td style="padding-left: 0.5em;">
flatmax@597 37 <div id="projectname">CARFAC C++
flatmax@597 38
flatmax@597 39 </div>
flatmax@597 40 <div id="projectbrief">C++ implementation of CARFAC</div>
flatmax@597 41 </td>
flatmax@597 42
flatmax@597 43
flatmax@597 44
flatmax@597 45 </tr>
flatmax@597 46 </tbody>
flatmax@597 47 </table>
flatmax@597 48 </div>
flatmax@597 49
flatmax@597 50 <!-- Generated by Doxygen 1.7.6.1 -->
flatmax@597 51 <script type="text/javascript">
flatmax@597 52 var searchBox = new SearchBox("searchBox", "search",false,'Search');
flatmax@597 53 </script>
flatmax@597 54 <div id="navrow1" class="tabs">
flatmax@597 55 <ul class="tablist">
flatmax@597 56 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
flatmax@597 57 <li><a href="annotated.html"><span>Classes</span></a></li>
flatmax@597 58 <li><a href="files.html"><span>Files</span></a></li>
flatmax@597 59 <li>
flatmax@597 60 <div id="MSearchBox" class="MSearchBoxInactive">
flatmax@597 61 <span class="left">
flatmax@597 62 <img id="MSearchSelect" src="search/mag_sel.png"
flatmax@597 63 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@597 64 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@597 65 alt=""/>
flatmax@597 66 <input type="text" id="MSearchField" value="Search" accesskey="S"
flatmax@597 67 onfocus="searchBox.OnSearchFieldFocus(true)"
flatmax@597 68 onblur="searchBox.OnSearchFieldFocus(false)"
flatmax@597 69 onkeyup="searchBox.OnSearchFieldChange(event)"/>
flatmax@597 70 </span><span class="right">
flatmax@597 71 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
flatmax@597 72 </span>
flatmax@597 73 </div>
flatmax@597 74 </li>
flatmax@597 75 </ul>
flatmax@597 76 </div>
flatmax@597 77 </div>
flatmax@597 78 <div id="side-nav" class="ui-resizable side-nav-resizable">
flatmax@597 79 <div id="nav-tree">
flatmax@597 80 <div id="nav-tree-contents">
flatmax@597 81 </div>
flatmax@597 82 </div>
flatmax@597 83 <div id="splitbar" style="-moz-user-select:none;"
flatmax@597 84 class="ui-resizable-handle">
flatmax@597 85 </div>
flatmax@597 86 </div>
flatmax@597 87 <script type="text/javascript">
flatmax@597 88 initNavTree('graph_legend.html','');
flatmax@597 89 </script>
flatmax@597 90 <div id="doc-content">
flatmax@597 91 <div class="header">
flatmax@597 92 <div class="headertitle">
flatmax@597 93 <div class="title">Graph Legend</div> </div>
flatmax@597 94 </div><!--header-->
flatmax@597 95 <div class="contents">
flatmax@597 96 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
flatmax@597 97 <p>Consider the following example: </p>
flatmax@597 98 <div class="fragment"><pre class="fragment"><span class="comment">/*! Invisible class because of truncation */</span>
flatmax@597 99 <span class="keyword">class </span>Invisible { };
flatmax@597 100 <span class="comment"></span>
flatmax@597 101 <span class="comment">/*! Truncated class, inheritance relation is hidden */</span>
flatmax@597 102 <span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
flatmax@597 103
flatmax@597 104 <span class="comment">/* Class not documented with doxygen comments */</span>
flatmax@597 105 <span class="keyword">class </span>Undocumented { };
flatmax@597 106 <span class="comment"></span>
flatmax@597 107 <span class="comment">/*! Class that is inherited using public inheritance */</span>
flatmax@597 108 <span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
flatmax@597 109 <span class="comment"></span>
flatmax@597 110 <span class="comment">/*! A template class */</span>
flatmax@597 111 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
flatmax@597 112 <span class="comment"></span>
flatmax@597 113 <span class="comment">/*! Class that is inherited using protected inheritance */</span>
flatmax@597 114 <span class="keyword">class </span>ProtectedBase { };
flatmax@597 115 <span class="comment"></span>
flatmax@597 116 <span class="comment">/*! Class that is inherited using private inheritance */</span>
flatmax@597 117 <span class="keyword">class </span>PrivateBase { };
flatmax@597 118 <span class="comment"></span>
flatmax@597 119 <span class="comment">/*! Class that is used by the Inherited class */</span>
flatmax@597 120 <span class="keyword">class </span>Used { };
flatmax@597 121 <span class="comment"></span>
flatmax@597 122 <span class="comment">/*! Super class that inherits a number of other classes */</span>
flatmax@597 123 <span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
flatmax@597 124 <span class="keyword">protected</span> ProtectedBase,
flatmax@597 125 <span class="keyword">private</span> PrivateBase,
flatmax@597 126 <span class="keyword">public</span> Undocumented,
flatmax@597 127 <span class="keyword">public</span> Templ&lt;int&gt;
flatmax@597 128 {
flatmax@597 129 <span class="keyword">private</span>:
flatmax@597 130 Used *m_usedClass;
flatmax@597 131 };
flatmax@597 132 </pre></div><p> This will result in the following graph:</p>
flatmax@597 133 <center><div class="image">
flatmax@597 134 <img src="graph_legend.png" />
flatmax@597 135 </div>
flatmax@597 136 </center> <p>The boxes in the above graph have the following meaning: </p>
flatmax@597 137 <ul>
flatmax@597 138 <li>
flatmax@597 139 A filled gray box represents the struct or class for which the graph is generated. </li>
flatmax@597 140 <li>
flatmax@597 141 A box with a black border denotes a documented struct or class. </li>
flatmax@597 142 <li>
flatmax@597 143 A box with a grey border denotes an undocumented struct or class. </li>
flatmax@597 144 <li>
flatmax@597 145 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>
flatmax@597 146 </ul>
flatmax@597 147 <p>The arrows have the following meaning: </p>
flatmax@597 148 <ul>
flatmax@597 149 <li>
flatmax@597 150 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
flatmax@597 151 <li>
flatmax@597 152 A dark green arrow is used for protected inheritance. </li>
flatmax@597 153 <li>
flatmax@597 154 A dark red arrow is used for private inheritance. </li>
flatmax@597 155 <li>
flatmax@597 156 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>
flatmax@597 157 <li>
flatmax@597 158 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>
flatmax@597 159 </ul>
flatmax@597 160 </div><!-- contents -->
flatmax@597 161 <!-- window showing the filter options -->
flatmax@597 162 <div id="MSearchSelectWindow"
flatmax@597 163 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@597 164 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@597 165 onkeydown="return searchBox.OnSearchSelectKey(event)">
flatmax@597 166 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Defines</a></div>
flatmax@597 167
flatmax@597 168 <!-- iframe showing the search results (closed by default) -->
flatmax@597 169 <div id="MSearchResultsWindow">
flatmax@597 170 <iframe src="javascript:void(0)" frameborder="0"
flatmax@597 171 name="MSearchResults" id="MSearchResults">
flatmax@597 172 </iframe>
flatmax@597 173 </div>
flatmax@597 174
flatmax@597 175 </div>
flatmax@597 176 <div id="nav-path" class="navpath">
flatmax@597 177 <ul>
flatmax@597 178
flatmax@597 179 <li class="footer">Generated on Sun Feb 10 2013 10:47:46 for CARFAC C++ by
flatmax@597 180 <a href="http://www.doxygen.org/index.html">
flatmax@597 181 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
flatmax@597 182 </ul>
flatmax@597 183 </div>
flatmax@597 184
flatmax@597 185
flatmax@597 186 </body>
flatmax@597 187 </html>