Update documentation.

[m6w6/libmemcached] / docs / memcached_memory_allocators.rst

diff --git a/docs/memcached_memory_allocators.rst b/docs/memcached_memory_allocators.rst
index 46e03733c3c0e4d20f54268de937b18b98f5e5b9..33f3d3a72596ae6b6fa045af7594aae3ea4fb135 100644 (file)
--- a/docs/memcached_memory_allocators.rst
+++ b/docs/memcached_memory_allocators.rst
@@ -2,41 +2,32 @@
 Use custom allocators for embedded usage
 ========================================
 
+.. index:: object: memcached_st
 
 Manage memory allocator functions
 
+--------
+SYNOPSIS
+--------
 
--------
-LIBRARY
--------
 
+#include <libmemcached/memcached.h>
 
-C Client Library for memcached (libmemcached, -lmemcached)
+.. c:function:: memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context);
 
+.. c:function:: void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc);
 
---------
-SYNOPSIS
---------
+.. c:function:: void * memcached_get_memory_allocators_context(const memcached_st *ptr);
+
+.. c:function:: void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context);
 
+.. c:function:: void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context);
 
+.. c:function:: void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context);
 
-.. code-block:: perl
+.. c:function:: void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
 
-   #include <libmemcached/memcached.h>
- 
-   memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context);
- 
-   void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc);
- 
-   void * memcached_get_memory_allocators_context(const memcached_st *ptr);
- 
-   void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context);
- 
-   void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context);
- 
-   void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context);
- 
-   void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
+Compile and link with -lmemcached
 
 
 
@@ -45,7 +36,7 @@ DESCRIPTION
 -----------
 
 
-libmemcached(3) allows you to specify your own memory allocators optimized
+libmemcached(3) allows you to specify your own memory allocators, optimized
 for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
 
 memcached_set_memory_allocators() is used to set the memory allocators used
@@ -91,7 +82,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 --------