Fixed all key methods to now take const char * (all previous code will work

[awesomized/libmemcached] / docs / memcached_auto.pod

diff --git a/docs/memcached_auto.pod b/docs/memcached_auto.pod
index 66feefcef2ba4ac579de7ffe2bc5d07e58f78fd6..df0a8b58b4352dc7da9020e96bc2684d95177b40 100755 (executable)
--- a/docs/memcached_auto.pod
+++ b/docs/memcached_auto.pod
@@ -8,21 +8,25 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
-#include <memcached.h>
-
-memcached_return memcached_increment(memcached_st *ptr, 
-                                     char *key, size_t key_length,
-                                     unsigned int offset,
-                                     unsigned int *value);
-memcached_return memcached_decrement(memcached_st *ptr, 
-                                     char *key, size_t key_length,
-                                     unsigned int offset,
-                                     unsigned int *value);
+  #include <memcached.h>
+
+  memcached_return
+    memcached_increment (memcached_st *ptr, 
+                         const char *key, size_t key_length,
+                         unsigned int offset,
+                         uint64_t *value);
+
+  memcached_return
+    memcached_decrement (memcached_st *ptr, 
+                         const char *key, size_t key_length,
+                         unsigned int offset,
+                         uint64_t *value);
+
 =head1 DESCRIPTION
 
 memcached(1) servers have the ability to increment and decrement keys
 (overflow and underflow are not detected). This gives you the ability to use
-servers to generate sequences of values.  
+memcached to generate shared sequences of values.  
 
 memcached_increment() takes a key and keylength and increments the value by
 the offset passed to it. The value is then returned via the unsigned int
@@ -34,16 +38,18 @@ value pointer you pass to it.
 
 =head1 RETURN
 
-memcached_increment() and memcached_decrement() return a memcached_return
-value. For information on this value see memcached_strerr(3).
+A value of type C<memcached_return> is returned.
+On success that value will be C<MEMCACHED_SUCCESS>.
+Use memcached_strerror() to translate this value to a printable string.
 
 =head1 HOME
 
-To find out more information please check: http://tangent.org/552/libmemcached.html
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
 
 =head1 AUTHOR
 
-Brian Aker, brian@tangent.org
+Brian Aker, E<lt>brian@tangent.orgE<gt>
 
 =head1 SEE ALSO