revert API doc contribution since the document size is big, it affact the code download.
[o-du/phy.git] / docs / API / struct_bbu_io_buf_ctrl_struct.html
diff --git a/docs/API/struct_bbu_io_buf_ctrl_struct.html b/docs/API/struct_bbu_io_buf_ctrl_struct.html
deleted file mode 100644 (file)
index f81825b..0000000
+++ /dev/null
@@ -1,207 +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: BbuIoBufCtrlStruct 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">BbuIoBufCtrlStruct Struct Reference</div>  </div>
-</div><!--header-->
-<div class="contents">
-
-<p><code>#include &lt;<a class="el" href="xran__common_8h_source.html">xran_common.h</a>&gt;</code></p>
-<div class="dynheader">
-Collaboration diagram for BbuIoBufCtrlStruct:</div>
-<div class="dyncontent">
-<div class="center"><img src="struct_bbu_io_buf_ctrl_struct__coll__graph.png" border="0" usemap="#_bbu_io_buf_ctrl_struct_coll__map" alt="Collaboration graph"/></div>
-<map name="_bbu_io_buf_ctrl_struct_coll__map" id="_bbu_io_buf_ctrl_struct_coll__map">
-<area shape="rect" id="node2" href="structxran__buffer__list.html" title="{xran_buffer_list\n|+ nNumBuffers\l+ pUserData\l+ pPrivateMetaData\l|}" alt="" coords="14,219,153,325"/>
-<area shape="rect" id="node3" href="structxran__flat__buffer.html" title="{xran_flat_buffer\n|+ nElementLenInBytes\l+ nNumberOfElements\l+ nOffsetInBytes\l+ nIsPhyAddr\l+ pData\l+ pCtrl\l|}" alt="" coords="5,5,161,156"/>
-</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:a48c33fa4a8f2f93d51cba58b78d3cd9f"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#a48c33fa4a8f2f93d51cba58b78d3cd9f">bValid</a></td></tr>
-<tr class="separator:a48c33fa4a8f2f93d51cba58b78d3cd9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a7dc97933eadb8a8049057209c3303818"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#a7dc97933eadb8a8049057209c3303818">nSegToBeGen</a></td></tr>
-<tr class="separator:a7dc97933eadb8a8049057209c3303818"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:af00b094918ddba2073443dcd755141f6"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#af00b094918ddba2073443dcd755141f6">nSegGenerated</a></td></tr>
-<tr class="separator:af00b094918ddba2073443dcd755141f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a09ab9a2f4541256129428a4ccabc6803"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#a09ab9a2f4541256129428a4ccabc6803">nSegTransferred</a></td></tr>
-<tr class="separator:a09ab9a2f4541256129428a4ccabc6803"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a7941f6b35742c3de02e270f7b80c8dda"><td class="memItemLeft" align="right" valign="top">struct rte_mbuf *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#a7941f6b35742c3de02e270f7b80c8dda">pData</a> [<a class="el" href="sample-app_8c.html#ac29300907d1558b4b1f7bc1091151643">N_MAX_BUFFER_SEGMENT</a>]</td></tr>
-<tr class="separator:a7941f6b35742c3de02e270f7b80c8dda"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ab79185e465507117d7b13fd30ec49f70"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__buffer__list.html">xran_buffer_list</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#ab79185e465507117d7b13fd30ec49f70">sBufferList</a></td></tr>
-<tr class="separator:ab79185e465507117d7b13fd30ec49f70"><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 class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00116">116</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
-</div><h2 class="groupheader">Field Documentation</h2>
-<a id="a48c33fa4a8f2f93d51cba58b78d3cd9f"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a48c33fa4a8f2f93d51cba58b78d3cd9f">&#9670;&nbsp;</a></span>bValid</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int32_t bValid</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00123">123</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
-
-</div>
-</div>
-<a id="af00b094918ddba2073443dcd755141f6"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#af00b094918ddba2073443dcd755141f6">&#9670;&nbsp;</a></span>nSegGenerated</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int32_t nSegGenerated</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00125">125</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
-
-</div>
-</div>
-<a id="a7dc97933eadb8a8049057209c3303818"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a7dc97933eadb8a8049057209c3303818">&#9670;&nbsp;</a></span>nSegToBeGen</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int32_t nSegToBeGen</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00124">124</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
-
-</div>
-</div>
-<a id="a09ab9a2f4541256129428a4ccabc6803"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a09ab9a2f4541256129428a4ccabc6803">&#9670;&nbsp;</a></span>nSegTransferred</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int32_t nSegTransferred</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00127">127</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
-
-</div>
-</div>
-<a id="a7941f6b35742c3de02e270f7b80c8dda"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a7941f6b35742c3de02e270f7b80c8dda">&#9670;&nbsp;</a></span>pData</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">struct rte_mbuf * pData</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00128">128</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
-
-</div>
-</div>
-<a id="ab79185e465507117d7b13fd30ec49f70"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ab79185e465507117d7b13fd30ec49f70">&#9670;&nbsp;</a></span>sBufferList</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">struct <a class="el" href="structxran__buffer__list.html">xran_buffer_list</a> sBufferList</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00129">129</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
-
-</div>
-</div>
-<hr/>The documentation for this struct was generated from the following files:<ul>
-<li><a class="el" href="sample-app_8c_source.html">sample-app.c</a></li>
-<li><a class="el" href="xran__common_8h_source.html">xran_common.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>