From b311aabc313c12d3b66c3468338453ed7fdfc0a9 Mon Sep 17 00:00:00 2001
From: Jeffrey Walton <noloader@gmail.com>
Date: Wed, 16 Aug 2017 05:42:58 -0400
Subject: [PATCH] Update documentation

---
 aes.h      | 6 ++++++
 rijndael.h | 2 +-
 shacal2.h  | 8 ++++++++
 3 files changed, 15 insertions(+), 1 deletion(-)

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;
diff --git a/rijndael.h b/rijndael.h
index 0a17ad84..d8cba04e 100644
--- a/rijndael.h
+++ b/rijndael.h
@@ -29,7 +29,7 @@ struct Rijndael_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 1
 //! \sa <a href="http://www.weidai.com/scan-mirror/cs.html#Rijndael">Rijndael</a>
 class CRYPTOPP_DLL Rijndael : public Rijndael_Info, public BlockCipherDocumentation
 {
-	//! \brief Rijndael block cipher data processing functionss
+	//! \brief Rijndael block cipher data processing functions
 	//! \details Provides implementation common to encryption and decryption
 	class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<Rijndael_Info>
 	{
diff --git a/shacal2.h b/shacal2.h
index 2a92cb6d..79c35c53 100644
--- a/shacal2.h
+++ b/shacal2.h
@@ -2,6 +2,7 @@
 
 //! \file shacal2.h
 //! \brief Classes for the SHACAL-2 block cipher
+//! \since Crypto++ 5.2, Intel SHA since Crypto++ 6.0
 
 #ifndef CRYPTOPP_SHACAL2_H
 #define CRYPTOPP_SHACAL2_H
@@ -20,9 +21,12 @@ struct SHACAL2_Info : public FixedBlockSize<32>, public VariableKeyLength<16, 16
 
 //! \class SHACAL2
 //! \brief SHACAL2 block cipher
+//! \since Crypto++ 5.2, Intel SHA since Crypto++ 6.0
 //! \sa <a href="http://www.weidai.com/scan-mirror/cs.html#SHACAL-2">SHACAL-2</a>
 class SHACAL2 : public SHACAL2_Info, public BlockCipherDocumentation
 {
+	//! \brief SHACAL2 block cipher data processing functions
+	//! \details Provides implementation common to encryption and decryption
 	class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<SHACAL2_Info>
 	{
 	public:
@@ -34,12 +38,16 @@ class SHACAL2 : public SHACAL2_Info, public BlockCipherDocumentation
 		static const word32 K[64];
 	};
 
+	//! \brief SHACAL2 block cipher data processing functions
+	//! \details Provides implementation for encryption transformation
 	class CRYPTOPP_NO_VTABLE Enc : public Base
 	{
 	public:
 		void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
 	};
 
+	//! \brief SHACAL2 block cipher data processing functions
+	//! \details Provides implementation for decryption transformation
 	class CRYPTOPP_NO_VTABLE Dec : public Base
 	{
 	public: