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-01 16:36:21 +10:00
parent 100a18a956
commit 95a162cdfd
377 changed files with 6799 additions and 801 deletions

View File

@@ -86,6 +86,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classChaCha-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ChaCha Class Reference</div> </div>
@@ -155,13 +156,19 @@ Static Public Member Functions</h2></td></tr>
<tr class="memitem:a41ac3262e52ff49dcd916d0b3b2e2038"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChaCha.html#a41ac3262e52ff49dcd916d0b3b2e2038">hashCore</a> (uint32_t *output, const uint32_t *input, uint8_t rounds)</td></tr>
<tr class="memdesc:a41ac3262e52ff49dcd916d0b3b2e2038"><td class="mdescLeft">&#160;</td><td class="mdescRight">Executes the <a class="el" href="classChaCha.html" title="ChaCha stream cipher. ">ChaCha</a> hash core on an input memory block. <a href="#a41ac3262e52ff49dcd916d0b3b2e2038">More...</a><br/></td></tr>
<tr class="separator:a41ac3262e52ff49dcd916d0b3b2e2038"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a597954d014b0fcaa5d2a366a7411e523"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a597954d014b0fcaa5d2a366a7411e523"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>ChaChaPoly</b></td></tr>
<tr class="separator:a597954d014b0fcaa5d2a366a7411e523"><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><a class="el" href="classChaCha.html" title="ChaCha stream cipher. ">ChaCha</a> stream cipher. </p>
<p><a class="el" href="classChaCha.html" title="ChaCha stream cipher. ">ChaCha</a> is a stream cipher that takes a key, an 8-byte nonce/IV, and a counter and hashes them to generate a keystream to XOR with the plaintext. Variations on the <a class="el" href="classChaCha.html" title="ChaCha stream cipher. ">ChaCha</a> cipher use 8, 12, or 20 rounds of hashing operations with either 128-bit or 256-bit keys.</p>
<p>Reference: <a href="http://cr.yp.to/chacha.html">http://cr.yp.to/chacha.html</a> </p>
<p>Definition at line <a class="el" href="ChaCha_8h_source.html#l00028">28</a> of file <a class="el" href="ChaCha_8h_source.html">ChaCha.h</a>.</p>
<p>Definition at line <a class="el" href="ChaCha_8h_source.html#l00030">30</a> of file <a class="el" href="ChaCha_8h_source.html">ChaCha.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5831811b705d3c80e97f0242597f0c7e"></a>
<div class="memitem">
@@ -224,7 +231,7 @@ Static Public Member Functions</h2></td></tr>
<p>Implements <a class="el" href="classCipher.html#a4b7c3965646441a70d9ab934a7c92ab1">Cipher</a>.</p>
<p>Definition at line <a class="el" href="ChaCha_8cpp_source.html#l00195">195</a> of file <a class="el" href="ChaCha_8cpp_source.html">ChaCha.cpp</a>.</p>
<p>Definition at line <a class="el" href="ChaCha_8cpp_source.html#l00218">218</a> of file <a class="el" href="ChaCha_8cpp_source.html">ChaCha.cpp</a>.</p>
</div>
</div>
@@ -389,7 +396,7 @@ Static Public Member Functions</h2></td></tr>
</dl>
<p>This function is provided for the convenience of applications that need access to the <a class="el" href="classChaCha.html" title="ChaCha stream cipher. ">ChaCha</a> hash core without the higher-level processing that turns the core into a stream cipher. </p>
<p>Definition at line <a class="el" href="ChaCha_8cpp_source.html#l00230">230</a> of file <a class="el" href="ChaCha_8cpp_source.html">ChaCha.cpp</a>.</p>
<p>Definition at line <a class="el" href="ChaCha_8cpp_source.html#l00253">253</a> of file <a class="el" href="ChaCha_8cpp_source.html">ChaCha.cpp</a>.</p>
</div>
</div>
@@ -478,7 +485,7 @@ Static Public Member Functions</h2></td></tr>
<p>Returns the number of encryption rounds; usually 8, 12, or 20. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classChaCha.html#a1a0911e0be8f4590d7fb76884d98c541" title="Sets the number of encryption rounds. ">setNumRounds()</a> </dd></dl>
<p>Definition at line <a class="el" href="ChaCha_8h_source.html#l00037">37</a> of file <a class="el" href="ChaCha_8h_source.html">ChaCha.h</a>.</p>
<p>Definition at line <a class="el" href="ChaCha_8h_source.html#l00039">39</a> of file <a class="el" href="ChaCha_8h_source.html">ChaCha.h</a>.</p>
</div>
</div>
@@ -655,7 +662,7 @@ Static Public Member Functions</h2></td></tr>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classChaCha.html#a0a73d3623da377bc593876156768dd72" title="Returns the number of encryption rounds; usually 8, 12, or 20. ">numRounds()</a> </dd></dl>
<p>Definition at line <a class="el" href="ChaCha_8h_source.html#l00038">38</a> of file <a class="el" href="ChaCha_8h_source.html">ChaCha.h</a>.</p>
<p>Definition at line <a class="el" href="ChaCha_8h_source.html#l00040">40</a> of file <a class="el" href="ChaCha_8h_source.html">ChaCha.h</a>.</p>
</div>
</div>
@@ -666,7 +673,7 @@ Static Public Member Functions</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Mar 29 2015 08:30:13 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Apr 1 2015 16:36:10 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>