X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_value.rst;h=d27e35281ee74814941bd34f22ed469a5a98b986;hb=3998b1125e1b9f8ebd2c963aa6f8d60131bc97c4;hp=f768f887c4cb1e121d0ebc4cc82d72d52fa9036a;hpb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;p=m6w6%2Flibmemcached diff --git a/docs/hashkit_value.rst b/docs/hashkit_value.rst index f768f887..d27e3528 100644 --- a/docs/hashkit_value.rst +++ b/docs/hashkit_value.rst @@ -14,19 +14,16 @@ SYNOPSIS #include -.. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length); +.. c:function:: 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. @@ -54,5 +51,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)`