Merge in new examples.

[m6w6/libmemcached] / docs / hashkit_create.rst

diff --git a/docs/hashkit_create.rst b/docs/hashkit_create.rst
index 4fa5974600ae5c03c34d107744395ab79ee971d3..3d801b1fe2210ed2dc0f402cb4589777f031cfd5 100644 (file)
--- a/docs/hashkit_create.rst
+++ b/docs/hashkit_create.rst
@@ -1,32 +1,28 @@
-.. highlight:: perl
+============================
+Creating a hashkit structure
+============================
 
 
-****
-NAME
-****
-
-
-hashkit_create, hashkit_clone, hashkit_free, hashkit_is_allocated -
 Create and destroy hashkit objects
 
 
-*******
+-------
 LIBRARY
-*******
+-------
 
 
-C Library for hashing algorithms (libhashkit, -lhashkit)
+C Library for hashing algorithms (libmemcached, -lhashkit)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
 .. code-block:: perl
 
-   #include <libhashkit/hashkit.h>
+   #include <libmemcached/hashkit.h>
  
    hashkit_st *hashkit_create(hashkit_st *hash);
  
@@ -38,9 +34,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 The hashkit_create() function initializes a hashkit object for use. If
@@ -59,9 +55,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 +68,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>
-