revert API doc contribution since the document size is big, it affact the code download.
[o-du/phy.git] / docs / API / structcompression__hdr.html
diff --git a/docs/API/structcompression__hdr.html b/docs/API/structcompression__hdr.html
deleted file mode 100644 (file)
index 00cb79c..0000000
+++ /dev/null
@@ -1,133 +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: compression_hdr 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">compression_hdr Struct Reference<div class="ingroups"><a class="el" href="group__xran__common__pkt.html">XRAN Packet definitions and functions</a></div></div>  </div>
-</div><!--header-->
-<div class="contents">
-
-<p><code>#include &lt;<a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>&gt;</code></p>
-<div class="dynheader">
-Collaboration diagram for compression_hdr:</div>
-<div class="dyncontent">
-<div class="center"><img src="structcompression__hdr__coll__graph.png" border="0" usemap="#compression__hdr_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:ab3f5c028170bd3bd241a58be8ca8da96"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__hdr.html#ab3f5c028170bd3bd241a58be8ca8da96">ud_iq_width</a>:4</td></tr>
-<tr class="separator:ab3f5c028170bd3bd241a58be8ca8da96"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae12079177feb5d2ee414356fc18473cf"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__hdr.html#ae12079177feb5d2ee414356fc18473cf">ud_comp_meth</a>:4</td></tr>
-<tr class="separator:ae12079177feb5d2ee414356fc18473cf"><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>This parameter defines the compression method and IQ bit width for the user data in the data section. This field is absent from U-Plane messages when the static IQ format and compression method is configured via the M-Plane. In this way a single compression method and IQ bit width is provided (per UL and DL, per LTE and NR) without adding more overhead to U-Plane messages. </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00206">206</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
-</div><h2 class="groupheader">Field Documentation</h2>
-<a id="ae12079177feb5d2ee414356fc18473cf"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ae12079177feb5d2ee414356fc18473cf">&#9670;&nbsp;</a></span>ud_comp_meth</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint8_t ud_comp_meth</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>udCompMeth| compression method |udIqWidth meaning ------------&mdash;+--------------------------&mdash;+-----------------------------------------&mdash; 0000b | no compression |bitwidth of each uncompressed I and Q value 0001b | block floating point |bitwidth of each I and Q mantissa value 0010b | block scaling |bitwidth of each I and Q scaled value 0011b | mu-law |bitwidth of each compressed I and Q value 0100b | modulation compression |bitwidth of each compressed I and Q value 0100b - 1111b | reserved for future methods |depends on the specific compression method </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00213">213</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
-
-</div>
-</div>
-<a id="ab3f5c028170bd3bd241a58be8ca8da96"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ab3f5c028170bd3bd241a58be8ca8da96">&#9670;&nbsp;</a></span>ud_iq_width</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint8_t ud_iq_width</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Bit width of each I and each Q 16 for udIqWidth=0, otherwise equals udIqWidth e.g. udIqWidth = 0000b means I and Q are each 16 bits wide; e.g. udIQWidth = 0001b means I and Q are each 1 bit wide; e.g. udIqWidth = 1111b means I and Q are each 15 bits wide </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00208">208</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
-
-</div>
-</div>
-<hr/>The documentation for this struct was generated from the following file:<ul>
-<li><a class="el" href="xran__pkt_8h_source.html">xran_pkt.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>