Merge in updates to all docs/etc.

[m6w6/libmemcached] / docs / memcached_auto.rst

diff --git a/docs/memcached_auto.rst b/docs/memcached_auto.rst
index a08400e48e6b228c6e0b4a512f32a0ddbf44cb35..fab217f928f83c5b5be5816a5c53e2fe5203a80c 100644 (file)
--- a/docs/memcached_auto.rst
+++ b/docs/memcached_auto.rst
@@ -1,108 +1,42 @@
-.. highlight:: perl
+====================================
+Incrementing and Decrementing Values
+====================================
 
 
-****
-NAME
-****
 
+--------
+SYNOPSIS
+--------
 
-memcached_increment, memcached_decrement,
-memcached_increment_with_initial, memcached_decrement_with_initial - Manipulate
-counters
 
 
-*******
-LIBRARY
-*******
+#include <libmemcached/memcached.h>
+ 
+.. c:function:: memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
 
+.. c:function:: memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
 
-C Client Library for memcached (libmemcached, -lmemcached)
+.. c:function:: memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
 
+.. c:function:: memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
 
-********
-SYNOPSIS
-********
+.. c:function::  memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
 
+.. c:function:: memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
 
+.. c:function:: memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
 
-.. code-block:: perl
+.. c:function:: memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
 
-   #include <memcached.h>
- 
-   memcached_return_t
-     memcached_increment (memcached_st *ptr, 
-                          const char *key, size_t key_length,
-                          unsigned int offset,
-                          uint64_t *value);
- 
-   memcached_return_t
-     memcached_decrement (memcached_st *ptr, 
-                          const char *key, size_t key_length,
-                          unsigned int offset,
-                          uint64_t *value);
- 
-   memcached_return_t
-     memcached_increment_with_initial (memcached_st *ptr,
-                                       const char *key,
-                                       size_t key_length,
-                                       uint64_t offset,
-                                       uint64_t initial,
-                                       time_t expiration,
-                                       uint64_t *value);
- 
-   memcached_return_t
-     memcached_decrement_with_initial (memcached_st *ptr,
-                                       const char *key,
-                                       size_t key_length,
-                                       uint64_t offset,
-                                       uint64_t initial,
-                                       time_t expiration,
-                                       uint64_t *value);
- 
-   memcached_return_t
-     memcached_increment_by_key (memcached_st *ptr, 
-                                 const char *master_key, size_t master_key_length,
-                                 const char *key, size_t key_length,
-                                 unsigned int offset,
-                                 uint64_t *value);
- 
-   memcached_return_t
-     memcached_decrement_by_key (memcached_st *ptr, 
-                                 const char *master_key, size_t master_key_length,
-                                 const char *key, size_t key_length,
-                                 unsigned int offset,
-                                 uint64_t *value);
- 
-   memcached_return_t
-     memcached_increment_with_initial_by_key (memcached_st *ptr,
-                                              const char *master_key,
-                                              size_t master_key_length,
-                                              const char *key,
-                                              size_t key_length,
-                                              uint64_t offset,
-                                              uint64_t initial,
-                                              time_t expiration,
-                                              uint64_t *value);
- 
-   memcached_return_t
-     memcached_decrement_with_initial_by_key (memcached_st *ptr,
-                                              const char *master_key,
-                                              size_t master_key_length,
-                                              const char *key,
-                                              size_t key_length,
-                                              uint64_t offset,
-                                              uint64_t initial,
-                                              time_t expiration,
-                                              uint64_t *value);
+Compile and link with -lmemcached
 
 
-
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
-memcached(1) servers have the ability to increment and decrement keys
+:manpage:`memcached(1)` servers have the ability to increment and decrement keys
 (overflow and underflow are not detected). This gives you the ability to use
 memcached to generate shared sequences of values.
 
@@ -138,9 +72,9 @@ memcached_decrement_with_initial_by_key() are master key equivalents of the
 above.
 
 
-******
+------
 RETURN
-******
+------
 
 
 A value of type \ ``memcached_return_t``\  is returned.
@@ -148,27 +82,18 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ .
 Use memcached_strerror() to translate this value to a printable string.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-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)`