Make sure we use the correct strerror() in case someone is using threads.
[awesomized/libmemcached] / docs / memcached_strerror.rst
index 6a22bd9b9d4b56db7c396f018f8c74661c6e7a95..ce5b1fa0b9bbbd7440b1c1ee76a2ed4c3fecc3a9 100644 (file)
@@ -3,28 +3,17 @@ Coverting Errors, memcached_return_t, to strings
 ================================================
 
 
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
+.. index:: object: memcached_st
 
 --------
 SYNOPSIS
 --------
 
+#include <libmemcached/memcached.h>
 
+.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc);
 
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
-   const char *
-     memcached_strerror (memcached_st *ptr,
-                         memcached_return_t rc);
-
+Compile and link with -lmemcached
 
 
 -----------
@@ -43,30 +32,23 @@ This string must not be modified by the application.
 with switch/case and know that you are capturing all possible return values.
 
 
-******
+------
 RETURN
-******
+------
 
 
 memcached_strerror() returns a string describing a \ ``memcached_return_t``\  value.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
 
 --------
 SEE ALSO