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-08-23 18:54:56 +10:00
parent 85faa4b5e9
commit e963eb0377
413 changed files with 753 additions and 825 deletions

View File

@@ -161,20 +161,20 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classNewHope_html_a679601da301134f037c3a5786bd7085fae270e706968a8e01e5c1cb40422b22c6"><div class="ttname"><a href="classNewHope.html#a679601da301134f037c3a5786bd7085fae270e706968a8e01e5c1cb40422b22c6">NewHope::Torref</a></div><div class="ttdoc">The alternative &quot;torref&quot; version of the New Hope algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8h_source.html#l00058">NewHope.h:58</a></div></div>
<div class="ttc" id="classNewHopePoly_html_ad7c3c83cb078be4e6f136eeea7e21250"><div class="ttname"><a href="classNewHopePoly.html#ad7c3c83cb078be4e6f136eeea7e21250">NewHopePoly::~NewHopePoly</a></div><div class="ttdeci">~NewHopePoly()</div><div class="ttdoc">Clears sensitive data and destroys this &quot;poly&quot; object. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01064">NewHope.cpp:1064</a></div></div>
<div class="ttc" id="classNewHopePoly_html_ad7c3c83cb078be4e6f136eeea7e21250"><div class="ttname"><a href="classNewHopePoly.html#ad7c3c83cb078be4e6f136eeea7e21250">NewHopePoly::~NewHopePoly</a></div><div class="ttdeci">~NewHopePoly()</div><div class="ttdoc">Clears sensitive data and destroys this &quot;poly&quot; object. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l00992">NewHope.cpp:992</a></div></div>
<div class="ttc" id="classNewHope_html_a679601da301134f037c3a5786bd7085f"><div class="ttname"><a href="classNewHope.html#a679601da301134f037c3a5786bd7085f">NewHope::Variant</a></div><div class="ttdeci">Variant</div><div class="ttdoc">Describes the variant of the New Hope algorithm to implement. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8h_source.html#l00055">NewHope.h:55</a></div></div>
<div class="ttc" id="classNewHope_html"><div class="ttname"><a href="classNewHope.html">NewHope</a></div><div class="ttdoc">NewHope post-quantum key exchange algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8h_source.html#l00048">NewHope.h:48</a></div></div>
<div class="ttc" id="classNewHope_html_ae8f821867bce309220aee7a43c2d4f51"><div class="ttname"><a href="classNewHope.html#ae8f821867bce309220aee7a43c2d4f51">NewHope::keygen</a></div><div class="ttdeci">static void keygen(uint8_t send[NEWHOPE_SENDABYTES], NewHopePoly &amp;sk, Variant variant=Ref, const uint8_t *random_seed=0)</div><div class="ttdoc">Generates the key pair for Alice in a New Hope key exchange. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01111">NewHope.cpp:1111</a></div></div>
<div class="ttc" id="classNewHopePoly_html_a842db1796a45ba78f279e008210df304"><div class="ttname"><a href="classNewHopePoly.html#a842db1796a45ba78f279e008210df304">NewHopePoly::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears sensitive data in this &quot;poly&quot; object. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01072">NewHope.cpp:1072</a></div></div>
<div class="ttc" id="classNewHope_html_a2f09529f5f73cf9763c28b58b13bbd14"><div class="ttname"><a href="classNewHope.html#a2f09529f5f73cf9763c28b58b13bbd14">NewHope::sharedb</a></div><div class="ttdeci">static void sharedb(uint8_t shared_key[NEWHOPE_SHAREDBYTES], uint8_t send[NEWHOPE_SENDBBYTES], uint8_t received[NEWHOPE_SENDABYTES], Variant variant=Ref, const uint8_t *random_seed=0)</div><div class="ttdoc">Generates the public key and shared secret for Bob. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01170">NewHope.cpp:1170</a></div></div>
<div class="ttc" id="classNewHopePoly_html_aec9804046c753436ffbe88afd175bb39"><div class="ttname"><a href="classNewHopePoly.html#aec9804046c753436ffbe88afd175bb39">NewHopePoly::NewHopePoly</a></div><div class="ttdeci">NewHopePoly()</div><div class="ttdoc">Constructs a new &quot;poly&quot; object for the NewHope algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01057">NewHope.cpp:1057</a></div></div>
<div class="ttc" id="classNewHope_html_ae8f821867bce309220aee7a43c2d4f51"><div class="ttname"><a href="classNewHope.html#ae8f821867bce309220aee7a43c2d4f51">NewHope::keygen</a></div><div class="ttdeci">static void keygen(uint8_t send[NEWHOPE_SENDABYTES], NewHopePoly &amp;sk, Variant variant=Ref, const uint8_t *random_seed=0)</div><div class="ttdoc">Generates the key pair for Alice in a New Hope key exchange. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01039">NewHope.cpp:1039</a></div></div>
<div class="ttc" id="classNewHopePoly_html_a842db1796a45ba78f279e008210df304"><div class="ttname"><a href="classNewHopePoly.html#a842db1796a45ba78f279e008210df304">NewHopePoly::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears sensitive data in this &quot;poly&quot; object. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01000">NewHope.cpp:1000</a></div></div>
<div class="ttc" id="classNewHope_html_a2f09529f5f73cf9763c28b58b13bbd14"><div class="ttname"><a href="classNewHope.html#a2f09529f5f73cf9763c28b58b13bbd14">NewHope::sharedb</a></div><div class="ttdeci">static void sharedb(uint8_t shared_key[NEWHOPE_SHAREDBYTES], uint8_t send[NEWHOPE_SENDBBYTES], uint8_t received[NEWHOPE_SENDABYTES], Variant variant=Ref, const uint8_t *random_seed=0)</div><div class="ttdoc">Generates the public key and shared secret for Bob. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01098">NewHope.cpp:1098</a></div></div>
<div class="ttc" id="classNewHopePoly_html_aec9804046c753436ffbe88afd175bb39"><div class="ttname"><a href="classNewHopePoly.html#aec9804046c753436ffbe88afd175bb39">NewHopePoly::NewHopePoly</a></div><div class="ttdeci">NewHopePoly()</div><div class="ttdoc">Constructs a new &quot;poly&quot; object for the NewHope algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l00985">NewHope.cpp:985</a></div></div>
<div class="ttc" id="classNewHopePoly_html"><div class="ttname"><a href="classNewHopePoly.html">NewHopePoly</a></div><div class="ttdoc">NewHope polynomial representation. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8h_source.html#l00034">NewHope.h:34</a></div></div>
<div class="ttc" id="classNewHope_html_ae490ebcfcbc18179b03c1a1ae8874458"><div class="ttname"><a href="classNewHope.html#ae490ebcfcbc18179b03c1a1ae8874458">NewHope::shareda</a></div><div class="ttdeci">static void shareda(uint8_t shared_key[NEWHOPE_SHAREDBYTES], const NewHopePoly &amp;sk, uint8_t received[NEWHOPE_SENDBBYTES])</div><div class="ttdoc">Generates the shared secret for Alice. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01231">NewHope.cpp:1231</a></div></div>
<div class="ttc" id="classNewHope_html_ae490ebcfcbc18179b03c1a1ae8874458"><div class="ttname"><a href="classNewHope.html#ae490ebcfcbc18179b03c1a1ae8874458">NewHope::shareda</a></div><div class="ttdeci">static void shareda(uint8_t shared_key[NEWHOPE_SHAREDBYTES], const NewHopePoly &amp;sk, uint8_t received[NEWHOPE_SENDBBYTES])</div><div class="ttdoc">Generates the shared secret for Alice. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01159">NewHope.cpp:1159</a></div></div>
<div class="ttc" id="classNewHope_html_a679601da301134f037c3a5786bd7085fa2326f3fd76345d5900834593a74f6596"><div class="ttname"><a href="classNewHope.html#a679601da301134f037c3a5786bd7085fa2326f3fd76345d5900834593a74f6596">NewHope::Ref</a></div><div class="ttdoc">The standard &quot;reference&quot; version of the New Hope algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8h_source.html#l00057">NewHope.h:57</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Aug 18 2016 18:42:10 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Tue Aug 23 2016 18:54:05 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>