Merge from tip

[m6w6/libmemcached] / docs / memcached_flush.rst

diff --git a/docs/memcached_flush.rst b/docs/memcached_flush.rst
index 3852366eb652dc433cd8996f2cd41e0f477c2597..a5c273de8730dfa9e1f2e45292f26252a12d7d02 100644 (file)
--- a/docs/memcached_flush.rst
+++ b/docs/memcached_flush.rst
@@ -2,32 +2,21 @@
 Wiping clean the contents of a server
 =====================================
 
+.. index:: object: memcached_st
 
 Wipe contents of memcached servers
 
 
--------
-LIBRARY
--------
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
 --------
 SYNOPSIS
 --------
 
 
-
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
+#include <libmemcached/memcached.h>
  
-   memcached_return_t
-     memcached_flush (memcached_st *ptr,
-                      time_t expiration);
+.. c:function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration);
 
+Compile and link with -lmemcached
 
 
 -----------
@@ -35,7 +24,7 @@ DESCRIPTION
 -----------
 
 
-memcached_flush() is used to wipe clean the contents of memcached(1) servers.
+:c:func::`memcached_flush()` is used to wipe clean the contents of :program:`memcached` servers.
 It will either do this immediately or expire the content based on the
 expiration time passed to the method (a value of zero causes an immediate
 flush). The operation is not atomic to multiple servers, just atomic to a
@@ -48,10 +37,9 @@ 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:type:`memcached_strerror()` to translate this value to a printable string.
 
 ----
 HOME
@@ -59,7 +47,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 ------