# HG changeset patch
# User Simon Josefsson <simon@josefsson.org>
# Date 1129052476 0
# Node ID 998625a579ed5e887b439d77432a8ccd1dcbac38
# Parent  bbcddcd96f1f266ccd4d34d83674423546c69ac3
* gc.h (gc_hash_buffer): Add doc.

diff --git a/lib/ChangeLog b/lib/ChangeLog
--- a/lib/ChangeLog
+++ b/lib/ChangeLog
@@ -1,3 +1,7 @@
+2005-10-11  Simon Josefsson  <jas@extundo.com>
+
+	* gc.h (gc_hash_buffer): Add doc.
+
 2005-10-11  Bruno Haible  <bruno@clisp.org>
 
 	* strcasecmp.c: Include limits.h.
diff --git a/lib/gc.h b/lib/gc.h
--- a/lib/gc.h
+++ b/lib/gc.h
@@ -63,6 +63,12 @@
 			       gc_free_t func_free);
 
 /* Hashes. */
+
+/* Compute a hash value over buffer IN of INLEN bytes size using the
+   algorithm HASH, placing the result in the pre-allocated buffer OUT.
+   The required size of OUT depends on HASH, and is generally
+   GC_<HASH>_DIGEST_SIZE.  For example, for GC_MD5 the output buffer
+   must be 16 bytes. */
 extern int
 gc_hash_buffer (int hash, const void *in, size_t inlen, char *out);