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
2016-02-14 08:32:06 +10:00
parent c74770a343
commit 443fa28b67
401 changed files with 5331 additions and 2249 deletions

View File

@@ -232,7 +232,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classSHA3__256_html_a835d09eb88d477cd162330c493cbdf64"><div class="ttname"><a href="classSHA3__256.html#a835d09eb88d477cd162330c493cbdf64">SHA3_256::~SHA3_256</a></div><div class="ttdeci">virtual ~SHA3_256()</div><div class="ttdoc">Destroys this hash object after clearing sensitive information. </div><div class="ttdef"><b>Definition:</b> <a href="SHA3_8cpp_source.html#l00046">SHA3.cpp:46</a></div></div>
<div class="ttc" id="classSHA3__256_html_a324fe4d268bbf23d7b492033fe3bc632"><div class="ttname"><a href="classSHA3__256.html#a324fe4d268bbf23d7b492033fe3bc632">SHA3_256::resetHMAC</a></div><div class="ttdeci">void resetHMAC(const void *key, size_t keyLen)</div><div class="ttdoc">Resets the hash ready for a new HMAC hashing process. </div><div class="ttdef"><b>Definition:</b> <a href="SHA3_8cpp_source.html#l00083">SHA3.cpp:83</a></div></div>
<div class="ttc" id="classSHA3__512_html_a9f13e4d2b99dd204e96b11142e9c1803"><div class="ttname"><a href="classSHA3__512.html#a9f13e4d2b99dd204e96b11142e9c1803">SHA3_512::hashSize</a></div><div class="ttdeci">size_t hashSize() const </div><div class="ttdoc">Size of the hash result from finalize(). </div><div class="ttdef"><b>Definition:</b> <a href="SHA3_8cpp_source.html#l00123">SHA3.cpp:123</a></div></div>
<div class="ttc" id="classKeccakCore_html_aeff6b3357916bf426b60d3629db52628"><div class="ttname"><a href="classKeccakCore.html#aeff6b3357916bf426b60d3629db52628">KeccakCore::setHMACKey</a></div><div class="ttdeci">void setHMACKey(const void *key, size_t len, uint8_t pad, size_t hashSize)</div><div class="ttdoc">Sets a HMAC key for a Keccak-based hash algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00243">KeccakCore.cpp:243</a></div></div>
<div class="ttc" id="classKeccakCore_html_aeff6b3357916bf426b60d3629db52628"><div class="ttname"><a href="classKeccakCore.html#aeff6b3357916bf426b60d3629db52628">KeccakCore::setHMACKey</a></div><div class="ttdeci">void setHMACKey(const void *key, size_t len, uint8_t pad, size_t hashSize)</div><div class="ttdoc">Sets a HMAC key for a Keccak-based hash algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00293">KeccakCore.cpp:293</a></div></div>
<div class="ttc" id="classSHA3__256_html_ac091b276c6d80a981fa64a9e8c68ca87"><div class="ttname"><a href="classSHA3__256.html#ac091b276c6d80a981fa64a9e8c68ca87">SHA3_256::SHA3_256</a></div><div class="ttdeci">SHA3_256()</div><div class="ttdoc">Constructs a new SHA3-256 hash object. </div><div class="ttdef"><b>Definition:</b> <a href="SHA3_8cpp_source.html#l00038">SHA3.cpp:38</a></div></div>
<div class="ttc" id="classSHA3__256_html_a001215fa1b7d2c30717b4b5b1618d68c"><div class="ttname"><a href="classSHA3__256.html#a001215fa1b7d2c30717b4b5b1618d68c">SHA3_256::finalizeHMAC</a></div><div class="ttdeci">void finalizeHMAC(const void *key, size_t keyLen, void *hash, size_t hashLen)</div><div class="ttdoc">Finalizes the HMAC hashing process and returns the hash. </div><div class="ttdef"><b>Definition:</b> <a href="SHA3_8cpp_source.html#l00088">SHA3.cpp:88</a></div></div>
<div class="ttc" id="classSHA3__512_html_a327005ebc8c0768118ec7d334c583f85"><div class="ttname"><a href="classSHA3__512.html#a327005ebc8c0768118ec7d334c583f85">SHA3_512::~SHA3_512</a></div><div class="ttdeci">virtual ~SHA3_512()</div><div class="ttdoc">Destroys this hash object after clearing sensitive information. </div><div class="ttdef"><b>Definition:</b> <a href="SHA3_8cpp_source.html#l00118">SHA3.cpp:118</a></div></div>
@@ -249,7 +249,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classSHA3__512_html_a4493a717bad8fa5cd35fe3aa36f25ab3"><div class="ttname"><a href="classSHA3__512.html#a4493a717bad8fa5cd35fe3aa36f25ab3">SHA3_512::blockSize</a></div><div class="ttdeci">size_t blockSize() const </div><div class="ttdoc">Size of the internal block used by the hash algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="SHA3_8cpp_source.html#l00128">SHA3.cpp:128</a></div></div>
<div class="ttc" id="classSHA3__512_html_a0563e4c87150e6019671b4fe92fd63a4"><div class="ttname"><a href="classSHA3__512.html#a0563e4c87150e6019671b4fe92fd63a4">SHA3_512::update</a></div><div class="ttdeci">void update(const void *data, size_t len)</div><div class="ttdoc">Updates the hash with more data. </div><div class="ttdef"><b>Definition:</b> <a href="SHA3_8cpp_source.html#l00138">SHA3.cpp:138</a></div></div>
<div class="ttc" id="classKeccakCore_html_aaaa0355ccec0f469ac8eb577bdf853ed"><div class="ttname"><a href="classKeccakCore.html#aaaa0355ccec0f469ac8eb577bdf853ed">KeccakCore::update</a></div><div class="ttdeci">void update(const void *data, size_t size)</div><div class="ttdoc">Updates the Keccak sponge function with more input data. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00133">KeccakCore.cpp:133</a></div></div>
<div class="ttc" id="classKeccakCore_html_aeff1df56e4a3103c99c1fe4307e60c66"><div class="ttname"><a href="classKeccakCore.html#aeff1df56e4a3103c99c1fe4307e60c66">KeccakCore::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears all sensitive data from this object. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00225">KeccakCore.cpp:225</a></div></div>
<div class="ttc" id="classKeccakCore_html_aeff1df56e4a3103c99c1fe4307e60c66"><div class="ttname"><a href="classKeccakCore.html#aeff1df56e4a3103c99c1fe4307e60c66">KeccakCore::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears all sensitive data from this object. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00275">KeccakCore.cpp:275</a></div></div>
<div class="ttc" id="classSHA3__256_html_a8fe7cad1f83bd1bae1a0d521324247a1"><div class="ttname"><a href="classSHA3__256.html#a8fe7cad1f83bd1bae1a0d521324247a1">SHA3_256::finalize</a></div><div class="ttdeci">void finalize(void *hash, size_t len)</div><div class="ttdoc">Finalizes the hashing process and returns the hash. </div><div class="ttdef"><b>Definition:</b> <a href="SHA3_8cpp_source.html#l00071">SHA3.cpp:71</a></div></div>
<div class="ttc" id="classKeccakCore_html_a5a322eb7e3b5c1eaad127c9c6e6a529b"><div class="ttname"><a href="classKeccakCore.html#a5a322eb7e3b5c1eaad127c9c6e6a529b">KeccakCore::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Resets the Keccak sponge function ready for a new session. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00114">KeccakCore.cpp:114</a></div></div>
<div class="ttc" id="classSHA3__256_html_a8356957ea403c5da326fc6899b91ea71"><div class="ttname"><a href="classSHA3__256.html#a8356957ea403c5da326fc6899b91ea71">SHA3_256::update</a></div><div class="ttdeci">void update(const void *data, size_t len)</div><div class="ttdoc">Updates the hash with more data. </div><div class="ttdef"><b>Definition:</b> <a href="SHA3_8cpp_source.html#l00066">SHA3.cpp:66</a></div></div>
@@ -257,7 +257,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 14 2016 07:48:07 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Feb 14 2016 08:32:00 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>