Fix all warnings found via clang.

[awesomized/libmemcached] / docs / memcached_sasl.rst

diff --git a/docs/memcached_sasl.rst b/docs/memcached_sasl.rst
index bf0251dd9415e70542bd5474e57408e8fe917921..2a2e5699088047cc160a55d103600a363033c83b 100644 (file)
--- a/docs/memcached_sasl.rst
+++ b/docs/memcached_sasl.rst
@@ -2,34 +2,24 @@
 SASL support
 ============
 
-
--------
-LIBRARY
--------
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
+.. index:: object: memcached_st
 
 
 --------
 SYNOPSIS
 --------
 
+#include <libmemcached/memcached_pool.h>
 
+.. c:function:: void memcached_set_sasl_callbacks(memcached_st *ptr, const sasl_callback_t *callbacks)
 
-.. code-block:: perl
+.. c:function:: const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
 
-   #include <libmemcached/memcached.h>
- 
-   void memcached_set_sasl_callbacks(memcached_st *ptr,
-                                     const sasl_callback_t *callbacks)
- 
-   const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
- 
-   memcached_return memcached_set_sasl_auth_data(memcached_st *ptr,
-                                                 const char *username,
-                                                 const char *password)
-   memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr)
+.. c:function:: memcached_return_t memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password)
+
+.. c:function:: memcached_return_t memcached_destroy_sasl_auth_data(memcached_st *ptr)
+
+Compile and link with -lmemcached
 
 
 
@@ -44,16 +34,13 @@ libsasl to perform SASL authentication.
 Please note that SASL requires the memcached binary protocol, and you have
 to specify the callbacks before you connect to the server.
 
-memcached_set_sasl_auth_data() is a helper function defining
+:c:func:`memcached_set_sasl_auth_data` is a helper function defining
 the basic functionality for you, but it will store the username and password
 in memory. If you choose to use this method you have to call
-memcached_destroy_sasl_auth_data before calling memcached_free to avoid
-a memory leak. You should NOT call memcached_destroy_sasl_auth_data if you
-specify your own callback function with memcached_set_sasl_callbacks().
-
-You as a client user have to initialize libsasl by using sasl_client_init
-before enabling it in libmemcached, and you have to shut down libsasl by
-calling sasl_done() when you are done using SASL from libmemcached.
+:c:type:`memcached_destroy_sasl_auth_data` before calling 
+:c:type:`memcached_free` to avoid a memory leak. You should NOT call 
+:c:type:`memcached_destroy_sasl_auth_data` if you specify your own callback 
+function with :c:func:`memcached_set_sasl_callbacks`.
 
 
 ------
@@ -61,9 +48,9 @@ RETURN
 ------
 
 
-memcached_get_sasl_callbacks() returns the callbacks currently used
-by this memcached handle.
-memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
+:c:func:`memcached_get_sasl_callbacks` returns the callbacks currently used by
+this memcached handle. :c:func:`memcached_set_sasl_auth_data` returns
+:c:type:`MEMCACHED_SUCCESS` upon success.
 
 
 ----