docs: flush libmemcached progress

[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 9e71fb2110d2fc17818ccf6dd4b91d8584c88048..85b7aaa8b39cc8058348ef149026bf5550074988 100644 (file)
--- a/docs/source/libmemcached/memcached_flush_buffers.rst
+++ b/docs/source/libmemcached/memcached_flush_buffers.rst
@@ -1,36 +1,44 @@
-Flushing client buffers
-=======================
-
-.. index:: object: memcached_st
-
 Flush and send buffered commands
+================================
 
 SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
+    Compile and link with -lmemcached
 
 .. function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
 
-Compile and link with -lmemcached
+    :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` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
+`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` to flush all buffers by
+sending the buffered commands to the server for processing.
 
 RETURN VALUE
 ------------
 
-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`