Merge pull request #140 from hussainnaqvee/patch-1

[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 c852a2a19df5f43140c95c7111a7e1f3ca10c76f..3421d47be8e51ac406fb53139d7d3bdb76551394 100644 (file)
--- a/docs/source/libmemcached/memcached_quit.rst
+++ b/docs/source/libmemcached/memcached_quit.rst
@@ -1,48 +1,50 @@
-====================================
 Disconnecting a client from a server
 ====================================
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
- 
+    Compile and link with -lmemcached
+
 .. 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 
-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.
+:func:`memcached_quit` will disconnect you from all currently connected
+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
 function is provided mainly so that you can timeout your connections or
 reset connections during the middle of a :func:`memcached_fetch`.
 
-
-------
-RETURN
-------
-
+RETURN VALUE
+------------
 
 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.
 
-
---------
 SEE ALSO
 --------
 
 .. 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`