X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fsource%2Flibmemcached%2Fmemcached_dump.rst;h=e96c76348d1779ad3510cf9bac130e6ca31ed5e1;hb=52027f889cdd7435ae3cba934f190996ad739a3a;hp=d8b5c9c5b79ee1f8622041af4eb55c302d5d9f8a;hpb=bdf3398dac90a54d82aed65099290d51e92d4601;p=awesomized%2Flibmemcached

diff --git a/docs/source/libmemcached/memcached_dump.rst b/docs/source/libmemcached/memcached_dump.rst
index d8b5c9c5..e96c7634 100644
--- a/docs/source/libmemcached/memcached_dump.rst
+++ b/docs/source/libmemcached/memcached_dump.rst
@@ -1,46 +1,57 @@
-==========================
 Dumping data from a server
 ==========================
 
-Get a list of keys found on memcached servers
-
-.. index:: object: memcached_st
-
---------
 SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
+    Compile and link with -lmemcached
+
+.. type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context)
+
+    :param ptr: pointer to `memcached_st` object
+    :param key: key string being dumped
+    :param key_length: length of the key without any terminating zero
+    :param context: pointer to the user supplied context
+    :returns: `memcached_return_t` indicating success
 
 .. function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)
 
-.. type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,  const char *key, size_t key_length, void *context)
+    :param ptr: pointer to initialized `memcached_st` struct
+    :param function: pointer to `number_of_callbacks` `memcached_dump_fn` callbacks
+    :param context: pointer to a user managed context
+    :param number_of_callbacks: number of callbacks in the `function` array
+    :returns: `memcached_return_t` indicating success
 
-Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
-:func:`memcached_dump` is used to get a list of keys found in memcached(1)
-servers. Because memcached(1) does not guarantee to dump all keys you can not
+:func:`memcached_dump` is used to get a list of keys found in :manpage:`memcached(1)`
+servers. Because memcached does not guarantee to dump all keys you can not
 assume you have fetched all keys from the server. The function takes an array
 of callbacks that it will use to execute on keys as they are found.
 
 Currently the binary protocol is not tested.
 
-RETURN
-------
+RETURN VALUE
+------------
 
-A value of type :type:`memcached_return_t` is returned
+A value of type :type:`memcached_return_t` is returned.
 On success that value will be `MEMCACHED_SUCCESS`.
 Use :func:`memcached_strerror` to translate this value to a printable 
 string.
 
---------
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+    :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+    * :doc:`../libmemcached`
+    * :doc:`memcached_strerror`