X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fhashkit_free.3;h=fcc34aa92b01b318c0e7b6409bde8d41e5ee8f38;hb=bc9a024d4d2292b68be5d3a90063ea0193c7770f;hp=9bac53151f315b0cb28839085889226f9ee86629;hpb=625e84ebfc422790372bc2984f504bdcb4da779c;p=m6w6%2Flibmemcached diff --git a/docs/man/hashkit_free.3 b/docs/man/hashkit_free.3 index 9bac5315..fcc34aa9 100644 --- a/docs/man/hashkit_free.3 +++ b/docs/man/hashkit_free.3 @@ -1,4 +1,4 @@ -.TH "HASHKIT_FREE" "3" "June 17, 2011" "0.49" "libmemcached" +.TH "HASHKIT_FREE" "3" "September 26, 2011" "0.53" "libmemcached" .SH NAME hashkit_free \- libhashkit Documentation . @@ -35,6 +35,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] #include .INDENT 0.0 .TP +.B hashkit_st +.UNINDENT +.INDENT 0.0 +.TP .B hashkit_st *hashkit_create(hashkit_st *hash); .UNINDENT .INDENT 0.0 @@ -53,32 +57,35 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] Compile and link with \-lhashkit .SH DESCRIPTION .sp -The hashkit_create() function initializes a hashkit object for use. If +The \fBhashkit_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 \fBhashkit_clone()\fP function initializes a hashkit object much like +\fBhashkit_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 \fBhashkit_free()\fP frees any resources being consumed by the hashkit +objects that were initialized with \fBhashkit_create()\fP or \fBhashkit_clone()\fP. .sp -The hashkit_is_allocated() reports where the memory was allocated +The \fBhashkit_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. +\fBhashkit_create()\fP and \fBhashkit_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. +\fBhashkit_is_allocated()\fP returns true if the memory for the hashkit +object was allocated inside of \fBhashkit_create()\fP or +\fBhashkit_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