Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

[m6w6/libmemcached] / docs / man / memcached_result_free.3

diff --git a/docs/man/memcached_result_free.3 b/docs/man/memcached_result_free.3
index fce830dd7fe7e468f40a44cf902b985c269d9ca8..71cff37833db407fd9b138a12425a7b2f4b29f1d 100644 (file)
--- a/docs/man/memcached_result_free.3
+++ b/docs/man/memcached_result_free.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_RESULT_FREE" "3" "June 17, 2011" "0.49" "libmemcached"
+.TH "MEMCACHED_RESULT_FREE" "3" "April 28, 2012" "1.0.7" "libmemcached"

 .SH NAME
 memcached_result_free \- Working with result sets
 .
 .SH NAME
 memcached_result_free \- Working with result sets
 .


@@ -39,27 +39,27 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
+.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B void memcached_result_free (memcached_result_st *result);
+.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B const char * memcached_result_key_value (memcached_result_st *result);
+.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B size_t memcached_result_key_length (const memcached_result_st *result);
+.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B const char *memcached_result_value (memcached_result_st *ptr);
+.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B size_t memcached_result_length (const memcached_result_st *ptr);
+.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP


@@ -67,7 +67,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B uint64_t memcached_result_cas (const memcached_result_st *result);
+.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP


@@ -85,49 +85,49 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 Compile and link with \-lmemcachedutil \-lmemcached
 .SH DESCRIPTION
 .sp
 Compile and link with \-lmemcachedutil \-lmemcached
 .SH DESCRIPTION
 .sp

-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 \fI\%memcached_result_st\fP 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.

 .sp
 .sp

-The structure of memcached_result_st has been encapsulated, you should not
-write code to directly access members of the structure.
+The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
+not write code to directly access members of the structure.

 .sp
 .sp

-memcached_result_create() will either allocate memory for a
-memcached_result_st or will initialize a structure passed to it.
+\fI\%memcached_result_create()\fP will either allocate memory for a
+\fI\%memcached_result_st\fP or will initialize a structure passed to it.

 .sp
 .sp

-memcached_result_free() will deallocate any memory attached to the
+\fI\%memcached_result_free()\fP will deallocate any memory attached to the

 structure. If the structure was also allocated, it will deallocate it.
 .sp
 structure. If the structure was also allocated, it will deallocate it.
 .sp

-memcached_result_key_value() returns the key value associated with the
+\fI\%memcached_result_key_value()\fP returns the key value associated with the

 current result object.
 .sp
 current result object.
 .sp

-memcached_result_key_length() returns the key length associated with the
-current result object.
+\fI\%memcached_result_key_length()\fP returns the key length associated with
+the current result object.

 .sp
 .sp

-memcached_result_value() returns the result value associated with the
+\fI\%memcached_result_value()\fP returns the result value associated with the

 current result object.
 .sp
 current result object.
 .sp

-memcached_result_length() returns the result length associated with the
-current result object.
+\fI\%memcached_result_length()\fP returns the result length associated with
+the current result object.

 .sp
 .sp

-memcached_result_flags() returns the flags associated with the
+\fI\%memcached_result_flags()\fP returns the flags associated with the

 current result object.
 .sp
 current result object.
 .sp

-memcached_result_cas() returns the cas associated with the
+\fI\%memcached_result_cas()\fP returns the cas associated with the

 current result object. This value will only be available if the server
 tests it.
 .sp
 current result object. This value will only be available if the server
 tests it.
 .sp

-memcached_result_set_value() takes a byte array and a size and sets
+\fI\%memcached_result_set_value()\fP takes a byte array and a size and sets

 the result to this value. This function is used for trigger responses.
 .sp
 the result to this value. This function is used for trigger responses.
 .sp

-void memcached_result_set_flags() takes a result structure and stores
-a new value for the flags field.
+\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
+value for the flags field.

 .sp
 .sp

-void memcached_result_set_expiration(A) takes a result structure and stores
+\fI\%memcached_result_set_expiration()\fP takes a result structure and stores

 a new value for the expiration field (this is only used by read through
 triggers).
 .sp
 a new value for the expiration field (this is only used by read through
 triggers).
 .sp


@@ -137,8 +137,8 @@ heap allocated structures.
 .SH RETURN
 .sp
 Varies, see particular functions. All structures must have
 .SH RETURN
 .sp
 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.
+\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
+to do this will result in leaked memory.

 .SH HOME
 .sp
 To find out more information please check:
 .SH HOME
 .sp
 To find out more information please check: