X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_server_st.rst;fp=docs%2Fmemcached_server_st.rst;h=f39c478b720ea47be93cb32322f431715a1bdadf;hb=16ba6539e831e2abcef9dcf56fa26e3a0d5c7f91;hp=77eb9137319e54545fa1cb2047e7e44c991e63c6;hpb=1056271e7a25406f0a118faeebeb67decf1c243b;p=awesomized%2Flibmemcached diff --git a/docs/memcached_server_st.rst b/docs/memcached_server_st.rst index 77eb9137..f39c478b 100644 --- a/docs/memcached_server_st.rst +++ b/docs/memcached_server_st.rst @@ -35,30 +35,25 @@ DESCRIPTION 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!). -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. -DEPRECATED memcached_servers_parse(), please see :manpage:`memcached(3)` +DEPRECATED :c:func:`memcached_servers_parse()`, please see :manpage:`memcached(3)` -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 -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. ------