X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_functions.rst;h=542fd95f6021a93a27cbc4e9d5127b95fcaabef9;hb=dc421179c0d159f1ca8a6b2b64b89163a7e0c639;hp=a0368839228672bf40e3289b610fa14b558ed11f;hpb=f0a568f40ab283bb0be08bd0d930c70386418b97;p=m6w6%2Flibmemcached diff --git a/docs/hashkit_functions.rst b/docs/hashkit_functions.rst index a0368839..542fd95f 100644 --- a/docs/hashkit_functions.rst +++ b/docs/hashkit_functions.rst @@ -1,30 +1,28 @@ -.. highlight:: perl - - -hashkit_default, hashkit_fnv1_64, hashkit_fnv1a_64, hashkit_fnv1_32, hashkit_fnv1a_32, hashkit_crc32, hashkit_hsieh, hashkit_murmur, hashkit_jenkins, hashkit_md5 -***************************************************************************************************************************************************************** +================ +Available Hashes +================ Various hash functions to use for calculating values for keys -******* +------- LIBRARY -******* +------- -C Library for hashing algorithms (libhashkit, -lhashkit) +C Library for hashing algorithms (libmemcached, -lhashkit) -******** +-------- SYNOPSIS -******** +-------- .. code-block:: perl - #include + #include uint32_t hashkit_default(const char *key, size_t key_length); uint32_t hashkit_fnv1_64(const char *key, size_t key_length); @@ -39,9 +37,9 @@ SYNOPSIS -*********** +----------- DESCRIPTION -*********** +----------- These functions generate hash values from a key using a variety of @@ -52,34 +50,26 @@ The hashkit_hsieh() is only available if the library is built with the appropriate flag enabled. -************ +------------ RETURN VALUE -************ +------------ A 32-bit hash value. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Brian Aker, - - -******** +-------- SEE ALSO -******** +-------- hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3)