Merge in documentation updates.
[m6w6/libmemcached] / docs / man / memcached_set_memory_allocators.3
index 614426f696a3db34632ceca71d0abd82079440b8..22655217c607cf85dfab835b67cf536540697a4c 100644 (file)
@@ -41,48 +41,25 @@ C Client Library for memcached (libmemcached, \-lmemcached)
 .ft C
 #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);
 .ft P
 .fi
 .SH DESCRIPTION
 .sp
 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.
 .sp
 memcached_set_memory_allocators() is used to set the memory allocators used
 by the memcached instance specified by ptr. Please note that you cannot
@@ -113,13 +90,9 @@ and MEMCACHED_FAILURE if you don\(aqt pass a complete set of function pointers.
 .sp
 To find out more information please check:
 \fI\%https://launchpad.net/libmemcached\fP
-.SH AUTHOR
-.sp
-Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
-Brian Aker, <\fI\%brian@tangent\fP.orf<gt>
 .SH SEE ALSO
 .sp
-memcached(1) libmemcached(3) memcached_get_user_data(3) memcached_set_user_data(3)
+\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT