From 4364fc9a0d630183dbb4c676062d4369181131f1 Mon Sep 17 00:00:00 2001 From: Kostya Shishkov Date: Thu, 9 Jul 2009 07:07:01 +0000 Subject: Document SHA-1 functions and structures Originally committed as revision 19385 to svn://svn.ffmpeg.org/ffmpeg/trunk --- libavutil/sha1.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'libavutil/sha1.h') diff --git a/libavutil/sha1.h b/libavutil/sha1.h index 0f14ca8960..b9a43cdd39 100644 --- a/libavutil/sha1.h +++ b/libavutil/sha1.h @@ -27,8 +27,28 @@ extern const int av_sha1_size; struct AVSHA1; +/** + * Initializes SHA-1 hashing. + * + * @param context pointer to the function context (of size av_sha_size) + */ void av_sha1_init(struct AVSHA1* context); + +/** + * Updates hash value. + * + * @param context hash function context + * @param data input data to update hash with + * @param len input data length + */ void av_sha1_update(struct AVSHA1* context, const uint8_t* data, unsigned int len); + +/** + * Finishes hashing and output digest value. + * + * @param context hash function context + * @param digest buffer where output digest value is stored + */ void av_sha1_final(struct AVSHA1* context, uint8_t digest[20]); #endif /* AVUTIL_SHA1_H */ -- cgit v1.2.3