Update documentation.

[awesomized/libmemcached] / docs / memcached_result_st.rst

diff --git a/docs/memcached_result_st.rst b/docs/memcached_result_st.rst
index e8aba51842a009d50d6c2b982c13036806e59223..fab6c4a41b0c93f1a398efb30c2f7293d33600e7 100644 (file)
--- a/docs/memcached_result_st.rst
+++ b/docs/memcached_result_st.rst
@@ -2,53 +2,40 @@
 Working with result sets
 ========================
 
+.. index:: object: memcached_result_st
 
 Work with memcached_result_st
 
 
--------
-LIBRARY
--------
+--------
+SYNOPSIS
+--------
 
+#include <libmemcached/memcached_pool.h>
 
-C Client Library for memcached (libmemcached, -lmemcached)
+.. c:function:: memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
 
+.. c:function:: void memcached_result_free (memcached_result_st *result);
 
---------
-SYNOPSIS
---------
+.. c:function:: const char * memcached_result_key_value (memcached_result_st *result);
+
+.. c:function:: size_t memcached_result_key_length (const memcached_result_st *result);
+
+.. c:function:: const char *memcached_result_value (memcached_result_st *ptr);
+
+.. c:function:: size_t memcached_result_length (const memcached_result_st *ptr);
+
+.. c:function:: uint32_t memcached_result_flags (const memcached_result_st *result)
+
+.. c:function:: uint64_t memcached_result_cas (const memcached_result_st *result);
+
+.. c:function:: memcached_return_t memcached_result_set_value (memcached_result_st *ptr, const char *value, size_t length)
 
+.. c:function:: void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags)
 
+.. c:function:: void memcached_result_set_expiration (memcached_result_st *ptr, time_t)
 
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
- 
-   memcached_result_st *
-     memcached_result_create (memcached_st *ptr,
-                              memcached_result_st *result);
- 
-   void memcached_result_free (memcached_result_st *result);
- 
-   const char * memcached_result_key_value (memcached_result_st *result);
- 
-   size_t memcached_result_key_length (const memcached_result_st *result);
- 
-   const char *memcached_result_value (memcached_result_st *ptr);
- 
-   size_t memcached_result_length (const memcached_result_st *ptr);
- 
-   uint32_t memcached_result_flags (const memcached_result_st *result)
- 
-   uint64_t memcached_result_cas (const memcached_result_st *result);
- 
-   memcached_return_t
-     memcached_result_set_value (memcached_result_st *ptr,
-                                 const char *value, size_t length)
- 
-   void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags)
- 
-   void memcached_result_set_expiration (memcached_result_st *ptr, time_t)
+Compile and link with -lmemcachedutil -lmemcached