docs: flush libmemcached progress
[awesomized/libmemcached] / docs / source / libmemcached / memcached_analyze.rst
index 312b42f06cf3097af85b8510b1cda10848dc06b5..74c7541ca7785647e7d7cb9be9d0522648e596c9 100644 (file)
@@ -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
 -----------