Fix Trond's email address.

[awesomized/libmemcached] / docs / memcached_strerror.pod

diff --git a/docs/memcached_strerror.pod b/docs/memcached_strerror.pod
old mode 100755 (executable)
new mode 100644 (file)
index 342d77f..07801d8
--- a/docs/memcached_strerror.pod
+++ b/docs/memcached_strerror.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-memcached_strerror
+memcached_strerror - Get error string
 
 =head1 LIBRARY
 
@@ -8,31 +8,36 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
-#include <memcached.h>
-char *memcached_strerror(memcached_st *ptr, memcached_return rc);
+  #include <memcached.h>
+
+  const char *
+    memcached_strerror (memcached_st *ptr,
+                        memcached_return_t rc);
 
 =head1 DESCRIPTION
 
+memcached_strerror() takes a C<memcached_return_t> value and returns a string
+describing the error.
+
+This string must not be modified by the application.
 
-memcached_strerror() takes a memcached_return value and returns a string
-describing the error. memcahed_return values are returned from nearly all
-libmemcached functions. They are a set of ENUM values describing all
-possibly success and failure operations possible in the library. 
+C<memcached_return_t> values are returned from nearly all libmemcached(3) functions.
 
-memcached_return values are of an ENUM type so that you can set up responses
+C<memcached_return_t> values are of an enum type so that you can set up responses
 with switch/case and know that you are capturing all possible return values.
 
 =head1 RETURN
 
-memcached_strerror() returns a string describing a memcached_return value.
+memcached_strerror() returns a string describing a C<memcached_return_t> value.
 
 =head1 HOME
 
-To find out more information please check: http://tangent.org/552/libmemcached.html
+To find out more information please check:
+L<https://launchpad.net/libmemcached>
 
 =head1 AUTHOR
 
-Brian Aker, brian@tangent.org
+Brian Aker, E<lt>brian@tangent.orgE<gt>
 
 =head1 SEE ALSO