Merge bzr://10.0.3.21 Build: jenkins-Libmemcached-469

[awesomized/libmemcached] / docs / memcached_dump.rst

diff --git a/docs/memcached_dump.rst b/docs/memcached_dump.rst
index a7dcb4fe54587ace8b1ab02ec2f563ac4ec2a51c..988410fc40fbdac1b57505962a75a2009845a3ab 100644 (file)
--- a/docs/memcached_dump.rst
+++ b/docs/memcached_dump.rst
@@ -5,13 +5,7 @@ Dumping data from a server
 
 Get a list of keys found on memcached servers
 
-
--------
-LIBRARY
--------
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
+.. index:: object: memcached_st
 
 
 --------
@@ -19,21 +13,13 @@ SYNOPSIS
 --------
 
 
+#include <libmemcached/memcached.h>
 
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
- 
-   memcached_return_t
-     memcached_dump (memcached_st *ptr, 
-                     memcached_dump_fn *function, 
-                     void *context, 
-                     uint32_t number_of_callbacks);
+.. c:function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)
  
-   typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,  
-                                                   const char *key, 
-                                                   size_t key_length, 
-                                                   void *context);
+.. c:type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,  const char *key, size_t key_length, void *context)
+
+Compile and link with -lmemcached
 
 
 
@@ -42,9 +28,9 @@ DESCRIPTION
 -----------
 
 
-memcached_dump() is used to get a list of keys found in memcached(1) servers.
-Because memcached(1) does not guarentee to dump all keys you can not assume
-you have fetched all keys from the server. The function takes an array
+:c:func:`memcached_dump` is used to get a list of keys found in memcached(1) 
+servers. Because memcached(1) does not guarentee 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 testsed.
@@ -55,9 +41,10 @@ RETURN
 ------
 
 
-A value of type \ ``memcached_return_t``\  is returned
-On success that value will be \ ``MEMCACHED_SUCCESS``\ .
-Use memcached_strerror() to translate this value to a printable string.
+A value of type :c:type:`memcached_return_t` is returned
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror` to translate this value to a printable 
+string.
 
 
 ----