Code Review / o-du / phy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
add Doxygen documentation
[o-du/phy.git] / docs / API / config_8h.html
diff --git a/docs/API/config_8h.html b/docs/API/config_8h.html
new file mode 100644 (file)
index 0000000..016570b
--- /dev/null
+++ b/docs/API/config_8h.html
@@ -0,0 +1,196 @@
+<!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: config.h File 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 id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><a class="el" href="dir_a4c74d6baed87eba72f3b201b7b4b8f2.html">fhi_lib</a></li><li class="navelem"><a class="el" href="dir_4b76f00ffa3e05ab9c225ea6671f6b6c.html">app</a></li><li class="navelem"><a class="el" href="dir_dd7de4ccd45f8474612b8f6c09959d91.html">src</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#nested-classes">Data Structures</a> &#124;
+<a href="#typedef-members">Typedefs</a> &#124;
+<a href="#func-members">Functions</a>  </div>
+  <div class="headertitle">
+<div class="title">config.h File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
+<code>#include &lt;rte_ether.h&gt;</code><br />
+<code>#include &quot;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&quot;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for config.h:</div>
+<div class="dyncontent">
+<div class="center"><img src="config_8h__incl.png" border="0" usemap="#config_8h" alt=""/></div>
+<map name="config_8h" id="config_8h">
+<area shape="rect" id="node4" href="xran__fh__o__du_8h.html" title="This file provides public interface to xRAN Front Haul layer implementation as defined in the ORAN&#45;WG..." alt="" coords="568,80,679,107"/>
+</map>
+</div>
+</div><div class="textblock"><div class="dynheader">
+This graph shows which files directly or indirectly include this file:</div>
+<div class="dyncontent">
+<div class="center"><img src="config_8h__dep__incl.png" border="0" usemap="#config_8hdep" alt=""/></div>
+<map name="config_8hdep" id="config_8hdep">
+<area shape="rect" id="node2" href="config_8c.html" title="config.c" alt="" coords="5,155,73,181"/>
+<area shape="rect" id="node3" href="debug_8h.html" title="debug.h" alt="" coords="41,80,109,107"/>
+<area shape="rect" id="node4" href="sample-app_8c.html" title="sample&#45;app.c" alt="" coords="133,80,233,107"/>
+</map>
+</div>
+</div>
+<p><a href="config_8h_source.html">Go to the source code of this file.</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
+Data Structures</h2></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct___runtime_config.html">_RuntimeConfig</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
+Typedefs</h2></td></tr>
+<tr class="memitem:af57013248b2c9c128e04d2e8ce8c93c9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct___runtime_config.html">_RuntimeConfig</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="config_8h.html#af57013248b2c9c128e04d2e8ce8c93c9">RuntimeConfig</a></td></tr>
+<tr class="separator:af57013248b2c9c128e04d2e8ce8c93c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
+Functions</h2></td></tr>
+<tr class="memitem:add16264aa9472e4e90d1a77e086c7f93"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="config_8h.html#add16264aa9472e4e90d1a77e086c7f93">parseConfigFile</a> (char *filename, <a class="el" href="config_8h.html#af57013248b2c9c128e04d2e8ce8c93c9">RuntimeConfig</a> *config)</td></tr>
+<tr class="separator:add16264aa9472e4e90d1a77e086c7f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
+
+<p class="definition">Definition in file <a class="el" href="config_8h_source.html">config.h</a>.</p>
+</div><h2 class="groupheader">Typedef Documentation</h2>
+<a id="af57013248b2c9c128e04d2e8ce8c93c9"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af57013248b2c9c128e04d2e8ce8c93c9">&#9670;&nbsp;</a></span>RuntimeConfig</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">typedef struct <a class="el" href="struct___runtime_config.html">_RuntimeConfig</a>  <a class="el" href="config_8h.html#af57013248b2c9c128e04d2e8ce8c93c9">RuntimeConfig</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Run time configuration of application </p>
+
+</div>
+</div>
+<h2 class="groupheader">Function Documentation</h2>
+<a id="add16264aa9472e4e90d1a77e086c7f93"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#add16264aa9472e4e90d1a77e086c7f93">&#9670;&nbsp;</a></span>parseConfigFile()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int parseConfigFile </td>
+          <td>(</td>
+          <td class="paramtype">char *&#160;</td>
+          <td class="paramname"><em>filename</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="config_8h.html#af57013248b2c9c128e04d2e8ce8c93c9">RuntimeConfig</a> *&#160;</td>
+          <td class="paramname"><em>config</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Parse application configuration file.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">filename</td><td>The name of the configuration file to be parsed. </td></tr>
+    <tr><td class="paramname">config</td><td>The configuration structure to be filled with parsed data. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p class="definition">Definition at line <a class="el" href="config_8c_source.html#l00497">497</a> of file <a class="el" href="config_8c_source.html">config.c</a>.</p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="config_8h_add16264aa9472e4e90d1a77e086c7f93_cgraph.png" border="0" usemap="#config_8h_add16264aa9472e4e90d1a77e086c7f93_cgraph" alt=""/></div>
+<map name="config_8h_add16264aa9472e4e90d1a77e086c7f93_cgraph" id="config_8h_add16264aa9472e4e90d1a77e086c7f93_cgraph">
+<area shape="rect" id="node2" href="gen__test_8m.html#a14e2cbac46a5d611bf112b1f4beb7021" title="fclose" alt="" coords="167,5,224,32"/>
+</map>
+</div>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="config_8h_add16264aa9472e4e90d1a77e086c7f93_icgraph.png" border="0" usemap="#config_8h_add16264aa9472e4e90d1a77e086c7f93_icgraph" alt=""/></div>
+<map name="config_8h_add16264aa9472e4e90d1a77e086c7f93_icgraph" id="config_8h_add16264aa9472e4e90d1a77e086c7f93_icgraph">
+<area shape="rect" id="node2" href="sample-app_8c.html#a0ddf1224851353fc92bfbff6f499fa97" title="main" alt="" coords="167,5,217,32"/>
+</map>
+</div>
+
+</div>
+</div>
+</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>
O-RAN DU Physical Layer