From: Simon Josefsson <simon@josefsson.org>
Date: Tue, 11 Oct 2005 17:41:16 +0000 (+0000)
Subject: * gc.h (gc_hash_buffer): Add doc.
X-Git-Tag: cvs-readonly~2830
X-Git-Url: http://erislabs.org.uk/gitweb/?a=commitdiff_plain;h=15ca72eba1ef4d940a05f6bcf92986b2cecad12e;p=gnulib.git

* gc.h (gc_hash_buffer): Add doc.
---

diff --git a/lib/ChangeLog b/lib/ChangeLog
index 9b0ed2c6a..ec98e7d55 100644
--- 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
index f9b66d1bf..9932770d8 100644
--- a/lib/gc.h
+++ b/lib/gc.h
@@ -63,6 +63,12 @@ extern void gc_set_allocators (gc_malloc_t func_malloc,
 			       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);