docs: bin/
[m6w6/libmemcached] / docs / source / libmemcached / memcached_quit.rst
index c852a2a19df5f43140c95c7111a7e1f3ca10c76f..60e11ae77417964333ea1fb848a7ab27c62e4733 100644 (file)
@@ -1,25 +1,21 @@
-====================================
 Disconnecting a client from a server
 ====================================
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
+
 .. function:: void memcached_quit (memcached_st *ptr)
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
-
-:func:`memcached_quit` will disconnect you from all currently connected 
+: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.
 
@@ -28,18 +24,13 @@ 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
 --------