docs: flush libmemcached

[awesomized/libmemcached] / docs / source / libmemcached / memcached_set_encoding_key.rst

diff --git a/docs/source/libmemcached/memcached_set_encoding_key.rst b/docs/source/libmemcached/memcached_set_encoding_key.rst
index 38ddba092ad11896eb94d8f15d8b6c0512c02a81..95e3e32f7843d2e22753b1d9922745209db8e755 100644 (file)
--- a/docs/source/libmemcached/memcached_set_encoding_key.rst
+++ b/docs/source/libmemcached/memcached_set_encoding_key.rst
@@ -1,34 +1,45 @@
 Set encryption key
 ==================
 
-.. index:: object: memcached_st
-
 SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
+    Compile and link with -lmemcached
 
-.. function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length)
+.. function:: memcached_return_t memcached_set_encoding_key (memcached_st *ptr, const char *str, const size_t length)
 
-Compile and link with -lmemcached
+    :param ptr: pointer to initialized `memcached_st` struct
+    :param str: the key to use
+    :param length: the length of `key` without any terminating zero
+    :returns: `memcached_return_t` indicating success
 
 DESCRIPTION
 -----------
 
-:func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and received from the server.
+:func:`memcached_set_encoding_key` sets the key that will be used to encrypt and
+decrypt data as it is sent and received from the server.
 
 Currently only AES is is supported.
 
 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.
+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`