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-18 08:45:02 +10:00
parent 52795520e2
commit 0ad779856a
352 changed files with 3931 additions and 1734 deletions

View File

@@ -237,8 +237,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; clean(state);</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; state.ivSize = 8;</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;}</div>
<div class="ttc" id="classPoly1305_html_aab3fa6c5f6fa7d9ca6c82bead38f499c"><div class="ttname"><a href="classPoly1305.html#aab3fa6c5f6fa7d9ca6c82bead38f499c">Poly1305::finalize</a></div><div class="ttdeci">void finalize(const void *nonce, void *token, size_t len)</div><div class="ttdoc">Finalizes the authentication process and returns the token. </div><div class="ttdef"><b>Definition:</b> <a href="Poly1305_8cpp_source.html#l00180">Poly1305.cpp:180</a></div></div>
<div class="ttc" id="classPoly1305_html_a544839403d0a19300c239708bc1e6ed8"><div class="ttname"><a href="classPoly1305.html#a544839403d0a19300c239708bc1e6ed8">Poly1305::reset</a></div><div class="ttdeci">void reset(const void *key)</div><div class="ttdoc">Resets the Poly1305 message authenticator for a new session. </div><div class="ttdef"><b>Definition:</b> <a href="Poly1305_8cpp_source.html#l00111">Poly1305.cpp:111</a></div></div>
<div class="ttc" id="classPoly1305_html_aab3fa6c5f6fa7d9ca6c82bead38f499c"><div class="ttname"><a href="classPoly1305.html#aab3fa6c5f6fa7d9ca6c82bead38f499c">Poly1305::finalize</a></div><div class="ttdeci">void finalize(const void *nonce, void *token, size_t len)</div><div class="ttdoc">Finalizes the authentication process and returns the token. </div><div class="ttdef"><b>Definition:</b> <a href="Poly1305_8cpp_source.html#l00179">Poly1305.cpp:179</a></div></div>
<div class="ttc" id="classPoly1305_html_a544839403d0a19300c239708bc1e6ed8"><div class="ttname"><a href="classPoly1305.html#a544839403d0a19300c239708bc1e6ed8">Poly1305::reset</a></div><div class="ttdeci">void reset(const void *key)</div><div class="ttdoc">Resets the Poly1305 message authenticator for a new session. </div><div class="ttdef"><b>Definition:</b> <a href="Poly1305_8cpp_source.html#l00110">Poly1305.cpp:110</a></div></div>
<div class="ttc" id="classChaCha_html_a6b2bdffbd3705e388bb458edb2f40c90"><div class="ttname"><a href="classChaCha.html#a6b2bdffbd3705e388bb458edb2f40c90">ChaCha::setKey</a></div><div class="ttdeci">bool setKey(const uint8_t *key, size_t len)</div><div class="ttdoc">Sets the key to use for future encryption and decryption operations. </div><div class="ttdef"><b>Definition:</b> <a href="ChaCha_8cpp_source.html#l00087">ChaCha.cpp:87</a></div></div>
<div class="ttc" id="classChaChaPoly_html_a7c37e683ee0d2f1181007d8bded4f80c"><div class="ttname"><a href="classChaChaPoly.html#a7c37e683ee0d2f1181007d8bded4f80c">ChaChaPoly::~ChaChaPoly</a></div><div class="ttdeci">virtual ~ChaChaPoly()</div><div class="ttdoc">Destroys this ChaChaPoly authenticated cipher. </div><div class="ttdef"><b>Definition:</b> <a href="ChaChaPoly_8cpp_source.html#l00056">ChaChaPoly.cpp:56</a></div></div>
<div class="ttc" id="classChaChaPoly_html_a086c2aea395ab31136ebe7805591fd0a"><div class="ttname"><a href="classChaChaPoly.html#a086c2aea395ab31136ebe7805591fd0a">ChaChaPoly::tagSize</a></div><div class="ttdeci">size_t tagSize() const </div><div class="ttdoc">Returns the size of the authentication tag. </div><div class="ttdef"><b>Definition:</b> <a href="ChaChaPoly_8cpp_source.html#l00073">ChaChaPoly.cpp:73</a></div></div>
@@ -251,18 +251,18 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classChaChaPoly_html_a4aa3514d1fb6272da977a7467ae6734b"><div class="ttname"><a href="classChaChaPoly.html#a4aa3514d1fb6272da977a7467ae6734b">ChaChaPoly::addAuthData</a></div><div class="ttdeci">void addAuthData(const void *data, size_t len)</div><div class="ttdoc">Adds extra data that will be authenticated but not encrypted. </div><div class="ttdef"><b>Definition:</b> <a href="ChaChaPoly_8cpp_source.html#l00126">ChaChaPoly.cpp:126</a></div></div>
<div class="ttc" id="classChaChaPoly_html_a7df4acd04f459ecf9d3b24317bde94a3"><div class="ttname"><a href="classChaChaPoly.html#a7df4acd04f459ecf9d3b24317bde94a3">ChaChaPoly::encrypt</a></div><div class="ttdeci">void encrypt(uint8_t *output, const uint8_t *input, size_t len)</div><div class="ttdoc">Encrypts an input buffer and writes the ciphertext to an output buffer. </div><div class="ttdef"><b>Definition:</b> <a href="ChaChaPoly_8cpp_source.html#l00104">ChaChaPoly.cpp:104</a></div></div>
<div class="ttc" id="classChaChaPoly_html_ac3ebfaaaffe9d607905681949e75140d"><div class="ttname"><a href="classChaChaPoly.html#ac3ebfaaaffe9d607905681949e75140d">ChaChaPoly::ivSize</a></div><div class="ttdeci">size_t ivSize() const </div><div class="ttdoc">Size of the initialization vector for this cipher, in bytes. </div></div>
<div class="ttc" id="classPoly1305_html_ae4e0b647ff93f501bd01459b1616557c"><div class="ttname"><a href="classPoly1305.html#ae4e0b647ff93f501bd01459b1616557c">Poly1305::update</a></div><div class="ttdeci">void update(const void *data, size_t len)</div><div class="ttdoc">Updates the message authenticator with more data. </div><div class="ttdef"><b>Definition:</b> <a href="Poly1305_8cpp_source.html#l00143">Poly1305.cpp:143</a></div></div>
<div class="ttc" id="classPoly1305_html_ae4e0b647ff93f501bd01459b1616557c"><div class="ttname"><a href="classPoly1305.html#ae4e0b647ff93f501bd01459b1616557c">Poly1305::update</a></div><div class="ttdeci">void update(const void *data, size_t len)</div><div class="ttdoc">Updates the message authenticator with more data. </div><div class="ttdef"><b>Definition:</b> <a href="Poly1305_8cpp_source.html#l00142">Poly1305.cpp:142</a></div></div>
<div class="ttc" id="classChaCha_html_af533905f679066c41f4d6cd76bddb4cb"><div class="ttname"><a href="classChaCha.html#af533905f679066c41f4d6cd76bddb4cb">ChaCha::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears all security-sensitive state from this cipher. </div><div class="ttdef"><b>Definition:</b> <a href="ChaCha_8cpp_source.html#l00218">ChaCha.cpp:218</a></div></div>
<div class="ttc" id="classChaChaPoly_html_a2d7fc3fd05a0b6c7c9c21fff6e939c9a"><div class="ttname"><a href="classChaChaPoly.html#a2d7fc3fd05a0b6c7c9c21fff6e939c9a">ChaChaPoly::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears all security-sensitive state from this cipher. </div><div class="ttdef"><b>Definition:</b> <a href="ChaChaPoly_8cpp_source.html#l00163">ChaChaPoly.cpp:163</a></div></div>
<div class="ttc" id="classChaChaPoly_html_a42f556f202b1166486434ee15b6d95a0"><div class="ttname"><a href="classChaChaPoly.html#a42f556f202b1166486434ee15b6d95a0">ChaChaPoly::decrypt</a></div><div class="ttdeci">void decrypt(uint8_t *output, const uint8_t *input, size_t len)</div><div class="ttdoc">Decrypts an input buffer and writes the plaintext to an output buffer. </div><div class="ttdef"><b>Definition:</b> <a href="ChaChaPoly_8cpp_source.html#l00115">ChaChaPoly.cpp:115</a></div></div>
<div class="ttc" id="classPoly1305_html_aaea2f40c1f22dcc2f8f690c793fb4388"><div class="ttname"><a href="classPoly1305.html#aaea2f40c1f22dcc2f8f690c793fb4388">Poly1305::pad</a></div><div class="ttdeci">void pad()</div><div class="ttdoc">Pads the input stream with zero bytes to a multiple of 16. </div><div class="ttdef"><b>Definition:</b> <a href="Poly1305_8cpp_source.html#l00251">Poly1305.cpp:251</a></div></div>
<div class="ttc" id="classPoly1305_html_ae3f3392b9a2bd0f3472e7e50dd7e21dd"><div class="ttname"><a href="classPoly1305.html#ae3f3392b9a2bd0f3472e7e50dd7e21dd">Poly1305::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears the authenticator&#39;s state, removing all sensitive data. </div><div class="ttdef"><b>Definition:</b> <a href="Poly1305_8cpp_source.html#l00265">Poly1305.cpp:265</a></div></div>
<div class="ttc" id="classPoly1305_html_aaea2f40c1f22dcc2f8f690c793fb4388"><div class="ttname"><a href="classPoly1305.html#aaea2f40c1f22dcc2f8f690c793fb4388">Poly1305::pad</a></div><div class="ttdeci">void pad()</div><div class="ttdoc">Pads the input stream with zero bytes to a multiple of 16. </div><div class="ttdef"><b>Definition:</b> <a href="Poly1305_8cpp_source.html#l00250">Poly1305.cpp:250</a></div></div>
<div class="ttc" id="classPoly1305_html_ae3f3392b9a2bd0f3472e7e50dd7e21dd"><div class="ttname"><a href="classPoly1305.html#ae3f3392b9a2bd0f3472e7e50dd7e21dd">Poly1305::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears the authenticator&#39;s state, removing all sensitive data. </div><div class="ttdef"><b>Definition:</b> <a href="Poly1305_8cpp_source.html#l00264">Poly1305.cpp:264</a></div></div>
<div class="ttc" id="classChaChaPoly_html_ae300892647dd92cbce711b834aa20c09"><div class="ttname"><a href="classChaChaPoly.html#ae300892647dd92cbce711b834aa20c09">ChaChaPoly::setKey</a></div><div class="ttdeci">bool setKey(const uint8_t *key, size_t len)</div><div class="ttdoc">Sets the key to use for future encryption and decryption operations. </div><div class="ttdef"><b>Definition:</b> <a href="ChaChaPoly_8cpp_source.html#l00079">ChaChaPoly.cpp:79</a></div></div>
<div class="ttc" id="classChaChaPoly_html_aeffb3e0df0b4da03f72f30251243d953"><div class="ttname"><a href="classChaChaPoly.html#aeffb3e0df0b4da03f72f30251243d953">ChaChaPoly::checkTag</a></div><div class="ttdeci">bool checkTag(const void *tag, size_t len)</div><div class="ttdoc">Finalizes the decryption process and checks the authentication tag. </div><div class="ttdef"><b>Definition:</b> <a href="ChaChaPoly_8cpp_source.html#l00149">ChaChaPoly.cpp:149</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Apr 6 2015 09:30:16 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sat Apr 18 2015 08:44:48 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>