docs: flush libmemcached

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

diff --git a/docs/source/libmemcached/memcached_touch.rst b/docs/source/libmemcached/memcached_touch.rst
index b1b982e4c2623928d46b804b5cb73cd9f4469ffe..1b0fdb610a651292b5a3e5dfee183f5992c442e3 100644 (file)
--- a/docs/source/libmemcached/memcached_touch.rst
+++ b/docs/source/libmemcached/memcached_touch.rst
@@ -1,19 +1,29 @@
-===========================================
-memcached_touch, memcached_touch_by_key
-===========================================
-
-.. index:: object: memcached_st
+Update expiration on a key
+==========================
 
 SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
+    Compile and link with -lmemcached
 
 .. function:: memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
 
+    :param ptr: pointer to initialized `memcached_st` struct
+    :param key: the key to touch
+    :param key_length: the length of `key` without any terminating zero
+    :param expiration: new expiration as a unix timestamp or as relative expiration time in seconds
+    :returns: `memcached_return_t` indicating success
+
 .. function:: memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
 
-Compile and link with -lmemcached
+    :param ptr: pointer to initialized `memcached_st` struct
+    :param group_key: the `key` namespace
+    :param group_key_length: the length of `group_key` without any terminating zero
+    :param key: the key to touch
+    :param key_length: the length of `key` without any terminating zero
+    :param expiration: new expiration as a unix timestamp or as relative expiration time in seconds
+    :returns: `memcached_return_t` indicating success
 
 DESCRIPTION
 -----------
@@ -25,7 +35,7 @@ to find the given value.
 RETURN VALUE
 ------------
 
-A value of type :type:`memcached_return_t` is returned
+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.
@@ -35,5 +45,12 @@ 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`