Update documentation

1 files changed, 20 insertions, 0 deletions

diff --git a/pubkey.h b/pubkey.h
index 27885b56..ea5534f4 100644
--- a/pubkey.h
+++ b/pubkey.h
@@ -718,7 +718,19 @@ CRYPTOPP_DLL void CRYPTOPP_API P1363_MGF1KDF2_Common(HashTransformation &hash, b
 class P1363_MGF1 : public MaskGeneratingFunction

 {

 public:

+	/// \brief The algorithm name

+	/// \returns the algorithm name

+	/// \details StaticAlgorithmName returns the algorithm's name as a static

+	///   member function.

 	CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "MGF1";}

+

+	/// \brief P1363 mask generation function

+	/// \param hash HashTransformation derived class

+	/// \param output the destination byte array

+	/// \param outputLength the size fo the the destination byte array

+	/// \param input the message to hash

+	/// \param inputLength the size of the message

+	/// \param mask flag indicating whether to apply the mask

 	void GenerateAndMask(HashTransformation &hash, byte *output, size_t outputLength, const byte *input, size_t inputLength, bool mask = true) const

 	{

 		P1363_MGF1KDF2_Common(hash, output, outputLength, input, inputLength, NULLPTR, 0, mask, 0);

@@ -737,6 +749,14 @@ template <class H>
 class P1363_KDF2

 {

 public:

+	/// \brief P1363 key derivation function

+	/// \param output the destination byte array

+	/// \param outputLength the size fo the the destination byte array

+	/// \param input the message to hash

+	/// \param inputLength the size of the message

+	/// \param derivationParams additional derivation parameters

+	/// \param derivationParamsLength the size of the additional derivation parameters

+	/// \details DeriveKey calls P1363_MGF1KDF2_Common

 	static void CRYPTOPP_API DeriveKey(byte *output, size_t outputLength, const byte *input, size_t inputLength, const byte *derivationParams, size_t derivationParamsLength)

 	{

 		H h;