Add support for murmur3

[awesomized/libmemcached] / docs / memcached_generate_hash_value.rst

diff --git a/docs/memcached_generate_hash_value.rst b/docs/memcached_generate_hash_value.rst
index eb213c9b3a92bbffef39d4676f4014cd015a1941..9a9b5a6706316cac661d05824ddca2d7922dccdc 100644 (file)
--- a/docs/memcached_generate_hash_value.rst
+++ b/docs/memcached_generate_hash_value.rst
@@ -2,38 +2,48 @@
 Generating hash values directly
 ===============================
 
+.. index:: object: memcached_st
 
 Hash a key value
 
 
--------
-LIBRARY
--------
+-------- 
+SYNOPSIS 
+--------
 
 
-C Client Library for memcached (libmemcached, -lmemcached)
+#include <libmemcached/memcached.h>
 
+.. c:type:: memcached_hash_t
+ 
+.. c:function:: uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm)
 
---------
-SYNOPSIS
---------
+.. c:function:: uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length)
 
+.. c:type:: MEMCACHED_HASH_DEFAULT
 
+.. c:type:: MEMCACHED_HASH_MD5
 
-.. code-block:: perl
+.. c:type:: MEMCACHED_HASH_CRC
+
+.. c:type:: MEMCACHED_HASH_FNV1_64
+
+.. c:type:: MEMCACHED_HASH_FNV1A_64
+
+.. c:type:: MEMCACHED_HASH_FNV1_32
+
+.. c:type:: MEMCACHED_HASH_FNV1A_32
+
+.. c:type:: MEMCACHED_HASH_JENKINS
+
+.. c:type:: MEMCACHED_HASH_MURMUR
+
+.. c:type:: MEMCACHED_HASH_HSIEH
+
+.. c:type:: MEMCACHED_HASH_MURMUR3
 
-   #include <libmemcached/memcached.h>
- 
-   uint32_t
-     memcached_generate_hash_value (const char *key,
-                                    size_t key_length,
-                                    memcached_hash_t hash_algorithm);
- 
-   uint32_t 
-     memcached_generate_hash (memcached_st *ptr,
-                              const char *key, 
-                              size_t key_length);
 
+Compile and link with -lmemcachedutil -lmemcached
 
 
 -----------
@@ -41,17 +51,17 @@ DESCRIPTION
 -----------
 
 
-memcached_generate_hash_value() allows you to hash a key using one of
+:c:func:`memcached_generate_hash_value` allows you to hash a key using one of
 the hash functions defined in the library. This method is provided for
 the convenience of higher-level language bindings and is not necessary
 for normal memcache operations.
 
 The allowed hash algorithm constants are listed in the manpage for
-memcached_behavior_set().
+:c:func:`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.
+:c:func:`memcached_generate_hash` takes a :c:type:`memcached_st` struture 
+and produces the hash value that would have been generated based on the 
+defaults of :c:type:`memcached_st`.
 
 As of version 0.36 all hash methods have been placed into the library
 libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
@@ -73,7 +83,7 @@ HOME
 
 
 To find out more information please check: 
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 ------