iFix for OSX

[awesomized/libmemcached] / docs / hashkit_create.rst

diff --git a/docs/hashkit_create.rst b/docs/hashkit_create.rst
index 6679f88e240b94c11645a293e3bb63079d1559d9..e0c9c71c0fd48c06cae541faad9347fad45def16 100644 (file)
--- a/docs/hashkit_create.rst
+++ b/docs/hashkit_create.rst
@@ -1,44 +1,31 @@
-.. highlight:: perl
+============================
+Creating a hashkit structure
+============================
 
 
-hashkit_create, hashkit_clone, hashkit_free, hashkit_is_allocated
-*****************************************************************
-
-
-Create and destroy hashkit objects
-
-
-*******
-LIBRARY
-*******
-
-
-C Library for hashing algorithms (libhashkit, -lhashkit)
-
-
-********
+--------
 SYNOPSIS
-********
-
+--------
 
+C Library for hashing algorithms (libmemcached, -lhashkit)
 
-.. code-block:: perl
 
-   #include <libhashkit/hashkit.h>
+#include <libhashkit/hashkit.h>
  
-   hashkit_st *hashkit_create(hashkit_st *hash);
+.. c:function:: hashkit_st *hashkit_create(hashkit_st *hash);
  
-   hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
- 
-   void hashkit_free(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 -lmemcached
 
-***********
+
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 The hashkit_create() function initializes a hashkit object for use. If
@@ -57,9 +44,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
@@ -70,19 +57,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/>`_