Finally tracked down the oddball valgrind warning that I could never figure

[m6w6/libmemcached] / docs / memcached_create.pod

diff --git a/docs/memcached_create.pod b/docs/memcached_create.pod
index 61132d05c16bd5ee592380f72f307e26bb61d16d..cbe6fc1ee91c6accde864424b66133bfb294d384 100755 (executable)
--- a/docs/memcached_create.pod
+++ b/docs/memcached_create.pod
@@ -8,19 +8,20 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
-#include <memcached.h>
-memcached_st *memcached_create(memcached_st *ptr);
-void memcached_free(memcached_st *ptr);
+  #include <memcached.h>
 
-=head1 DESCRIPTION
+  memcached_st *memcached_create (memcached_st *ptr);
+
+  void memcached_free (memcached_st *ptr);
 
+=head1 DESCRIPTION
 
-memcached_create() is used to create a memcached_st structure that will then
-be used by other libmemcached functions to communicate with the server. You
-should either pass a statically declared memcached_st to memcached_create or
+memcached_create() is used to create a C<memcached_st> structure that will then
+be used by other libmemcached(3) functions to communicate with the server. You
+should either pass a statically declared C<memcached_st> to memcached_create() or
 a NULL. If a NULL passed in then a structure is allocated for you.
 
-To clean up memory associated with a memcached_st structure you should pass
+To clean up memory associated with a C<memcached_st> structure you should pass
 it to memcached_free() when you are finished using it. memcached_free() is
 the only way to make sure all memory is deallocated when you finish using
 the structure.
@@ -28,15 +29,16 @@ the structure.
 =head1 RETURN
 
 memcached_create() returns a pointer to the memcached_st that was created
-(or initialized). On an allocation failure, it returns null.
+(or initialized). On an allocation failure, it returns NULL.
 
 =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