Merge in cleanup on the parser API.

[m6w6/libmemcached] / docs / memcached_flush_buffers.rst

diff --git a/docs/memcached_flush_buffers.rst b/docs/memcached_flush_buffers.rst
index 497d96ee5a7120c747d8211e1f29a91ad7971702..634ded1dbc0b36bc9390346d074b47671e894bdc 100644 (file)
--- a/docs/memcached_flush_buffers.rst
+++ b/docs/memcached_flush_buffers.rst
@@ -1,40 +1,32 @@
-.. highlight:: perl
+=======================
+Flushing client buffers
+=======================
 
 
-****
-NAME
-****
+Flush buffers and send buffered commands
 
 
-memcached_flush_buffers - Flush buffers and send buffered commands
-
-
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
-
-
+--------
 
-.. code-block:: perl
-
-   #include <memcached.h>
+#include <libmemcached/memcached.h>
  
-   memcached_return_t
-     memcached_flush_buffers (memcached_st *ptr);
+.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr);
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_flush_buffers() is used in conjunction with 
@@ -42,9 +34,9 @@ MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush
 all buffers by sending the buffered commands to the server for processing.
 
 
-******
+------
 RETURN
-******
+------
 
 
 A value of type \ ``memcached_return_t``\  is returned
@@ -52,27 +44,28 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ .
 Use 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>`_
 
 
-******
+------
 AUTHOR
-******
+------
+
 
+Brian Aker, <brian@tangent.org>
 
 Trond Norbye, <trond.norbye@gmail.com>
 
 
-********
+--------
 SEE ALSO
-********
-
+--------
 
-memcached(1) libmemcached(3) memcached_strerror(3) memcached_behavior(3)
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`