Adding prebuilt parser/scanner

[m6w6/libmemcached] / docs / hashkit_value.rst

diff --git a/docs/hashkit_value.rst b/docs/hashkit_value.rst
index 8f9fc4db007659f0c6fb34ea5ae28582e0902bec..d27e35281ee74814941bd34f22ed469a5a98b986 100644 (file)
--- a/docs/hashkit_value.rst
+++ b/docs/hashkit_value.rst
@@ -3,39 +3,27 @@ hashkit_value
 =============
 
 
-Generate a value for the given key
-
-
--------
-LIBRARY
--------
-
-
-C Library for hashing algorithms (libmemcached, -lhashkit)
+.. index:: object: hashkit_st
 
+Generate a value for the given key
 
 --------
 SYNOPSIS
 --------
 
 
+#include <libhashkit/hashkit.h>
 
-.. code-block:: perl
-
-   #include <libmemcached/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.
@@ -63,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)`