Add in version information for YATL

[m6w6/libmemcached] / docs / memcached_flush.rst

diff --git a/docs/memcached_flush.rst b/docs/memcached_flush.rst
index 41ca369620863ef2a9c09439c7c39ac0cb8c0689..042a4d424fe4cf31d87d033301d3060623512cbc 100644 (file)
--- a/docs/memcached_flush.rst
+++ b/docs/memcached_flush.rst
@@ -1,43 +1,30 @@
-.. highlight:: perl
-
-
-memcached_flush
-***************
+=====================================
+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
 
 
-***********
+-----------
 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
@@ -45,37 +32,34 @@ single server. That is, it will flush the servers in the order that they were
 added.
 
 
-******
+------
 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
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
+------
 AUTHOR
-******
+------
 
 
 Brian Aker, <brian@tangent.org>
 
 
-********
+--------
 SEE ALSO
-********
-
-
-memcached(1) libmemcached(3) memcached_strerror(3)
+--------
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`