release 1.1.1

[awesomized/libmemcached] / docs / source / libhashkit / hashkit_value.rst

diff --git a/docs/source/libhashkit/hashkit_value.rst b/docs/source/libhashkit/hashkit_value.rst
index ab6ef7ac7e525a65231ccd6e078290f30d3b4ec6..8daf0e4d1e9a6c3e95c165bd921b7df26474aff5 100644 (file)
--- a/docs/source/libhashkit/hashkit_value.rst
+++ b/docs/source/libhashkit/hashkit_value.rst
@@ -1,10 +1,6 @@
 Generate hash value
 ===================
 
-.. index:: object: hashkit_st
-
-Generate a value for the given key
-
 SYNOPSIS
 --------
 
@@ -13,13 +9,17 @@ SYNOPSIS
 
 .. function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length)
 
+    :param hash: pointer to an initialized `hashkit_st` struct
+    :param key: the key to genereate a hash of
+    :param key_length: the length of the `key` without any terminating zero byte
+
 DESCRIPTION
 -----------
 
-The :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.
+The `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.
 
 RETURN VALUE
 ------------
@@ -38,7 +38,7 @@ SEE ALSO
 
 .. only:: html
 
-    * :doc:`../libhashkit`
+    * :doc:`index`
     * :doc:`hashkit_create`
     * :doc:`hashkit_function`
     * :doc:`hashkit_functions`