X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_user_data.rst;h=a0bc602bb0629d4e084f09a28ee2e24969e049db;hb=66dcfb211cc2ca7dc6630754a6fd68343569e29a;hp=5f555f3f934daef02b0a4fbfd1875e61cac8d50c;hpb=49fc1e5ea4ea006f4a2ac71428833760f6fac030;p=awesomized%2Flibmemcached

diff --git a/docs/memcached_user_data.rst b/docs/memcached_user_data.rst
index 5f555f3f..a0bc602b 100644
--- a/docs/memcached_user_data.rst
+++ b/docs/memcached_user_data.rst
@@ -1,86 +1,75 @@
-.. highlight:: perl
+==============================================
+Storing custom user information in the client.
+==============================================
 
+.. index:: object: memcached_st
 
-****
-NAME
-****
+Manage user specific data
 
 
-memcached_set_user_data, memcached_get_user_data - Manage user specific data
-
-
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
+
+
+
+.. code-block:: c
 
+#include <libmemcached/memcached.h>
 
+.. c:function:: void *memcached_get_user_data (memcached_st *ptr)
 
-.. code-block:: perl
+.. c:function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
 
-   #include <memcached.h>
- 
-   void *memcached_get_user_data (memcached_st *ptr);
- 
-   void *memcached_set_user_data (memcached_st *ptr, void *data);
+Compile and link with -lmemcached
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 libmemcached(3) allows you to store a pointer to a user specific data inside
 the memcached_st structure.
 
-memcached_set_user_data() is used to set the user specific data in the
-memcached_st structure.
+:c:func:`memcached_set_user_data` is used to set the user specific data in the
+:c:type:`memcached_st` structure.
 
-memcached_get_user_data() is used to retrieve the user specific data in
-the memcached_st structure.
+:c:func:`memcached_get_user_data` is used to retrieve the user specific data in the :c:type:`memcached_st` structure.
 
 
-******
+------
 RETURN
-******
+------
 
 
-memcached_set_user_data() returns the previous value of the user specific 
-data.
+:c:func:`memcached_set_user_data` returns the previous value of the user specific data.
 
-memcached_get_user_data() returns the current value uf the user specific
-data.
+:c:func:`memcached_get_user_data` returns the current value uf the user specific data.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
-
-******
-AUTHOR
-******
-
-
-Trond Norbye, <trond.norbye@gmail.com>
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-********
+--------
 SEE ALSO
-********
+--------
 
 
-memcached(1) libmemcached(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`