Merge in latest release.

[m6w6/libmemcached] / docs / memcached_quit.rst

diff --git a/docs/memcached_quit.rst b/docs/memcached_quit.rst
index 5048f4562ede4152f76879790adad93ef9c44b08..8377f63ce51c0c98abf4fd1b3fc68ef3ea5ce0c3 100644 (file)
--- a/docs/memcached_quit.rst
+++ b/docs/memcached_quit.rst
@@ -2,46 +2,31 @@
 Disconnecting a client from a server
 ====================================
 
-
-Disconnect from all servers
-
-
--------
-LIBRARY
--------
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
+.. index:: object: memcached_st
 
 --------
 SYNOPSIS
 --------
 
-
-
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
+#include <libmemcached/memcached.h>
  
-   void memcached_quit (memcached_st *ptr);
-
+.. c:function:: void memcached_quit (memcached_st *ptr);
 
+Compile and link with -lmemcached
 
 -----------
 DESCRIPTION
 -----------
 
 
-memcached_quit() will disconnect you from all currently connected servers.
-It will also reset the state of the connection (ie, any memcached_fetch() you
-are in the middle of will be terminated). This function is called
-automatically when you call memcached_free() on the \ ``memcached_st``\  structure.
+:c:func:`memcached_quit()` will disconnect you from all currently connected 
+servers. It will also reset the state of the connection (ie, any :c:func:`memcached_fetch()` you are in the middle of will be terminated). This function is 
+called automatically when you call :c:func:`memcached_free()` on the :c: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 memcached_fetch().
+reset connections during the middle of a :c:func:`memcached_fetch()`.
 
 
 ------
@@ -49,9 +34,9 @@ RETURN
 ------
 
 
-A value of type \ ``memcached_return``\  is returned
-On success that value will be \ ``MEMCACHED_SUCCESS``\ .
-Use memcached_strerror() to translate this value to a printable string.
+A value of type :c:type:`memcached_return` is returned
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror()` to translate this value to a printable string.
 
 
 ----
@@ -60,7 +45,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 ------