docs: flush libmemcached progress
[awesomized/libmemcached] / docs / source / libmemcached / memcached_last_error.rst
index 9b82c38773abf6a5481b8a9f09a7f7a4639d5792..e135a8f3115a95ea0a4b37af3fe8eb969840a24f 100644 (file)
@@ -7,11 +7,20 @@ SYNOPSIS
 #include <libmemcached/memcached.h>
   Compile and link with -lmemcached
 
-.. function:: memcached_return_t memcached_last_error(const memcached_st *)
-.. function:: const char *memcached_last_error_message(const memcached_st *)
+.. function:: memcached_return_t memcached_last_error(const memcached_st *ptr)
 
-.. function:: int memcached_last_error_errno(const memcached_st *)
+    :param ptr: pointer to an initialized `memcached_st` struct
+    :returns: `memcached_return_t` indicating success of last operation
+
+.. function:: const char *memcached_last_error_message(const memcached_st *ptr)
+
+    :param ptr: pointer to an initialized `memcached_st` struct
+    :returns: message describing the status of last operation
+
+.. function:: int memcached_last_error_errno(const memcached_st *ptr)
+
+    :param ptr: pointer to an initialized `memcached_st` struct
+    :returns: :manpage:`errno(3)` (if any) of last operation
 
 DESCRIPTION
 -----------
@@ -31,18 +40,19 @@ need to be de-allocated. NULL will be returned if no error has occurred.
 `memcached_last_error_errno` returns any last local error code obtained from
 :manpage:`errno(3)`.
 
-
 SEE ALSO
 --------
 
 .. only:: man
 
     :manpage:`memcached(1)`
+    :manpage:`errno(3)`
     :manpage:`libmemcached(3)`
     :manpage:`memcached_strerror(3)`
 
 .. only:: html
 
     * :manpage:`memcached(1)`
+    * :manpage:`errno(3)`
     * :doc:`../libmemcached`
     * :doc:`memcached_strerror`