X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fsource%2Flibmemcached%2Fmemcached_analyze.rst;h=74c7541ca7785647e7d7cb9be9d0522648e596c9;hb=f3c8c900e86e36e9817aa35411a35a92ed2714f2;hp=312b42f06cf3097af85b8510b1cda10848dc06b5;hpb=e20117720ca0fa133781b62c43aab59fe864b390;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_analyze.rst b/docs/source/libmemcached/memcached_analyze.rst index 312b42f0..74c7541c 100644 --- a/docs/source/libmemcached/memcached_analyze.rst +++ b/docs/source/libmemcached/memcached_analyze.rst @@ -11,6 +11,11 @@ SYNOPSIS .. function:: memcached_analysis_st *memcached_analyze(memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error) + :param ptr: pointer to initialized `memcached_st` struct + :param stat: pointer to a `memcached_stat_st` struct to fill + :param error: pointer to `memcached_return_t` indicating success + :returns: pointer to an allocated and filled out `memcached_analysis_t` struct + DESCRIPTION -----------