]> begriffs open source - cmsis-freertos/blob - main/modules.html
Update documentation for branch main
[cmsis-freertos] / main / modules.html
1 <!-- HTML header for doxygen 1.9.2-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>CMSIS-FreeRTOS: API Reference</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 <script type="text/javascript" src="footer.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
18 <script type="text/javascript" src="search/searchdata.js"></script>
19 <script type="text/javascript" src="search/search.js"></script>
20 <script type="text/javascript">
21 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
22   $(document).ready(function() { init_search(); });
23 /* @license-end */
24 </script>
25 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
26 <link href="version.css" rel="stylesheet" type="text/css" />
27 <script type="text/javascript" src="../version.js"></script>
28 </head>
29 <body>
30 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
31 <div id="titlearea">
32 <table cellspacing="0" cellpadding="0">
33  <tbody>
34  <tr style="height: 55px;">
35   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
36   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
37    <div id="projectname">CMSIS-FreeRTOS
38    &#160;<span id="projectnumber"><script type="text/javascript">
39      <!--
40      writeHeader.call(this);
41      writeVersionDropdown(this);
42      //-->
43     </script>
44    </span>
45    </div>
46    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
47   </td>
48   <!--END !PROJECT_NAME-->
49    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
50         <span class="left">
51           <img id="MSearchSelect" src="search/mag_sel.svg"
52                onmouseover="return searchBox.OnSearchSelectShow()"
53                onmouseout="return searchBox.OnSearchSelectHide()"
54                alt=""/>
55           <input type="text" id="MSearchField" value="Search" accesskey="S"
56                onfocus="searchBox.OnSearchFieldFocus(true)" 
57                onblur="searchBox.OnSearchFieldFocus(false)" 
58                onkeyup="searchBox.OnSearchFieldChange(event)"/>
59           </span><span class="right">
60             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
61           </span>
62         </div>
63 </td>
64  </tr>
65  </tbody>
66 </table>
67 </div>
68 <!-- end header part -->
69 <!-- Generated by Doxygen 1.9.2 -->
70 <script type="text/javascript">
71 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
72 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
73 /* @license-end */
74 </script>
75 </div><!-- top -->
76 <div id="side-nav" class="ui-resizable side-nav-resizable">
77   <div id="nav-tree">
78     <div id="nav-tree-contents">
79       <div id="nav-sync" class="sync"></div>
80     </div>
81   </div>
82   <div id="splitbar" style="-moz-user-select:none;" 
83        class="ui-resizable-handle">
84   </div>
85 </div>
86 <script type="text/javascript">
87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
88 $(document).ready(function(){initNavTree('modules.html',''); initResizable(); });
89 /* @license-end */
90 </script>
91 <div id="doc-content">
92 <!-- window showing the filter options -->
93 <div id="MSearchSelectWindow"
94      onmouseover="return searchBox.OnSearchSelectShow()"
95      onmouseout="return searchBox.OnSearchSelectHide()"
96      onkeydown="return searchBox.OnSearchSelectKey(event)">
97 </div>
98
99 <!-- iframe showing the search results (closed by default) -->
100 <div id="MSearchResultsWindow">
101 <iframe src="javascript:void(0)" frameborder="0" 
102         name="MSearchResults" id="MSearchResults">
103 </iframe>
104 </div>
105
106 <div class="header">
107   <div class="headertitle"><div class="title">API Reference</div></div>
108 </div><!--header-->
109 <div class="contents">
110 <div class="textblock">Here is a list of all modules:</div><div class="directory">
111 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
112 <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><a class="el" href="group__freertos__specific.html" target="_self">CMSIS-FreeRTOS Specifics</a></td><td class="desc">This section describes CMSIS-FreeRTOS specifics </td></tr>
113 <tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__freertos__setup.html" target="_self">Event Recorder Setup</a></td><td class="desc">Information about Event Recorder configuration and setup </td></tr>
114 <tr id="row_0_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="toggleFolder('0_1_')">&#9660;</span><a class="el" href="group__freertos__evr.html" target="_self">Event functions</a></td><td class="desc">FreeRTOS Event Recorder functions </td></tr>
115 <tr id="row_0_1_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__freertos__evr__tasks.html" target="_self">Tasks Functions</a></td><td class="desc">Events generated by tasks functions </td></tr>
116 <tr id="row_0_1_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__freertos__evr__queue.html" target="_self">Message Queue Functions</a></td><td class="desc">Events generated by message queue functions </td></tr>
117 <tr id="row_0_1_2_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__freertos__evr__timers.html" target="_self">Timer Functions</a></td><td class="desc">Events generated by timer functions </td></tr>
118 <tr id="row_0_1_3_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__freertos__evr__event__groups.html" target="_self">Event Groups Functions</a></td><td class="desc">Events generated by event groups functions </td></tr>
119 <tr id="row_0_1_4_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__freertos__evr__streambuf.html" target="_self">Stream Buffer Functions</a></td><td class="desc">Events generated by Stream Buffer and Message Buffer functions </td></tr>
120 <tr id="row_0_1_5_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__freertos__evr__heap.html" target="_self">Heap Functions</a></td><td class="desc">Events generated by heap functions </td></tr>
121 </table>
122 </div><!-- directory -->
123 </div><!-- contents -->
124 </div><!-- doc-content -->
125 <!-- start footer part -->
126 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
127   <ul>
128     <li class="footer">
129       <script type="text/javascript">
130         <!--
131         writeFooter.call(this);
132         //-->
133       </script> 
134     </li>
135   </ul>
136 </div>
137 </body>
138 </html>