Added memcached_generate_hash() and more tests! :)

[awesomized/libmemcached] / docs / memcached_generate_hash_value.pod

diff --git a/docs/memcached_generate_hash_value.pod b/docs/memcached_generate_hash_value.pod
index 8f2c78de40deee1120500c6b05b5c14b530b104d..dd45ab3ea22b41458d4bdf1996fc821c100367f9 100644 (file)
--- a/docs/memcached_generate_hash_value.pod
+++ b/docs/memcached_generate_hash_value.pod
@@ -15,6 +15,11 @@ C Client Library for memcached (libmemcached, -lmemcached)
                                    size_t key_length,
                                    memcached_hash hash_algorithm);
 
+  uint32_t 
+    memcached_generate_hash (memcached_st *ptr,
+                             const char *key, 
+                             size_t key_length);
+
 =head1 DESCRIPTION
 
 memcached_generate_hash_value() allows you to hash a key using one of
@@ -25,6 +30,10 @@ for normal memcache operations.
 The allowed hash algorithm constants are listed in the manpage for
 memcached_behavior_set().
 
+memcached_generate_hash() takes a memcached_st struture and produces
+the hash value that would have been generated based on the defaults
+of the memcached_st structure.
+
 =head1 RETURN
 
 A 32-bit integer which is the result of hashing the given key.