Merge trunk
[m6w6/libmemcached] / docs / hashkit_value.rst
index c31848700ce76c2338265c8e04f27893c7e1479a..f418a394f14d5085819d1f260d0c018612808964 100644 (file)
@@ -3,30 +3,21 @@ hashkit_value
 =============
 
 
-Generate a value for the given key
-
-
--------
-LIBRARY
--------
-
-
-C Library for hashing algorithms (libmemcached, -lhashkit)
+.. index:: object: hashkit_st
 
+Generate a value for the given key
 
 --------
 SYNOPSIS
 --------
 
 
+#include <libhashkit/hashkit.h>
 
-.. code-block:: perl
-
-   #include <libmemcached/hashkit.h>
+.. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length);
  
-   uint32_t hashkit_value(hashkit_st *hash,
-                          const char *key,
-                          size_t key_length);
+
+Compile and link with -lhashkit
 
 
 
@@ -35,7 +26,7 @@ DESCRIPTION
 -----------
 
 
-The hashkit_value() function generates a 32-bit hash value from the
+The :c:func:`hashkit_value()` function generates a 32-bit hash value from the
 given key and key_length. The hash argument is an initialized hashkit
 object, and distribution type and hash function is used from this
 object while generating the value.
@@ -55,7 +46,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 --------
@@ -63,5 +54,5 @@ SEE ALSO
 --------
 
 
-hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3)
+:manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)`