Merge in fix for url to main libmemcached.org site.
[awesomized/libmemcached] / docs / memcached_delete.rst
index 56ad96977c6626c260d7a1e7ada1b16d888a832e..5afccee7f4e5f3fe349e9a4a9c8c7b4bdd77f4dd 100644 (file)
@@ -1,43 +1,19 @@
-.. highlight:: perl
-
-
-memcached_delete
-----------------
-
-
-Delete a key
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
+===========================
+Deleting data from a server
+===========================
 
 --------
 SYNOPSIS
 --------
 
 
-
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
-   memcached_return_t
-     memcached_delete (memcached_st *ptr,
-                       const char *key, size_t key_length,
-                       time_t expiration);
+#include <libmemcached/memcached.h>
  
-   memcached_return_t
-   memcached_delete_by_key (memcached_st *ptr,
-                            const char *master_key, size_t master_key_length,
-                            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);
 
+Compile and link with -lmemcached
 
 -----------
 DESCRIPTION
@@ -57,9 +33,9 @@ Please note the the Danga memcached server removed tests for expiration in
 the 1.4 version.
 
 
-******
+------
 RETURN
-******
+------
 
 
 A value of type \ ``memcached_return_t``\  is returned
@@ -70,18 +46,18 @@ If you are using the non-blocking mode of the library, success only
 means that the message was queued for delivery.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
+------
 AUTHOR
-******
+------
 
 
 Brian Aker, <brian@tangent.org>