Remove dead local call.
[m6w6/libmemcached] / docs / memcached_delete.rst
index f628f69e96a68e887f15bc4880c8961aacb15a8d..1c4f2661bd11e9a5b7145fdcae97ee6a043c5f5e 100644 (file)
@@ -2,6 +2,8 @@
 Deleting data from a server
 ===========================
 
+.. index:: object: memcached_st
+
 --------
 SYNOPSIS
 --------
@@ -9,9 +11,9 @@ SYNOPSIS
 
 #include <libmemcached/memcached.h>
  
-.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
+.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
 
-.. c:function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration);
+.. c:function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
 
 Compile and link with -lmemcached
 
@@ -20,9 +22,9 @@ DESCRIPTION
 -----------
 
 
-memcached_delete() is used to delete a particular key. 
-memcached_delete_by_key() works the same, but it takes a master key to
-find the given value.
+:c:func:`memcached_delete` is used to delete a particular key. 
+:c:func:`memcached_delete_by_key` works the same, but it takes a master key 
+to find the given value.
 
 Expiration works by placing the item into a delete queue, which means that
 it won't be possible to retrieve it by the "get" command. The "add" and 
@@ -38,9 +40,10 @@ RETURN
 ------
 
 
-A value of type \ ``memcached_return_t``\  is returned
-On success that value will be \ ``MEMCACHED_SUCCESS``\ .
-Use memcached_strerror() to translate this value to a printable string.
+A value of type :c:type:`memcached_return_t` is returned
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror` to translate this value to a printable 
+string.
 
 If you are using the non-blocking mode of the library, success only
 means that the message was queued for delivery.