fix #131: add build time option: CLIENT_PREFIX

[awesomized/libmemcached] / docs / source / libmemcached / memcached_analyze.rst

diff --git a/docs/source/libmemcached/memcached_analyze.rst b/docs/source/libmemcached/memcached_analyze.rst
index 7843e4e8f934de7b28a44ae57152a69d22f05e5f..0dc9842022c8629a3283528c7c4f3c9b2651a352 100644 (file)
--- 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
 -----------
 
@@ -23,9 +28,10 @@ structure.
 and sets the result to the `memcached_analysis_st` structure. The return value
 must be freed by the calling application.
 
-.. seealso:: :option:`memstat --analyze`
+.. seealso:: :option:`memstat -a|--analyze [<arg>]`
     A command line tool to analyze a memcached server.
 
+
 RETURN VALUE
 ------------