Merge in documentation updates.

[m6w6/libmemcached] / docs / memcached_callback.rst

diff --git a/docs/memcached_callback.rst b/docs/memcached_callback.rst
index e830b7aa2c54deb6bb12899c7cb5549a3bd3db04..a4b4b3d3081548a430ab7583f5bf6dea496edfc0 100644 (file)
--- a/docs/memcached_callback.rst
+++ b/docs/memcached_callback.rst
@@ -1,12 +1,9 @@
-.. highlight:: perl
+=================
+Setting callbacks
+=================
 
 
-****
-NAME
-****
-
-
-memcached_callback_get, memcached_callback_set - Get and set a callback
+Get and set a callback
 
 
 *******
@@ -17,15 +14,15 @@ LIBRARY
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
 .. code-block:: perl
 
-   #include <memcached.h>
+   #include <libmemcached/memcached.h>
  
    memcached_return_t 
      memcached_callback_set (memcached_st *ptr, 
@@ -39,9 +36,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 libmemcached(3) can have callbacks set key execution points. These either
@@ -81,6 +78,7 @@ MEMCACHED_CALLBACK_PREFIX_KEY
  not the master key. MEMCACHED_FAILURE will be returned if no key is set. In the case
  of a key which is too long MEMCACHED_BAD_KEY_PROVIDED will be returned.
  
+ If you set a value with the value being NULL then the prefix key is disabled.
 
 
 MEMCACHED_CALLBACK_USER_DATA
@@ -164,10 +162,9 @@ AUTHOR
 Brian Aker, <brian@tangent.org>
 
 
-********
+--------
 SEE ALSO
-********
-
+--------
 
-memcached(1) libmemcached(3) memcached_strerror(3)
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`