Merge lp:~tangent-org/libmemcached/1.0-build/ Build: jenkins-Libmemcached-189

[awesomized/libmemcached] / docs / hashkit_functions.rst

diff --git a/docs/hashkit_functions.rst b/docs/hashkit_functions.rst
index 883f6e1d49df961e716db21226f56e79ec12ab50..4db416614ca4536eb7537126051da6251e792f66 100644 (file)
--- a/docs/hashkit_functions.rst
+++ b/docs/hashkit_functions.rst
@@ -1,91 +1,75 @@
-.. highlight:: perl
+================
+Available Hashes
+================
 
+.. index:: object: hashkit_st
 
-****
-NAME
-****
+Various hash functions to use for calculating values for keys
 
 
-hashkit_default, hashkit_fnv1_64, hashkit_fnv1a_64, hashkit_fnv1_32,
-hashkit_fnv1a_32, hashkit_crc32, hashkit_hsieh, hashkit_murmur,
-hashkit_jenkins, hashkit_md5 - Various hash functions to use for
-calculating values for keys
+--------
+SYNOPSIS
+--------
 
+#include <libhashkit/hashkit.h>
+ 
+.. c:function:: uint32_t hashkit_default(const char *key, size_t key_length)
 
-*******
-LIBRARY
-*******
+.. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)
 
+.. c:function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length)
 
-C Library for hashing algorithms (libhashkit, -lhashkit)
+.. c:function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length)
 
+.. c:function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length)
 
-********
-SYNOPSIS
-********
+.. c:function:: uint32_t hashkit_crc32(const char *key, size_t key_length)
 
+.. c:function:: uint32_t hashkit_hsieh(const char *key, size_t key_length)
 
+.. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length)
 
-.. code-block:: perl
+.. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)
 
-   #include <libhashkit/hashkit.h>
- 
-   uint32_t hashkit_default(const char *key, size_t key_length);
-   uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
-   uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
-   uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
-   uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
-   uint32_t hashkit_crc32(const char *key, size_t key_length);
-   uint32_t hashkit_hsieh(const char *key, size_t key_length);
-   uint32_t hashkit_murmur(const char *key, size_t key_length);
-   uint32_t hashkit_jenkins(const char *key, size_t key_length);
-   uint32_t hashkit_md5(const char *key, size_t key_length);
+.. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length)
 
+Compile and link with -lhashkit
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 These functions generate hash values from a key using a variety of
 algorithms. These functions can be used standalone, or as arguments
 to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
 
-The hashkit_hsieh() is only available if the library is built with
+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 <https://launchpad.net/libmemcached>`_
-
-
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-********
+--------
 SEE ALSO
-********
+--------
 
 
-hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3)
-hashkit_set_continuum_hash_fn(3)
+:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)`