docs: ws
[awesomized/libmemcached] / docs / source / libmemcached / memcached_memory_allocators.rst
index 230accb7eb10c74e2a01f49bc7226ed51e99bb8f..7cd89122d9035e282ab083c3f348e92c62b1f79c 100644 (file)
@@ -10,7 +10,6 @@ Manage memory allocator functions
 SYNOPSIS
 --------
 
-
 #include <libmemcached/memcached.h>
 
 .. 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)
@@ -29,54 +28,46 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
-
-
 -----------
 DESCRIPTION
 -----------
 
-
 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.
 
-:func:`memcached_set_memory_allocators` is used to set the memory 
+:func:`memcached_set_memory_allocators` is used to set the memory
 allocators used by the memcached instance specified by ptr. Please note that 
 you cannot override only one of the memory allocators, you have to specify a 
 complete new set if you want to override one of them. All of the memory 
 allocation functions should behave as specified in the C99 standard. Specify 
 NULL as all functions to reset them to the default values.
 
-:func:`memcached_get_memory_allocators` is used to get the currently used 
+:func:`memcached_get_memory_allocators` is used to get the currently used
 memory allocators by a memcached handle.
 
-:func:`memcached_get_memory_allocators_context` returns the void \* that 
+:func:`memcached_get_memory_allocators_context` returns the void \* that
 was passed in during the call to :func:`memcached_set_memory_allocators`.
 
 The first argument to the memory allocator functions is a pointer to a
 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
 passed to them. This was so that customer allocators could have their
 own space for memory.
 
-
 ------
 RETURN
 ------
 
-
-:func:`memcached_set_memory_allocators` return `MEMCACHED_SUCCESS` 
+:func:`memcached_set_memory_allocators` return `MEMCACHED_SUCCESS`
 upon success, and `MEMCACHED_FAILURE` if you don't pass a complete set 
 of function pointers.
 
-
 --------
 SEE ALSO
 --------