X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fsource%2Flibhashkit%2Fhashkit_value.rst;h=8daf0e4d1e9a6c3e95c165bd921b7df26474aff5;hb=6079c0e29529bf9dd13ef1ed89c046672e1a3121;hp=ab6ef7ac7e525a65231ccd6e078290f30d3b4ec6;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=awesomized%2Flibmemcached diff --git a/docs/source/libhashkit/hashkit_value.rst b/docs/source/libhashkit/hashkit_value.rst index ab6ef7ac..8daf0e4d 100644 --- 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`