-.. highlight:: perl
+=============
+hashkit_value
+=============
-****
-NAME
-****
+.. index:: object: hashkit_st
+Generate a value for the given key
-hashkit_value - Generate a value for the given key
-
-
-*******
-LIBRARY
-*******
-
-
-C Library for hashing algorithms (libhashkit, -lhashkit)
-
-
-********
+--------
SYNOPSIS
-********
-
+--------
-.. code-block:: perl
+#include <libhashkit/hashkit.h>
- #include <libhashkit/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
-
-
-***********
+-----------
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.
-************
+------------
RETURN VALUE
-************
+------------
A 32-bit hash value.
-****
+----
HOME
-****
+----
To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
-
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
+`http://libmemcached.org/ <http://libmemcached.org/>`_
-********
+--------
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)`