X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fhashkit_create.3;h=e8cead58a7c08267b7a070f1a959c594fbc25918;hb=1ed24c334f35870e6206ecea58f298dfbcd8f406;hp=d7cd48c0a5c5db396062f8bcd8fc07319c868409;hpb=228bf943e5469e09f437a0a71bd3b0863e3c4590;p=m6w6%2Flibmemcached diff --git a/docs/man/hashkit_create.3 b/docs/man/hashkit_create.3 index d7cd48c0..e8cead58 100644 --- a/docs/man/hashkit_create.3 +++ b/docs/man/hashkit_create.3 @@ -1,4 +1,4 @@ -.TH "HASHKIT_CREATE" "3" "October 18, 2011" "1.01" "libmemcached" +.TH "HASHKIT_CREATE" "3" "May 22, 2012" "1.0.8" "libmemcached" .SH NAME hashkit_create \- libhashkit Documentation . @@ -39,46 +39,46 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .UNINDENT .INDENT 0.0 .TP -.B hashkit_st *hashkit_create(hashkit_st *hash); +.B \fI\%hashkit_st\fP *hashkit_create(\fI\%hashkit_st\fP\fI\ *hash\fP) .UNINDENT .INDENT 0.0 .TP -.B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr); +.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 void hashkit_free(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 hashkit_st *hash); +.B bool hashkit_is_allocated(const \fI\%hashkit_st\fP\fI\ *hash\fP) .UNINDENT .sp Compile and link with \-lhashkit .SH DESCRIPTION .sp -The \fBhashkit_create()\fP 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 \fBhashkit_clone()\fP function initializes a hashkit object much like -\fBhashkit_create()\fP, 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 \fBhashkit_free()\fP frees any resources being consumed by the hashkit -objects that were initialized with \fBhashkit_create()\fP or \fBhashkit_clone()\fP. +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 \fBhashkit_is_allocated()\fP 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 -\fBhashkit_create()\fP and \fBhashkit_clone()\fP will return NULL on +\fI\%hashkit_create()\fP and \fI\%hashkit_clone()\fP will return NULL on failure or non\-NULL on success. .sp -\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. +\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: