1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00

Update docs

This commit is contained in:
Rhys Weatherley
2015-04-02 16:37:15 +10:00
parent 95a162cdfd
commit 772ecf46e8
331 changed files with 835 additions and 566 deletions

View File

@@ -121,18 +121,24 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;{</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;}</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="classNoiseSource.html#a1af7449a5ae4a8acd34ac218c9eec6c1"> 102</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classNoiseSource.html#a1af7449a5ae4a8acd34ac218c9eec6c1">NoiseSource::output</a>(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> len, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> credit)</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;{</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; RNG.<a class="code" href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02">stir</a>(data, len, credit);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;}</div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classNoiseSource.html#a48d0efabd71ff6e557a0898be79c49ba"> 95</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classNoiseSource.html#a48d0efabd71ff6e557a0898be79c49ba">NoiseSource::added</a>()</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;{</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="comment">// Nothing to do here.</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;}</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classNoiseSource.html#a1af7449a5ae4a8acd34ac218c9eec6c1"> 117</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classNoiseSource.html#a1af7449a5ae4a8acd34ac218c9eec6c1">NoiseSource::output</a>(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> len, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> credit)</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;{</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; RNG.<a class="code" href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02">stir</a>(data, len, credit);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;}</div>
<div class="ttc" id="classNoiseSource_html_a601479b7d8cc215f97f2f8a18d3ef4c2"><div class="ttname"><a href="classNoiseSource.html#a601479b7d8cc215f97f2f8a18d3ef4c2">NoiseSource::NoiseSource</a></div><div class="ttdeci">NoiseSource()</div><div class="ttdoc">Constructs a new random noise source. </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8cpp_source.html#l00036">NoiseSource.cpp:36</a></div></div>
<div class="ttc" id="classNoiseSource_html_a1af7449a5ae4a8acd34ac218c9eec6c1"><div class="ttname"><a href="classNoiseSource.html#a1af7449a5ae4a8acd34ac218c9eec6c1">NoiseSource::output</a></div><div class="ttdeci">virtual void output(const uint8_t *data, size_t len, unsigned int credit)</div><div class="ttdoc">Called from subclasses to output noise to the global random number pool. </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8cpp_source.html#l00102">NoiseSource.cpp:102</a></div></div>
<div class="ttc" id="classNoiseSource_html_a48d0efabd71ff6e557a0898be79c49ba"><div class="ttname"><a href="classNoiseSource.html#a48d0efabd71ff6e557a0898be79c49ba">NoiseSource::added</a></div><div class="ttdeci">virtual void added()</div><div class="ttdoc">Called when the noise source is added to RNG with RNG.addNoiseSource(). </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8cpp_source.html#l00095">NoiseSource.cpp:95</a></div></div>
<div class="ttc" id="classNoiseSource_html_a1af7449a5ae4a8acd34ac218c9eec6c1"><div class="ttname"><a href="classNoiseSource.html#a1af7449a5ae4a8acd34ac218c9eec6c1">NoiseSource::output</a></div><div class="ttdeci">virtual void output(const uint8_t *data, size_t len, unsigned int credit)</div><div class="ttdoc">Called from subclasses to output noise to the global random number pool. </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8cpp_source.html#l00117">NoiseSource.cpp:117</a></div></div>
<div class="ttc" id="classNoiseSource_html_a4eca1e894a5d719fb9bf4df34a791cdb"><div class="ttname"><a href="classNoiseSource.html#a4eca1e894a5d719fb9bf4df34a791cdb">NoiseSource::~NoiseSource</a></div><div class="ttdeci">virtual ~NoiseSource()</div><div class="ttdoc">Destroys this random noise source. </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8cpp_source.html#l00043">NoiseSource.cpp:43</a></div></div>
<div class="ttc" id="classRNGClass_html_ad99535ea23ae2fec55bdebb8c24def02"><div class="ttname"><a href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02">RNGClass::stir</a></div><div class="ttdeci">void stir(const uint8_t *data, size_t len, unsigned int credit=0)</div><div class="ttdoc">Stirs additional entropy data into the random pool. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00406">RNG.cpp:406</a></div></div>
<div class="ttc" id="classRNGClass_html_ad99535ea23ae2fec55bdebb8c24def02"><div class="ttname"><a href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02">RNGClass::stir</a></div><div class="ttdeci">void stir(const uint8_t *data, size_t len, unsigned int credit=0)</div><div class="ttdoc">Stirs additional entropy data into the random pool. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00408">RNG.cpp:408</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 1 2015 16:36:10 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Apr 2 2015 16:36:51 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>