Cleanup API documentation.
[m6w6/libmemcached] / docs / memcached_flush_buffers.rst
index 2d8a5b7f9119e1a7bd87aafba52acc1190d682d1..634ded1dbc0b36bc9390346d074b47671e894bdc 100644 (file)
@@ -1,16 +1,14 @@
-.. highlight:: perl
-
-
-memcached_flush_buffers
-----------------------*
+=======================
+Flushing client buffers
+=======================
 
 
 Flush buffers and send buffered commands
 
 
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
@@ -20,14 +18,9 @@ C Client Library for memcached (libmemcached, -lmemcached)
 SYNOPSIS
 --------
 
-
-
-.. code-block:: perl
-
-   #include <libmemcached/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);
 
 
 
@@ -41,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
@@ -51,19 +44,21 @@ 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>