summaryrefslogtreecommitdiff
path: root/aes.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2017-08-16 05:42:58 -0400
committerJeffrey Walton <noloader@gmail.com>2017-08-16 05:42:58 -0400
commitb311aabc313c12d3b66c3468338453ed7fdfc0a9 (patch)
treef2f686c1cd30b6e1a8803b1a655c7213cb3beaf5 /aes.h
parente19fad007fde3bc744c9c7b1ebdbd7d49ae6a185 (diff)
downloadcryptopp-git-b311aabc313c12d3b66c3468338453ed7fdfc0a9.tar.gz
Update documentation
Diffstat (limited to 'aes.h')
-rw-r--r--aes.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/aes.h b/aes.h
index e95d2102..2921ae90 100644
--- a/aes.h
+++ b/aes.h
@@ -2,6 +2,9 @@
//! \file
//! \brief Class file for the AES cipher (Rijndael)
+//! \details AES is a typdef for Rijndael classes. All key sizes are supported.
+//! The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks
+//! \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0
#ifndef CRYPTOPP_AES_H
#define CRYPTOPP_AES_H
@@ -12,7 +15,10 @@ NAMESPACE_BEGIN(CryptoPP)
//! \class AES
//! \brief AES block cipher (Rijndael)
+//! \details AES is a typdef for Rijndael classes. All key sizes are supported.
+//! The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks
//! \sa <a href="http://www.cryptolounge.org/wiki/AES">AES</a> winner, announced on 10/2/2000
+//! \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0
DOCUMENTED_TYPEDEF(Rijndael, AES);
typedef RijndaelEncryption AESEncryption;