1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00

Update docs to remove non-crypto libraries

This commit is contained in:
Rhys Weatherley
2018-04-07 10:24:41 +10:00
parent f46b005926
commit cb89ac731d
857 changed files with 2776 additions and 60092 deletions

View File

@@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>ArduinoLibs: AESSmall256 Class Reference</title>
<title>Arduino Cryptography Library: AESSmall256 Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
@@ -22,7 +22,7 @@
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ArduinoLibs
<div id="projectname">Arduino Cryptography Library
</div>
</td>
</tr>
@@ -38,7 +38,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
@@ -72,7 +71,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
@@ -149,7 +148,7 @@ Public Member Functions</h2></td></tr>
<p>The companion <a class="el" href="classAESTiny256.html" title="AES block cipher with 256-bit keys and tiny memory usage. ">AESTiny256</a> class uses even less RAM but only supports the <a class="el" href="classAESTiny256.html#a36e4ffc85f7d7604d01a5629c185d0ef" title="Encrypts a single block using this cipher. ">encryptBlock()</a> operation. Block cipher modes like <a class="el" href="classCTR.html" title="Implementation of the Counter (CTR) mode for 128-bit block ciphers. ">CTR</a>, <a class="el" href="classEAX.html" title="Implementation of the EAX authenticated cipher. ">EAX</a>, and <a class="el" href="classGCM.html" title="Implementation of the Galois Counter Mode (GCM). ">GCM</a> do not need the <a class="el" href="classAESSmall256.html#aaba6d59d07d2f40efa8c962375c15888" title="Decrypts a single block using this cipher. ">decryptBlock()</a> operation, so <a class="el" href="classAESTiny256.html" title="AES block cipher with 256-bit keys and tiny memory usage. ">AESTiny256</a> may be a better option than <a class="el" href="classAESSmall256.html" title="AES block cipher with 256-bit keys and reduced memory usage. ">AESSmall256</a> for many applications.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAESTiny256.html" title="AES block cipher with 256-bit keys and tiny memory usage. ">AESTiny256</a>, <a class="el" href="classAES256.html" title="AES block cipher with 256-bit keys. ">AES256</a> </dd></dl>
<p>Definition at line <a class="el" href="AES_8h_source.html#l00128">128</a> of file <a class="el" href="AES_8h_source.html">AES.h</a>.</p>
<p>Definition at line <a class="el" href="AES_8h_source.html#l00137">137</a> of file <a class="el" href="AES_8h_source.html">AES.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa343b59af73ad6c86541907f53f5572b"></a>
<div class="memitem">
@@ -167,7 +166,7 @@ Public Member Functions</h2></td></tr>
<p>Constructs an AES 256-bit block cipher with no initial key. </p>
<p>This constructor must be followed by a call to <a class="el" href="classAESSmall256.html#ae7e05119a6183d5f7fc520206f97c0e0" title="Sets the key to use for future encryption and decryption operations. ">setKey()</a> before the block cipher can be used for encryption or decryption. </p>
<p>Definition at line <a class="el" href="AES256_8cpp_source.html#l00306">306</a> of file <a class="el" href="AES256_8cpp_source.html">AES256.cpp</a>.</p>
<p>Definition at line <a class="el" href="AES256_8cpp_source.html#l00308">308</a> of file <a class="el" href="AES256_8cpp_source.html">AES256.cpp</a>.</p>
</div>
</div>
@@ -199,7 +198,7 @@ Public Member Functions</h2></td></tr>
<p>Reimplemented from <a class="el" href="classAESTiny256.html#ae4cac6af2e78cbf399b7f6d0e613a578">AESTiny256</a>.</p>
<p>Definition at line <a class="el" href="AES256_8cpp_source.html#l00393">393</a> of file <a class="el" href="AES256_8cpp_source.html">AES256.cpp</a>.</p>
<p>Definition at line <a class="el" href="AES256_8cpp_source.html#l00395">395</a> of file <a class="el" href="AES256_8cpp_source.html">AES256.cpp</a>.</p>
</div>
</div>
@@ -247,7 +246,7 @@ Public Member Functions</h2></td></tr>
<p>Reimplemented from <a class="el" href="classAESTiny256.html#abdf72a52c37c060a9089693c118585bc">AESTiny256</a>.</p>
<p>Definition at line <a class="el" href="AES256_8cpp_source.html#l00349">349</a> of file <a class="el" href="AES256_8cpp_source.html">AES256.cpp</a>.</p>
<p>Definition at line <a class="el" href="AES256_8cpp_source.html#l00351">351</a> of file <a class="el" href="AES256_8cpp_source.html">AES256.cpp</a>.</p>
</div>
</div>
@@ -297,7 +296,7 @@ Public Member Functions</h2></td></tr>
<p>Reimplemented from <a class="el" href="classAESTiny256.html#abc162075b181bfca34144f4eec6deec7">AESTiny256</a>.</p>
<p>Definition at line <a class="el" href="AES256_8cpp_source.html#l00315">315</a> of file <a class="el" href="AES256_8cpp_source.html">AES256.cpp</a>.</p>
<p>Definition at line <a class="el" href="AES256_8cpp_source.html#l00317">317</a> of file <a class="el" href="AES256_8cpp_source.html">AES256.cpp</a>.</p>
</div>
</div>
@@ -308,7 +307,7 @@ Public Member Functions</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Apr 7 2018 02:43:14 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sat Apr 7 2018 10:23:43 for Arduino Cryptography Library by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>