p9y: fix TCP constants

[awesomized/libmemcached] / docs / source / libmemcached / memcached_flush_buffers.rst

diff --git a/docs/source/libmemcached/memcached_flush_buffers.rst b/docs/source/libmemcached/memcached_flush_buffers.rst
index d94fa65d4feb09e49b23acb3e613c68284d4a5f1..85b7aaa8b39cc8058348ef149026bf5550074988 100644 (file)
--- a/docs/source/libmemcached/memcached_flush_buffers.rst
+++ b/docs/source/libmemcached/memcached_flush_buffers.rst
@@ -1,49 +1,44 @@
-=======================
-Flushing client buffers
-=======================
-
-
-.. index:: object: memcached_st
-
 Flush and send buffered commands
+================================
 
---------
 SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
- 
-.. function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
+    Compile and link with -lmemcached
 
-Compile and link with -lmemcached
+.. function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
 
+    :param ptr: pointer to initialized `memcached_st` struct
+    :returns: `memcached_return_t` indicating success
 
------------
 DESCRIPTION
 -----------
 
+:func:`memcached_flush_buffers` is used in conjunction with
+`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` to flush all buffers by
+sending the buffered commands to the server for processing.
 
-:func:`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.
-
+RETURN VALUE
+------------
 
-------
-RETURN
-------
-
-
-A value of type :type:`memcached_return_t` is returned
+A value of type :type:`memcached_return_t` is returned.
 On success that value will be `MEMCACHED_SUCCESS`.
-Use :func:`memcached_strerror` to translate this value to a printable 
-string.
-
-
+Use :func:`memcached_strerror` to translate this value to a printable string.
 
-
---------
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+    :manpage:`memcached_strerror(3)`
+    :manpage:`memcached_behavior(3)`
+
+.. only:: html
+
+    * :manpage:`memcached(1)`
+    * :doc:`../libmemcached`
+    * :doc:`memcached_strerror`
+    * :doc:`memcached_behavior`