Updates on C++ interface

[awesomized/libmemcached] / docs / memcached_quit.pod

diff --git a/docs/memcached_quit.pod b/docs/memcached_quit.pod
old mode 100755 (executable)
new mode 100644 (file)
index b438e3c..0500b2a
--- a/docs/memcached_quit.pod
+++ b/docs/memcached_quit.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-memcached_quit
+memcached_quit - Disconnect from all servers
 
 =head1 LIBRARY
 
@@ -8,16 +8,16 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
-#include <memcached.h>
-void memcached_quit(memcached_st *ptr);
+  #include <memcached.h>
 
-=head1 DESCRIPTION
+  void memcached_quit (memcached_st *ptr);
 
+=head1 DESCRIPTION
 
 memcached_quit() will disconnect you from all currently connected servers.
-It will also reset the state of the connection (aka any memcached_fetch you
+It will also reset the state of the connection (ie, any memcached_fetch() you
 are in the middle of will be terminated). This function is called
-automatically when you call memcached_free() on the memcached_st structure.
+automatically when you call memcached_free() on the C<memcached_st> structure.
 
 You do not need to call this on your own. All operations to change server
 hashes and parameters will handle connections to the server for you. This
@@ -26,15 +26,18 @@ reset connections during the middle of a memcached_fetch().
 
 =head1 RETURN
 
-memcached_quit() 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