add Doxygen documentation
[o-du/phy.git] / docs / API / globals_a.html
diff --git a/docs/API/globals_a.html b/docs/API/globals_a.html
new file mode 100644 (file)
index 0000000..929c92b
--- /dev/null
@@ -0,0 +1,175 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>o-du/phy: Globals</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">o-du/phy
+   </div>
+   <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="contents">
+<div class="textblock">Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:</div>
+
+<h3><a id="index_a"></a>- a -</h3><ul>
+<li>aligned_free()
+: <a class="el" href="common_8hpp.html#a2f1a3a41e28280d05df6b8d212d9c5c2">common.hpp</a>
+</li>
+<li>aligned_malloc()
+: <a class="el" href="common_8hpp.html#adfa5a01b33723394c2a1fa179abea990">common.hpp</a>
+</li>
+<li>all
+: <a class="el" href="gen__test_8m.html#a4603254d9990f7140c024d51302d1a8f">gen_test.m</a>
+</li>
+<li>ant
+: <a class="el" href="gen__test_8m.html#a38d2cdf58cc777c61b71dd2785d139af">gen_test.m</a>
+</li>
+<li>ant_c
+: <a class="el" href="gen__test_8m.html#aba0850eda7aea420ce9c9a1d760451ad">gen_test.m</a>
+</li>
+<li>ant_num
+: <a class="el" href="gen__test_8m.html#a549e3fface5e83cef0eb316a8b81a7f7">gen_test.m</a>
+</li>
+<li>antX_16
+: <a class="el" href="gen__test_8m.html#a44ac39f65dd00d0fa2f62a0175e23965">gen_test.m</a>
+</li>
+<li>APP_O_DU
+: <a class="el" href="common_8h.html#a0fde49745ec2d8b8b45c15be781985d6">common.h</a>
+</li>
+<li>APP_O_RU
+: <a class="el" href="common_8h.html#a29df1eeb2e3019bf28e348b79471421b">common.h</a>
+</li>
+<li>APP_RUNNING
+: <a class="el" href="common_8h.html#a3f6c4cb016839c3f57ab648b84dc4d8aa71b026b3a2b676e4176ee9f8dae22f1d">common.h</a>
+</li>
+<li>app_state
+: <a class="el" href="common_8h.html#a3f6c4cb016839c3f57ab648b84dc4d8a">common.h</a>
+</li>
+<li>APP_STOPPED
+: <a class="el" href="common_8h.html#a3f6c4cb016839c3f57ab648b84dc4d8aa19260773e34f9f3a8a32038f798c8dc8">common.h</a>
+</li>
+<li>app_xran_cal_nrarfcn()
+: <a class="el" href="common_8c.html#a6d7aac49f30b5d75a7a8436fbbc36cd7">common.c</a>
+, <a class="el" href="common_8h.html#a6d7aac49f30b5d75a7a8436fbbc36cd7">common.h</a>
+</li>
+<li>app_xran_clear_slot_type()
+: <a class="el" href="common_8c.html#a15e01f62daf328aef8184ea50c9955fa">common.c</a>
+</li>
+<li>app_xran_get_num_rbs()
+: <a class="el" href="common_8c.html#abd62743e637f8bee2b0d3b1e2b4ecaac">common.c</a>
+, <a class="el" href="common_8h.html#abd62743e637f8bee2b0d3b1e2b4ecaac">common.h</a>
+</li>
+<li>app_xran_get_scs()
+: <a class="el" href="common_8c.html#a4a9173ba3c1f1bdf4b1ea9f8e531c561">common.c</a>
+, <a class="el" href="common_8h.html#a4a9173ba3c1f1bdf4b1ea9f8e531c561">common.h</a>
+</li>
+<li>app_xran_get_slot_type()
+: <a class="el" href="common_8c.html#a0c617a0804e2a4eda51b402b03922dc2">common.c</a>
+</li>
+<li>app_xran_get_tti_interval()
+: <a class="el" href="common_8c.html#a7443b72e990584de0b5b2a9306ed820a">common.c</a>
+, <a class="el" href="common_8h.html#a7443b72e990584de0b5b2a9306ed820a">common.h</a>
+</li>
+<li>app_xran_set_slot_type()
+: <a class="el" href="common_8c.html#ae41dd953f43c314e9c7688d18cf69e8b">common.c</a>
+, <a class="el" href="common_8h.html#ae41dd953f43c314e9c7688d18cf69e8b">common.h</a>
+</li>
+<li>app_xran_slot_limit()
+: <a class="el" href="common_8c.html#a2b515e829520e3af448a4d00d22de161">common.c</a>
+</li>
+<li>assert_array_eq()
+: <a class="el" href="common_8hpp.html#a8f4a12d5e7aa88ef72d3a59f9d0a85f0">common.hpp</a>
+</li>
+<li>ASSERT_ARRAY_EQ
+: <a class="el" href="common_8hpp.html#a1c463cb9865e63120f666efd5a6555b5">common.hpp</a>
+</li>
+<li>ASSERT_ARRAY_NEAR
+: <a class="el" href="common_8hpp.html#a9a330f0a8f2feff43f1ccedfaf049e03">common.hpp</a>
+</li>
+<li>assert_array_near()
+: <a class="el" href="common_8hpp.html#aea945be561738ef40c759d617b04255c">common.hpp</a>
+</li>
+<li>assert_array_near&lt; complex_float &gt;()
+: <a class="el" href="common_8hpp.html#ab5ae003c98bada0196a7085942593271">common.hpp</a>
+</li>
+<li>assert_avg_greater_complex()
+: <a class="el" href="common_8hpp.html#a2bbe1c5dcabc83ba7d8485888720da42">common.hpp</a>
+</li>
+<li>ASSERT_AVG_GREATER_COMPLEX
+: <a class="el" href="common_8hpp.html#aa748fe650bfa70c23834297931a4a2a7">common.hpp</a>
+</li>
+<li>ASSUME_CACHE_ALIGNED
+: <a class="el" href="xran__compression_8hpp.html#a5e70c4df5750d49b6c4b2aacd556500f">xran_compression.hpp</a>
+</li>
+<li>AVX
+: <a class="el" href="common__typedef__xran_8h.html#a4c160ac3b177a2fde8738ef01e58494ca0f2500907bbad2fb795fba8fafd31b2a">common_typedef_xran.h</a>
+</li>
+<li>AVX2
+: <a class="el" href="common__typedef__xran_8h.html#a4c160ac3b177a2fde8738ef01e58494ca7b9822126e7b712535af7b882409bf8b">common_typedef_xran.h</a>
+</li>
+<li>AVX_512
+: <a class="el" href="common__typedef__xran_8h.html#a4c160ac3b177a2fde8738ef01e58494ca90b287f46b6b1d6837db75d9822aa45b">common_typedef_xran.h</a>
+</li>
+<li>AWAITING_PONG
+: <a class="el" href="ethdi_8h.html#a400519d4f3774fc47bc51223a4e3e1b4a626bfa1d39d92be95dde42f08ec88ef1">ethdi.h</a>
+</li>
+</ul>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>