Merge bzr://10.0.3.21 Build: jenkins-Libmemcached-469

[awesomized/libmemcached] / docs / hashkit_value.rst

diff --git a/docs/hashkit_value.rst b/docs/hashkit_value.rst
index ec5d71b6d0b0ea780745567e5280bd07e4821601..d27e35281ee74814941bd34f22ed469a5a98b986 100644 (file)
--- a/docs/hashkit_value.rst
+++ b/docs/hashkit_value.rst
@@ -1,77 +1,55 @@
-.. highlight:: perl
-
-
+=============
 hashkit_value
-*************
-
-
-Generate a value for the given key
-
+=============
 
-*******
-LIBRARY
-*******
 
+.. index:: object: hashkit_st
 
-C Library for hashing algorithms (libhashkit, -lhashkit)
-
+Generate a value for the given key
 
-********
+--------
 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
+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.
 
 
-************
+------------
 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)
+:manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)`