X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_generate_hash_value.rst;h=3da05dfd87a7f48551af4986c1a88ebb3cc02797;hb=aa431d73f34773d6a4b7fc104f9bd7ae0384e094;hp=278bf9c56b15560697161402457bbb511bdc55a8;hpb=49fc1e5ea4ea006f4a2ac71428833760f6fac030;p=m6w6%2Flibmemcached

diff --git a/docs/memcached_generate_hash_value.rst b/docs/memcached_generate_hash_value.rst
index 278bf9c5..3da05dfd 100644
--- a/docs/memcached_generate_hash_value.rst
+++ b/docs/memcached_generate_hash_value.rst
@@ -1,68 +1,50 @@
-.. highlight:: perl
+===============================
+Generating hash values directly
+===============================
 
+.. index:: object: memcached_st
 
-****
-NAME
-****
+Hash a key value
 
 
-memcached_generate_hash_value - Hash a key value
+-------- 
+SYNOPSIS 
+--------
 
 
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
-SYNOPSIS
-********
-
-
-
-.. code-block:: perl
-
-   #include <memcached.h>
- 
-   uint32_t
-     memcached_generate_hash_value (const char *key,
-                                    size_t key_length,
-                                    memcached_hash_t hash_algorithm);
+#include <libmemcached/memcached.h>
  
-   uint32_t 
-     memcached_generate_hash (memcached_st *ptr,
-                              const char *key, 
-                              size_t key_length);
+.. c:function:: uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm);
 
+.. c:function:: uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length);
 
+Compile and link with -lmemcachedutil -lmemcached
 
-***********
+
+-----------
 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 the :c:type:`memcached_st structure`.
 
 As of version 0.36 all hash methods have been placed into the library
-libhashkit(3) which is linked with libmemcached(3).
+libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
 
 
-******
+------
 RETURN
-******
+------
 
 
 A 32-bit integer which is the result of hashing the given key.
@@ -70,27 +52,26 @@ For 64-bit hash algorithms, only the least-significant 32 bits are
 returned.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check: 
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
+------
 AUTHOR
-******
+------
 
 
 Brian Aker, <brian@tangent.org>
 
 
-********
+--------
 SEE ALSO
-********
-
+--------
 
-memcached(1) libmemcached(3) memcached_behavior_set(3) libhashkit(3)
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`