Update framework.

[m6w6/libmemcached] / docs / memcached_server_st.rst

diff --git a/docs/memcached_server_st.rst b/docs/memcached_server_st.rst
index 77eb9137319e54545fa1cb2047e7e44c991e63c6..6bca49b8f5dd8ae82cb8ddbc23eabc51836968c6 100644 (file)
--- a/docs/memcached_server_st.rst
+++ b/docs/memcached_server_st.rst
@@ -3,8 +3,6 @@ Managing lists of servers
 =========================
 
 
 =========================
 
 

-.. index:: object: memcached_server_instance_st
-

 --------
 SYNOPSIS
 --------
 --------
 SYNOPSIS
 --------


@@ -12,19 +10,28 @@ SYNOPSIS
 
 
 #include <libmemcached/memcached.h>
 
 
 #include <libmemcached/memcached.h>

- 
-.. c:function:: const memcached_server_instance_st memcached_server_list (memcached_st *ptr);

 
 

-.. c:function:: void memcached_server_list_free (memcached_server_list_st list);
+.. c:type:: memcached_server_instance_st
+
+.. c:type:: memcached_server_list_st
+
+.. c:type:: memcached_server_st
+
+.. c:function:: const memcached_server_instance_st memcached_server_list (memcached_st *ptr)
+
+.. c:function:: void memcached_server_list_free (memcached_server_list_st list)

  
  

-.. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, unsigned int port, memcached_return_t *error);
+.. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, in_port_t port, memcached_return_t *error)

  
  

-.. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list);
+.. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list)

  
  

-.. c:function:: const char *memcached_server_error (memcached_server_instance_st instance);
+.. c:function:: const char *memcached_server_error (memcached_server_instance_st instance)

  
  

-.. c:function:: void memcached_server_error_reset (memcached_server_instance_st list); DEPRECATED 
+.. c:function:: void memcached_server_error_reset (memcached_server_instance_st list)
+.. deprecated:: 0.39

    
    

+.. c:function:: void memcached_servers_parse ()
+.. deprecated:: 0.39

 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 


@@ -35,30 +42,25 @@ DESCRIPTION
 
 
 libmemcached(3) operates on a list of hosts which are stored in
 
 
 libmemcached(3) operates on a list of hosts which are stored in

-memcached_server_st structures. You should not modify these structures
+:c:type:`memcached_server_st` structures. You should not modify these structures

 directly. Functions are provided to modify these structures (and more can be
 added, just ask!).
 
 directly. Functions are provided to modify these structures (and more can be
 added, just ask!).
 

-memcached_server_list() is used to provide an array of all defined hosts.
-This was incorrectly documented as "requiring free()" up till version 0.39.
+:c:func:`memcached_server_list` is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.

 
 

-memcached_server_list_free() deallocates all memory associated with the array
-of memcached_server_st that you passed to it.
+:c:func:`memcached_server_list_free` deallocates all memory associated with the array of :c:type:`memcached_server_st` that you passed to it.

 
 

-memcached_server_list_append() adds a server to the end of a
-memcached_server_st array. On error null will be returned and the
-memcached_return_t pointer you passed into the function will be set with the
-appropriate error. If the value of port is zero, it is set to the default
+:c:func:`memcached_server_list_append` adds a server to the end of a
+:c:type:`memcached_server_st` array. On error null will be returned and the
+:c:type:`memcached_return_t` pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default

 port of a memcached server.
 
 port of a memcached server.
 

-DEPRECATED memcached_servers_parse(), please see :manpage:`memcached(3)`
+DEPRECATED :c:func:`memcached_servers_parse`, please see :c:func:`memcached`

 
 

-memcached_server_error() can be used to look at the text of the last error 
-message sent by the server to to the client.
+:c:func:`memcached_server_error` can be used to look at the text of the last error message sent by the server to to the client.

 
 Before version 0.39 theses functions used a memcache_server_st \*. In 0.39
 
 Before version 0.39 theses functions used a memcache_server_st \*. In 0.39

-memcached_server_st \* was aliased to memcached_server_list_st. This was
-done for a style reason/to help clean up some concepts in the code.
+memcached_server_st \* was aliased to :c:type:`memcached_server_list_st`. This was done for a style reason to help clean up some concepts in the code.

 
 
 ------
 
 
 ------