diff options
| author | Jeffrey Walton <noloader@gmail.com> | 2019-01-28 22:42:34 -0500 |
|---|---|---|
| committer | Jeffrey Walton <noloader@gmail.com> | 2019-01-28 22:42:34 -0500 |
| commit | a4f6da8d304401c209a0e2ea89ef5377707d0b22 (patch) | |
| tree | 52e3ac6c322f3d8a02e25e5744f676a52dcaca2d /chachapoly.h | |
| parent | 281831c08a4af049f1de649d6561f4213b050c0a (diff) | |
| download | cryptopp-git-a4f6da8d304401c209a0e2ea89ef5377707d0b22.tar.gz | |
Update documentation
Diffstat (limited to 'chachapoly.h')
| -rw-r--r-- | chachapoly.h | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/chachapoly.h b/chachapoly.h index 0c03e392..fc3f4481 100644 --- a/chachapoly.h +++ b/chachapoly.h @@ -3,12 +3,13 @@ /// \file chachapoly.h
/// \brief ChaCha20/Poly1305-TLS AEAD cipher
-/// \details ChaCha20Poly1305 is an authenticated encryption cipher that combines
-/// ChaCha20TLS and Poly1305TLS. The cipher uses the IETF versions of ChaCha and
-/// Poly1305 because it is defined in RFC 8439, section 2.8, AEAD_CHACHA20_POLY1305
-/// construction.
+/// \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
+/// and Poly1305.
/// \sa <A HREF="http://tools.ietf.org/html/rfc8439">RFC 8439, ChaCha20 and Poly1305
/// for IETF Protocols</A>.
+/// \since Crypto++ 8.1
#ifndef CRYPTOPP_CHACHA_POLY1305_H
#define CRYPTOPP_CHACHA_POLY1305_H
@@ -119,10 +120,10 @@ protected: };
/// \brief ChaCha20Poly1305 cipher final implementation
-/// \details ChaCha20Poly1305 is an authenticated encryption cipher that combines
-/// ChaCha20TLS and Poly1305TLS. The cipher uses the IETF versions of ChaCha and
-/// Poly1305 because it is defined in RFC 8439, section 2.8, AEAD_CHACHA20_POLY1305
-/// construction.
+/// \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
+/// and Poly1305.
/// \sa <A HREF="http://tools.ietf.org/html/rfc8439">RFC 8439, ChaCha20 and Poly1305
/// for IETF Protocols</A>.
/// \since Crypto++ 8.1
@@ -151,10 +152,10 @@ private: };
/// \brief ChaCha20Poly1305-TLS cipher mode of operation
-/// \details ChaCha20Poly1305 is an authenticated encryption cipher that combines
-/// ChaCha20TLS and Poly1305TLS. The cipher uses the IETF versions of ChaCha and
-/// Poly1305 because it is defined in RFC 8439, section 2.8, AEAD_CHACHA20_POLY1305
-/// construction.
+/// \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
+/// and Poly1305.
/// \sa <A HREF="http://tools.ietf.org/html/rfc8439">RFC 8439, ChaCha20 and Poly1305
/// for IETF Protocols</A>.
/// \since Crypto++ 8.1
|