add Doxygen documentation
[o-du/phy.git] / docs / API / structburst__hdr.html
diff --git a/docs/API/structburst__hdr.html b/docs/API/structburst__hdr.html
new file mode 100644 (file)
index 0000000..42506fe
--- /dev/null
@@ -0,0 +1,166 @@
+<!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: burst_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">burst_hdr Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="ethernet_8h_source.html">ethernet.h</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for burst_hdr:</div>
+<div class="dyncontent">
+<div class="center"><img src="structburst__hdr__coll__graph.png" border="0" usemap="#burst__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:a90db3068871720903d0ccbb5a0b2fb1a"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structburst__hdr.html#a90db3068871720903d0ccbb5a0b2fb1a">pkt_idx</a></td></tr>
+<tr class="separator:a90db3068871720903d0ccbb5a0b2fb1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:addab391714c822ecc21f9b0551e2ae25"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structburst__hdr.html#addab391714c822ecc21f9b0551e2ae25">total_pkts</a></td></tr>
+<tr class="separator:addab391714c822ecc21f9b0551e2ae25"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1bf90df9ae78437aca3a36cc15d8dea4"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structburst__hdr.html#a1bf90df9ae78437aca3a36cc15d8dea4">original_type</a></td></tr>
+<tr class="separator:a1bf90df9ae78437aca3a36cc15d8dea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5cddf2dd16a831a2fecfa71bc0f34191"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structburst__hdr.html#a5cddf2dd16a831a2fecfa71bc0f34191">data</a> []</td></tr>
+<tr class="separator:a5cddf2dd16a831a2fecfa71bc0f34191"><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="ethernet_8h_source.html#l00105">105</a> of file <a class="el" href="ethernet_8h_source.html">ethernet.h</a>.</p>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="a5cddf2dd16a831a2fecfa71bc0f34191"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5cddf2dd16a831a2fecfa71bc0f34191">&#9670;&nbsp;</a></span>data</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int8_t data[]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="ethernet_8h_source.html#l00109">109</a> of file <a class="el" href="ethernet_8h_source.html">ethernet.h</a>.</p>
+
+</div>
+</div>
+<a id="a1bf90df9ae78437aca3a36cc15d8dea4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1bf90df9ae78437aca3a36cc15d8dea4">&#9670;&nbsp;</a></span>original_type</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int8_t original_type</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="ethernet_8h_source.html#l00108">108</a> of file <a class="el" href="ethernet_8h_source.html">ethernet.h</a>.</p>
+
+</div>
+</div>
+<a id="a90db3068871720903d0ccbb5a0b2fb1a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a90db3068871720903d0ccbb5a0b2fb1a">&#9670;&nbsp;</a></span>pkt_idx</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int8_t pkt_idx</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="ethernet_8h_source.html#l00106">106</a> of file <a class="el" href="ethernet_8h_source.html">ethernet.h</a>.</p>
+
+</div>
+</div>
+<a id="addab391714c822ecc21f9b0551e2ae25"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#addab391714c822ecc21f9b0551e2ae25">&#9670;&nbsp;</a></span>total_pkts</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int8_t total_pkts</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="ethernet_8h_source.html#l00107">107</a> of file <a class="el" href="ethernet_8h_source.html">ethernet.h</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="ethernet_8h_source.html">ethernet.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>