arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

pull/548/head
Jeffrey Walton 2017-11-28 04:37:37 -05:00
parent 8530b58edd
commit 5a8e4d1545
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
base32.h
View File

@ -13,8 +13,8 @@
NAMESPACE_BEGIN(CryptoPP) NAMESPACE_BEGIN(CryptoPP)
//! \class Base32Encoder //! \class Base32Encoder
//! \brief Base32 encodes data //! \brief Base32 encodes data using DUDE encoding
//! \details Converts data to base32. The default code is based on <A HREF="http://www.ietf.org/proceedings/51/I-D/draft-ietf-idn-dude-02.txt">Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt)</A>. //! \details Converts data to base32 using DUDE encoding. The default code is based on <A HREF="http://www.ietf.org/proceedings/51/I-D/draft-ietf-idn-dude-02.txt">Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt)</A>.
//! \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder //! \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder
class Base32Encoder : public SimpleProxyFilter class Base32Encoder : public SimpleProxyFilter
{ {
@ -58,8 +58,8 @@ public:
}; };
//! \class Base32Decoder //! \class Base32Decoder
//! \brief Base32 decodes data //! \brief Base32 decodes data using DUDE encoding
//! \details Decode base32 data. The default code is based on <A HREF="http://www.ietf.org/proceedings/51/I-D/draft-ietf-idn-dude-02.txt">Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt)</A>. //! \details Converts data from base32 using DUDE encoding. The default code is based on <A HREF="http://www.ietf.org/proceedings/51/I-D/draft-ietf-idn-dude-02.txt">Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt)</A>.
//! \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder //! \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder
class Base32Decoder : public BaseN_Decoder class Base32Decoder : public BaseN_Decoder
{ {
@ -131,8 +131,8 @@ public:
}; };
//! \class Base32HexDecoder //! \class Base32HexDecoder
//! \brief Base32 extended hex decodes data //! \brief Base32 decodes data using extended hex
//! \brief Base32 decodes data using extended hex alphabet. The alphabet is different than Base32Decoder. //! \details Converts data from base32 using extended hex alphabet. The alphabet is different than Base32Decoder.
//! \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder, <A HREF="http://tools.ietf.org/html/rfc4648#page-10">RFC 4648, Base 32 Encoding with Extended Hex Alphabet</A>. //! \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder, <A HREF="http://tools.ietf.org/html/rfc4648#page-10">RFC 4648, Base 32 Encoding with Extended Hex Alphabet</A>.
//! \since Crypto++ 6.0 //! \since Crypto++ 6.0
class Base32HexDecoder : public BaseN_Decoder class Base32HexDecoder : public BaseN_Decoder

3
cryptlib.h
View File

@ -60,11 +60,12 @@
<dt>Wrappers for OS features<dd> <dt>Wrappers for OS features<dd>
Timer, Socket, WindowsHandle, ThreadLocalStorage, ThreadUserTimer Timer, Socket, WindowsHandle, ThreadLocalStorage, ThreadUserTimer
</dl>
<!-- <!--
<dt>FIPS 140 validated cryptography<dd> <dt>FIPS 140 validated cryptography<dd>
fips140.h fips140.h
</dl>
In the DLL version of Crypto++, only the following implementation class are available. In the DLL version of Crypto++, only the following implementation class are available.
<dl> <dl>