Mercurial > hg > aimc

comparison C++/api/html/graph_legend.html @ 592:76c6b3fd0a05

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