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-06 09:30:30 +10:00
parent 772ecf46e8
commit 52795520e2
338 changed files with 2163 additions and 1234 deletions

View File

@@ -110,10 +110,10 @@ Static Public Member Functions</h2></td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Diffie-Hellman key agreement based on the elliptic curve modulo 2^255 - 19. </p>
<dl class="section note"><dt>Note</dt><dd>This public functions in this class need a substantial amount of stack space to store intermediate results while the curve function is being evaluated. About 1k of free stack space is recommended for safety.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The public functions in this class need a substantial amount of stack space to store intermediate results while the curve function is being evaluated. About 1k of free stack space is recommended for safety.</dd></dl>
<p>References: <a href="http://cr.yp.to/ecdh.html">http://cr.yp.to/ecdh.html</a> <a href="https://tools.ietf.org/html/draft-irtf-cfrg-curves-02">https://tools.ietf.org/html/draft-irtf-cfrg-curves-02</a> </p>
<p>Definition at line <a class="el" href="Curve25519_8h_source.html#l00029">29</a> of file <a class="el" href="Curve25519_8h_source.html">Curve25519.h</a>.</p>
<p>Definition at line <a class="el" href="Curve25519_8h_source.html#l00028">28</a> of file <a class="el" href="Curve25519_8h_source.html">Curve25519.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2b6911583d17ea9a36bbbb40d58b3d89"></a>
<div class="memitem">
@@ -180,7 +180,7 @@ Static Public Member Functions</h2></td></tr>
</div><!-- fragment --><p>Reference: <a href="https://tools.ietf.org/html/draft-irtf-cfrg-curves-02">https://tools.ietf.org/html/draft-irtf-cfrg-curves-02</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classCurve25519.html#a14022d6ac68ec691ffb0247275078ab9" title="Performs phase 2 of a Diffie-Hellman key exchange using Curve25519. ">dh2()</a> </dd></dl>
<p>Definition at line <a class="el" href="Curve25519_8cpp_source.html#l00231">231</a> of file <a class="el" href="Curve25519_8cpp_source.html">Curve25519.cpp</a>.</p>
<p>Definition at line <a class="el" href="Curve25519_8cpp_source.html#l00244">244</a> of file <a class="el" href="Curve25519_8cpp_source.html">Curve25519.cpp</a>.</p>
</div>
</div>
@@ -228,7 +228,7 @@ Static Public Member Functions</h2></td></tr>
<p>Reference: <a href="https://tools.ietf.org/html/draft-irtf-cfrg-curves-02">https://tools.ietf.org/html/draft-irtf-cfrg-curves-02</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classCurve25519.html#a2b6911583d17ea9a36bbbb40d58b3d89" title="Performs phase 1 of a Diffie-Hellman key exchange using Curve25519. ">dh1()</a> </dd></dl>
<p>Definition at line <a class="el" href="Curve25519_8cpp_source.html#l00269">269</a> of file <a class="el" href="Curve25519_8cpp_source.html">Curve25519.cpp</a>.</p>
<p>Definition at line <a class="el" href="Curve25519_8cpp_source.html#l00282">282</a> of file <a class="el" href="Curve25519_8cpp_source.html">Curve25519.cpp</a>.</p>
</div>
</div>
@@ -284,7 +284,7 @@ Static Public Member Functions</h2></td></tr>
<p>Reference: <a href="https://tools.ietf.org/html/draft-irtf-cfrg-curves-02">https://tools.ietf.org/html/draft-irtf-cfrg-curves-02</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classCurve25519.html#a2b6911583d17ea9a36bbbb40d58b3d89" title="Performs phase 1 of a Diffie-Hellman key exchange using Curve25519. ">dh1()</a>, <a class="el" href="classCurve25519.html#a14022d6ac68ec691ffb0247275078ab9" title="Performs phase 2 of a Diffie-Hellman key exchange using Curve25519. ">dh2()</a> </dd></dl>
<p>Definition at line <a class="el" href="Curve25519_8cpp_source.html#l00068">68</a> of file <a class="el" href="Curve25519_8cpp_source.html">Curve25519.cpp</a>.</p>
<p>Definition at line <a class="el" href="Curve25519_8cpp_source.html#l00079">79</a> of file <a class="el" href="Curve25519_8cpp_source.html">Curve25519.cpp</a>.</p>
</div>
</div>
@@ -295,7 +295,7 @@ Static Public Member Functions</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Apr 2 2015 16:36:51 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Apr 6 2015 09:30:16 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>