Updated documentation

1 files changed, 9 insertions, 2 deletions

diff --git a/authenc.h b/authenc.h
index a41dcd21..a40a538c 100644
--- a/authenc.h
+++ b/authenc.h
@@ -13,7 +13,7 @@
 NAMESPACE_BEGIN(CryptoPP)

 

 //! \class AuthenticatedSymmetricCipherBase

-//! \brief 

+//! \brief Base implementation for one direction (encryption or decryption) of a stream cipher or block cipher mode with authentication

 class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE AuthenticatedSymmetricCipherBase : public AuthenticatedSymmetricCipher

 {

 public:

@@ -22,7 +22,14 @@ public:
 

 	bool IsRandomAccess() const {return false;}

 	bool IsSelfInverting() const {return true;}

-	void UncheckedSetKey(const byte *,unsigned int,const CryptoPP::NameValuePairs &) {assert(false);}

+

+	//! \brief Sets the key for this object without performing parameter validation

+	//! \param key a byte buffer used to key the cipher

+	//! \param length the length of the byte buffer

+	//! \param params additional parameters passed as  NameValuePairs

+	//! \details key must be at least DEFAULT_KEYLENGTH in length.

+	void UncheckedSetKey(const byte * key, unsigned int length,const CryptoPP::NameValuePairs &params)

+		{CRYPTOPP_UNUSED(key), CRYPTOPP_UNUSED(length), CRYPTOPP_UNUSED(params); assert(false);}

 

 	void SetKey(const byte *userKey, size_t keylength, const NameValuePairs &params);

 	void Restart() {if (m_state > State_KeySet) m_state = State_KeySet;}