revert API doc contribution since the document size is big, it affact the code download.
[o-du/phy.git] / docs / API / structxran__cp__radioapp__common__header.html
diff --git a/docs/API/structxran__cp__radioapp__common__header.html b/docs/API/structxran__cp__radioapp__common__header.html
deleted file mode 100644 (file)
index 952f421..0000000
+++ /dev/null
@@ -1,266 +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_cp_radioapp_common_header 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_cp_radioapp_common_header Struct Reference</div>  </div>
-</div><!--header-->
-<div class="contents">
-
-<p><code>#include &lt;<a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>&gt;</code></p>
-<div class="dynheader">
-Collaboration diagram for xran_cp_radioapp_common_header:</div>
-<div class="dyncontent">
-<div class="center"><img src="structxran__cp__radioapp__common__header__coll__graph.png" border="0" usemap="#xran__cp__radioapp__common__header_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:a158cc4eb9be778527f9afe0bf9df19e0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a158cc4eb9be778527f9afe0bf9df19e0">startSymbolId</a>:6</td></tr>
-<tr class="separator:a158cc4eb9be778527f9afe0bf9df19e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae287404c8c0fa4fb464abf8f6a516346"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#ae287404c8c0fa4fb464abf8f6a516346">slotId</a>:6</td></tr>
-<tr class="separator:ae287404c8c0fa4fb464abf8f6a516346"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aa948cf928c529d24f8d536fb480094f2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#aa948cf928c529d24f8d536fb480094f2">subframeId</a>:4</td></tr>
-<tr class="separator:aa948cf928c529d24f8d536fb480094f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a15a5e5806d950f2d75550c17b007153c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a15a5e5806d950f2d75550c17b007153c">frameId</a>:8</td></tr>
-<tr class="separator:a15a5e5806d950f2d75550c17b007153c"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a6275bf84e65f219845e03cf9535f893a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a6275bf84e65f219845e03cf9535f893a">filterIndex</a>:4</td></tr>
-<tr class="separator:a6275bf84e65f219845e03cf9535f893a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a06cacc53918b2e51a13fc506b4351d63"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a06cacc53918b2e51a13fc506b4351d63">payloadVer</a>:3</td></tr>
-<tr class="separator:a06cacc53918b2e51a13fc506b4351d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a87c3e6cd307a5ee7d853ec7254fcd010"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a87c3e6cd307a5ee7d853ec7254fcd010">dataDirection</a>:1</td></tr>
-<tr class="separator:a87c3e6cd307a5ee7d853ec7254fcd010"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a879dd7efae60d48d1c20349a00feee87"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a879dd7efae60d48d1c20349a00feee87">numOfSections</a></td></tr>
-<tr class="separator:a879dd7efae60d48d1c20349a00feee87"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae273caa235b1c6085de4ad13886f82c9"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#ae273caa235b1c6085de4ad13886f82c9">sectionType</a></td></tr>
-<tr class="separator:ae273caa235b1c6085de4ad13886f82c9"><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>Common Radio Application Header for C-Plane </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00061">61</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
-</div><h2 class="groupheader">Field Documentation</h2>
-<a id="a87c3e6cd307a5ee7d853ec7254fcd010"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a87c3e6cd307a5ee7d853ec7254fcd010">&#9670;&nbsp;</a></span>dataDirection</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint32_t dataDirection</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>5.4.4.1 data direction (gNB Tx/Rx) </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00068">68</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
-
-</div>
-</div>
-<a id="a6275bf84e65f219845e03cf9535f893a"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a6275bf84e65f219845e03cf9535f893a">&#9670;&nbsp;</a></span>filterIndex</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint32_t filterIndex</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>5.4.4.3 filter index, XRAN_FILTERINDEX_xxxx </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00066">66</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
-
-</div>
-</div>
-<a id="a15a5e5806d950f2d75550c17b007153c"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a15a5e5806d950f2d75550c17b007153c">&#9670;&nbsp;</a></span>frameId</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint32_t frameId</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>5.4.4.4 frame identifier </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00065">65</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
-
-</div>
-</div>
-<a id="a879dd7efae60d48d1c20349a00feee87"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a879dd7efae60d48d1c20349a00feee87">&#9670;&nbsp;</a></span>numOfSections</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint8_t numOfSections</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>5.4.4.8 number of sections </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00069">69</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
-
-</div>
-</div>
-<a id="a06cacc53918b2e51a13fc506b4351d63"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a06cacc53918b2e51a13fc506b4351d63">&#9670;&nbsp;</a></span>payloadVer</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint32_t payloadVer</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>5.4.4.2 payload version, should be 1 </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00067">67</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
-
-</div>
-</div>
-<a id="ae273caa235b1c6085de4ad13886f82c9"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ae273caa235b1c6085de4ad13886f82c9">&#9670;&nbsp;</a></span>sectionType</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint8_t sectionType</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>5.4.4.9 section type </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00070">70</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
-
-</div>
-</div>
-<a id="ae287404c8c0fa4fb464abf8f6a516346"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ae287404c8c0fa4fb464abf8f6a516346">&#9670;&nbsp;</a></span>slotId</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint32_t slotId</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>5.4.4.6 slot identifier </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00063">63</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
-
-</div>
-</div>
-<a id="a158cc4eb9be778527f9afe0bf9df19e0"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a158cc4eb9be778527f9afe0bf9df19e0">&#9670;&nbsp;</a></span>startSymbolId</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint32_t startSymbolId</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>5.4.4.7 start symbol identifier </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00062">62</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
-
-</div>
-</div>
-<a id="aa948cf928c529d24f8d536fb480094f2"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#aa948cf928c529d24f8d536fb480094f2">&#9670;&nbsp;</a></span>subframeId</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint32_t subframeId</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>5.4.4.5 subframe identifier </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00064">64</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.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__cp_8h_source.html">xran_pkt_cp.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>