X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_create.rst;h=3d801b1fe2210ed2dc0f402cb4589777f031cfd5;hb=30e386cd241ac56fd9205d12c143761475307705;hp=4fa5974600ae5c03c34d107744395ab79ee971d3;hpb=c4dbc7e56b01545e25bc95ba122c79d4a2631a99;p=m6w6%2Flibmemcached diff --git a/docs/hashkit_create.rst b/docs/hashkit_create.rst index 4fa59746..3d801b1f 100644 --- a/docs/hashkit_create.rst +++ b/docs/hashkit_create.rst @@ -1,32 +1,28 @@ -.. highlight:: perl +============================ +Creating a hashkit structure +============================ -**** -NAME -**** - - -hashkit_create, hashkit_clone, hashkit_free, hashkit_is_allocated - Create and destroy hashkit objects -******* +------- LIBRARY -******* +------- -C Library for hashing algorithms (libhashkit, -lhashkit) +C Library for hashing algorithms (libmemcached, -lhashkit) -******** +-------- SYNOPSIS -******** +-------- .. code-block:: perl - #include + #include hashkit_st *hashkit_create(hashkit_st *hash); @@ -38,9 +34,9 @@ SYNOPSIS -*********** +----------- DESCRIPTION -*********** +----------- The hashkit_create() function initializes a hashkit object for use. If @@ -59,9 +55,9 @@ The hashkit_is_allocated() reports where the memory was allocated for a hashkit object. -************ +------------ RETURN VALUE -************ +------------ hashkit_create() and hashkit_clone() will return NULL on failure or @@ -72,19 +68,10 @@ object was allocated inside of hashkit_create() or hashkit_clone(), otherwise it is false and was user-supplied memory. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ - - -****** -AUTHOR -****** - - -Brian Aker, -