X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fsource%2Flibmemcached%2Fmemcached_create.rst;h=4b1fc8ced9e7b238c1b4f7a438a374ae25f88bbb;hb=60f8b5453b71e6a6252641607ce337739794d907;hp=a5bc63791785689bea3a8f68b7e3036c7f37cc39;hpb=0a654f848e13d470fb07b044347f2e91d6941807;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_create.rst b/docs/source/libmemcached/memcached_create.rst index a5bc6379..4b1fc8ce 100644 --- a/docs/source/libmemcached/memcached_create.rst +++ b/docs/source/libmemcached/memcached_create.rst @@ -11,11 +11,22 @@ SYNOPSIS .. function:: memcached_st* memcached_create(memcached_st *ptr) + :param ptr: pointer to user-allocated `memcached_st` struct or null pointer + :returns: pointer to initialized `memcached_st` struct + .. function:: void memcached_free(memcached_st *ptr) + :param ptr: pointer to initialized `memcached_st` struct to destroy and possibly free + .. function:: memcached_st* memcached_clone(memcached_st *destination, memcached_st *source) -.. function:: void memcached_servers_reset(memcached_st) + :param destination: pointer to user-allocated `memcached_st` struct or null pointer + :param source: pointer to initialized `memcached_st` struct to copy from + :returns: pointer to newly initialized `destination`, copied from `source` + +.. function:: void memcached_servers_reset(memcached_st *ptr) + + :param ptr: pointer to initialized `memcached_st` struct DESCRIPTION ----------- @@ -29,8 +40,8 @@ Please note, when you write new application use `memcached` over `memcached_create`. `memcached_clone` is similar to `memcached_create` but it copies the defaults -and list of servers from the source `memcached_st`. If you pass a null as the -argument for the source to clone, it is the same as a call to +and list of servers from the source `memcached_st` pointer. If you pass a null +as the argument for the source to clone, it is the same as a call to `memcached_create`. If the destination argument is NULL a `memcached_st` will be allocated for you.