Update man rules.

[awesomized/libmemcached] / docs / memcached_callback.rst

diff --git a/docs/memcached_callback.rst b/docs/memcached_callback.rst
index 3cdd5adba1fe508516f6f0a524d5c156f9375c9a..0641aa4af64c781f8f3c23317c0bbb7fd79667cf 100644 (file)
--- a/docs/memcached_callback.rst
+++ b/docs/memcached_callback.rst
@@ -13,10 +13,12 @@ SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
+
+.. c:type:: memcached_callback_t
  
-.. c:function:: memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data);
+.. c:function:: memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, const void *data)
  
-.. c:function:: void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
+.. c:function:: void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error)
 
 Compile and link with -lmemcached
 
@@ -30,36 +32,38 @@ libmemcached(3) can have callbacks set key execution points. These either
 provide function calls at points in the code, or return pointers to
 structures for particular usages.
 
-:c:func:`memcached_callback_get()` takes a callback flag and returns the 
-structure or function set by :c:func:`memcached_callback_set()`.
+:c:func:`memcached_callback_get` takes a callback flag and returns the 
+structure or function set by :c:func:`memcached_callback_set`.
 
-:c:func:`memcached_callback_set()` changes the function/structure assigned by a
+:c:func:`memcached_callback_set` changes the function/structure assigned by a
 callback flag. No connections are reset.
 
 You can use :c:type:`MEMCACHED_CALLBACK_USER_DATA` to provide custom context 
 if required for any of the callbacks.
 
 
-.. c:var:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION
+.. c:type:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION
  
-When :c:func:`memcached_delete()` is called this function will be excuted. At 
+When :c:func:`memcached_delete` is called this function will be excuted. At 
 the point of its execution all connections are closed.
  
 
 
-.. c:var:: MEMCACHED_CALLBACK_CLONE_FUNCTION
+.. c:type:: MEMCACHED_CALLBACK_CLONE_FUNCTION
  
-When :c:func:`memcached_delete()` is called this function will be excuted. 
+When :c:func:`memcached_delete` is called this function will be excuted. 
 At the point of its execution all connections are closed.
- 
 
+.. c:type:: MEMCACHED_CALLBACK_PREFIX_KEY
 
-.. c:var:: MEMCACHED_CALLBACK_PREFIX_KEY
+   See :c:type:`MEMCACHED_CALLBACK_NAMESPACE`
+
+.. c:type:: MEMCACHED_CALLBACK_NAMESPACE
  
 You can set a value which will be used to create a domain for your keys.
-The value specified here will be prefixed to each of your keys. The value can 
-not be greater then :c:type:`MEMCACHED_PREFIX_KEY_MAX_SIZE - 1` and will 
-reduce :c:type:`MEMCACHED_MAX_KEY` by the value of your key. 
+The value specified here will be prefixed to each of your keys. The value can
+not be greater then :c:macro:`MEMCACHED_PREFIX_KEY_MAX_SIZE` - 1 and will
+reduce :c:macro:`MEMCACHED_MAX_KEY` by the value of your key. 
 
 The prefix key is only applied to the primary key, not the master key. 
 :c:type:`MEMCACHED_FAILURE` will be returned if no key is set. In the case of 
@@ -67,34 +71,25 @@ a key which is too long, :c:type:`MEMCACHED_BAD_KEY_PROVIDED` will be returned.
  
 If you set a value with the value being NULL then the prefix key is disabled.
 
-
-.. c:var:: MEMCACHED_CALLBACK_USER_DATA
+.. c:type:: MEMCACHED_CALLBACK_USER_DATA
  
 This allows you to store a pointer to a specifc piece of data. This can be
-retrieved from inside of :c:func:`memcached_fetch_execute()`. Cloning a 
+retrieved from inside of :c:func:`memcached_fetch_execute`. Cloning a 
 :c:type:`memcached_st` will copy the pointer to the clone.
  
+.. c:type:: MEMCACHED_CALLBACK_MALLOC_FUNCTION
+.. deprecated:: <0.32
+   Use :c:type:`memcached_set_memory_allocators` instead.
 
-
-.. c:var:: MEMCACHED_CALLBACK_MALLOC_FUNCTION
- 
-DEPRECATED: use :c:type:`memcached_set_memory_allocators` instead.
+.. c:type:: MEMCACHED_CALLBACK_REALLOC_FUNCTION
+.. deprecated:: <0.32
+   Use :c:type:`memcached_set_memory_allocators` instead.
  
+.. c:type:: MEMCACHED_CALLBACK_FREE_FUNCTION
+.. deprecated:: <0.32
+   Use :c:type:`memcached_set_memory_allocators` instead.
 
-
-.. c:var:: MEMCACHED_CALLBACK_REALLOC_FUNCTION
- 
-DEPRECATED: use :c:type:`memcached_set_memory_allocators` instead.
- 
-
-
-.. c:var:: MEMCACHED_CALLBACK_FREE_FUNCTION
- 
-DEPRECATED: use :c:type:`memcached_set_memory_allocators` instead.
- 
-
-
-.. c:var:: MEMCACHED_CALLBACK_GET_FAILURE
+.. c:type:: MEMCACHED_CALLBACK_GET_FAILURE
  
 This function implements the read through cache behavior. On failure of retrieval this callback will be called. 
 
@@ -113,7 +108,7 @@ The prototype for this is:
  
 
 
-.. c:var:: MEMCACHED_CALLBACK_DELETE_TRIGGER
+.. c:type:: MEMCACHED_CALLBACK_DELETE_TRIGGER
  
 This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it.
  
@@ -129,11 +124,11 @@ RETURN
 ------
 
 
-:c:func:`memcached_callback_get()` return the function or structure that was 
+:c:func:`memcached_callback_get` return the function or structure that was 
 provided. Upon error, nothing is set, null is returned, and the 
 :c:type:`memcached_return_t` argument is set to :c:type:`MEMCACHED_FAILURE`.
 
-:c:func:`memcached_callback_set()` returns :c:type:`MEMCACHED_SUCCESS` upon 
+:c:func:`memcached_callback_set` returns :c:type:`MEMCACHED_SUCCESS` upon 
 successful setting, otherwise :c:type:`MEMCACHED_FAILURE` on error.