Merge in docs.

[awesomized/libmemcached] / docs / memcached_servers.rst

diff --git a/docs/memcached_servers.rst b/docs/memcached_servers.rst
index 7331dbdddb21cf796b13a5c66780f17246b5552d..72da276496b5db9be99e7b3500d11066e27c4c95 100644 (file)
--- a/docs/memcached_servers.rst
+++ b/docs/memcached_servers.rst
@@ -2,29 +2,29 @@
 Manipulate the server information stored in memcached_st
 ========================================================
 
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
+-------- 
+SYNOPSIS 
 --------
 
 #include <libmemcached/memcached.h>
  
-.. c:function:: uint32_t memcached_server_count (memcached_st *ptr);
+.. c:type:: memcached_server_fn
 
-.. c:function:: memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port);
+.. c:function:: uint32_t memcached_server_count (memcached_st *ptr)
 
-.. c:function:: memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port);
+.. c:function:: memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port)
 
-.. c:function:: memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket);
+.. c:function:: memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port)
 
-.. c:function:: memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list); 
+.. c:function:: memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket)
 
-.. c:function:: memcached_server_instance_st memcached_server_by_key (const memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error);
+.. c:function:: memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list) 
+
+.. c:function:: memcached_server_instance_st memcached_server_by_key (const memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error)
 
 .. c:function:: memcached_server_instance_st memcached_server_get_last_disconnect (const memcached_st *ptr)
 
-.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks);
+.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks)
 
 compile and link with -lmemcached
 
@@ -35,8 +35,8 @@ DESCRIPTION
 -----------
 
 
-libmemcached(3) performs operations on a list of hosts. The order of these
-hosts determine routing to keys. Functions are provided to add keys to
+:doc:`libmemcached` performs operations on a list of hosts. The order of
+these hosts determine routing to keys. Functions are provided to add keys to
 memcached_st structures. To manipulate lists of servers see
 memcached_server_st(3).
 
@@ -44,9 +44,7 @@ memcached_server_st(3).
 servers being used by a :c:type:`memcached_st` structure.
 
 :c:func:`memcached_server_add()` pushes a single TCP server into the :c:type:`memcached_st` structure. This server will be placed at the end. Duplicate servers
- are allowed, so duplication is not checked. Executing this function with the
-:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set will result in a
-:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
+ are allowed, so duplication is not checked. Executing this function with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set will result in a :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
 
 :c:func:`memcached_server_add_udp()` pushes a single UDP server into the :c:type:`memcached_st` structure. This server will be placed at the end. Duplicate 
 servers are allowed, so duplication is not checked. Executing this function with out setting the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior will result in a