Merge in more documentation.

[awesomized/libmemcached] / docs / memcached_get.rst

diff --git a/docs/memcached_get.rst b/docs/memcached_get.rst
index 5f62532cee133cbb1084e01d5c9832f97882e426..ea0c6355cbc92030c5d88660bbeb2a8ba7ef06bb 100644 (file)
--- a/docs/memcached_get.rst
+++ b/docs/memcached_get.rst
@@ -3,93 +3,32 @@ Retrieving data from the server
 ===============================
 
 
-Get a value
+--------
+SYNOPSIS
+--------
 
 
-*******
-LIBRARY
-*******
+#include <libmemcached/memcached.h>
+ 
+.. c:function:: memcached_result_st * memcached_fetch_result (memcached_st *ptr, memcached_result_st *result, memcached_return_t *error);
 
+.. c:function:: char * memcached_get (memcached_st *ptr, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error);
 
-C Client Library for memcached (libmemcached, -lmemcached)
+.. c:function::  memcached_return_t memcached_mget (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys);
 
+.. c:function:: char * memcached_get_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error);
 
---------
-SYNOPSIS
---------
+.. c:function:: memcached_return_t memcached_mget_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys);
 
+.. c:function::  char * memcached_fetch (memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error);
 
+.. c:function::  memcached_return_t memcached_fetch_execute (memcached_st *ptr, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks);
 
-.. code-block:: perl
+.. c:function:: memcached_return_t memcached_mget_execute (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks);
 
-   #include <libmemcached/memcached.h>
- 
-   memcached_result_st *
-     memcached_fetch_result (memcached_st *ptr,
-                             memcached_result_st *result,
-                             memcached_return_t *error);
- 
-   char *
-     memcached_get (memcached_st *ptr,
-                    const char *key, size_t key_length,
-                    size_t *value_length,
-                    uint32_t *flags,
-                    memcached_return_t *error);
- 
-   memcached_return_t
-     memcached_mget (memcached_st *ptr,
-                   const char * const *keys,
-                   const size_t *key_length,
-                   size_t number_of_keys);
-   char *
-     memcached_get_by_key (memcached_st *ptr,
-                           const char *master_key, size_t master_key_length,
-                           const char *key, size_t key_length,
-                           size_t *value_length,
-                           uint32_t *flags,
-                           memcached_return_t *error);
- 
-   memcached_return_t
-     memcached_mget_by_key (memcached_st *ptr,
-                            const char *master_key, size_t master_key_length,
-                            const char * const *keys,
-                            const size_t *key_length,
-                            size_t number_of_keys);
- 
-   char *
-     memcached_fetch (memcached_st *ptr,
-                      char *key, size_t *key_length,
-                      size_t *value_length,
-                      uint32_t *flags,
-                      memcached_return_t *error);
- 
-   memcached_return_t
-     memcached_fetch_execute (memcached_st *ptr,
-                              memcached_execute_fn *callback,
-                              void *context,
-                              uint32_t number_of_callbacks);
- 
- 
-   memcached_return_t
-     memcached_mget_execute (memcached_st *ptr,
-                             const char * const *keys,
-                             const size_t *key_length,
-                             size_t number_of_keys,
-                             memcached_execute_fn *callback,
-                             void *context,
-                             uint32_t number_of_callbacks);
- 
-   memcached_return_t
-     memcached_mget_execute_by_key (memcached_st *ptr,
-                                    const char *master_key,
-                                    size_t master_key_length,
-                                    const char * const *keys,
-                                    const size_t *key_length,
-                                    size_t number_of_keys,
-                                    memcached_execute_fn *callback,
-                                    void *context,
-                                    uint32_t number_of_callbacks);
+.. c:function:: memcached_return_t memcached_mget_execute_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks);
 
+Compile and link with -lmemcached
 
 
 -----------
@@ -168,9 +107,9 @@ a \ ``memcached_return_t``\ , the error function parameter will be set to
 \ ``MEMCACHED_NOT_SUPPORTED``\ .
 
 
-******
+------
 RETURN
-******
+------
 
 
 All objects returned must be freed by the calling application.
@@ -182,22 +121,15 @@ and the key was set larger then MEMCACHED_MAX_KEY, which was the largest
 key allowed for the original memcached ascii server.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
 
 --------
 SEE ALSO