Update build files.
[m6w6/libmemcached] / docs / hashkit_value.rst
index 5c34b157a02027f5892c9355a8959492f2fe7325..f768f887c4cb1e121d0ebc4cc82d72d52fa9036a 100644 (file)
@@ -1,41 +1,29 @@
-.. 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
-********
+--------
 
 
+#include <libhashkit/hashkit.h>
 
-.. code-block:: perl
-
-   #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
@@ -44,34 +32,26 @@ 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)