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-03-23 19:09:06 +10:00
parent 11f16a223a
commit 328b82e3fb
404 changed files with 1666 additions and 1456 deletions

View File

@@ -239,7 +239,7 @@ Protected Member Functions</h2></td></tr>
<p>Clears the hash state, removing all sensitive data, and then resets the hash ready for a new hashing process. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61" title="Resets the hash ready for a new hashing process. ">reset()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSHA3__512.html#acfbc5e9b4d394f011d5132a2b156d260">SHA3_512</a>, <a class="el" href="classSHA512.html#a0a9104dce5f099aeba216e5fbcb1ee1a">SHA512</a>, <a class="el" href="classBLAKE2b.html#a21623759bd381285ebf7e75a00c9c8a9">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a0848885f52df51dc53949d32a206e72d">BLAKE2s</a>, <a class="el" href="classSHA3__256.html#a531467f995ef6fc901ad8c2b5776a8d1">SHA3_256</a>, and <a class="el" href="classSHA256.html#add0d1649d533b27005ccd8508398c689">SHA256</a>.</p>
<p>Implemented in <a class="el" href="classSHA3__512.html#acfbc5e9b4d394f011d5132a2b156d260">SHA3_512</a>, <a class="el" href="classBLAKE2b.html#a21623759bd381285ebf7e75a00c9c8a9">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a0848885f52df51dc53949d32a206e72d">BLAKE2s</a>, <a class="el" href="classSHA512.html#a0a9104dce5f099aeba216e5fbcb1ee1a">SHA512</a>, <a class="el" href="classSHA3__256.html#a531467f995ef6fc901ad8c2b5776a8d1">SHA3_256</a>, and <a class="el" href="classSHA256.html#add0d1649d533b27005ccd8508398c689">SHA256</a>.</p>
</div>
</div>
@@ -287,7 +287,7 @@ Protected Member Functions</h2></td></tr>
<p>If <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c" title="Finalizes the hashing process and returns the hash. ">finalize()</a> is called again, then the returned <em>hash</em> value is undefined. Call <a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61" title="Resets the hash ready for a new hashing process. ">reset()</a> first to start a new hashing process.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classHash.html#aec9761ee427d122e7450de8df200265c" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSHA3__512.html#ac0227aafb5f047bb50f0bd84df0b4b5b">SHA3_512</a>, <a class="el" href="classSHA512.html#afc136ad0e77de527b031db3fb8b32464">SHA512</a>, <a class="el" href="classBLAKE2b.html#a0cd8146b7868bd0f4c24a3856f106d17">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b">BLAKE2s</a>, <a class="el" href="classSHA3__256.html#a8fe7cad1f83bd1bae1a0d521324247a1">SHA3_256</a>, and <a class="el" href="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6">SHA256</a>.</p>
<p>Implemented in <a class="el" href="classSHA3__512.html#ac0227aafb5f047bb50f0bd84df0b4b5b">SHA3_512</a>, <a class="el" href="classBLAKE2b.html#a0cd8146b7868bd0f4c24a3856f106d17">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b">BLAKE2s</a>, <a class="el" href="classSHA512.html#afc136ad0e77de527b031db3fb8b32464">SHA512</a>, <a class="el" href="classSHA3__256.html#a8fe7cad1f83bd1bae1a0d521324247a1">SHA3_256</a>, and <a class="el" href="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6">SHA256</a>.</p>
</div>
</div>
@@ -347,7 +347,7 @@ Protected Member Functions</h2></td></tr>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classHash.html#adf50359c1f525af884721cc9034e7945" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a>, <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c" title="Finalizes the hashing process and returns the hash. ">finalize()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSHA3__512.html#a25c9d2da26d01d46ba6b72c8a7905ea0">SHA3_512</a>, <a class="el" href="classSHA512.html#a1fe9533f0d3dfdb426eb3dc4bdc31904">SHA512</a>, <a class="el" href="classBLAKE2b.html#a29fafbba26e3c1d896b4d4c428f7d52a">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc">BLAKE2s</a>, <a class="el" href="classSHA3__256.html#a001215fa1b7d2c30717b4b5b1618d68c">SHA3_256</a>, and <a class="el" href="classSHA256.html#a28bc2510c5bdaf210a012f9f21a753cd">SHA256</a>.</p>
<p>Implemented in <a class="el" href="classSHA3__512.html#a25c9d2da26d01d46ba6b72c8a7905ea0">SHA3_512</a>, <a class="el" href="classBLAKE2b.html#a29fafbba26e3c1d896b4d4c428f7d52a">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc">BLAKE2s</a>, <a class="el" href="classSHA512.html#a1fe9533f0d3dfdb426eb3dc4bdc31904">SHA512</a>, <a class="el" href="classSHA3__256.html#a001215fa1b7d2c30717b4b5b1618d68c">SHA3_256</a>, and <a class="el" href="classSHA256.html#a28bc2510c5bdaf210a012f9f21a753cd">SHA256</a>.</p>
</div>
</div>
@@ -517,7 +517,7 @@ Protected Member Functions</h2></td></tr>
</div><!-- fragment --><p>The same key must be passed to both <a class="el" href="classHash.html#adf50359c1f525af884721cc9034e7945" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> and <a class="el" href="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a>, <a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61" title="Resets the hash ready for a new hashing process. ">reset()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSHA3__512.html#aac7133f420f2be0288965c2e863f389b">SHA3_512</a>, <a class="el" href="classSHA512.html#a2427ad8bf8b6958df91bd5806986167c">SHA512</a>, <a class="el" href="classBLAKE2b.html#acb1ca4081c509d1c34b3aee465cd4494">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd">BLAKE2s</a>, <a class="el" href="classSHA3__256.html#a324fe4d268bbf23d7b492033fe3bc632">SHA3_256</a>, and <a class="el" href="classSHA256.html#a2271683d6f1c7c103272f1dec55a6871">SHA256</a>.</p>
<p>Implemented in <a class="el" href="classSHA3__512.html#aac7133f420f2be0288965c2e863f389b">SHA3_512</a>, <a class="el" href="classBLAKE2b.html#acb1ca4081c509d1c34b3aee465cd4494">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd">BLAKE2s</a>, <a class="el" href="classSHA512.html#a2427ad8bf8b6958df91bd5806986167c">SHA512</a>, <a class="el" href="classSHA3__256.html#a324fe4d268bbf23d7b492033fe3bc632">SHA3_256</a>, and <a class="el" href="classSHA256.html#a2271683d6f1c7c103272f1dec55a6871">SHA256</a>.</p>
</div>
</div>
@@ -564,7 +564,7 @@ Protected Member Functions</h2></td></tr>
<p>If <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c" title="Finalizes the hashing process and returns the hash. ">finalize()</a> has already been called, then the behavior of <a class="el" href="classHash.html#aec9761ee427d122e7450de8df200265c" title="Updates the hash with more data. ">update()</a> will be undefined. Call <a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61" title="Resets the hash ready for a new hashing process. ">reset()</a> first to start a new hashing process.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c" title="Finalizes the hashing process and returns the hash. ">finalize()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSHA3__512.html#a0563e4c87150e6019671b4fe92fd63a4">SHA3_512</a>, <a class="el" href="classSHA512.html#a7d37a20d7ab431ab15d094f768b6a695">SHA512</a>, <a class="el" href="classBLAKE2b.html#a468e48c66ce1738e11c922d133135069">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">BLAKE2s</a>, <a class="el" href="classSHA3__256.html#a8356957ea403c5da326fc6899b91ea71">SHA3_256</a>, and <a class="el" href="classSHA256.html#a555bf8efb17afd4842d2e55a1f39f27b">SHA256</a>.</p>
<p>Implemented in <a class="el" href="classSHA3__512.html#a0563e4c87150e6019671b4fe92fd63a4">SHA3_512</a>, <a class="el" href="classBLAKE2b.html#a468e48c66ce1738e11c922d133135069">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">BLAKE2s</a>, <a class="el" href="classSHA512.html#a7d37a20d7ab431ab15d094f768b6a695">SHA512</a>, <a class="el" href="classSHA3__256.html#a8356957ea403c5da326fc6899b91ea71">SHA3_256</a>, and <a class="el" href="classSHA256.html#a555bf8efb17afd4842d2e55a1f39f27b">SHA256</a>.</p>
</div>
</div>
@@ -575,7 +575,7 @@ Protected Member Functions</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Mar 13 2016 08:28:01 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Mar 23 2016 19:08:46 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>