Document SHA-1 functions and structures
authorKostya Shishkov <kostya.shishkov@gmail.com>
Thu, 9 Jul 2009 07:07:01 +0000 (07:07 +0000)
committerKostya Shishkov <kostya.shishkov@gmail.com>
Thu, 9 Jul 2009 07:07:01 +0000 (07:07 +0000)
Originally committed as revision 19385 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavutil/sha1.c
libavutil/sha1.h

index f3e45de..fbff52a 100644 (file)
 #include "bswap.h"
 #include "sha1.h"
 
 #include "bswap.h"
 #include "sha1.h"
 
+/** hash context */
 typedef struct AVSHA1 {
 typedef struct AVSHA1 {
-    uint64_t count;
-    uint8_t buffer[64];
-    uint32_t state[5];
+    uint64_t count;       ///< number of bytes in buffer
+    uint8_t buffer[64];   ///< 512-bit buffer of input values used in hash updating
+    uint32_t state[5];    ///< current hash value
 } AVSHA1;
 
 const int av_sha1_size = sizeof(AVSHA1);
 } AVSHA1;
 
 const int av_sha1_size = sizeof(AVSHA1);
index 0f14ca8..b9a43cd 100644 (file)
@@ -27,8 +27,28 @@ extern const int av_sha1_size;
 
 struct AVSHA1;
 
 
 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);
 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);
 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 */
 void av_sha1_final(struct AVSHA1* context, uint8_t digest[20]);
 
 #endif /* AVUTIL_SHA1_H */