Update with current fixes.

[m6w6/libmemcached] / docs / memcached_quit.rst

diff --git a/docs/memcached_quit.rst b/docs/memcached_quit.rst
index cf5abdbe88e15b1141db8f3abc5824b1c1f4675e..b94832ec9d8259b42ba64cb339284117d951e42c 100644 (file)
--- a/docs/memcached_quit.rst
+++ b/docs/memcached_quit.rst
@@ -1,83 +1,63 @@
-.. highlight:: perl
+====================================
+Disconnecting a client from a server
+====================================
 
+.. index:: object: memcached_st
 
-****
-NAME
-****
-
-
-memcached_quit - Disconnect from all servers
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------
 SYNOPSIS
-********
-
-
-
-.. code-block:: perl
+--------
 
-   #include <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`.
 
 
-******
+------
 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_t` 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.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
+------
 AUTHOR
-******
+------
 
 
 Brian Aker, <brian@tangent.org>
 
 
-********
+--------
 SEE ALSO
-********
-
-
-memcached(1) libmemcached(3) memcached_strerror(3)
+--------
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`