Added descriptions to fix debian manpage-has-bad-whatis-entry lintian tag.

[awesomized/libmemcached] / docs / memcached_result_st.pod

diff --git a/docs/memcached_result_st.pod b/docs/memcached_result_st.pod
old mode 100755 (executable)
new mode 100644 (file)
index 89d4e81..2463129
--- a/docs/memcached_result_st.pod
+++ b/docs/memcached_result_st.pod
@@ -1,9 +1,9 @@
 =head1 NAME
 
-memcahed_result_create, memcached_result_free,
+memcached_result_create, memcached_result_free,
 memcached_result_key_value, memcached_result_key_length,
 memcached_result_value, memcached_result_length,
-memcached_result_flags, memcached_result_cas
+memcached_result_flags, memcached_result_cas - Work with results
 
 
 =head1 LIBRARY
@@ -31,13 +31,20 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   uint64_t memcached_result_cas(memcached_result_st *result);
 
+  memcached_return memcached_result_set_value (memcached_result_st *ptr, 
+                                              char *value, size_t length)
+
+  void memcached_result_set_flags(memcached_result_st *ptr, uint32_t flags)
+
+  void memcached_result_set_expiration(memcached_result_st *ptr, time_t)
+
 =head1 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 currect example of
-this is the CAS return iteam). The structures can also be reused which will
+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.
 
@@ -69,6 +76,16 @@ memcached_result_cas() returns the cas associated with the
 current result object. This value will only be available if the server
 supports it.
 
+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
+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).
+
 
 =head1 RETURN