Update documentation

1 files changed, 11 insertions, 1 deletions

diff --git a/tiger.h b/tiger.h
index a9f92e18..580d6ed6 100644
--- a/tiger.h
+++ b/tiger.h
@@ -38,9 +38,19 @@ public:
 	CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "Tiger";}

 	std::string AlgorithmProvider() const;

 

+	/// \brief Initialize state array

+	/// \param state the state of the hash

 	static void InitState(HashWordType *state);

+	/// \brief Operate the hash

+	/// \param digest the state of the hash

+	/// \param data the data to be digested

 	static void Transform(word64 *digest, const word64 *data);

-	void TruncatedFinal(byte *hash, size_t size);

+	/// \brief Computes the hash of the current message

+	/// \param digest a pointer to the buffer to receive the hash

+	/// \param digestSize the size of the truncated digest, in bytes

+	/// \details TruncatedFinal() call Final() and then copies digestSize bytes to digest.

+	///   The hash is restarted the hash for the next message.

+	void TruncatedFinal(byte *digest, size_t digestSize);

 

 protected:

 	static const word64 table[4*256+3];