# HG changeset patch
# User kostya
# Date 1247123221 0
# Node ID 860d74503de2c4312fa08c3e835c02256d747014
# Parent  3b90ae5577ad17d295d199f9a7d2598dbd4d4468
Document SHA-1 functions and structures

diff -r 3b90ae5577ad -r 860d74503de2 sha1.c
--- a/sha1.c	Thu Jul 09 02:20:29 2009 +0000
+++ b/sha1.c	Thu Jul 09 07:07:01 2009 +0000
@@ -23,10 +23,11 @@
 #include "bswap.h"
 #include "sha1.h"
 
+/** hash context */
 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);
diff -r 3b90ae5577ad -r 860d74503de2 sha1.h
--- a/sha1.h	Thu Jul 09 02:20:29 2009 +0000
+++ b/sha1.h	Thu Jul 09 07:07:01 2009 +0000
@@ -27,8 +27,28 @@
 
 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 */