[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / psdk_cust / ipc_3_43_00_00_eng / docs / doxygen / html / graph_legend.html
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"/>
7 <meta name="generator" content="Doxygen 1.8.9.1"/>
8 <title>IPC API: Graph Legend</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <script type="text/javascript">
16 $(document).ready(function() { init_search(); });
17 </script>
18 <link href="doxygen.css" rel="stylesheet" type="text/css" />
19 </head>
20 <body>
21 <table width="100%">
22 <tr>
23 <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border="0" src="tilogo.gif" /></a></td>
24 <td bgcolor="red"><img src="titagline.gif" /></td>
25 </tr>
26 </table>
27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
28 <div id="titlearea">
29 <table cellspacing="0" cellpadding="0">
30 <tbody>
31 <tr style="height: 56px;">
32 <td style="padding-left: 0.5em;">
33 <div id="projectname">IPC API
34  <span id="projectnumber">3.43.00.00_eng</span>
35 </div>
36 </td>
37 </tr>
38 </tbody>
39 </table>
40 </div>
41 <!-- end header part -->
42 <!-- Generated by Doxygen 1.8.9.1 -->
43 <script type="text/javascript">
44 var searchBox = new SearchBox("searchBox", "search",false,'Search');
45 </script>
46 <div id="navrow1" class="tabs">
47 <ul class="tablist">
48 <li><a href="index.html"><span>Main Page</span></a></li>
49 <li><a href="modules.html"><span>Modules</span></a></li>
50 <li><a href="annotated.html"><span>Data Structures</span></a></li>
51 <li><a href="files.html"><span>Files</span></a></li>
52 <li><a href="pages.html"><span>Related Pages</span></a></li>
53 <li>
54 <div id="MSearchBox" class="MSearchBoxInactive">
55 <span class="left">
56 <img id="MSearchSelect" src="search/mag_sel.png"
57 onmouseover="return searchBox.OnSearchSelectShow()"
58 onmouseout="return searchBox.OnSearchSelectHide()"
59 alt=""/>
60 <input type="text" id="MSearchField" value="Search" accesskey="S"
61 onfocus="searchBox.OnSearchFieldFocus(true)"
62 onblur="searchBox.OnSearchFieldFocus(false)"
63 onkeyup="searchBox.OnSearchFieldChange(event)"/>
64 </span><span class="right">
65 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
66 </span>
67 </div>
68 </li>
69 </ul>
70 </div>
71 </div><!-- top -->
72 <!-- window showing the filter options -->
73 <div id="MSearchSelectWindow"
74 onmouseover="return searchBox.OnSearchSelectShow()"
75 onmouseout="return searchBox.OnSearchSelectHide()"
76 onkeydown="return searchBox.OnSearchSelectKey(event)">
77 </div>
79 <!-- iframe showing the search results (closed by default) -->
80 <div id="MSearchResultsWindow">
81 <iframe src="javascript:void(0)" frameborder="0"
82 name="MSearchResults" id="MSearchResults">
83 </iframe>
84 </div>
86 <div class="header">
87 <div class="headertitle">
88 <div class="title">Graph Legend</div> </div>
89 </div><!--header-->
90 <div class="contents">
91 <p>This page explains how to interpret the graphs that are generated by doxygen.</p>
92 <p>Consider the following example: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> /*! Invisible class because of truncation */</div>
93 <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> class Invisible { };</div>
94 <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div>
95 <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> /*! Truncated class, inheritance relation is hidden */</div>
96 <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> class Truncated : public Invisible { };</div>
97 <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div>
98 <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> /* Class not documented with doxygen comments */</div>
99 <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> class Undocumented { };</div>
100 <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div>
101 <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> /*! Class that is inherited using public inheritance */</div>
102 <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> class PublicBase : public Truncated { };</div>
103 <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
104 <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> /*! A template class */</div>
105 <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> template<class T> class Templ { };</div>
106 <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
107 <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> /*! Class that is inherited using protected inheritance */</div>
108 <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> class ProtectedBase { };</div>
109 <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
110 <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> /*! Class that is inherited using private inheritance */</div>
111 <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> class PrivateBase { };</div>
112 <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
113 <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> /*! Class that is used by the Inherited class */</div>
114 <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> class Used { };</div>
115 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
116 <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> /*! Super class that inherits a number of other classes */</div>
117 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> class Inherited : public PublicBase,</div>
118 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  protected ProtectedBase,</div>
119 <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  private PrivateBase,</div>
120 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  public Undocumented,</div>
121 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  public Templ<int></div>
122 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div>
123 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  private:</div>
124 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  Used *m_usedClass;</div>
125 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> };</div>
126 </div><!-- fragment --><p> This will result in the following graph:</p>
127 <center><div class="image">
128 <img src="graph_legend.png" />
129 </div>
130 </center><p>The boxes in the above graph have the following meaning: </p>
131 <ul>
132 <li>
133 A filled gray box represents the struct or class for which the graph is generated. </li>
134 <li>
135 A box with a black border denotes a documented struct or class. </li>
136 <li>
137 A box with a grey border denotes an undocumented struct or class. </li>
138 <li>
139 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>
140 </ul>
141 <p>The arrows have the following meaning: </p>
142 <ul>
143 <li>
144 A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
145 <li>
146 A dark green arrow is used for protected inheritance. </li>
147 <li>
148 A dark red arrow is used for private inheritance. </li>
149 <li>
150 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>
151 <li>
152 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>
153 </ul>
154 </div><!-- contents -->
155 <!-- HTML footer for doxygen 1.8.9.1-->
156 <!-- start footer part -->
157 <hr class="footer"/><small>
158 Copyright 2016, Texas Instruments Incorporated
159 </small>
160 </body>
161 </html>