diff options
author | Jeffrey Walton <noloader@gmail.com> | 2017-11-21 15:29:41 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2017-11-21 15:29:41 -0500 |
commit | 3f7eb03eaf2971aa6ac43a417181065165bc7544 (patch) | |
tree | 7b2380d61b5e3c8c53479c487f41cba911747773 /speck.h | |
parent | 6b7a7b1ca6435bb3d9b27fd1ea46bd0cad9103c4 (diff) | |
download | cryptopp-git-3f7eb03eaf2971aa6ac43a417181065165bc7544.tar.gz |
Update documentation
Diffstat (limited to 'speck.h')
-rw-r--r-- | speck.h | 14 |
1 files changed, 12 insertions, 2 deletions
@@ -55,8 +55,13 @@ struct SPECK_Base //! \class SPECK64
//! \brief SPECK 64-bit block cipher
+//! \details Speck is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith,
+//! Stefan Treatman-Clark, Bryan Weeks and Louis Wingers.
//! \details SPECK64 provides 64-bit block size. The valid key sizes are 96-bit and 128-bit.
-//! \sa SPECK64, SPECK128, <a href="http://www.cryptopp.com/wiki/SPECK">SPECK</a>
+//! \sa SPECK64, SPECK128, <A HREF="http://eprint.iacr.org/2013/404">The SIMON and SPECK
+//! Families of Lightweight Block Ciphers</A>, <A HREF="http://iadgov.github.io/simon-speck/">
+//! The Simon and Speck GitHub</A>, <a href="http://www.cryptopp.com/wiki/SPECK">SPECK</a> on the
+//! Crypto++ wiki
//! \since Crypto++ 6.0
class CRYPTOPP_NO_VTABLE SPECK64 : public SPECK_Info<8, 12, 12, 16>, public BlockCipherDocumentation
{
@@ -102,8 +107,13 @@ public: //! \class SPECK128
//! \brief SPECK 128-bit block cipher
+//! \details Speck is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith,
+//! Stefan Treatman-Clark, Bryan Weeks and Louis Wingers.
//! \details SPECK128 provides 128-bit block size. The valid key sizes are 128-bit, 192-bit and 256-bit.
-//! \sa SPECK64, SPECK128, <a href="http://www.cryptopp.com/wiki/SPECK">SPECK</a>
+//! \sa SPECK64, SPECK128, <A HREF="http://eprint.iacr.org/2013/404">The SIMON and SPECK
+//! Families of Lightweight Block Ciphers</A>, <A HREF="http://iadgov.github.io/simon-speck/">
+//! The Simon and Speck GitHub</A>, <a href="http://www.cryptopp.com/wiki/SPECK">SPECK</a> on the
+//! Crypto++ wiki
//! \since Crypto++ 6.0
class CRYPTOPP_NO_VTABLE SPECK128 : public SPECK_Info<16, 16, 16, 32>, public BlockCipherDocumentation
{
|