Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / bf8b01dfbfdca124673ade33c5eac8f3748d7abd / . / documentation / graph_legend.xhtml
blob: eda00d5476d4b21b453b88219e8f2ea24aa8a7e8 [file] [log] [blame]
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]1<!-- HTML header for doxygen 1.8.9.1-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]7<meta name="generator" content="Doxygen 1.8.6"/>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]8<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
Anthony Barbierdbdab852017-06-23 15:42:00 +0100[diff] [blame]9<title>Compute Library: Graph Legend</title>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18 $(window).load(resizeHeight);
19</script>
20<link href="search/search.css" rel="stylesheet" type="text/css"/>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]21<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]23 $(document).ready(function() { searchBox.OnSelectItem(0); });
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]24</script>
25<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]30</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]31<link href="doxygen.css" rel="stylesheet" type="text/css" />
32</head>
33<body>
34<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
35<div id="titlearea">
36<table cellspacing="0" cellpadding="0">
37 <tbody>
38 <tr style="height: 56px;">
39 <td style="padding-left: 0.5em;">
Anthony Barbierdbdab852017-06-23 15:42:00 +0100[diff] [blame]40 <div id="projectname">Compute Library
Kaizenbf8b01d2017-10-12 14:26:51 +0100[diff] [blame^]41 &#160;<span id="projectnumber">17.10</span>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]42 </div>
43 </td>
44 </tr>
45 </tbody>
46</table>
47</div>
48<!-- end header part -->
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]49<!-- Generated by Doxygen 1.8.6 -->
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]50<script type="text/javascript">
51var searchBox = new SearchBox("searchBox", "search",false,'Search');
52</script>
53 <div id="navrow1" class="tabs">
54 <ul class="tablist">
55 <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100[diff] [blame]56 <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]57 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58 <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
59 <li><a href="files.xhtml"><span>Files</span></a></li>
60 <li>
61 <div id="MSearchBox" class="MSearchBoxInactive">
62 <span class="left">
63 <img id="MSearchSelect" src="search/mag_sel.png"
64 onmouseover="return searchBox.OnSearchSelectShow()"
65 onmouseout="return searchBox.OnSearchSelectHide()"
66 alt=""/>
67 <input type="text" id="MSearchField" value="Search" accesskey="S"
68 onfocus="searchBox.OnSearchFieldFocus(true)"
69 onblur="searchBox.OnSearchFieldFocus(false)"
70 onkeyup="searchBox.OnSearchFieldChange(event)"/>
71 </span><span class="right">
72 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
73 </span>
74 </div>
75 </li>
76 </ul>
77 </div>
78</div><!-- top -->
79<div id="side-nav" class="ui-resizable side-nav-resizable">
80 <div id="nav-tree">
81 <div id="nav-tree-contents">
82 <div id="nav-sync" class="sync"></div>
83 </div>
84 </div>
85 <div id="splitbar" style="-moz-user-select:none;"
86 class="ui-resizable-handle">
87 </div>
88</div>
89<script type="text/javascript">
90$(document).ready(function(){initNavTree('graph_legend.xhtml','');});
91</script>
92<div id="doc-content">
93<!-- window showing the filter options -->
94<div id="MSearchSelectWindow"
95 onmouseover="return searchBox.OnSearchSelectShow()"
96 onmouseout="return searchBox.OnSearchSelectHide()"
97 onkeydown="return searchBox.OnSearchSelectKey(event)">
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]98<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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]99
100<!-- iframe showing the search results (closed by default) -->
101<div id="MSearchResultsWindow">
102<iframe src="javascript:void(0)" frameborder="0"
103 name="MSearchResults" id="MSearchResults">
104</iframe>
105</div>
106
107<div class="header">
108 <div class="headertitle">
109<div class="title">Graph Legend</div> </div>
110</div><!--header-->
111<div class="contents">
112<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]113<p>Consider the following example: </p>
114<div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>
115<div class="line"><span class="keyword">class </span>Invisible { };</div>
116<div class="line"><span class="comment"></span></div>
117<div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>
118<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>
119<div class="line"></div>
120<div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>
121<div class="line"><span class="keyword">class </span>Undocumented { };</div>
122<div class="line"><span class="comment"></span></div>
123<div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>
124<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>
125<div class="line"><span class="comment"></span></div>
126<div class="line"><span class="comment">/*! A template class */</span></div>
127<div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>
128<div class="line"><span class="comment"></span></div>
129<div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>
130<div class="line"><span class="keyword">class </span>ProtectedBase { };</div>
131<div class="line"><span class="comment"></span></div>
132<div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>
133<div class="line"><span class="keyword">class </span>PrivateBase { };</div>
134<div class="line"><span class="comment"></span></div>
135<div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>
136<div class="line"><span class="keyword">class </span>Used { };</div>
137<div class="line"><span class="comment"></span></div>
138<div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>
139<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>
140<div class="line"> <span class="keyword">protected</span> ProtectedBase,</div>
141<div class="line"> <span class="keyword">private</span> PrivateBase,</div>
142<div class="line"> <span class="keyword">public</span> Undocumented,</div>
143<div class="line"> <span class="keyword">public</span> Templ&lt;int&gt;</div>
144<div class="line">{</div>
145<div class="line"> <span class="keyword">private</span>:</div>
146<div class="line"> Used *m_usedClass;</div>
147<div class="line">};</div>
148</div><!-- fragment --><p> This will result in the following graph:</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]149<center><iframe scrolling="no" frameborder="0" src="graph_legend.svg" width="683" height="212"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe> </center><p>The boxes in the above graph have the following meaning: </p>
150<ul>
151<li>
152A filled gray box represents the struct or class for which the graph is generated. </li>
153<li>
154A box with a black border denotes a documented struct or class. </li>
155<li>
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]156A box with a grey border denotes an undocumented struct or class. </li>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]157<li>
158A 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>
159</ul>
160<p>The arrows have the following meaning: </p>
161<ul>
162<li>
163A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
164<li>
165A dark green arrow is used for protected inheritance. </li>
166<li>
167A dark red arrow is used for private inheritance. </li>
168<li>
169A 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>
170<li>
171A 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>
172</ul>
173</div><!-- contents -->
174</div><!-- doc-content -->
175<!-- start footer part -->
176<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
177 <ul>
Kaizenbf8b01d2017-10-12 14:26:51 +0100[diff] [blame^]178 <li class="footer">Generated on Thu Oct 12 2017 14:26:39 for Compute Library by
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]179 <a href="http://www.doxygen.org/index.html">
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]180 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame]181 </ul>
182</div>
183</body>
184</html>