-.. highlight:: perl
+============================
+Creating a hashkit structure
+============================
+.. index:: object: hashkit_st
-****
-NAME
-****
-
-
-hashkit_create, hashkit_clone, hashkit_free, hashkit_is_allocated -
-Create and destroy hashkit objects
-
-
-*******
-LIBRARY
-*******
-
-
-C Library for hashing algorithms (libhashkit, -lhashkit)
-
-
-********
+--------
SYNOPSIS
-********
-
-
+--------
-.. code-block:: perl
-
- #include <libhashkit/hashkit.h>
-
- hashkit_st *hashkit_create(hashkit_st *hash);
-
- hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
+#include <libhashkit/hashkit.h>
- void hashkit_free(hashkit_st *hash);
+.. c:function:: hashkit_st *hashkit_create(hashkit_st *hash);
- bool hashkit_is_allocated(const hashkit_st *hash);
+.. c:function:: hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
+
+.. c:function:: void hashkit_free(hashkit_st *hash);
+
+.. c:function:: bool hashkit_is_allocated(const hashkit_st *hash);
+Compile and link with -lhashkit
-***********
+-----------
DESCRIPTION
-***********
+-----------
The hashkit_create() function initializes a hashkit object for use. If
for a hashkit object.
-************
+------------
RETURN VALUE
-************
+------------
hashkit_create() and hashkit_clone() will return NULL on failure or
otherwise it is false and was user-supplied memory.
-****
+----
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/>`_