Merge

[awesomized/libmemcached] / docs / memcached_user_data.rst

diff --git a/docs/memcached_user_data.rst b/docs/memcached_user_data.rst
index 5f555f3f934daef02b0a4fbfd1875e61cac8d50c..45482f70da4ae97315fb27b293659cca61b16fae 100644 (file)
--- a/docs/memcached_user_data.rst
+++ b/docs/memcached_user_data.rst
@@ -1,31 +1,29 @@
-.. 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:: perl
 
-   #include <memcached.h>
+   #include <libmemcached/memcached.h>
  
    void *memcached_get_user_data (memcached_st *ptr);
  
@@ -33,54 +31,43 @@ SYNOPSIS
 
 
 
-***********
+-----------
 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)`