revert API doc contribution since the document size is big, it affact the code download.
[o-du/phy.git] / docs / API / structxran__ru__config.html
diff --git a/docs/API/structxran__ru__config.html b/docs/API/structxran__ru__config.html
deleted file mode 100644 (file)
index 9ef368a..0000000
+++ /dev/null
@@ -1,228 +0,0 @@
-<!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: xran_ru_config Struct Reference</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>
-<!-- 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><!-- top -->
-<div class="header">
-  <div class="summary">
-<a href="#pub-attribs">Data Fields</a>  </div>
-  <div class="headertitle">
-<div class="title">xran_ru_config Struct Reference</div>  </div>
-</div><!--header-->
-<div class="contents">
-
-<p><code>#include &lt;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&gt;</code></p>
-<div class="dynheader">
-Collaboration diagram for xran_ru_config:</div>
-<div class="dyncontent">
-<div class="center"><img src="structxran__ru__config__coll__graph.png" border="0" usemap="#xran__ru__config_coll__map" alt="Collaboration graph"/></div>
-</div>
-<table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
-Data Fields</h2></td></tr>
-<tr class="memitem:af92ff2dfd2bddd0880d779c04b9fb359"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="xran__fh__o__du_8h.html#abf0211a253f5881ebad3910cef98d30e">xran_category</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#af92ff2dfd2bddd0880d779c04b9fb359">xranCat</a></td></tr>
-<tr class="separator:af92ff2dfd2bddd0880d779c04b9fb359"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a1520b1ef6131bff6c14b88d849c266c5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#a1520b1ef6131bff6c14b88d849c266c5">iqWidth</a></td></tr>
-<tr class="separator:a1520b1ef6131bff6c14b88d849c266c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a1e4a3c43fc7865c6520471fb9ba8501f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#a1e4a3c43fc7865c6520471fb9ba8501f">compMeth</a></td></tr>
-<tr class="separator:a1e4a3c43fc7865c6520471fb9ba8501f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a59e7e8f3feb686850b0cb0ae065de85b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#a59e7e8f3feb686850b0cb0ae065de85b">fftSize</a></td></tr>
-<tr class="separator:a59e7e8f3feb686850b0cb0ae065de85b"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a74e72997edeea7f9f1696baffb9989b4"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="xran__fh__o__du_8h.html#ab5ce6839bae2968c79930a0bfa17f4d8">xran_input_byte_order</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#a74e72997edeea7f9f1696baffb9989b4">byteOrder</a></td></tr>
-<tr class="separator:a74e72997edeea7f9f1696baffb9989b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ad1b1309ca2645e24fa201f8decae1988"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="xran__fh__o__du_8h.html#a0d9cb4cebbc59a8fa5bfef7547898859">xran_input_i_q_order</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#ad1b1309ca2645e24fa201f8decae1988">iqOrder</a></td></tr>
-<tr class="separator:ad1b1309ca2645e24fa201f8decae1988"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a7a25206e77e83a57fd036102cebfb4f0"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#a7a25206e77e83a57fd036102cebfb4f0">xran_max_frame</a></td></tr>
-<tr class="separator:a7a25206e77e83a57fd036102cebfb4f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
-</table>
-<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>XRAN front haul IQ compression settings </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00483">483</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
-</div><h2 class="groupheader">Field Documentation</h2>
-<a id="a74e72997edeea7f9f1696baffb9989b4"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a74e72997edeea7f9f1696baffb9989b4">&#9670;&nbsp;</a></span>byteOrder</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">enum <a class="el" href="xran__fh__o__du_8h.html#ab5ce6839bae2968c79930a0bfa17f4d8">xran_input_byte_order</a> byteOrder</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Order of bytes in int16_t in buffer. Big or little endian </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00489">489</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
-
-</div>
-</div>
-<a id="a1e4a3c43fc7865c6520471fb9ba8501f"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a1e4a3c43fc7865c6520471fb9ba8501f">&#9670;&nbsp;</a></span>compMeth</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint8_t compMeth</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Compression method </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00487">487</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
-
-</div>
-</div>
-<a id="a59e7e8f3feb686850b0cb0ae065de85b"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a59e7e8f3feb686850b0cb0ae065de85b">&#9670;&nbsp;</a></span>fftSize</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint8_t fftSize</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>FFT Size </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00488">488</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
-
-</div>
-</div>
-<a id="ad1b1309ca2645e24fa201f8decae1988"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ad1b1309ca2645e24fa201f8decae1988">&#9670;&nbsp;</a></span>iqOrder</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">enum <a class="el" href="xran__fh__o__du_8h.html#a0d9cb4cebbc59a8fa5bfef7547898859">xran_input_i_q_order</a> iqOrder</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>order of IQs in the buffer </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00490">490</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
-
-</div>
-</div>
-<a id="a1520b1ef6131bff6c14b88d849c266c5"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a1520b1ef6131bff6c14b88d849c266c5">&#9670;&nbsp;</a></span>iqWidth</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint8_t iqWidth</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>IQ bit width </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00486">486</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
-
-</div>
-</div>
-<a id="a7a25206e77e83a57fd036102cebfb4f0"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a7a25206e77e83a57fd036102cebfb4f0">&#9670;&nbsp;</a></span>xran_max_frame</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint16_t xran_max_frame</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>max frame number supported </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00491">491</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
-
-</div>
-</div>
-<a id="af92ff2dfd2bddd0880d779c04b9fb359"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#af92ff2dfd2bddd0880d779c04b9fb359">&#9670;&nbsp;</a></span>xranCat</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">enum <a class="el" href="xran__fh__o__du_8h.html#abf0211a253f5881ebad3910cef98d30e">xran_category</a> xranCat</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>mode: Catergory A or Category B </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00484">484</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
-
-</div>
-</div>
-<hr/>The documentation for this struct was generated from the following file:<ul>
-<li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.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>