Merge of all doc fixes.

[m6w6/libmemcached] / docs / memcached_pool.rst

diff --git a/docs/memcached_pool.rst b/docs/memcached_pool.rst
index a3e57899bf7fadb1d09b50b2d9781a7259a830f5..b7a0f04081754cb88636e5e4a072d37b6a47d266 100644 (file)
--- a/docs/memcached_pool.rst
+++ b/docs/memcached_pool.rst
@@ -1,61 +1,33 @@
-.. highlight:: perl
+============================
+Working with memcached pools
+============================
 
-
-****
-NAME
-****
-
-
-memcached_pool_create, memcached_pool_destroy, memcached_pool_push, memcached_pool_pop - Manage pools
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcachedutil, -lmemcachedutil)
-
-
-********
+--------
 SYNOPSIS
-********
-
+--------
 
+#include <libmemcached/memcached_pool.h>
 
-.. code-block:: perl
-
-   #include <libmemcached/memcached_pool.h>
- 
-   memcached_pool_st *
-     memcached_pool_create(memcached_st* mmc, int initial, int max);
+.. c:function:: memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
  
-   memcached_st *
-     memcached_pool_destroy(memcached_pool_st* pool);
+.. c:function:: memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
  
-   memcached_st *
-     memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
+.. c:function:: memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
  
-   memcached_return_t
-     memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
  
-   memcached_st *memcached_create (memcached_st *ptr);
+.. c:function:: memcached_st *memcached_create (memcached_st *ptr);
  
-   memcached_return_t
-     memcached_pool_behavior_set(memcached_pool_st *pool,
-                                 memcached_behavior_t flag,
-                                 uint64_t data)
+.. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
  
-   memcached_return_t
-     memcached_pool_behavior_get(memcached_pool_st *pool,
-                                 memcached_behavior_t flag,
-                                 uint64_t *value)
+.. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
 
+Compile and link with -lmemcachedutil -lmemcached
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_pool_create() is used to create a connection pool of objects you
@@ -87,9 +59,9 @@ memcached_pool_behavior_set() and memcached_pool_behagior_get() is
 used to get/set behavior flags on all connections in the pool.
 
 
-******
+------
 RETURN
-******
+------
 
 
 memcached_pool_create() returns a pointer to the newly created
@@ -109,27 +81,27 @@ memcached_pool_behavior_get() and memcached_pool_behavior_get()
 returns MEMCACHED_SUCCESS upon success.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
+------
 AUTHOR
-******
+------
 
 
+Brian Aker, <brian@tangent.org>
+
 Trond Norbye, <trond.norbye@gmail.com>
 
 
-********
+--------
 SEE ALSO
-********
-
-
-memcached(1) libmemcached(3) memcached_create(3) memcached_free(3) libmemcachedutil(3) memcached_behavior_get(3) memcached_behavior_set(3)
+--------
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`