Skip to content

Commit

Permalink
Update documentation manually
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielfedel committed Sep 22, 2023
1 parent bcdb30c commit 55944af
Show file tree
Hide file tree
Showing 4,415 changed files with 297,513 additions and 4,243 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
166 changes: 166 additions & 0 deletions _frac_synth_analyze_8c.html
Original file line number Diff line number Diff line change
@@ -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>mrfioc2: FracSynthAnalyze.c 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">mrfioc2
&#160;<span id="projectnumber">2.3.0</span>
</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_94ff919899d933be1b6abb0111a41984.html">mrfCommon</a></li><li class="navelem"><a class="el" href="dir_e4b7bd9f3fd4bf82a843d00ee59380dd.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">FracSynthAnalyze.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;errno.h&gt;</code><br />
<code>#include &lt;epicsTypes.h&gt;</code><br />
<code>#include &lt;<a class="el" href="mrf_common_8h_source.html">mrfCommon.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="debug_print_8h_source.html">debugPrint.h</a>&gt;</code><br />
<code>#include &lt;epicsExport.h&gt;</code><br />
<code>#include &lt;<a class="el" href="mrf_frac_synth_8h_source.html">mrfFracSynth.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="mrf_frac_synth_8c_source.html">mrfFracSynth.c</a>&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for FracSynthAnalyze.c:</div>
<div class="dyncontent">
<div class="center"><img src="_frac_synth_analyze_8c__incl.png" border="0" usemap="#_frac_synth_analyze_8c" alt=""/></div>
<map name="_frac_synth_analyze_8c" id="_frac_synth_analyze_8c">
<area shape="rect" id="node6" href="mrf_common_8h.html" title="mrfCommon.h" alt="" coords="975,155,1091,181"/>
<area shape="rect" id="node21" href="debug_print_8h.html" title="debugPrint.h" alt="" coords="796,155,900,181"/>
<area shape="rect" id="node23" href="mrf_frac_synth_8h.html" title="mrfFracSynth.h" alt="" coords="1513,155,1633,181"/>
<area shape="rect" id="node24" href="mrf_frac_synth_8c.html" title="Support routines for the Micrel SY87739L Fractional&#45;N Synthesizer. " alt="" coords="1182,80,1301,107"/>
</map>
</div>
</div>
<p><a href="_frac_synth_analyze_8c_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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a413873fa3e667fc7303122af9845d57a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_frac_synth_analyze_8c.html#a413873fa3e667fc7303122af9845d57a">HOST_BUILD</a></td></tr>
<tr class="separator:a413873fa3e667fc7303122af9845d57a"><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:a0ddf1224851353fc92bfbff6f499fa97"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_frac_synth_analyze_8c.html#a0ddf1224851353fc92bfbff6f499fa97">main</a> (int argc, char *argv[])</td></tr>
<tr class="separator:a0ddf1224851353fc92bfbff6f499fa97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a413873fa3e667fc7303122af9845d57a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a413873fa3e667fc7303122af9845d57a">&#9670;&nbsp;</a></span>HOST_BUILD</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HOST_BUILD</td>
</tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_frac_synth_analyze_8c_source.html#l00094">94</a> of file <a class="el" href="_frac_synth_analyze_8c_source.html">FracSynthAnalyze.c</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0ddf1224851353fc92bfbff6f499fa97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ddf1224851353fc92bfbff6f499fa97">&#9670;&nbsp;</a></span>main()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>argv</em>[]&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_frac_synth_analyze_8c_source.html#l00104">104</a> of file <a class="el" href="_frac_synth_analyze_8c_source.html">FracSynthAnalyze.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="comment">/*---------------------</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment"> * Local Variables</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordtype">int</span> badArgs = 1; <span class="comment">/* True if we could not parse the argument list */</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; epicsUInt32 controlWord; <span class="comment">/* SY87739L control word to analyze */</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordtype">char</span> *tailPtr; <span class="comment">/* Pointer to tail of parsed control word string */</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="comment">/*---------------------</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment"> * Make sure we were passed only one argument.</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="comment"> * If so, see if we can parse it as a hexadecimal number.</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">if</span> (argc == 2) {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; controlWord = strtoul (argv[1], &amp;tailPtr, 16);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="comment">/*---------------------</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment"> * If we successfully parsed the control word,</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="comment"> * analyze it and display the results.</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordflow">if</span> ((errno == <a class="code" href="mrf_frac_synth_8h.html#aba51915c87d64af47fb1cc59348961c9">OK</a>) &amp;&amp; (tailPtr != argv[1])) {</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <a class="code" href="group__mrf_common.html#ga42a0aecda942f6b758fbace9d8b3cdaa">FracSynthAnalyze</a> (controlWord, <a class="code" href="mrf_common_8h.html#a71f339e0c947dd8482f0de2f42005609">MRF_FRAC_SYNTH_REF</a>, <a class="code" href="debug_print_8h.html#afeb648eb8d2d3c3754f00a0abd605320">DP_DEBUG</a>);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; badArgs = 0;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; }<span class="comment">/*end if control word parse was successful*/</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; }<span class="comment">/*end if we had the right number of arguments*/</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="comment">/*---------------------</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment"> * Print the &quot;Usage&quot; message if we could not parse the argument.</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordflow">if</span> (badArgs) {</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; printf (<span class="stringliteral">&quot;Usage:\n&quot;</span>);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; printf (<span class="stringliteral">&quot;FracSynthAnalyze &lt;ControlWord&gt;\n&quot;</span>);</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; printf (<span class="stringliteral">&quot; Where &lt;ControlWord&gt; is a hexadecimal number representing\n&quot;</span>);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; printf (<span class="stringliteral">&quot; a Micrel SY87739L control word to be analyzed.\n&quot;</span>);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; }<span class="comment">/*end if could not parse arguments*/</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="comment">/*---------------------</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="comment"> * Always return success.</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keywordflow">return</span> <a class="code" href="mrf_frac_synth_8h.html#aba51915c87d64af47fb1cc59348961c9">OK</a>;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;}<span class="comment">/*end main()*/</span></div><div class="ttc" id="mrf_frac_synth_8h_html_aba51915c87d64af47fb1cc59348961c9"><div class="ttname"><a href="mrf_frac_synth_8h.html#aba51915c87d64af47fb1cc59348961c9">OK</a></div><div class="ttdeci">#define OK</div><div class="ttdef"><b>Definition:</b> <a href="mrf_frac_synth_8h_source.html#l00081">mrfFracSynth.h:81</a></div></div>
<div class="ttc" id="mrf_common_8h_html_a71f339e0c947dd8482f0de2f42005609"><div class="ttname"><a href="mrf_common_8h.html#a71f339e0c947dd8482f0de2f42005609">MRF_FRAC_SYNTH_REF</a></div><div class="ttdeci">#define MRF_FRAC_SYNTH_REF</div><div class="ttdef"><b>Definition:</b> <a href="mrf_common_8h_source.html#l00099">mrfCommon.h:99</a></div></div>
<div class="ttc" id="group__mrf_common_html_ga42a0aecda942f6b758fbace9d8b3cdaa"><div class="ttname"><a href="group__mrf_common.html#ga42a0aecda942f6b758fbace9d8b3cdaa">FracSynthAnalyze</a></div><div class="ttdeci">epicsShareExtern epicsFloat64 FracSynthAnalyze(epicsUInt32 ControlWord, epicsFloat64 ReferenceFreq, epicsInt32 PrintFlag)</div><div class="ttdef"><b>Definition:</b> <a href="mrf_frac_synth_8c_source.html#l00844">mrfFracSynth.c:844</a></div></div>
<div class="ttc" id="debug_print_8h_html_afeb648eb8d2d3c3754f00a0abd605320"><div class="ttname"><a href="debug_print_8h.html#afeb648eb8d2d3c3754f00a0abd605320">DP_DEBUG</a></div><div class="ttdeci">#define DP_DEBUG</div><div class="ttdef"><b>Definition:</b> <a href="debug_print_8h_source.html#l00093">debugPrint.h:93</a></div></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 22 2023 08:45:38 for mrfioc2 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>
6 changes: 6 additions & 0 deletions _frac_synth_analyze_8c__incl.map
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<map id="FracSynthAnalyze.c" name="FracSynthAnalyze.c">
<area shape="rect" id="node6" href="$mrf_common_8h.html" title="mrfCommon.h" alt="" coords="975,155,1091,181"/>
<area shape="rect" id="node21" href="$debug_print_8h.html" title="debugPrint.h" alt="" coords="796,155,900,181"/>
<area shape="rect" id="node23" href="$mrf_frac_synth_8h.html" title="mrfFracSynth.h" alt="" coords="1513,155,1633,181"/>
<area shape="rect" id="node24" href="$mrf_frac_synth_8c.html" title="Support routines for the Micrel SY87739L Fractional&#45;N Synthesizer. " alt="" coords="1182,80,1301,107"/>
</map>
1 change: 1 addition & 0 deletions _frac_synth_analyze_8c__incl.md5
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
a2fd61bc7c45ef6b38d56fb6d8a2dab6
Binary file added _frac_synth_analyze_8c__incl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
87 changes: 87 additions & 0 deletions _frac_synth_analyze_8c_source.html

Large diffs are not rendered by default.

Loading

0 comments on commit 55944af

Please sign in to comment.