Mercurial > hg > aimc

annotate C++/api/html/graph_legend.html @ 627:7c82250c8dd2

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