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-03-25 19:36:25 +10:00
parent fba6ac9417
commit efb2741e4a
306 changed files with 2931 additions and 1386 deletions

View File

@@ -131,20 +131,23 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBLAKE2b.html#a21623759bd381285ebf7e75a00c9c8a9">clear</a>();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; uint64_t h[8];</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; uint64_t m[16];</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; uint64_t v[16];</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; uint64_t lengthLow;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; uint64_t lengthHigh;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; uint8_t chunkSize;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; } state;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">void</span> processChunk(uint64_t f0);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;};</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBLAKE2b.html#acb1ca4081c509d1c34b3aee465cd4494">resetHMAC</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> keyLen);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBLAKE2b.html#a29fafbba26e3c1d896b4d4c428f7d52a">finalizeHMAC</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> keyLen, <span class="keywordtype">void</span> *hash, <span class="keywordtype">size_t</span> hashLen);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; uint64_t h[8];</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; uint64_t m[16];</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; uint64_t v[16];</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; uint64_t lengthLow;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uint64_t lengthHigh;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; uint8_t chunkSize;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; } state;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">void</span> processChunk(uint64_t f0);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;};</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classBLAKE2b_html_a0cd8146b7868bd0f4c24a3856f106d17"><div class="ttname"><a href="classBLAKE2b.html#a0cd8146b7868bd0f4c24a3856f106d17">BLAKE2b::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="BLAKE2b_8cpp_source.html#l00143">BLAKE2b.cpp:143</a></div></div>
<div class="ttc" id="classBLAKE2b_html_a917beae2ca6e9831a35717a526089e8a"><div class="ttname"><a href="classBLAKE2b.html#a917beae2ca6e9831a35717a526089e8a">BLAKE2b::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Resets the hash ready for a new hashing process. </div><div class="ttdef"><b>Definition:</b> <a href="BLAKE2b_8cpp_source.html#l00081">BLAKE2b.cpp:81</a></div></div>
<div class="ttc" id="classBLAKE2b_html_a21623759bd381285ebf7e75a00c9c8a9"><div class="ttname"><a href="classBLAKE2b.html#a21623759bd381285ebf7e75a00c9c8a9">BLAKE2b::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears the hash state, removing all sensitive data, and then resets the hash ready for a new hashing ...</div><div class="ttdef"><b>Definition:</b> <a href="BLAKE2b_8cpp_source.html#l00159">BLAKE2b.cpp:159</a></div></div>
@@ -155,10 +158,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classBLAKE2b_html_a7555de16f6918ab820170a7ed3098c89"><div class="ttname"><a href="classBLAKE2b.html#a7555de16f6918ab820170a7ed3098c89">BLAKE2b::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="BLAKE2b_8cpp_source.html#l00061">BLAKE2b.cpp:61</a></div></div>
<div class="ttc" id="classBLAKE2b_html_ad0287d7284000ff236153e6afa0130f1"><div class="ttname"><a href="classBLAKE2b.html#ad0287d7284000ff236153e6afa0130f1">BLAKE2b::~BLAKE2b</a></div><div class="ttdeci">virtual ~BLAKE2b()</div><div class="ttdoc">Destroys this BLAKE2b hash object after clearing sensitive information. </div><div class="ttdef"><b>Definition:</b> <a href="BLAKE2b_8cpp_source.html#l00056">BLAKE2b.cpp:56</a></div></div>
<div class="ttc" id="classBLAKE2b_html_a468e48c66ce1738e11c922d133135069"><div class="ttname"><a href="classBLAKE2b.html#a468e48c66ce1738e11c922d133135069">BLAKE2b::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="BLAKE2b_8cpp_source.html#l00118">BLAKE2b.cpp:118</a></div></div>
<div class="ttc" id="classBLAKE2b_html_acb1ca4081c509d1c34b3aee465cd4494"><div class="ttname"><a href="classBLAKE2b.html#acb1ca4081c509d1c34b3aee465cd4494">BLAKE2b::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="BLAKE2b_8cpp_source.html#l00165">BLAKE2b.cpp:165</a></div></div>
<div class="ttc" id="classBLAKE2b_html_a29fafbba26e3c1d896b4d4c428f7d52a"><div class="ttname"><a href="classBLAKE2b.html#a29fafbba26e3c1d896b4d4c428f7d52a">BLAKE2b::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="BLAKE2b_8cpp_source.html#l00172">BLAKE2b.cpp:172</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Mar 22 2015 15:54:26 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Mar 25 2015 19:36:07 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>