X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_create.rst;h=f7aabac5313b42bc9747f195ef7caed90aa7db0d;hb=e7855e43bbc4dd0a5e8fcbfd4888181001dcd1ec;hp=4fa5974600ae5c03c34d107744395ab79ee971d3;hpb=c4dbc7e56b01545e25bc95ba122c79d4a2631a99;p=awesomized%2Flibmemcached

diff --git a/docs/hashkit_create.rst b/docs/hashkit_create.rst
index 4fa59746..f7aabac5 100644
--- a/docs/hashkit_create.rst
+++ b/docs/hashkit_create.rst
@@ -1,46 +1,29 @@
-.. 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
@@ -59,9 +42,9 @@ The hashkit_is_allocated() reports where the memory was allocated
 for a hashkit object.
 
 
-************
+------------
 RETURN VALUE
-************
+------------
 
 
 hashkit_create() and hashkit_clone() will return NULL on failure or
@@ -72,19 +55,10 @@ object was allocated inside of hashkit_create() or hashkit_clone(),
 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/>`_