Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

[m6w6/libmemcached] / docs / hashkit_create.rst

diff --git a/docs/hashkit_create.rst b/docs/hashkit_create.rst
index 6679f88e240b94c11645a293e3bb63079d1559d9..a46729a9729cd38f7eb372a4ee1f96c475df9800 100644 (file)
--- a/docs/hashkit_create.rst
+++ b/docs/hashkit_create.rst
@@ -1,88 +1,77 @@
-.. highlight:: perl
+============================
+Creating a hashkit structure
+============================
 
+.. highlightlang:: c
 
-hashkit_create, hashkit_clone, hashkit_free, hashkit_is_allocated
-*****************************************************************
+.. index:: object: hashkit_st
 
-
-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:type:: hashkit_st
+
+.. 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
+The :c:func:`hashkit_create` function initializes a hashkit object for use. If
 you pass a NULL argument for hash, then the memory for the object is
 allocated. If you specify a pre-allocated piece of memory, that is
 initialized for use.
 
-The hashkit_clone() function initializes a hashkit object much like
-hashkit_create(), but instead of using default settings it will use
+The :c:func:`hashkit_clone` function initializes a hashkit object much like
+:c:func:`hashkit_create`, but instead of using default settings it will use
 the settings of the ptr hashkit object.
 
-The hashkit_free() frees any resources being consumed by the hashkit
-objects that were initialized with hashkit_create() or hashkit_clone().
+The :c:func:`hashkit_free` frees any resources being consumed by the hashkit
+objects that were initialized with :c:func:`hashkit_create` or :c:func:`hashkit_clone`.
 
-The hashkit_is_allocated() reports where the memory was allocated 
+The :c:func:`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
-non-NULL on success.
+:c:func:`hashkit_create` and :c:func:`hashkit_clone` will return NULL on 
+failure or non-NULL on success.
 
-hashkit_is_allocated() returns true if the memory for the hashkit
-object was allocated inside of hashkit_create() or hashkit_clone(),
-otherwise it is false and was user-supplied memory.
+:c:func:`hashkit_is_allocated` returns true if the memory for the hashkit
+object was allocated inside of :c:func:`hashkit_create` or 
+:c:func:`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>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
 
 
-******
-AUTHOR
-******
+--------
+SEE ALSO
+--------
 
 
-Brian Aker, <brian@tangent.org>
+:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)`