X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_value.pod;fp=docs%2Fhashkit_value.pod;h=db594bc9c4a92025f9dc93c64eac928962771b90;hb=ff2f828a531d23ee087940fed20e8798fdf2c204;hp=0000000000000000000000000000000000000000;hpb=d39962cd481eb10a7d9dceb6d442af0fd49521fb;p=awesomized%2Flibmemcached

diff --git a/docs/hashkit_value.pod b/docs/hashkit_value.pod
new file mode 100644
index 00000000..db594bc9
--- /dev/null
+++ b/docs/hashkit_value.pod
@@ -0,0 +1,41 @@
+=head1 NAME
+
+hashkit_value - Generate a value for the given key
+
+=head1 LIBRARY
+
+C Library for hashing algorithms (libhashkit, -lhashkit)
+
+=head1 SYNOPSIS
+
+  #include <libhashkit/hashkit.h>
+
+  uint32_t hashkit_value(hashkit_st *hash,
+                         const char *key,
+                         size_t key_length);
+
+=head1 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.
+
+=head1 RETURN VALUE
+
+A 32-bit hash value.
+
+=head1 HOME
+
+To find out more information please check:
+L<https://launchpad.net/libmemcached>
+
+=head1 AUTHOR
+
+Brian Aker, E<lt>brian@tangent.orgE<gt>
+
+=head1 SEE ALSO
+
+hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3)
+
+=cut