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

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

diff --git a/docs/man/hashkit_clone.3 b/docs/man/hashkit_clone.3
index 6b94f0bde0dcdd7182d5a5743e8b75950b73710d..52f2e0a3cfaadf73a284a8c4ff5200447e96231a 100644 (file)
--- a/docs/man/hashkit_clone.3
+++ b/docs/man/hashkit_clone.3
@@ -1,4 +1,4 @@
-.TH "HASHKIT_CLONE" "3" "June 17, 2011" "0.49" "libmemcached"
+.TH "HASHKIT_CLONE" "3" "April 17, 2012" "1.0.6" "libmemcached"
 .SH NAME
 hashkit_clone \- libhashkit Documentation
 .
@@ -35,50 +35,57 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 #include <libhashkit/hashkit.h>
 .INDENT 0.0
 .TP
-.B hashkit_st *hashkit_create(hashkit_st *hash);
+.B hashkit_st
 .UNINDENT
 .INDENT 0.0
 .TP
-.B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
+.B \fI\%hashkit_st\fP *hashkit_create(\fI\%hashkit_st\fP\fI\ *hash\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B void hashkit_free(hashkit_st *hash);
+.B \fI\%hashkit_st\fP *hashkit_clone(\fI\%hashkit_st\fP\fI\ *destination\fP, const \fI\%hashkit_st\fP\fI\ *ptr\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B bool hashkit_is_allocated(const hashkit_st *hash);
+.B void hashkit_free(\fI\%hashkit_st\fP\fI\ *hash\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B bool hashkit_is_allocated(const \fI\%hashkit_st\fP\fI\ *hash\fP)
 .UNINDENT
 .sp
 Compile and link with \-lhashkit
 .SH DESCRIPTION
 .sp
-The hashkit_create() function initializes a hashkit object for use. If
+The \fI\%hashkit_create()\fP function initializes a hashkit object for use. If
 you pass a NULL argument for hash, then the memory for the object is
 allocated. If you specify a pre\-allocated piece of memory, that is
 initialized for use.
 .sp
-The hashkit_clone() function initializes a hashkit object much like
-hashkit_create(), but instead of using default settings it will use
+The \fI\%hashkit_clone()\fP function initializes a hashkit object much like
+\fI\%hashkit_create()\fP, but instead of using default settings it will use
 the settings of the ptr hashkit object.
 .sp
-The hashkit_free() frees any resources being consumed by the hashkit
-objects that were initialized with hashkit_create() or hashkit_clone().
+The \fI\%hashkit_free()\fP frees any resources being consumed by the hashkit
+objects that were initialized with \fI\%hashkit_create()\fP or \fI\%hashkit_clone()\fP.
 .sp
-The hashkit_is_allocated() reports where the memory was allocated
+The \fI\%hashkit_is_allocated()\fP reports where the memory was allocated
 for a hashkit object.
 .SH RETURN VALUE
 .sp
-hashkit_create() and hashkit_clone() will return NULL on failure or
-non\-NULL on success.
+\fI\%hashkit_create()\fP and \fI\%hashkit_clone()\fP will return NULL on
+failure or non\-NULL on success.
 .sp
-hashkit_is_allocated() returns true if the memory for the hashkit
-object was allocated inside of hashkit_create() or hashkit_clone(),
-otherwise it is false and was user\-supplied memory.
+\fI\%hashkit_is_allocated()\fP returns true if the memory for the hashkit
+object was allocated inside of \fI\%hashkit_create()\fP or
+\fI\%hashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
 .SH HOME
 .sp
 To find out more information please check:
 \fI\%http://libmemcached.org/\fP
+.SH SEE ALSO
+.sp
+\fIhashkit_create(3)\fP \fIhashkit_value(3)\fP \fIhashkit_set_hash_fn(3)\fP
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT