Merge Patrick

[awesomized/libmemcached] / docs / memcached_flush.pod

diff --git a/docs/memcached_flush.pod b/docs/memcached_flush.pod
old mode 100755 (executable)
new mode 100644 (file)
index 9f76079..0249fda
--- a/docs/memcached_flush.pod
+++ b/docs/memcached_flush.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-memcached_flush
+memcached_flush - wipe contents of memcached servers
 
 =head1 LIBRARY
 
@@ -8,30 +8,35 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
-#include <memcached.h>
-memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
+  #include <memcached.h>
 
-=head1 DESCRIPTION
+  memcached_return
+    memcached_flush (memcached_st *ptr,
+                     time_t expiration);
 
+=head1 DESCRIPTION
 
-memcached_flush() is used to wipe clean the contents of memcached servers.
-It will either do this immediatly or expire the content based on the
+memcached_flush() is used to wipe clean the contents of memcached(1) servers.
+It will either do this immediately or expire the content based on the
 expiration time passed to the method (a value of zero causes an immediate
 flush). The operation is not atomic to multiple servers, just atomic to a
-single server. Aka it will flush the servers in the order that they were
+single server. That is, it will flush the servers in the order that they were
 added.
 
 =head1 RETURN
 
-memcached_flush() returns memcached_return. The value on success will be MEMCACHED_SUCCESS. For all errors check with memcached_strerror().
+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