Merge bzr://10.0.3.21 Build: jenkins-Libmemcached-469
[awesomized/libmemcached] / docs / memcached_user_data.rst
index 107d04752913796cb5d6cdb724841ad67f54b845..a0bc602bb0629d4e084f09a28ee2e24969e049db 100644 (file)
@@ -21,13 +21,15 @@ SYNOPSIS
 
 
 
-.. code-block:: perl
+.. code-block:: c
 
-   #include <libmemcached/memcached.h>
-   void *memcached_get_user_data (memcached_st *ptr);
-   void *memcached_set_user_data (memcached_st *ptr, void *data);
+#include <libmemcached/memcached.h>
+
+.. c:function:: void *memcached_get_user_data (memcached_st *ptr)
+
+.. c:function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
+
+Compile and link with -lmemcached
 
 
 
@@ -39,11 +41,10 @@ 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.
 
 
 ------
@@ -51,11 +52,9 @@ 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.
 
 
 ----
@@ -72,5 +71,5 @@ SEE ALSO
 --------
 
 
-memcached(1) libmemcached(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`