From 5a8e4d1545c0b21dcad9a8ff6fcc23e6904f94f5 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Tue, 28 Nov 2017 04:37:37 -0500 Subject: [PATCH] Update documentation --- base32.h | 12 ++++++------ cryptlib.h | 3 ++- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/base32.h b/base32.h index 61ce3e85..7818a220 100644 --- a/base32.h +++ b/base32.h @@ -13,8 +13,8 @@ NAMESPACE_BEGIN(CryptoPP) //! \class Base32Encoder -//! \brief Base32 encodes data -//! \details Converts data to base32. The default code is based on Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt). +//! \brief Base32 encodes data using DUDE encoding +//! \details Converts data to base32 using DUDE encoding. The default code is based on Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt). //! \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder class Base32Encoder : public SimpleProxyFilter { @@ -58,8 +58,8 @@ public: }; //! \class Base32Decoder -//! \brief Base32 decodes data -//! \details Decode base32 data. The default code is based on Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt). +//! \brief Base32 decodes data using DUDE encoding +//! \details Converts data from base32 using DUDE encoding. The default code is based on Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt). //! \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder class Base32Decoder : public BaseN_Decoder { @@ -131,8 +131,8 @@ public: }; //! \class Base32HexDecoder -//! \brief Base32 extended hex decodes data -//! \brief Base32 decodes data using extended hex alphabet. The alphabet is different than Base32Decoder. +//! \brief Base32 decodes data using extended hex +//! \details Converts data from base32 using extended hex alphabet. The alphabet is different than Base32Decoder. //! \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder, RFC 4648, Base 32 Encoding with Extended Hex Alphabet. //! \since Crypto++ 6.0 class Base32HexDecoder : public BaseN_Decoder diff --git a/cryptlib.h b/cryptlib.h index a954b7c6..644f4790 100644 --- a/cryptlib.h +++ b/cryptlib.h @@ -60,11 +60,12 @@
Wrappers for OS features
Timer, Socket, WindowsHandle, ThreadLocalStorage, ThreadUserTimer + +