Final bits for 1.0.9

[m6w6/libmemcached] / docs / memcached_flush_buffers.rst

diff --git a/docs/memcached_flush_buffers.rst b/docs/memcached_flush_buffers.rst
index 634ded1dbc0b36bc9390346d074b47671e894bdc..888c9254420ed6d1072d4a3faa095e9e87311229 100644 (file)
--- a/docs/memcached_flush_buffers.rst
+++ b/docs/memcached_flush_buffers.rst
@@ -3,16 +3,9 @@ Flushing client buffers
 =======================
 
 
-Flush buffers and send buffered commands
-
-
--------
-LIBRARY
--------
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
+.. index:: object: memcached_st
 
+Flush and senf buffered commands
 
 --------
 SYNOPSIS
@@ -20,8 +13,9 @@ SYNOPSIS
 
 #include <libmemcached/memcached.h>
  
-.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr);
+.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
 
+Compile and link with -lmemcached
 
 
 -----------
@@ -29,9 +23,8 @@ DESCRIPTION
 -----------
 
 
-memcached_flush_buffers() is used in conjunction with 
-MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush
-all buffers by sending the buffered commands to the server for processing.
+:c:func:`memcached_flush_buffers` is used in conjunction with 
+:c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
 
 
 ------
@@ -39,9 +32,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.
 
 
 ----
@@ -50,7 +44,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 ------