Updated documentation

1 files changed, 13 insertions, 3 deletions

diff --git a/hex.h b/hex.h
index 1acc0903..2668b62c 100644
--- a/hex.h
+++ b/hex.h
@@ -1,6 +1,6 @@
 // hex.h - written and placed in the public domain by Wei Dai

 

-//! \file

+//! \file hex.h

 //! \brief Classes for HexEncoder and HexDecoder

 

 #ifndef CRYPTOPP_HEX_H

@@ -11,10 +11,17 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! Converts given data to base 16

+//! \class HexEncoder

+//! \brief Converts given data to base 16

 class CRYPTOPP_DLL HexEncoder : public SimpleProxyFilter

 {

 public:

+	//! \brief Construct a HexEncoder

+	//! \param attachment a BufferedTrasformation to attach to this object

+	//! \param uppercase a flag indicating uppercase output

+	//! \param groupSize the size of the grouping

+	//! \param separator the separator to use between groups

+	//! \param terminator the terminator append after processing

 	HexEncoder(BufferedTransformation *attachment = NULL, bool uppercase = true, int outputGroupSize = 0, const std::string &separator = ":", const std::string &terminator = "")

 		: SimpleProxyFilter(new BaseN_Encoder(new Grouper), attachment)

 	{

@@ -24,10 +31,13 @@ public:
 	void IsolatedInitialize(const NameValuePairs &parameters);

 };

 

-//! Decode base 16 data back to bytes

+//! \class HexDecoder

+//! \brief Decode base 16 data back to bytes

 class CRYPTOPP_DLL HexDecoder : public BaseN_Decoder

 {

 public:

+	//! \brief Construct a HexDecoder

+	//! \param attachment a BufferedTrasformation to attach to this object

 	HexDecoder(BufferedTransformation *attachment = NULL)

 		: BaseN_Decoder(GetDefaultDecodingLookupArray(), 4, attachment) {}