Many fixes to the POD documentation

[awesomized/libmemcached] / docs / memcached_set.pod

diff --git a/docs/memcached_set.pod b/docs/memcached_set.pod
index 77d5c140861f48bc93402e81cf0c1d5c6b81a132..93037c14ce60473097dde66008c9875e0a0ff235 100755 (executable)
--- a/docs/memcached_set.pod
+++ b/docs/memcached_set.pod
@@ -8,26 +8,35 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
-#include <memcached.h>
-memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length, 
-    char *value, size_t value_length, 
-    time_t expiration,
-    uint16_t  flags);
-memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
-    char *value, size_t value_length, 
-    time_t expiration,
-    uint16_t  flags);
-memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
-    char *value, size_t value_length, 
-    time_t expiration,
-    uint16_t  flags);
+  #include <memcached.h>
+
+  memcached_return
+    memcached_set (memcached_st *ptr,
+                   char *key, size_t key_length, 
+                   char *value, size_t value_length, 
+                   time_t expiration,
+                   uint16_t flags);
+
+  memcached_return
+    memcached_add (memcached_st *ptr,
+                   char *key, size_t key_length,
+                   char *value, size_t value_length, 
+                   time_t expiration,
+                   uint16_t flags);
+
+  memcached_return
+    memcached_replace (memcached_st *ptr,
+                       char *key, size_t key_length,
+                       char *value, size_t value_length, 
+                       time_t expiration,
+                       uint16_t flags);
 
 =head1 DESCRIPTION
 
-memcached_set() , memcached_add(), and memcached_replace() are all used to
+memcached_set(), memcached_add(), and memcached_replace() are all used to
 store information on the server. All methods take a key, and its length to
-store the object. Keys are currently limited to 250 charcterss by the
-memcached server. You must also supply a value and a length. Optionally you
+store the object. Keys are currently limited to 250 characters by the
+memcached(1) server. You must also supply a value and a length. Optionally you
 may support an expiration time for the object and a 16 byte value (it is
 meant to be used as a bitmap).
 
@@ -47,18 +56,21 @@ server.
 
 =head1 RETURN
 
-All methods return a memcached_return value. On success the value will be
-MEMCACHED_SUCCESS (see memcached_strerror() for more information on this).
-For memcached_replace() and memcached_add() MEMCACHED_NOTSTORED is a
+All methods return a value of type C<memcached_return>.
+On success the value will be C<MEMCACHED_SUCCESS>.
+Use memcached_strerror() to translate this value to a printable string.
+
+For memcached_replace() and memcached_add(), C<MEMCACHED_NOTSTORED> is a
 legitmate error in the case of a collision.
 
 =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