Replace pod docs with sphinx docs.

[awesomized/libmemcached] / docs / hashkit_value.rst

diff --git a/docs/hashkit_value.rst b/docs/hashkit_value.rst
new file mode 100644 (file)
index 0000000..5c34b15
--- /dev/null
+++ b/docs/hashkit_value.rst
@@ -0,0 +1,78 @@
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+hashkit_value - Generate a value for the given key
+
+
+*******
+LIBRARY
+*******
+
+
+C Library for hashing algorithms (libhashkit, -lhashkit)
+
+
+********
+SYNOPSIS
+********
+
+
+
+.. code-block:: perl
+
+   #include <libhashkit/hashkit.h>
+ 
+   uint32_t hashkit_value(hashkit_st *hash,
+                          const char *key,
+                          size_t key_length);
+
+
+
+***********
+DESCRIPTION
+***********
+
+
+The 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>
+
+
+********
+SEE ALSO
+********
+
+
+hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3)
+