Merge of all doc fixes.

[m6w6/libmemcached] / docs / memcached_generate_hash_value.rst

diff --git a/docs/memcached_generate_hash_value.rst b/docs/memcached_generate_hash_value.rst
index 278bf9c56b15560697161402457bbb511bdc55a8..116bfd2b83ae1583fbd492b1cd8f39c33da8b57d 100644 (file)
--- a/docs/memcached_generate_hash_value.rst
+++ b/docs/memcached_generate_hash_value.rst
@@ -1,47 +1,28 @@
-.. highlight:: perl
+===============================
+Generating hash values directly
+===============================
 
 
-****
-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
@@ -57,12 +38,12 @@ the hash value that would have been generated based on the defaults
 of the 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 +51,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>`_
 
 
-******
+------
 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)`