Merge bzr://10.0.3.21 Build: jenkins-Libmemcached-469

[awesomized/libmemcached] / docs / memcached_analyze.rst

diff --git a/docs/memcached_analyze.rst b/docs/memcached_analyze.rst
index 53cd85374767d4c8ac78f1c008383e1f693ca49f..88f3ad9d6b74076d8666606bc5db1c7cce375ce0 100644 (file)
--- a/docs/memcached_analyze.rst
+++ b/docs/memcached_analyze.rst
@@ -6,46 +6,36 @@ Anaylzing servers
 Analyze server information
 
 
--------
-LIBRARY
--------
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
 --------
 SYNOPSIS
 --------
 
+.. index:: object: memcached_analysis_st
 
 
-.. code-block:: perl
+#include <libmemcached/memcached.h>
 
-   #include <libmemcached/memcached.h>
+.. c:type:: memcached_analysis_st
  
-   memcached_analysis_st *
-     memcached_analyze (memcached_st *ptr,
-                        memcached_stat_st *stat,
-                        memcached_return_t *error);
-
+.. c:function::  memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
 
+Compile and link with -lmemcached
 
 -----------
 DESCRIPTION
 -----------
 
 
-libmemcached(3) has the ability to query a memcached server (or collection
-of servers) for their current state. Queries to find state return a
-\ ``memcached_analysis_st``\  structure. You are responsible for freeing this structure.
+:program:`libmemcached` has the ability to query a memcached server (or 
+collection of servers) for their current state. Queries to find state return a
+:c:type:`memcached_analysis_st` structure. You are responsible for freeing this structure.
 
-memcached_analyze() analyzes useful information based on the provided servers
-and sets the result to the \ ``memcached_analysis_st``\  structure. The return value
-must be freed by the calling application.
+:c:func:`memcached_analyze` analyzes useful information based on the 
+provided servers and sets the result to the :c:type:`memcached_analysis_st` 
+structure. The return value must be freed by the calling application.
 
-A command line tool, memstat(1) with the option --analyze, is provided so that
-you do not have to write an application to use this method.
+A command line tool, :program:`memstat` with the option :option:`memstat --analyze`, 
+is provided so that you do not have to write an application to use this method.
 
 
 ------
@@ -53,11 +43,11 @@ RETURN
 ------
 
 
-A pointer to the allocated \ ``memcached_analysis_st``\  structure on success and
-a NULL pointer on failure. You may inspect the error detail by checking the
-\ ``memcached_return_t``\  value.
+A pointer to the allocated :c:type:`memcached_analysis_st` structure on 
+success and a NULL pointer on failure. You may inspect the error detail by 
+checking the :c:type:`memcached_return_t` value.
 
-Any method returning a \ ``memcached_analysis_st``\  expects you to free the
+Any method returning a :c:type:`memcached_analysis_st` expects you to free the
 memory allocated for it.