docs: flush libmemcached progress

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

diff --git a/docs/source/libmemcached/memcached_quit.rst b/docs/source/libmemcached/memcached_quit.rst
index 60e11ae77417964333ea1fb848a7ab27c62e4733..3421d47be8e51ac406fb53139d7d3bdb76551394 100644 (file)
--- a/docs/source/libmemcached/memcached_quit.rst
+++ b/docs/source/libmemcached/memcached_quit.rst
@@ -7,17 +7,20 @@ SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
 --------
 
 #include <libmemcached/memcached.h>

+    Compile and link with -lmemcached

 
 .. function:: void memcached_quit (memcached_st *ptr)
 
 
 .. function:: void memcached_quit (memcached_st *ptr)
 

-Compile and link with -lmemcached
+    :param ptr: pointer to initialized `memcached_st` struct

 
 DESCRIPTION
 -----------
 
 :func:`memcached_quit` will disconnect you from all currently connected
 
 DESCRIPTION
 -----------
 
 :func:`memcached_quit` will disconnect you from all currently connected

-servers. It will also reset the state of the connection (ie, any :func:`memcached_fetch` you are in the middle of will be terminated). This function is 
-called automatically when you call :func:`memcached_free` on the :type:`memcached_st` structure.
+servers. It will also reset the state of the connection (i.e., any
+:func:`memcached_fetch` you are in the middle of will be terminated). This
+function is called automatically when you call :func:`memcached_free` on the
+:type:`memcached_st` structure.

 
 You do not need to call this on your own. All operations to change server
 hashes and parameters will handle connections to the server for you. This
 
 You do not need to call this on your own. All operations to change server
 hashes and parameters will handle connections to the server for you. This


@@ -36,4 +39,12 @@ SEE ALSO
 
 .. only:: man
 
 
 .. only:: man
 

-  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+    :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+    * :manpage:`memcached(1)`
+    * :doc:`../libmemcached`
+    * :doc:`memcached_strerror`