revert API doc contribution since the document size is big, it affact the code download.
[o-du/phy.git] / docs / API / structxran__frame__config.html
diff --git a/docs/API/structxran__frame__config.html b/docs/API/structxran__frame__config.html
deleted file mode 100644 (file)
index 8baa354..0000000
+++ /dev/null
@@ -1,174 +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_frame_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_frame_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_frame_config:</div>
-<div class="dyncontent">
-<div class="center"><img src="structxran__frame__config__coll__graph.png" border="0" usemap="#xran__frame__config_coll__map" alt="Collaboration graph"/></div>
-<map name="xran__frame__config_coll__map" id="xran__frame__config_coll__map">
-<area shape="rect" id="node2" href="structxran__slot__config.html" title="{xran_slot_config\n|+ nSymbolType\l+ reserved\l|}" alt="" coords="21,5,138,97"/>
-</map>
-</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:a3b86317723a592e240c0047e53a6326d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__frame__config.html#a3b86317723a592e240c0047e53a6326d">nFrameDuplexType</a></td></tr>
-<tr class="separator:a3b86317723a592e240c0047e53a6326d"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a78b2fab8e8d6a6424c2712d528fd9a58"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__frame__config.html#a78b2fab8e8d6a6424c2712d528fd9a58">nNumerology</a></td></tr>
-<tr class="separator:a78b2fab8e8d6a6424c2712d528fd9a58"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a53a1d989c6dee827495401b1973c9ef8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__frame__config.html#a53a1d989c6dee827495401b1973c9ef8">nTddPeriod</a></td></tr>
-<tr class="separator:a53a1d989c6dee827495401b1973c9ef8"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a4664e9a9005020b4a98ada2d256906e2"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__slot__config.html">xran_slot_config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__frame__config.html#a4664e9a9005020b4a98ada2d256906e2">sSlotConfig</a> [<a class="el" href="xran__fh__o__du_8h.html#aba79881ec9b30850184b4f5f6b0afc39">XRAN_MAX_TDD_PERIODICITY</a>]</td></tr>
-<tr class="separator:a4664e9a9005020b4a98ada2d256906e2"><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 frame config </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00459">459</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="a3b86317723a592e240c0047e53a6326d"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a3b86317723a592e240c0047e53a6326d">&#9670;&nbsp;</a></span>nFrameDuplexType</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint8_t nFrameDuplexType</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Frame Duplex type: 0 -&gt; FDD, 1 -&gt; TDD </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00460">460</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="a78b2fab8e8d6a6424c2712d528fd9a58"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a78b2fab8e8d6a6424c2712d528fd9a58">&#9670;&nbsp;</a></span>nNumerology</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint8_t nNumerology</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Numerology, determine sub carrier spacing, Value: 0-&gt;4 0: 15khz, 1: 30khz, 2: 60khz 3: 120khz, 4: 240khz </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00461">461</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="a53a1d989c6dee827495401b1973c9ef8"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a53a1d989c6dee827495401b1973c9ef8">&#9670;&nbsp;</a></span>nTddPeriod</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">uint8_t nTddPeriod</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>TDD period </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00464">464</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="a4664e9a9005020b4a98ada2d256906e2"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a4664e9a9005020b4a98ada2d256906e2">&#9670;&nbsp;</a></span>sSlotConfig</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">struct <a class="el" href="structxran__slot__config.html">xran_slot_config</a> sSlotConfig[<a class="el" href="xran__fh__o__du_8h.html#aba79881ec9b30850184b4f5f6b0afc39">XRAN_MAX_TDD_PERIODICITY</a>]</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>TDD Slot configuration - If nFrameDuplexType = TDD(1), then this config defines the slot config type for each slot. </p>
-
-<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00465">465</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>