Merge in docs.

[m6w6/libmemcached] / docs / memcached_result_st.rst

diff --git a/docs/memcached_result_st.rst b/docs/memcached_result_st.rst
index dbbbfd20c36037b3aa98285a3b081985c34eb686..295b2229ebb669a2ede77e227de2a8d7723e50da 100644 (file)
--- a/docs/memcached_result_st.rst
+++ b/docs/memcached_result_st.rst
@@ -41,51 +41,50 @@ DESCRIPTION
 -----------
 
 
-libmemcached(3) can optionally return a memcached_result_st which acts as a
-result object. The result objects have added benefits over the character
-pointer returns, in that they are forward compatible with new return items
-that future memcached servers may implement (the best current example of
-this is the CAS return item). The structures can also be reused, which will
-save on calls to malloc(3). It is suggested that you use result objects over
-char \* return functions.
+libmemcached(3) can optionally return a :c:type:`memcached_result_st` which 
+acts as a result object. The result objects have added benefits over the 
+character pointer returns, in that they are forward compatible with new 
+return items that future memcached servers may implement (the best current 
+example of this is the CAS return item). The structures can also be reused, 
+which will save on calls to malloc(3). It is suggested that you use result 
+objects over char \* return functions.
 
-The structure of memcached_result_st has been encapsulated, you should not
-write code to directly access members of the structure.
+The structure of :c:type:`memcached_result_st` has been encapsulated, you should
+not write code to directly access members of the structure.
 
-memcached_result_create() will either allocate memory for a
-memcached_result_st or will initialize a structure passed to it.
+:c:func:`memcached_result_create()` will either allocate memory for a
+:c:type:`memcached_result_st` or will initialize a structure passed to it.
 
-memcached_result_free() will deallocate any memory attached to the
+:c:func:`memcached_result_free()` will deallocate any memory attached to the
 structure. If the structure was also allocated, it will deallocate it.
 
-memcached_result_key_value() returns the key value associated with the
+:c:func:`memcached_result_key_value()` returns the key value associated with the
 current result object.
 
-memcached_result_key_length() returns the key length associated with the
-current result object.
+:c:func:`memcached_result_key_length()` returns the key length associated with 
+the current result object.
 
-memcached_result_value() returns the result value associated with the
+:c:func:`memcached_result_value()` returns the result value associated with the
 current result object.
 
-memcached_result_length() returns the result length associated with the
-current result object.
+:c:func:`memcached_result_length()` returns the result length associated with 
+the current result object.
 
-memcached_result_flags() returns the flags associated with the
+:c:func:`memcached_result_flags()` returns the flags associated with the
 current result object.
 
-memcached_result_cas() returns the cas associated with the
+:c:func:`memcached_result_cas()` returns the cas associated with the
 current result object. This value will only be available if the server
 tests it.
 
-memcached_result_set_value() takes a byte array and a size and sets
+:c:func:`memcached_result_set_value()` takes a byte array and a size and sets
 the result to this value. This function is used for trigger responses.
 
-void memcached_result_set_flags() takes a result structure and stores
+:c:func:`void memcached_result_set_flags()` takes a result structure and stores
 a new value for the flags field.
 
-void memcached_result_set_expiration(A) takes a result structure and stores
-a new value for the expiration field (this is only used by read through
-triggers).
+:c:func:`void memcached_result_set_expiration(A)` takes a result structure and stores a new value for the expiration field (this is only used by read 
+through triggers).
 
 You may wish to avoid using memcached_result_create(3) with a
 stack based allocation. The most common issues related to ABI safety involve
@@ -98,8 +97,8 @@ RETURN
 
 
 Varies, see particular functions. All structures must have
-memcached_result_free() called on them for cleanup purposes. Failure to
-do this will result in leaked memory.
+:c:func:`memcached_result_free()` called on them for cleanup purposes. Failure 
+to do this will result in leaked memory.
 
 
 ----