Merge in documentation updates.

[awesomized/libmemcached] / docs / memcached_memory_allocators.rst

diff --git a/docs/memcached_memory_allocators.rst b/docs/memcached_memory_allocators.rst
index 540565aefdcff326e7bc67d8f749259fdbeb619a..46e03733c3c0e4d20f54268de937b18b98f5e5b9 100644 (file)
--- a/docs/memcached_memory_allocators.rst
+++ b/docs/memcached_memory_allocators.rst
@@ -1,24 +1,22 @@
-.. highlight:: perl
-
-
-memcached_set_memory_allocators, memcached_get_memory_allocators, memcached_set_memory_allocators_context
-*********************************************************************************************************
+========================================
+Use custom allocators for embedded usage
+========================================
 
 
 Manage memory allocator functions
 
 
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
@@ -26,52 +24,29 @@ SYNOPSIS
 
    #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);
+   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 (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_get_memory_allocators_context(const memcached_st *ptr);
  
-   void *
-     (*memcached_malloc_fn) (memcached_st *ptr, const size_t size,
-                           void *context);
+   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_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_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);
+   void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 libmemcached(3) allows you to specify your own memory allocators optimized
-for your application.
+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
 by the memcached instance specified by ptr. Please note that you cannot
@@ -91,9 +66,9 @@ memcached structure, the is passed as const and you will need to clone
 it in order to make use of any operation which would modify it.
 
 
-*****
+-----
 NOTES
-*****
+-----
 
 
 In version 0.38 all functions were modified to have a context void pointer
@@ -101,35 +76,26 @@ passed to them. This was so that customer allocators could have their
 own space for memory.
 
 
-******
+------
 RETURN
-******
+------
 
 
 memcached_set_memory_allocators() return MEMCACHED_SUCCESS upon success,
 and MEMCACHED_FAILURE if you don't pass a complete set of function pointers.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Trond Norbye, <trond.norbye@gmail.com>
-Brian Aker, <brian@tangent.orf<gt>
-
-
-********
+--------
 SEE ALSO
-********
+--------
 
 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`