From 3b5de1bf15f6930cececdc537cce9fff91ff4d9a Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Thu, 31 Jan 2019 19:53:34 -0500 Subject: [PATCH] Update documentation --- chachapoly.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/chachapoly.h b/chachapoly.h index 1b7fcde3..cb6d8fce 100644 --- a/chachapoly.h +++ b/chachapoly.h @@ -2,7 +2,7 @@ // RFC 8439, Section 2.8, AEAD Construction, http://tools.ietf.org/html/rfc8439 /// \file chachapoly.h -/// \brief ChaCha20/Poly1305-TLS AEAD cipher +/// \brief ChaCha20/Poly1305-TLS AEAD scheme /// \details ChaCha20Poly1305 is an authenticated encryption scheme that combines /// ChaCha20TLS and Poly1305TLS. The scheme is defined in RFC 8439, section 2.8, /// AEAD_CHACHA20_POLY1305 construction, and uses the IETF versions of ChaCha @@ -150,7 +150,7 @@ private: Poly1305TLS m_mac; }; -/// \brief ChaCha20Poly1305-TLS cipher mode of operation +/// \brief ChaCha20/Poly1305-TLS AEAD scheme /// \details ChaCha20Poly1305 is an authenticated encryption scheme that combines /// ChaCha20TLS and Poly1305TLS. The scheme is defined in RFC 8439, section 2.8, /// AEAD_CHACHA20_POLY1305 construction, and uses the IETF versions of ChaCha @@ -160,7 +160,9 @@ private: /// \since Crypto++ 8.1 struct ChaCha20Poly1305 : public AuthenticatedSymmetricCipherDocumentation { + /// \brief ChaCha20Poly1305 encryption typedef ChaCha20Poly1305_Final Encryption; + /// \brief ChaCha20Poly1305 decryption typedef ChaCha20Poly1305_Final Decryption; };